{ "openapi": "3.1.0", "info": { "title": "UnifyDesk API", "version": "v1", "description": "Read and change your workspace data from your own tools. Every request carries a personal API token from Settings > Access & API." }, "servers": [ { "url": "https://{team}.unifydesk.app/api/v1", "variables": { "team": { "default": "your-team", "description": "Your organization's UnifyDesk address." } } } ], "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "activity" }, { "name": "assets" }, { "name": "companies" }, { "name": "contacts" }, { "name": "contracts" }, { "name": "conversations" }, { "name": "credit_notes" }, { "name": "documents" }, { "name": "expenses" }, { "name": "invoices" }, { "name": "opportunities" }, { "name": "pipeline" }, { "name": "projects" }, { "name": "purchase_orders" }, { "name": "quotes" }, { "name": "refunds", "description": "Recording a refund needs a signed-in person with current two-step sign-in, so tokens cannot record refunds (CO51). Refunds stay readable and their reason editable." }, { "name": "reports" }, { "name": "tasks" }, { "name": "time_entries" } ], "paths": { "/activity": { "get": { "operationId": "list_activity", "tags": [ "activity" ], "summary": "List activity", "x-unifydesk-scope": { "module": "activity", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "event_type", "in": "query", "description": "Only rows whose event_type equals this value.", "schema": { "type": "string" } }, { "name": "actor_id", "in": "query", "description": "Only rows whose actor_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "entity_type", "in": "query", "description": "Only rows whose entity_type equals this value.", "schema": { "type": "string" } }, { "name": "entity_id", "in": "query", "description": "Only rows whose entity_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/activity/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_activity", "tags": [ "activity" ], "summary": "Get one activity", "x-unifydesk-scope": { "module": "activity", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Activity" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/assets": { "get": { "operationId": "list_assets", "tags": [ "assets" ], "summary": "List assets", "x-unifydesk-scope": { "module": "assets", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "asset_type_id", "in": "query", "description": "Only rows whose asset_type_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "assigned_user_id", "in": "query", "description": "Only rows whose assigned_user_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Asset" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_asset", "tags": [ "assets" ], "summary": "Create a asset", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "assets", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Asset" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/assets/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_asset", "tags": [ "assets" ], "summary": "Get one asset", "x-unifydesk-scope": { "module": "assets", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Asset" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_asset", "tags": [ "assets" ], "summary": "Update a asset", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "assets", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AssetUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Asset" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_asset", "tags": [ "assets" ], "summary": "Move a asset to the trash", "x-unifydesk-scope": { "module": "assets", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/companies": { "get": { "operationId": "list_companies", "tags": [ "companies" ], "summary": "List companies", "x-unifydesk-scope": { "module": "companies", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc", "name.asc", "name.desc" ] } }, { "name": "industry", "in": "query", "description": "Only rows whose industry equals this value.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_company", "tags": [ "companies" ], "summary": "Create a company", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "companies", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/companies/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_company", "tags": [ "companies" ], "summary": "Get one company", "x-unifydesk-scope": { "module": "companies", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_company", "tags": [ "companies" ], "summary": "Update a company", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "companies", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Company" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_company", "tags": [ "companies" ], "summary": "Move a company to the trash", "x-unifydesk-scope": { "module": "companies", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/contacts": { "get": { "operationId": "list_contacts", "tags": [ "contacts" ], "summary": "List contacts", "x-unifydesk-scope": { "module": "contacts", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_contact", "tags": [ "contacts" ], "summary": "Create a contact", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "contacts", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Contact" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/contacts/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_contact", "tags": [ "contacts" ], "summary": "Get one contact", "x-unifydesk-scope": { "module": "contacts", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Contact" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_contact", "tags": [ "contacts" ], "summary": "Update a contact", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "contacts", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Contact" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_contact", "tags": [ "contacts" ], "summary": "Move a contact to the trash", "x-unifydesk-scope": { "module": "contacts", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/contracts": { "get": { "operationId": "list_contracts", "tags": [ "contracts" ], "summary": "List contracts", "x-unifydesk-scope": { "module": "contracts", "capability": "view", "action_for_rates": "view_billing_rates" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contact_id", "in": "query", "description": "Only rows whose contact_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Contract" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_contract", "tags": [ "contracts" ], "summary": "Create a contract", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "contracts", "capability": "create", "action_for_rates": "view_billing_rates" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Contract" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/contracts/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_contract", "tags": [ "contracts" ], "summary": "Get one contract", "x-unifydesk-scope": { "module": "contracts", "capability": "view", "action_for_rates": "view_billing_rates" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Contract" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_contract", "tags": [ "contracts" ], "summary": "Update a contract", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "contracts", "capability": "edit", "action_for_rates": "view_billing_rates" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Contract" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_contract", "tags": [ "contracts" ], "summary": "Move a contract to the trash", "x-unifydesk-scope": { "module": "contracts", "capability": "delete", "action_for_rates": "view_billing_rates" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/conversations": { "get": { "operationId": "list_conversations", "tags": [ "conversations" ], "summary": "List conversations", "x-unifydesk-scope": { "module": "conversations", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default updated_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "updated_at.asc", "updated_at.desc" ] } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } }, { "name": "priority", "in": "query", "description": "Only rows whose priority equals this value.", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Only rows whose assignee_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contact_id", "in": "query", "description": "Only rows whose contact_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "query", "description": "Only rows whose project_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contract_id", "in": "query", "description": "Only rows whose contract_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Conversation" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_conversation", "tags": [ "conversations" ], "summary": "Create a conversation", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "conversations", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Conversation" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/conversations/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_conversation", "tags": [ "conversations" ], "summary": "Get one conversation", "x-unifydesk-scope": { "module": "conversations", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Conversation" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_conversation", "tags": [ "conversations" ], "summary": "Update a conversation", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "conversations", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConversationUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Conversation" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_conversation", "tags": [ "conversations" ], "summary": "Move a conversation to the trash", "x-unifydesk-scope": { "module": "conversations", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/credit_notes": { "get": { "operationId": "list_credit_notes", "tags": [ "credit_notes" ], "summary": "List credit notes", "x-unifydesk-scope": { "module": "credit_notes", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } }, { "name": "invoice_id", "in": "query", "description": "Only rows whose invoice_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNote" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_credit_note", "tags": [ "credit_notes" ], "summary": "Create a credit note", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "credit_notes", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNoteCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CreditNote" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/credit_notes/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_credit_note", "tags": [ "credit_notes" ], "summary": "Get one credit note", "x-unifydesk-scope": { "module": "credit_notes", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CreditNote" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_credit_note", "tags": [ "credit_notes" ], "summary": "Update a credit note", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "credit_notes", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/CreditNote" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_credit_note", "tags": [ "credit_notes" ], "summary": "Move a credit note to the trash", "x-unifydesk-scope": { "module": "credit_notes", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/documents": { "get": { "operationId": "list_documents", "tags": [ "documents" ], "summary": "List documents", "x-unifydesk-scope": { "module": "documents", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "folder", "in": "query", "description": "Only rows whose folder equals this value.", "schema": { "type": "string" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contact_id", "in": "query", "description": "Only rows whose contact_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "query", "description": "Only rows whose project_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Document" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/documents/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_document", "tags": [ "documents" ], "summary": "Get one document", "x-unifydesk-scope": { "module": "documents", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Document" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_document", "tags": [ "documents" ], "summary": "Update a document", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "documents", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DocumentUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Document" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_document", "tags": [ "documents" ], "summary": "Move a document to the trash", "x-unifydesk-scope": { "module": "documents", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/expenses": { "get": { "operationId": "list_expenses", "tags": [ "expenses" ], "summary": "List expenses", "x-unifydesk-scope": { "module": "expenses", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Only rows whose category equals this value.", "schema": { "type": "string" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "query", "description": "Only rows whose project_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Expense" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_expense", "tags": [ "expenses" ], "summary": "Create a expense", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "expenses", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Expense" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/expenses/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_expense", "tags": [ "expenses" ], "summary": "Get one expense", "x-unifydesk-scope": { "module": "expenses", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Expense" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_expense", "tags": [ "expenses" ], "summary": "Update a expense", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "expenses", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Expense" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_expense", "tags": [ "expenses" ], "summary": "Move a expense to the trash", "x-unifydesk-scope": { "module": "expenses", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/invoices": { "get": { "operationId": "list_invoices", "tags": [ "invoices" ], "summary": "List invoices", "x-unifydesk-scope": { "module": "invoices", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default issue_date.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "issue_date.asc", "issue_date.desc" ] } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contact_id", "in": "query", "description": "Only rows whose contact_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contract_id", "in": "query", "description": "Only rows whose contract_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_invoice", "tags": [ "invoices" ], "summary": "Create a invoice", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "invoices", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Invoice" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/invoices/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_invoice", "tags": [ "invoices" ], "summary": "Get one invoice", "x-unifydesk-scope": { "module": "invoices", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Invoice" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_invoice", "tags": [ "invoices" ], "summary": "Update a invoice", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "invoices", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Invoice" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_invoice", "tags": [ "invoices" ], "summary": "Move a invoice to the trash", "x-unifydesk-scope": { "module": "invoices", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/opportunities": { "get": { "operationId": "list_opportunities", "tags": [ "opportunities" ], "summary": "List opportunities", "x-unifydesk-scope": { "module": "pipeline", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default expected_close_date.asc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "expected_close_date.asc", "expected_close_date.desc" ] } }, { "name": "stage_id", "in": "query", "description": "Only rows whose stage_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contact_id", "in": "query", "description": "Only rows whose contact_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "owner_id", "in": "query", "description": "Only rows whose owner_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Opportunity" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_opportunity", "tags": [ "opportunities" ], "summary": "Create a opportunity", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "pipeline", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Opportunity" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/opportunities/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_opportunity", "tags": [ "opportunities" ], "summary": "Get one opportunity", "x-unifydesk-scope": { "module": "pipeline", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Opportunity" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_opportunity", "tags": [ "opportunities" ], "summary": "Update a opportunity", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "pipeline", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OpportunityUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Opportunity" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_opportunity", "tags": [ "opportunities" ], "summary": "Move a opportunity to the trash", "x-unifydesk-scope": { "module": "pipeline", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/pipeline": { "get": { "operationId": "list_pipeline", "tags": [ "pipeline" ], "summary": "List pipeline", "x-unifydesk-scope": { "module": "pipeline", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default expected_close_date.asc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "expected_close_date.asc", "expected_close_date.desc" ] } }, { "name": "stage_id", "in": "query", "description": "Only rows whose stage_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contact_id", "in": "query", "description": "Only rows whose contact_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "owner_id", "in": "query", "description": "Only rows whose owner_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Pipeline" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_pipeline", "tags": [ "pipeline" ], "summary": "Create a pipeline", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "pipeline", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Pipeline" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/pipeline/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_pipeline", "tags": [ "pipeline" ], "summary": "Get one pipeline", "x-unifydesk-scope": { "module": "pipeline", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Pipeline" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_pipeline", "tags": [ "pipeline" ], "summary": "Update a pipeline", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "pipeline", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PipelineUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Pipeline" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_pipeline", "tags": [ "pipeline" ], "summary": "Move a pipeline to the trash", "x-unifydesk-scope": { "module": "pipeline", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/projects": { "get": { "operationId": "list_projects", "tags": [ "projects" ], "summary": "List projects", "x-unifydesk-scope": { "module": "projects", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "owner_id", "in": "query", "description": "Only rows whose owner_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contact_id", "in": "query", "description": "Only rows whose contact_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "health_status", "in": "query", "description": "Only rows whose health_status equals this value.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_project", "tags": [ "projects" ], "summary": "Create a project", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "projects", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/projects/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_project", "tags": [ "projects" ], "summary": "Get one project", "x-unifydesk-scope": { "module": "projects", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_project", "tags": [ "projects" ], "summary": "Update a project", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "projects", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Project" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_project", "tags": [ "projects" ], "summary": "Move a project to the trash", "x-unifydesk-scope": { "module": "projects", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/purchase_orders": { "get": { "operationId": "list_purchase_orders", "tags": [ "purchase_orders" ], "summary": "List purchase orders", "x-unifydesk-scope": { "module": "purchase_orders", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } }, { "name": "vendor_id", "in": "query", "description": "Only rows whose vendor_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "query", "description": "Only rows whose project_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrder" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/purchase_orders/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_purchase_order", "tags": [ "purchase_orders" ], "summary": "Get one purchase order", "x-unifydesk-scope": { "module": "purchase_orders", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrder" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_purchase_order", "tags": [ "purchase_orders" ], "summary": "Update a purchase order", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "purchase_orders", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/PurchaseOrder" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_purchase_order", "tags": [ "purchase_orders" ], "summary": "Move a purchase order to the trash", "x-unifydesk-scope": { "module": "purchase_orders", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/quotes": { "get": { "operationId": "list_quotes", "tags": [ "quotes" ], "summary": "List quotes", "x-unifydesk-scope": { "module": "quotes", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contact_id", "in": "query", "description": "Only rows whose contact_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "opportunity_id", "in": "query", "description": "Only rows whose opportunity_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Quote" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_quote", "tags": [ "quotes" ], "summary": "Create a quote", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "quotes", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Quote" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/quotes/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_quote", "tags": [ "quotes" ], "summary": "Get one quote", "x-unifydesk-scope": { "module": "quotes", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Quote" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_quote", "tags": [ "quotes" ], "summary": "Update a quote", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "quotes", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/QuoteUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Quote" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_quote", "tags": [ "quotes" ], "summary": "Move a quote to the trash", "x-unifydesk-scope": { "module": "quotes", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/refunds": { "get": { "operationId": "list_refunds", "tags": [ "refunds" ], "summary": "List refunds", "x-unifydesk-scope": { "module": "refunds", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "invoice_id", "in": "query", "description": "Only rows whose invoice_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "credit_note_id", "in": "query", "description": "Only rows whose credit_note_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Refund" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/refunds/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_refund", "tags": [ "refunds" ], "summary": "Get one refund", "x-unifydesk-scope": { "module": "refunds", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Refund" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_refund", "tags": [ "refunds" ], "summary": "Update a refund", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "refunds", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Refund" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_refund", "tags": [ "refunds" ], "summary": "Move a refund to the trash", "x-unifydesk-scope": { "module": "refunds", "capability": "delete" }, "parameters": [], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/reports": { "get": { "operationId": "list_reports", "tags": [ "reports" ], "summary": "List reports", "x-unifydesk-scope": { "module": "reports", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Report" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/reports/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_report", "tags": [ "reports" ], "summary": "Get one report", "x-unifydesk-scope": { "module": "reports", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Report" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/tasks": { "get": { "operationId": "list_tasks", "tags": [ "tasks" ], "summary": "List tasks", "x-unifydesk-scope": { "module": "tasks", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default created_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "created_at.asc", "created_at.desc" ] } }, { "name": "status", "in": "query", "description": "Only rows whose status equals this value.", "schema": { "type": "string" } }, { "name": "priority", "in": "query", "description": "Only rows whose priority equals this value.", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Only rows whose assignee_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "company_id", "in": "query", "description": "Only rows whose company_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "contact_id", "in": "query", "description": "Only rows whose contact_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "project_id", "in": "query", "description": "Only rows whose project_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "parent_task_id", "in": "query", "description": "Only rows whose parent_task_id equals this value.", "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Task" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_task", "tags": [ "tasks" ], "summary": "Create a task", "description": "Send only the fields you set.", "x-unifydesk-scope": { "module": "tasks", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Task" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/tasks/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_task", "tags": [ "tasks" ], "summary": "Get one task", "x-unifydesk-scope": { "module": "tasks", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Task" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_task", "tags": [ "tasks" ], "summary": "Update a task", "description": "Send only the fields you change.", "x-unifydesk-scope": { "module": "tasks", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/Task" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_task", "tags": [ "tasks" ], "summary": "Move a task to the trash", "x-unifydesk-scope": { "module": "tasks", "capability": "delete" }, "parameters": [ { "name": "If-Match", "in": "header", "required": true, "description": "The row's updated_at from a GET, in double quotes.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "412": { "description": "The row changed since your GET; read it again.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "428": { "description": "If-Match is required.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/time_entries": { "get": { "operationId": "list_time_entries", "tags": [ "time_entries" ], "summary": "List time entries", "x-unifydesk-scope": { "module": "time_reports", "capability": "view" }, "parameters": [ { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/offset" }, { "$ref": "#/components/parameters/cursor" }, { "name": "order", "in": "query", "description": "Sort as .asc or .desc. Default started_at.desc.", "schema": { "type": "string", "enum": [ "id.asc", "id.desc", "started_at.asc", "started_at.desc" ] } }, { "name": "entity_type", "in": "query", "description": "Only rows whose entity_type equals this value.", "schema": { "type": "string" } }, { "name": "entity_id", "in": "query", "description": "Only rows whose entity_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "user_id", "in": "query", "description": "Only rows whose user_id equals this value.", "schema": { "type": "string", "format": "uuid" } }, { "name": "billable", "in": "query", "description": "Only rows whose billable equals this value.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "A page of rows.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "limit", "offset" ], "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntry" } }, "limit": { "type": "integer" }, "offset": { "type": "integer" }, "nextCursor": { "type": [ "string", "null" ], "description": "Pass as cursor to read the next page; null on the last page." } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "post": { "operationId": "create_time_entry", "tags": [ "time_entries" ], "summary": "Create a time entry", "description": "Send only the fields you set. Changes also need time tracking switched on in the workspace and apply to your own entries only.", "x-unifydesk-scope": { "module": "time_reports", "capability": "create" }, "parameters": [ { "$ref": "#/components/parameters/idempotencyKey" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryCreate" } } } }, "responses": { "201": { "description": "Created.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TimeEntry" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } }, "/time_entries/{id}": { "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "get": { "operationId": "get_time_entry", "tags": [ "time_entries" ], "summary": "Get one time entry", "x-unifydesk-scope": { "module": "time_reports", "capability": "view" }, "responses": { "200": { "description": "The row.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TimeEntry" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "patch": { "operationId": "update_time_entry", "tags": [ "time_entries" ], "summary": "Update a time entry", "description": "Send only the fields you change. Changes also need time tracking switched on in the workspace and apply to your own entries only.", "x-unifydesk-scope": { "module": "time_reports", "capability": "edit" }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryUpdate" } } } }, "responses": { "200": { "description": "Updated.", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "$ref": "#/components/schemas/TimeEntry" } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "The row changed or the change conflicts with its state.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } }, "delete": { "operationId": "delete_time_entry", "tags": [ "time_entries" ], "summary": "Move a time entry to the trash", "x-unifydesk-scope": { "module": "time_reports", "capability": "delete" }, "parameters": [], "responses": { "200": { "description": "Done.", "content": { "application/json": { "schema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } } } } } } } }, "400": { "description": "The request is not valid (unknown field, bad value, bad query).", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "The token is missing, expired or revoked.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "The token or its owner may not do this, or the subscription is read-only.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "No such row in this workspace.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "429": { "description": "More requests than the token allows per minute.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } }, "headers": { "Retry-After": { "schema": { "type": "integer" }, "description": "Seconds to wait (60)." } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "description": "A token from Settings > Access & API, sent as Authorization: Bearer . Its scopes name the modules and capabilities it may use." } }, "parameters": { "limit": { "name": "limit", "in": "query", "description": "Rows per page, 1 to 100. Default 50.", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 50 } }, "offset": { "name": "offset", "in": "query", "description": "Rows to skip, up to 1000. Use cursor beyond that.", "schema": { "type": "integer", "minimum": 0, "maximum": 1000, "default": 0 } }, "cursor": { "name": "cursor", "in": "query", "description": "The nextCursor of the previous page.", "schema": { "type": "string" } }, "idempotencyKey": { "name": "Idempotency-Key", "in": "header", "description": "Up to 255 characters. A retry with the same key returns the first result instead of creating twice.", "schema": { "type": "string", "maxLength": 255 } } }, "schemas": { "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "string" } } }, "Activity": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "event_type": { "type": [ "string", "null" ] }, "actor_id": { "type": [ "string", "null" ], "format": "uuid" }, "entity_type": { "type": [ "string", "null" ] }, "entity_id": { "type": [ "string", "null" ], "format": "uuid" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "Asset": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "asset_type_id": { "type": [ "string", "null" ], "format": "uuid" }, "serial_number": { "type": [ "string", "null" ] }, "manufacturer": { "type": [ "string", "null" ] }, "model": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "assigned_user_id": { "type": [ "string", "null" ], "format": "uuid" }, "location": { "type": [ "string", "null" ] }, "purchased_at": { "type": [ "string", "null" ], "format": "date" }, "warranty_until": { "type": [ "string", "null" ], "format": "date" }, "notes": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "AssetCreate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "asset_type_id": { "type": [ "string", "null" ], "format": "uuid" }, "serial_number": { "type": [ "string", "null" ] }, "manufacturer": { "type": [ "string", "null" ] }, "model": { "type": [ "string", "null" ] }, "purchased_at": { "type": [ "string", "null" ], "format": "date" }, "warranty_until": { "type": [ "string", "null" ], "format": "date" }, "assigned_user_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "location": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } }, "required": [ "name" ], "minProperties": 1 }, "AssetUpdate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": [ "string", "null" ] }, "asset_type_id": { "type": [ "string", "null" ], "format": "uuid" }, "serial_number": { "type": [ "string", "null" ] }, "manufacturer": { "type": [ "string", "null" ] }, "model": { "type": [ "string", "null" ] }, "purchased_at": { "type": [ "string", "null" ], "format": "date" }, "warranty_until": { "type": [ "string", "null" ], "format": "date" }, "assigned_user_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "location": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Company": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "domain": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "industry": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "is_vendor": { "type": [ "boolean", "null" ] }, "employee_count": { "type": [ "number", "null" ] }, "last_interaction_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "CompanyCreate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "domain": { "type": [ "string", "null" ] }, "industry": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } }, "required": [ "name" ], "minProperties": 1 }, "CompanyUpdate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": [ "string", "null" ] }, "domain": { "type": [ "string", "null" ] }, "industry": { "type": [ "string", "null" ] }, "address": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Contact": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "ContactCreate": { "type": "object", "additionalProperties": false, "properties": { "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "notes": { "type": [ "string", "null" ] } }, "required": [ "first_name", "last_name" ], "minProperties": 1 }, "ContactUpdate": { "type": "object", "additionalProperties": false, "properties": { "first_name": { "type": [ "string", "null" ] }, "last_name": { "type": [ "string", "null" ] }, "email": { "type": [ "string", "null" ] }, "phone": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "notes": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Contract": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_number": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "billing_cycle": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ], "format": "date" }, "end_date": { "type": [ "string", "null" ], "format": "date" }, "start_at": { "type": [ "string", "null" ], "format": "date-time" }, "end_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_all_day": { "type": [ "boolean", "null" ] }, "renewal_date": { "type": [ "string", "null" ], "format": "date" }, "description": { "type": [ "string", "null" ] }, "rate_per_word": { "type": [ "number", "null" ] }, "is_default": { "type": [ "boolean", "null" ] }, "source_quote_id": { "type": [ "string", "null" ], "format": "uuid" }, "signed_by_name": { "type": [ "string", "null" ] }, "signed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "ContractCreate": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": "string" }, "billing_cycle": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ], "format": "date" }, "end_date": { "type": [ "string", "null" ], "format": "date" }, "start_at": { "type": [ "string", "null" ], "format": "date-time" }, "end_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_all_day": { "type": [ "boolean", "null" ] }, "renewal_date": { "type": [ "string", "null" ], "format": "date" }, "description": { "type": [ "string", "null" ] }, "rate_per_word": { "type": [ "number", "null" ] } }, "required": [ "title", "currency" ], "minProperties": 1 }, "ContractUpdate": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": [ "string", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "billing_cycle": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ], "format": "date" }, "end_date": { "type": [ "string", "null" ], "format": "date" }, "start_at": { "type": [ "string", "null" ], "format": "date-time" }, "end_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_all_day": { "type": [ "boolean", "null" ] }, "renewal_date": { "type": [ "string", "null" ], "format": "date" }, "description": { "type": [ "string", "null" ] }, "rate_per_word": { "type": [ "number", "null" ] } }, "minProperties": 1 }, "Conversation": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "mailbox_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "category_id": { "type": [ "string", "null" ], "format": "uuid" }, "subject": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "priority": { "type": [ "string", "null" ] }, "assignee_id": { "type": [ "string", "null" ], "format": "uuid" }, "team_id": { "type": [ "string", "null" ], "format": "uuid" }, "ticket_number": { "type": [ "string", "null" ] }, "channel": { "type": [ "string", "null" ] }, "first_response_at": { "type": [ "string", "null" ], "format": "date-time" }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "ConversationCreate": { "type": "object", "additionalProperties": false, "properties": { "subject": { "type": "string" }, "status": { "type": [ "string", "null" ] }, "priority": { "type": [ "string", "null" ] }, "assignee_id": { "type": [ "string", "null" ], "format": "uuid" }, "team_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "category_id": { "type": [ "string", "null" ], "format": "uuid" }, "mailbox_id": { "type": [ "string", "null" ], "format": "uuid" }, "channel": { "type": [ "string", "null" ] }, "resolution_category_id": { "type": [ "string", "null" ], "format": "uuid" }, "resolution_note": { "type": [ "string", "null" ] } }, "required": [ "subject" ], "minProperties": 1 }, "ConversationUpdate": { "type": "object", "additionalProperties": false, "properties": { "subject": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "priority": { "type": [ "string", "null" ] }, "assignee_id": { "type": [ "string", "null" ], "format": "uuid" }, "team_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "category_id": { "type": [ "string", "null" ], "format": "uuid" }, "mailbox_id": { "type": [ "string", "null" ], "format": "uuid" }, "channel": { "type": [ "string", "null" ] }, "resolution_category_id": { "type": [ "string", "null" ], "format": "uuid" }, "resolution_note": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "CreditNote": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "credit_number": { "type": [ "string", "null" ] }, "invoice_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "issue_date": { "type": [ "string", "null" ], "format": "date" }, "applied_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "CreditNoteCreate": { "type": "object", "additionalProperties": false, "properties": { "invoice_id": { "type": [ "string", "null" ], "format": "uuid" }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "CreditNoteUpdate": { "type": "object", "additionalProperties": false, "properties": { "invoice_id": { "type": [ "string", "null" ], "format": "uuid" }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Document": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "invoice_id": { "type": [ "string", "null" ], "format": "uuid" }, "task_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "file_type": { "type": [ "string", "null" ] }, "mime_type": { "type": [ "string", "null" ] }, "size_bytes": { "type": [ "number", "null" ] }, "folder": { "type": [ "string", "null" ] }, "version": { "type": [ "number", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "DocumentUpdate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "folder": { "type": [ "string", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "invoice_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "task_id": { "type": [ "string", "null" ], "format": "uuid" } }, "minProperties": 1 }, "Expense": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "submitted_by": { "type": [ "string", "null" ] }, "approved_by": { "type": [ "string", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "invoice_id": { "type": [ "string", "null" ], "format": "uuid" }, "category": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "expense_date": { "type": [ "string", "null" ], "format": "date" }, "status": { "type": [ "string", "null" ] }, "rejection_reason": { "type": [ "string", "null" ] }, "approved_at": { "type": [ "string", "null" ], "format": "date-time" }, "reimbursed_at": { "type": [ "string", "null" ], "format": "date-time" }, "billable": { "type": [ "boolean", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "ExpenseCreate": { "type": "object", "additionalProperties": false, "properties": { "description": { "type": "string" }, "amount": { "type": "number" }, "currency": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "expense_date": { "type": [ "string", "null" ], "format": "date" }, "billable": { "type": [ "boolean", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "description", "amount" ], "minProperties": 1 }, "ExpenseUpdate": { "type": "object", "additionalProperties": false, "properties": { "description": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "category": { "type": [ "string", "null" ] }, "expense_date": { "type": [ "string", "null" ], "format": "date" }, "billable": { "type": [ "boolean", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" } }, "minProperties": 1 }, "Invoice": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "invoice_number": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "issue_date": { "type": [ "string", "null" ], "format": "date" }, "due_date": { "type": [ "string", "null" ], "format": "date" }, "paid_date": { "type": [ "string", "null" ], "format": "date" }, "sent_at": { "type": [ "string", "null" ], "format": "date-time" }, "delivered_at": { "type": [ "string", "null" ], "format": "date-time" }, "delivery_method": { "type": [ "string", "null" ] }, "payment_terms": { "type": [ "string", "null" ] }, "memo": { "type": [ "string", "null" ] }, "customer_po_number": { "type": [ "string", "null" ] }, "is_recurring": { "type": [ "boolean", "null" ] }, "recurring_frequency": { "type": [ "string", "null" ] }, "recurring_next_at": { "type": [ "string", "null" ], "format": "date" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "InvoiceCreate": { "type": "object", "additionalProperties": false, "properties": { "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": "string" }, "due_date": { "type": [ "string", "null" ], "format": "date" }, "issue_date": { "type": [ "string", "null" ], "format": "date" }, "customer_po_number": { "type": [ "string", "null" ] } }, "required": [ "currency" ], "minProperties": 1 }, "InvoiceUpdate": { "type": "object", "additionalProperties": false, "properties": { "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "due_date": { "type": [ "string", "null" ], "format": "date" }, "issue_date": { "type": [ "string", "null" ], "format": "date" }, "customer_po_number": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Opportunity": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "stage_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "owner_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "expected_close_date": { "type": [ "string", "null" ], "format": "date" }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "probability_snapshot": { "type": [ "number", "null" ] }, "source": { "type": [ "string", "null" ] }, "lost_reason_id": { "type": [ "string", "null" ], "format": "uuid" }, "lost_reason_note": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "OpportunityCreate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "stage_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "owner_id": { "type": [ "string", "null" ], "format": "uuid" }, "expected_close_date": { "type": [ "string", "null" ], "format": "date" }, "source": { "type": [ "string", "null" ] }, "lost_reason_id": { "type": [ "string", "null" ], "format": "uuid" }, "lost_reason_note": { "type": [ "string", "null" ] } }, "required": [ "name" ], "minProperties": 1 }, "OpportunityUpdate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "stage_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "owner_id": { "type": [ "string", "null" ], "format": "uuid" }, "expected_close_date": { "type": [ "string", "null" ], "format": "date" }, "source": { "type": [ "string", "null" ] }, "lost_reason_id": { "type": [ "string", "null" ], "format": "uuid" }, "lost_reason_note": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Pipeline": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "stage_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "owner_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "expected_close_date": { "type": [ "string", "null" ], "format": "date" }, "closed_at": { "type": [ "string", "null" ], "format": "date-time" }, "probability_snapshot": { "type": [ "number", "null" ] }, "source": { "type": [ "string", "null" ] }, "lost_reason_id": { "type": [ "string", "null" ], "format": "uuid" }, "lost_reason_note": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "PipelineCreate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "stage_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "owner_id": { "type": [ "string", "null" ], "format": "uuid" }, "expected_close_date": { "type": [ "string", "null" ], "format": "date" }, "source": { "type": [ "string", "null" ] }, "lost_reason_id": { "type": [ "string", "null" ], "format": "uuid" }, "lost_reason_note": { "type": [ "string", "null" ] } }, "required": [ "name" ], "minProperties": 1 }, "PipelineUpdate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "stage_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "owner_id": { "type": [ "string", "null" ], "format": "uuid" }, "expected_close_date": { "type": [ "string", "null" ], "format": "date" }, "source": { "type": [ "string", "null" ] }, "lost_reason_id": { "type": [ "string", "null" ], "format": "uuid" }, "lost_reason_note": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Project": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_type_id": { "type": [ "string", "null" ], "format": "uuid" }, "stage_id": { "type": [ "string", "null" ], "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "start_date": { "type": [ "string", "null" ], "format": "date" }, "end_date": { "type": [ "string", "null" ], "format": "date" }, "start_at": { "type": [ "string", "null" ], "format": "date-time" }, "end_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_all_day": { "type": [ "boolean", "null" ] }, "owner_id": { "type": [ "string", "null" ], "format": "uuid" }, "budget_amount": { "type": [ "number", "null" ] }, "budget_currency": { "type": [ "string", "null" ] }, "budget_type": { "type": [ "string", "null" ] }, "budget_alert_threshold_pct": { "type": [ "number", "null" ] }, "health_status": { "type": [ "string", "null" ] }, "source_word_count": { "type": [ "number", "null" ] }, "target_word_count": { "type": [ "number", "null" ] }, "word_count_updated_at": { "type": [ "string", "null" ], "format": "date-time" }, "memsource_project_uid": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "ProjectCreate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "owner_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "start_date": { "type": [ "string", "null" ], "format": "date" }, "end_date": { "type": [ "string", "null" ], "format": "date" }, "start_at": { "type": [ "string", "null" ], "format": "date-time" }, "end_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_all_day": { "type": [ "boolean", "null" ] }, "budget_amount": { "type": [ "number", "null" ] }, "budget_currency": { "type": [ "string", "null" ] }, "budget_type": { "type": [ "string", "null" ] }, "budget_alert_threshold_pct": { "type": [ "number", "null" ] }, "health_status": { "type": [ "string", "null" ] }, "source_word_count": { "type": [ "number", "null" ] }, "target_word_count": { "type": [ "number", "null" ] }, "memsource_project_uid": { "type": [ "string", "null" ] } }, "required": [ "name" ], "minProperties": 1 }, "ProjectUpdate": { "type": "object", "additionalProperties": false, "properties": { "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "owner_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "start_date": { "type": [ "string", "null" ], "format": "date" }, "end_date": { "type": [ "string", "null" ], "format": "date" }, "start_at": { "type": [ "string", "null" ], "format": "date-time" }, "end_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_all_day": { "type": [ "boolean", "null" ] }, "budget_amount": { "type": [ "number", "null" ] }, "budget_currency": { "type": [ "string", "null" ] }, "budget_type": { "type": [ "string", "null" ] }, "budget_alert_threshold_pct": { "type": [ "number", "null" ] }, "health_status": { "type": [ "string", "null" ] }, "source_word_count": { "type": [ "number", "null" ] }, "target_word_count": { "type": [ "number", "null" ] }, "memsource_project_uid": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "PurchaseOrder": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "po_number": { "type": [ "string", "null" ] }, "vendor_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "status": { "type": [ "string", "null" ] }, "total_amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "order_date": { "type": [ "string", "null" ], "format": "date" }, "expected_date": { "type": [ "string", "null" ], "format": "date" }, "received_date": { "type": [ "string", "null" ], "format": "date" }, "notes": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "PurchaseOrderUpdate": { "type": "object", "additionalProperties": false, "properties": { "vendor_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "currency": { "type": [ "string", "null" ] }, "order_date": { "type": [ "string", "null" ], "format": "date" }, "expected_date": { "type": [ "string", "null" ], "format": "date" }, "notes": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Quote": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "opportunity_id": { "type": [ "string", "null" ], "format": "uuid" }, "quote_number": { "type": [ "string", "null" ] }, "title": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "valid_until": { "type": [ "string", "null" ], "format": "date" }, "line_items": {}, "terms": { "type": [ "string", "null" ] }, "notes": { "type": [ "string", "null" ] }, "sent_at": { "type": [ "string", "null" ], "format": "date-time" }, "accepted_at": { "type": [ "string", "null" ], "format": "date-time" }, "accepted_by_name": { "type": [ "string", "null" ] }, "declined_at": { "type": [ "string", "null" ], "format": "date-time" }, "invoice_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "QuoteCreate": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "opportunity_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "currency": { "type": "string" }, "valid_until": { "type": [ "string", "null" ], "format": "date" }, "line_items": {}, "notes": { "type": [ "string", "null" ] } }, "required": [ "title", "currency" ], "minProperties": 1 }, "QuoteUpdate": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": [ "string", "null" ] }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "opportunity_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "currency": { "type": [ "string", "null" ] }, "valid_until": { "type": [ "string", "null" ], "format": "date" }, "line_items": {}, "notes": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Refund": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "invoice_id": { "type": [ "string", "null" ], "format": "uuid" }, "credit_note_id": { "type": [ "string", "null" ], "format": "uuid" }, "amount": { "type": [ "number", "null" ] }, "currency": { "type": [ "string", "null" ] }, "reason": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "refunded_at": { "type": [ "string", "null" ], "format": "date-time" }, "refunded_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "RefundUpdate": { "type": "object", "additionalProperties": false, "properties": { "reason": { "type": [ "string", "null" ] } }, "minProperties": 1 }, "Report": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "source": { "type": [ "string", "null" ] }, "columns": {}, "filters": {}, "group_by": { "type": [ "string", "null" ] }, "aggregate": { "type": [ "string", "null" ] }, "aggregate_field": { "type": [ "string", "null" ] }, "sort_by": { "type": [ "string", "null" ] }, "sort_dir": { "type": [ "string", "null" ] }, "created_by": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "Task": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "invoice_id": { "type": [ "string", "null" ], "format": "uuid" }, "parent_task_id": { "type": [ "string", "null" ], "format": "uuid" }, "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "priority": { "type": [ "string", "null" ] }, "assignee_id": { "type": [ "string", "null" ], "format": "uuid" }, "due_date": { "type": [ "string", "null" ], "format": "date" }, "due_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_all_day": { "type": [ "boolean", "null" ] }, "recurrence_rule": { "type": [ "string", "null" ] }, "estimated_hours": { "type": [ "number", "null" ] }, "estimate_minutes": { "type": [ "number", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "TaskCreate": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": "string" }, "description": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "priority": { "type": [ "string", "null" ] }, "due_date": { "type": [ "string", "null" ], "format": "date" }, "due_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_all_day": { "type": [ "boolean", "null" ] }, "assignee_id": { "type": [ "string", "null" ], "format": "uuid" }, "parent_task_id": { "type": [ "string", "null" ], "format": "uuid" }, "recurrence_rule": { "type": [ "string", "null" ] }, "estimated_hours": { "type": [ "number", "null" ] }, "estimate_minutes": { "type": [ "number", "null" ] }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "invoice_id": { "type": [ "string", "null" ], "format": "uuid" } }, "required": [ "title" ], "minProperties": 1 }, "TaskUpdate": { "type": "object", "additionalProperties": false, "properties": { "title": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "status": { "type": [ "string", "null" ] }, "priority": { "type": [ "string", "null" ] }, "due_date": { "type": [ "string", "null" ], "format": "date" }, "due_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_all_day": { "type": [ "boolean", "null" ] }, "assignee_id": { "type": [ "string", "null" ], "format": "uuid" }, "parent_task_id": { "type": [ "string", "null" ], "format": "uuid" }, "recurrence_rule": { "type": [ "string", "null" ] }, "estimated_hours": { "type": [ "number", "null" ] }, "estimate_minutes": { "type": [ "number", "null" ] }, "project_id": { "type": [ "string", "null" ], "format": "uuid" }, "company_id": { "type": [ "string", "null" ], "format": "uuid" }, "contact_id": { "type": [ "string", "null" ], "format": "uuid" }, "conversation_id": { "type": [ "string", "null" ], "format": "uuid" }, "contract_id": { "type": [ "string", "null" ], "format": "uuid" }, "invoice_id": { "type": [ "string", "null" ], "format": "uuid" } }, "minProperties": 1 }, "TimeEntry": { "type": "object", "additionalProperties": false, "properties": { "id": { "type": "string", "format": "uuid" }, "entity_id": { "type": [ "string", "null" ], "format": "uuid" }, "entity_type": { "type": [ "string", "null" ] }, "user_id": { "type": [ "string", "null" ], "format": "uuid" }, "duration_minutes": { "type": [ "number", "null" ] }, "description": { "type": [ "string", "null" ] }, "billable": { "type": [ "boolean", "null" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "is_running": { "type": [ "boolean", "null" ] }, "approval_status": { "type": [ "string", "null" ] }, "submitted_at": { "type": [ "string", "null" ], "format": "date-time" }, "approved_at": { "type": [ "string", "null" ], "format": "date-time" }, "approved_by": { "type": [ "string", "null" ] }, "rejection_reason": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "id" ] }, "TimeEntryCreate": { "type": "object", "additionalProperties": false, "properties": { "entity_type": { "type": "string", "enum": [ "conversation", "task", "project", "contact", "company", "contract", "invoice" ] }, "entity_id": { "type": "string", "format": "uuid" }, "duration_minutes": { "type": "integer", "minimum": 1 }, "description": { "type": [ "string", "null" ] }, "billable": { "type": [ "boolean", "null" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time" } }, "required": [ "entity_type", "entity_id", "duration_minutes" ], "minProperties": 1 }, "TimeEntryUpdate": { "type": "object", "additionalProperties": false, "properties": { "entity_type": { "type": "string", "enum": [ "conversation", "task", "project", "contact", "company", "contract", "invoice" ] }, "entity_id": { "type": [ "string", "null" ], "format": "uuid" }, "duration_minutes": { "type": "integer", "minimum": 0 }, "description": { "type": [ "string", "null" ] }, "billable": { "type": [ "boolean", "null" ] }, "started_at": { "type": [ "string", "null" ], "format": "date-time" } }, "minProperties": 1 } } }, "x-unifydesk-scopes": { "modules": [ "activity", "assets", "companies", "contacts", "contracts", "conversations", "credit_notes", "documents", "expenses", "invoices", "pipeline", "projects", "purchase_orders", "quotes", "refunds", "reports", "tasks", "time_reports" ], "capabilities": [ "view", "create", "edit", "delete" ], "actions": [ "view_billing_rates" ] } }