{ "openapi": "3.0.4", "info": { "title": "Visma.net ERP API", "version": "v1" }, "servers": [ { "url": "https://api.finance.visma.net" } ], "paths": { "/v1/account/{accountCd}": { "get": { "tags": [ "Account" ], "summary": "Get a specific Account - ScreenId=GL202500", "description": "Data for Account

\r\n The response headers include an ETag after a successful GET operation.", "operationId": "Account_GetByaccountCd", "parameters": [ { "name": "accountCd", "in": "path", "description": "Return the Information from Chart of account for the specified AccountCD", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Account" ], "summary": "Updates an account", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\n Response Message has StatusCode BadRequest if PUT operation failed

\r\n The response headers include an ETag after a successful PUT operation", "operationId": "Account_PutByaccountCd", "parameters": [ { "name": "accountCd", "in": "path", "description": "Identifies the account to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the fields and field values to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } } }, "required": true, "x-bodyName": "accountUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Account version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/account": { "get": { "tags": [ "Account" ], "summary": "Get a range of General ledger accounts - ScreenId=GL202500", "description": "Data for Account", "operationId": "Account_GetAll", "parameters": [ { "name": "active", "in": "query", "description": "Set to True to select active accounts.", "schema": { "type": "boolean" } }, { "name": "includeAccountClassDescription", "in": "query", "description": "Set to True to include AccountClass description.", "schema": { "type": "boolean" } }, { "name": "greaterThanValue", "in": "query", "description": "Enter the from-value for Account no.", "schema": { "type": "string" } }, { "name": "publicCode", "in": "query", "description": "Filter by the Public code 1, authorities mapped code to the account.", "schema": { "type": "string" } }, { "name": "externalCode1", "in": "query", "description": "Filter by External code 1 (field used for sorting and inquiries.)", "schema": { "type": "string" } }, { "name": "externalCode2", "in": "query", "description": "Filter by External code 2 (field used for sorting and inquiries.)", "schema": { "type": "string" } }, { "name": "analysisCode", "in": "query", "description": "Filter by Analysis code (field used for sorting and inquiries.)", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AccountDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Account" ], "summary": "Creates an account", "description": "Response Message has StatusCode Created if POST operation succeed

\r\n The response headers include an ETag after a successful POST operation.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed", "operationId": "Account_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the fields and field values to be set on created account", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AccountUpdateDto" } } }, "required": true, "x-bodyName": "accountUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/attachment/{attachmentId}": { "get": { "tags": [ "Attachment" ], "summary": "Get latest revision of a specific Attachment", "operationId": "Attachment_GetByattachmentId", "parameters": [ { "name": "attachmentId", "in": "path", "description": "Identifies the attachment", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Attachment" ], "summary": "Update a specific Attachment", "description": "The the Response Message has StatusCode NoContent if Put operation succeed", "operationId": "Attachment_PutByattachmentId", "parameters": [ { "name": "attachmentId", "in": "path", "description": "Identifies the Attachment to update", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Attachment to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentMetadataUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttachmentMetadataUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AttachmentMetadataUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AttachmentMetadataUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttachmentMetadataUpdateDto" } } }, "required": true, "x-bodyName": "metadataDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/attribute/{attributeId}": { "get": { "tags": [ "Attribute" ], "summary": "Get specific Attribute", "operationId": "Attribute_GetAttributeByattributeId", "parameters": [ { "name": "attributeId", "in": "path", "description": "Identifies the attribute", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttributeDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Attribute" ], "summary": "Updates an attribute", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "Attribute_PutByattributeId", "parameters": [ { "name": "attributeId", "in": "path", "description": "Identifies the attribute to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the fields and field values to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } } }, "required": true, "x-bodyName": "attributeUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "Attribute" ], "summary": "Deletes an attribute", "description": "Response Message has StatusCode NoContent if DEL operation succeed", "operationId": "Attribute_DeleteByattributeId", "parameters": [ { "name": "attributeId", "in": "path", "description": "Identifies the attribute to delete", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/attribute": { "get": { "tags": [ "Attribute" ], "summary": "Get a range of General ledger attributes - screen ID: CS205000.\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "Attribute_GetAttributes", "parameters": [ { "name": "attributeID", "in": "query", "schema": { "type": "string" } }, { "name": "controlType", "in": "query", "schema": { "type": "string" } }, { "name": "internal", "in": "query", "schema": { "type": "boolean" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Attribute" ], "summary": "Creates an attribute", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "Attribute_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the fields and field values to be set on created attribute", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/AttributeUpdateDto" } } }, "required": true, "x-bodyName": "attributeUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/background/{requestId}": { "get": { "tags": [ "Background" ], "summary": "Gets the state of a previously started background API operation", "operationId": "Background_GetBackgroundApiOperationByrequestId", "parameters": [ { "name": "requestId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundRequestStateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundRequestStateDto" } } } }, "403": { "description": "State request was not done by same company/user as for the background operation request.", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "No background operation state was found.", "content": { "application/json": { }, "text/json": { } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/background/{requestId}/content": { "get": { "tags": [ "Background" ], "summary": "Gets the response content, if any, of a previously started background API operation that has finished", "operationId": "Background_GetBackgroundApiOperationContentByrequestId", "parameters": [ { "name": "requestId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "200": { "description": "Gets response content for a finished background operation, if any.", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "403": { "description": "State request was not done by same company/user as for the background operation request.", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "No background operation response content was found.", "content": { "application/json": { }, "text/json": { } } }, "410": { "description": "State for background operation has been removed after 24 hours.", "content": { "application/json": { }, "text/json": { } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/blob/download/{blobId}": { "get": { "tags": [ "Blob" ], "summary": "Get a specific blob (attachment)", "operationId": "Blob_GetByblobId", "parameters": [ { "name": "blobId", "in": "path", "description": "Identifies the blob (attachment)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Stream" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Stream" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Stream" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Stream" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/blob/presignedurl": { "get": { "tags": [ "Blob" ], "summary": "Get a presigned URL to download a specific blob (attachment)", "operationId": "Blob_GetPresignedUrl", "parameters": [ { "name": "blobId", "in": "query", "description": "Identifies the blob (attachment)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "includeMetadata", "in": "query", "description": "Optional. If true, includes blob metadata in the response. Default is false.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PresignedUrlResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PresignedUrlResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PresignedUrlResponse" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PresignedUrlResponse" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/blob/metadata/{blobId}": { "get": { "tags": [ "Blob" ], "summary": "Get metadata for a specific blob (attachment)", "operationId": "Blob_GetMetadataByblobId", "parameters": [ { "name": "blobId", "in": "path", "description": "Identifies the blob (attachment)", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BlobMetadata" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BlobMetadata" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BlobMetadata" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BlobMetadata" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/branch/{branchNumber}": { "get": { "tags": [ "Branch" ], "summary": "Get a specific branch", "operationId": "Branch_GetSpecificBranchBybranchNumber", "parameters": [ { "name": "branchNumber", "in": "path", "description": "Identifies the branch", "required": true, "schema": { "type": "string" } }, { "name": "expandAddress", "in": "query", "description": "True to get main address for branch.", "schema": { "type": "boolean" } }, { "name": "expandContact", "in": "query", "description": "True to get main contact for a branch.", "schema": { "type": "boolean" } }, { "name": "expandCurrency", "in": "query", "description": "True to get base currency for a branch.", "schema": { "type": "boolean" } }, { "name": "expandVatZone", "in": "query", "description": "True to get vat zone for a branch.", "schema": { "type": "boolean" } }, { "name": "expandLedger", "in": "query", "description": "True to get ledger for a branch.", "schema": { "type": "boolean" } }, { "name": "expandIndustryCode", "in": "query", "description": "True to get industry code for a branch.", "schema": { "type": "boolean" } }, { "name": "expandDeliveryAddress", "in": "query", "description": "True to get delivery address for a branch.", "schema": { "type": "boolean" } }, { "name": "expandDeliveryContact", "in": "query", "description": "True to get delivery contact for a branch.", "schema": { "type": "boolean" } }, { "name": "expandDefaultCountry", "in": "query", "description": "True to get default country for a branch.", "schema": { "type": "boolean" } }, { "name": "expandBankSettings", "in": "query", "description": "True to get payment settings for Branch.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BranchDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BranchDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/branch": { "get": { "tags": [ "Branch" ], "summary": "Get a range of Branches - ScreenId=CS101500", "operationId": "Branch_GetAllBranches", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "Filter by branch ID (number) greater than.", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "Order by Branch ID", "schema": { "enum": [ "Id", "Number", "Name", "OrganizationId", "LastModifiedDateTime" ], "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "expandAddress", "in": "query", "description": "True to get main address for branch.", "schema": { "type": "boolean" } }, { "name": "expandContact", "in": "query", "description": "True to get main contact for a branch.", "schema": { "type": "boolean" } }, { "name": "expandCurrency", "in": "query", "description": "True to get base currency for a branch.", "schema": { "type": "boolean" } }, { "name": "expandVatZone", "in": "query", "description": "True to get vat zone for a branch.", "schema": { "type": "boolean" } }, { "name": "expandLedger", "in": "query", "description": "True to get ledger for a branch.", "schema": { "type": "boolean" } }, { "name": "expandIndustryCode", "in": "query", "description": "True to get industry code for a branch.", "schema": { "type": "boolean" } }, { "name": "expandDeliveryAddress", "in": "query", "description": "True to get delivery address for a branch.", "schema": { "type": "boolean" } }, { "name": "expandDeliveryContact", "in": "query", "description": "True to get delivery contact for a branch.", "schema": { "type": "boolean" } }, { "name": "expandDefaultCountry", "in": "query", "description": "True to get default country for a branch.", "schema": { "type": "boolean" } }, { "name": "expandBankSettings", "in": "query", "description": "True to get payment settings for Branch.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BranchDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BranchDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/branch/{branchNumber}/BankSettings": { "put": { "tags": [ "Branch" ], "summary": "Update bank settings for branch.", "description": "Response Message has StatusCode No Content if PUT operation succeed", "operationId": "Branch_PutBankSettingsForBranchBybranchNumber", "parameters": [ { "name": "branchNumber", "in": "path", "description": "branch number to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the bank settings to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } } }, "required": true, "x-bodyName": "bankSettings" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/budget": { "get": { "tags": [ "Budget" ], "summary": "Get a range of General Ledger Budget Figures - ScreenId=GL302010", "operationId": "Budget_GetAll", "parameters": [ { "name": "isReleased", "in": "query", "description": "True to get released budgets.", "schema": { "type": "boolean" } }, { "name": "greaterThanValue", "in": "query", "description": "Filter by from date.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "Order by Last modified date and time.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Mandatory. Filter by budgets Branch.", "required": true, "schema": { "type": "string" } }, { "name": "ledger", "in": "query", "description": "Mandatory. The budgets Ledger", "required": true, "schema": { "type": "string" } }, { "name": "financialYear", "in": "query", "description": "The budgets financial year.", "required": true, "schema": { "type": "string" } }, { "name": "subaccount", "in": "query", "description": "The Subaccount of the budget article.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BudgetDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BudgetDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Budget" ], "summary": "Update a specific Budget", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\n Response Message has StatusCode BadRequest if PUT operation failed

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "Budget_Put", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Budget to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } } }, "required": true, "x-bodyName": "budget" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Budget version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Budget" ], "summary": "Create a Budget", "description": "Response Message has StatusCode Created if POST operation succeed

\r\n The response headers include an ETag after a successful POST operation.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed", "operationId": "Budget_CreateBudget", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Budget to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BudgetUpdateDto" } } }, "required": true, "x-bodyName": "budget" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/carrier/{carrierName}": { "get": { "tags": [ "Carrier" ], "summary": "Get a specific Carrier", "operationId": "Carrier_GetCarrierBycarrierName", "parameters": [ { "name": "carrierName", "in": "path", "description": "Identifies the Carrier", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CarrierDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/carrier": { "get": { "tags": [ "Carrier" ], "summary": "Get a range of Carriers - ScreeId=CS207500", "operationId": "Carrier_GetAllCarriers", "parameters": [ { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/cashaccount/{accountNumber}": { "get": { "tags": [ "CashAccount" ], "summary": "Get a specific cash account", "operationId": "CashAccount_GetByaccountNumber", "parameters": [ { "name": "accountNumber", "in": "path", "description": "Identifies the cash account", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashAccountDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CashAccountDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/cashaccount": { "get": { "tags": [ "CashAccount" ], "summary": "Get all Cash Accounts - ScreenId=CA202000", "operationId": "CashAccount_GetAll", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "Filter Cass account identifier greater than.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CashAccountDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CashAccountDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/cashsale/{documentNumber}": { "get": { "tags": [ "CashSale" ], "summary": "Get a specific Cash Sale", "description": "Data for Cash Sale

\r\n The response headers include an ETag after a successful GET operation.", "operationId": "CashSale_GetBydocumentNumber", "parameters": [ { "name": "documentNumber", "in": "path", "description": "Identifies the Cash Sale Document", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashSaleDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CashSaleDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CashSale" ], "summary": "Update a specific Cash Sale", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CashSale_PutBydocumentNumber", "parameters": [ { "name": "documentNumber", "in": "path", "description": "Identifies the Cash Sale to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Cash Sale to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } } }, "required": true, "x-bodyName": "cashSaleUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Cash sale version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/cashsale": { "get": { "tags": [ "CashSale" ], "summary": "Get a range of Cash Sales - ScreenId=AR304000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2021-October:Added forced pagination", "operationId": "CashSale_GetAllCashSales", "parameters": [ { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CashSaleDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CashSaleDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CashSale" ], "summary": "Create a Cash Sale", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "CashSale_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Cash Sale to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CashSaleUpdateDto" } } }, "required": true, "x-bodyName": "cashSaleUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/cashTransaction/{referenceNbr}": { "get": { "tags": [ "CashTransaction" ], "summary": "Get a specific Transaction - ScreenID=CA304000", "description": "Data for the Cash Transaction

\r\n The response headers include an ETag after a successful GET operation.", "operationId": "CashTransaction_GetByreferenceNbr", "parameters": [ { "name": "referenceNbr", "in": "path", "description": "Returns data for the selected Cash transaction", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashTransactionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CashTransactionDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CashTransaction" ], "summary": "Update a specific CashTransaction - ScreenID=CA304000", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "CashTransaction_PutByreferenceNbr", "parameters": [ { "name": "referenceNbr", "in": "path", "description": "Identifies the Cash Transaction to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Cash Transaction to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } } }, "required": true, "x-bodyName": "cashTransaction" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Cash transaction document version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/cashTransaction": { "get": { "tags": [ "CashTransaction" ], "summary": "Get all Transaction - ScreenID=CA304000", "description": "Data for the Cash Transaction", "operationId": "CashTransaction_GetAll", "parameters": [ { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CashTransactionDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CashTransactionDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CashTransaction" ], "summary": "Create a Cash Transaction- ScreenID=CA304000", "description": "Response Message has StatusCode Created if POST operation succeed

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "CashTransaction_CreateCashTransaction", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Cash Transaction to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CashTransactionUpdateDto" } } }, "required": true, "x-bodyName": "cashTransaction" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/cashTransaction/{referenceNbr}/action/release": { "post": { "tags": [ "CashTransaction" ], "summary": "Release cash transaction - ScreenID=CA304000", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can also be checked against resource current version when calling with 'erp-api-background' HTTP header.

", "operationId": "CashTransaction_ReleaseByreferenceNbr", "parameters": [ { "name": "referenceNbr", "in": "path", "description": "Reference number of the cash transaction to be released.", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseCashTransactionActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseCashTransactionActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleaseCashTransactionActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleaseCashTransactionActionResultDto" } } } }, "412": { "description": "Cash transaction document version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/cashTransaction/{referenceNbr}/action/reverse": { "post": { "tags": [ "CashTransaction" ], "summary": "Reverse a Cash Transaction- ScreenID=CA304000", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can also be checked against resource current version when calling with 'erp-api-background' HTTP header.

", "operationId": "CashTransaction_ReverseByreferenceNbr", "parameters": [ { "name": "referenceNbr", "in": "path", "description": "Reference number of the cash transaction to be reversed.", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The action dto use to condition the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReverseCashTransactionActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReverseCashTransactionActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReverseCashTransactionActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReverseCashTransactionActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReverseCashTransactionActionDto" } } }, "required": true, "x-bodyName": "reverseActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReverseCashTransactionActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReverseCashTransactionActionResultDto" } } } }, "412": { "description": "Cash transaction document version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/cashTransaction/{referenceNbr}/attachment": { "post": { "tags": [ "CashTransaction" ], "summary": "Creates an attachment and associates it with a cash transaction document. If the file already exists, a new revision is created.", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CashTransaction_CreateAttachmentByreferenceNbr", "parameters": [ { "name": "referenceNbr", "in": "path", "description": "Identifies the cash transaction document", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } }, "412": { "description": "Cash transaction document version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/contact/{contactId}": { "get": { "tags": [ "Contact" ], "summary": "Get a specific Contact", "description": "Data for Contact

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Contact_GetBycontactId", "parameters": [ { "name": "contactId", "in": "path", "description": "Identifies the Contact", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Contact" ], "summary": "Update a specific Contact", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "Contact_PutBycontactId", "parameters": [ { "name": "contactId", "in": "path", "description": "Identifies the Contact to update", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Contact to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } } }, "required": true, "x-bodyName": "contact" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Contact version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/contact": { "get": { "tags": [ "Contact" ], "summary": "Get a range of Contacts - ScreenId=CR302000", "operationId": "Contact_GetAllContacts", "parameters": [ { "name": "displayName", "in": "query", "schema": { "type": "string" } }, { "name": "active", "in": "query", "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "schema": { "type": "string" } }, { "name": "businessAccount", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Contact" ], "summary": "Create a Contact", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "Contact_CreateContact", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Contact to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ContactUpdateDto" } } }, "required": true, "x-bodyName": "contact" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/contractTemplate": { "get": { "tags": [ "ContractTemplate" ], "summary": "Get a range of Contract Templates - ScreenId=CT202000", "operationId": "ContractTemplate_GetAll", "parameters": [ { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "schema": { "type": "string" } }, { "name": "expandAttributes", "in": "query", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContractTemplateDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContractTemplateDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/contractUsage/{contractId}": { "get": { "tags": [ "ContractUsage" ], "summary": "Get a specific Contract Usage", "description": "Data for the Contract Usage

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "ContractUsage_GetSpecificBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Identify the Contract Usage", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractUsageDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContractUsageDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "ContractUsage" ], "summary": "Update a specific Contract Usage", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "ContractUsage_PutBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Identifies the Contract Usage to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Contract Usage to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractUsageUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ContractUsageUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ContractUsageUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ContractUsageUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ContractUsageUpdateDto" } } }, "required": true, "x-bodyName": "contractUsage" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer contract version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/contractUsage": { "get": { "tags": [ "ContractUsage" ], "summary": "Get a range of Contract Usage - ScreenId=CT303000", "operationId": "ContractUsage_GetAll", "parameters": [ { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContractUsageDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContractUsageDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/country/{countryId}": { "get": { "tags": [ "Country" ], "summary": "Get a specific Country", "operationId": "Country_GetCountryBycountryId", "parameters": [ { "name": "countryId", "in": "path", "description": "Identifies the Country", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CountryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CountryDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/country": { "get": { "tags": [ "Country" ], "summary": "Get a range of Countries - ScreenId=CS20400S\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "Country_GetCountries", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CountryDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/creditNote/{creditNoteNumber}": { "get": { "tags": [ "CreditNote" ], "summary": "Get a specific Credit Note - Method is deprecated start using the new method in endpoint Customer Credit Note", "operationId": "CreditNote_GetBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the Credit Note", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditNoteDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CreditNote" ], "summary": "Update a specific Credit Note - Method is deprecated start using the new method in endpoint Customer Credit Note", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "CreditNote_PutBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the Credit Note to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Credit Note to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } } }, "required": true, "x-bodyName": "creditNoteUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/creditNote": { "get": { "tags": [ "CreditNote" ], "summary": "Get a range of Credit Notes - Method is deprecated start using the new method in endpoint Customer Credit Note", "operationId": "CreditNote_GetAllCreditNotesDto", "parameters": [ { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNoteDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNoteDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CreditNote" ], "summary": "Create a Credit Note - Method is deprecated start using the new method in endpoint Customer Credit Note", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "CreditNote_CreateCreditNote", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Credit Note to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreditNoteUpdateDto" } } }, "required": true, "x-bodyName": "creditNoteUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/creditNote/{creditNoteNumber}/attachment": { "post": { "tags": [ "CreditNote" ], "summary": "Creates an attachment and associates it with a Credit Note. If the file already exists, a new revision is created.\r\n - Method is deprecated start using the new method in endpoint Customer Credit Note", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "CreditNote_CreateHeaderAttachmentBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the Credit Note", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/creditNote/{creditNoteNumber}/{lineNumber}/attachment": { "post": { "tags": [ "CreditNote" ], "summary": "Creates an attachment and associates it with a certain Credit Note line. If the file already exists, a new revision is created.\r\n - Method is deprecated start using the new method in endpoint Customer Credit Note", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "CreditNote_CreateLineAttachmentBycreditNoteNumberlineNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the Credit Note", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/creditNote/{creditNoteNumber}/action/release": { "post": { "tags": [ "CreditNote" ], "summary": "Release credit note operation - Method is deprecated start using the new method in endpoint Customer Credit Note", "description": "The action result dto contains information about the result of running the action", "operationId": "CreditNote_ReleaseInvoiceBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Reference number of the credit note to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInvoiceActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseInvoiceActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInvoiceActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInvoiceActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/creditTerm": { "get": { "tags": [ "CreditTerm" ], "summary": "Get a range of credit terms - ScreenId=CS206500", "operationId": "CreditTerm_GetCreditTerms", "parameters": [ { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "termsId", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfCreditTermDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfCreditTermDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/currency/{curyId}": { "get": { "tags": [ "Currency" ], "summary": "Get a specific Currency - ScreenId=CM202000", "operationId": "Currency_GetSpecificCurrencyBycuryId", "parameters": [ { "name": "curyId", "in": "path", "description": "Returns data for the selected CurrencyId", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CurrencyDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/currency": { "get": { "tags": [ "Currency" ], "summary": "Get all available Currencies - ScreenId=CM202000", "operationId": "Currency_GetAll", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/currencyrate": { "get": { "tags": [ "CurrencyRate" ], "summary": "Get all currency rates.", "operationId": "CurrencyRate_GetAll", "parameters": [ { "name": "fromDate", "in": "query", "description": "From effective date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "query", "description": "To effective date.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fromCurrency", "in": "query", "description": "Identifies from currency.", "schema": { "type": "string" } }, { "name": "toCurrency", "in": "query", "description": "Identifies to currency.", "schema": { "type": "string" } }, { "name": "rateType", "in": "query", "description": "Identifies rate type.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRateDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRateDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRateDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRateDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CurrencyRate" ], "summary": "Create currency rate.", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "CurrencyRate_PostCurrencyRate", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Currency Rate to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateDto" } } }, "required": true, "x-bodyName": "currencyRate" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/currencyrate/{currencyRateId}": { "put": { "tags": [ "CurrencyRate" ], "summary": "Update Currency rate.", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "CurrencyRate_PutCurrencyRateBycurrencyRateId", "parameters": [ { "name": "currencyRateId", "in": "path", "description": "Identifies the currency rate id.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the currency rate to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCurrencyRateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCurrencyRateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/UpdateCurrencyRateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateCurrencyRateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UpdateCurrencyRateDto" } } }, "required": true, "x-bodyName": "currencyRate" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Currency rate version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/currencyratetype": { "get": { "tags": [ "CurrencyRateType" ], "summary": "Get currency rate types.", "operationId": "CurrencyRateType_GetAll", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRateTypeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRateTypeDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRateTypeDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CurrencyRateTypeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CurrencyRateType" ], "summary": "Create currency rate type.", "operationId": "CurrencyRateType_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the currency rate type to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateTypeDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateTypeDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateTypeDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateCurrencyRateTypeDto" } } }, "required": true, "x-bodyName": "currencyRateType" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/customerClass": { "get": { "tags": [ "Customer" ], "summary": "Get Customer Classes - ScreenId=AR201000", "operationId": "Customer_GetCustomerClasses", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerClassDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerClassDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/customerClass/{customerClassId}": { "get": { "tags": [ "Customer" ], "summary": "Get a specific customer class - ScreenId=AR201000", "operationId": "Customer_GetSpecificCustomerClassBycustomerClassId", "parameters": [ { "name": "customerClassId", "in": "path", "description": "Identifies the customer class", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerClassDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerClassDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerCd}/balance": { "get": { "tags": [ "Customer" ], "summary": "Get a specific customer's balance - ScreenId=AR303000", "operationId": "Customer_GetCustomerBalanceBycustomerCd", "parameters": [ { "name": "customerCd", "in": "path", "description": "Identifies the customer for which to return data", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerBalanceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerBalanceDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerBalanceDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerBalanceDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerCd}/directdebit": { "get": { "tags": [ "Customer" ], "summary": "Get direct debit information for a specific customer(only for Netherlands)", "operationId": "Customer_GetCustomerDirectDebitBycustomerCd", "parameters": [ { "name": "customerCd", "in": "path", "description": "Identifies the customer for which to return data", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDirectDebitDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDirectDebitDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDirectDebitDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDirectDebitDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerCd}/salesorder": { "get": { "tags": [ "Customer" ], "summary": "Get a range of SO Orders of a specific customer", "operationId": "Customer_GetAllOrderForCustomerBycustomerCd", "parameters": [ { "name": "customerCd", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "query", "description": "Filter by Order type.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Select to filter on status on order.", "schema": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Filter on Order no. greater than value.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "showNotes", "in": "query", "description": "Set to true to include notes.", "schema": { "type": "boolean" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerCd}/salesorderbasic": { "get": { "tags": [ "Customer" ], "summary": "Get a range of SO Orders Basic of a specific customer", "operationId": "Customer_GetAllSalesOrderBasicForCustomerBycustomerCd", "parameters": [ { "name": "customerCd", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "query", "description": "Filter by Order type.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Select to filter on status on order.", "schema": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Filter on Order no. greater than value.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "showNotes", "in": "query", "description": "Set to true to include notes.", "schema": { "type": "boolean" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderBasicDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderBasicDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerCd}/contact": { "get": { "tags": [ "Customer" ], "summary": "Get a range of Contacts of a specific customer", "operationId": "Customer_GetAllContactsForCustomerBycustomerCd", "parameters": [ { "name": "customerCd", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "displayName", "in": "query", "schema": { "type": "string" } }, { "name": "active", "in": "query", "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "schema": { "type": "string" } }, { "name": "businessAccount", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerCd}/salespersons": { "get": { "tags": [ "Customer" ], "summary": "Get a range of Sales Persons of a specific customer", "operationId": "Customer_GetSalesPersonsForCustomerBycustomerCd", "parameters": [ { "name": "customerCd", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustSalesPersonsDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustSalesPersonsDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/balance": { "get": { "tags": [ "Customer" ], "summary": "Get the balance for a range of customers", "operationId": "Customer_GetAllCustomerBalance", "parameters": [ { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerCd}/note": { "get": { "tags": [ "Customer" ], "summary": "Get a specific customer's note", "operationId": "Customer_GetCustomerNoteBycustomerCd", "parameters": [ { "name": "customerCd", "in": "path", "description": "Identifies the customer for which to return data", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NoteDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NoteDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NoteDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/internal/{internalID}": { "get": { "tags": [ "Customer" ], "summary": "Get a specific customer by internalID", "description": "Data for the customer

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Customer_GetByinternalID", "parameters": [ { "name": "internalID", "in": "path", "description": "Identifies the customer", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Customer" ], "summary": "Updates a specific customer using the internalID", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "Customer_PutByinternalID", "parameters": [ { "name": "internalID", "in": "path", "description": "Identifies the customer to update by its internalID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for the customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } } }, "required": true, "x-bodyName": "customer" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerCd}": { "get": { "tags": [ "Customer" ], "summary": "Get a specific customer", "description": "Data for the customer

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Customer_GetBycustomerCd", "parameters": [ { "name": "customerCd", "in": "path", "description": "Identifies the customer", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Customer" ], "summary": "Updates a specific customer", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "Customer_PutBycustomerCd", "parameters": [ { "name": "customerCd", "in": "path", "description": "Identifies the customer to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for the customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } } }, "required": true, "x-bodyName": "customer" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer": { "get": { "tags": [ "Customer" ], "summary": "Get a range of customers - ScreenId=AR303000", "operationId": "Customer_GetAll", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "This field does not work and has been deprecated. It will be removed in future versions.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "[This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.]\r\nTells the service to return only {numberToRead} number of records.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "[This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.]\r\nTells the service to return only records after the first {skipRecords} number of records.", "schema": { "type": "integer", "format": "int32" } }, { "name": "name", "in": "query", "description": "Contains Customer name.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Drop down and select Status.", "schema": { "enum": [ "Active", "OnHold", "CreditHold", "Inactive", "OneTime" ], "type": "string" } }, { "name": "corporateId", "in": "query", "description": "Equals Corporate ID from Delivery settings tab.", "schema": { "type": "string" } }, { "name": "vatRegistrationId", "in": "query", "description": "Equals VAT registration ID from Delivery settings tab.", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Equals Email for customer.", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Equals Phone 1 for customer.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "expandAccountInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandPaymentMethods", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandDirectDebit", "in": "query", "description": "Expand direct debit info", "schema": { "type": "boolean" } }, { "name": "attributes", "in": "query", "description": " Attributes (additional information) connected to the entity.\r\n Examples:\r\n{{base}}/customer?attributes={\"AttributeID\":\"ValueID\",\"AttributeID\":\"ValueID\"}\r\n{{base}}/customer?attributes={\"AttributeID\":\"ValueID1,ValueID2\"}", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Customer" ], "summary": "Creates a customer", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Customer_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the customer to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerUpdateDto" } } }, "required": true, "x-bodyName": "customer" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerNumber}/invoice": { "get": { "tags": [ "Customer" ], "summary": "Get a range of invoices for a specific customer", "operationId": "Customer_GetAllInvoicesForCustomerBycustomerNumber", "parameters": [ { "name": "customerNumber", "in": "path", "description": "Identifies the customer for which to return data", "required": true, "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInvoiceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInvoiceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerNumber}/cashSale": { "get": { "tags": [ "Customer" ], "summary": "Get a range of cash sales for a specific customer", "operationId": "Customer_GetAllCashSalesForCustomerBycustomerNumber", "parameters": [ { "name": "customerNumber", "in": "path", "description": "Identifies the customer for which to return data", "required": true, "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CashSaleDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CashSaleDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customerNumber}/document": { "get": { "tags": [ "Customer" ], "summary": "Gets a range of documents for a specific customer", "operationId": "Customer_GetAllDocumentsForCustomerBycustomerNumber", "parameters": [ { "name": "customerNumber", "in": "path", "description": "Identifies the customer for which to return data", "required": true, "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDocumentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDocumentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/{customer}/action/createDunningLetter": { "post": { "tags": [ "Customer" ], "summary": "Creates dunning letters for a specific customer", "description": "The action result dto contains information about the result of running the action", "operationId": "Customer_CreateDunningLetterActionBycustomer", "parameters": [ { "name": "customer", "in": "path", "description": "Reference number of the customer for which the dunning letters will be created", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the dunning letters to be created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDunningLetterActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDunningLetterActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateDunningLetterActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreateDunningLetterActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateDunningLetterActionDto" } } }, "required": true, "x-bodyName": "createDunningLetterActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateDunningLetterActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateDunningLetterActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateDunningLetterActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreateDunningLetterActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customer/action/changeCustomerCd/{internalId}": { "post": { "tags": [ "Customer" ], "summary": "Updates the CustomerNr for the specified Customer", "description": "The action result dto contains information about the result of running the action", "operationId": "Customer_ChangeCustomerNrActionByinternalId", "parameters": [ { "name": "internalId", "in": "path", "description": "Internal identifier of the Customer for which the Customer Nr will be changed", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCustomerCdActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeCustomerCdActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ChangeCustomerCdActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ChangeCustomerCdActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ChangeCustomerCdActionDto" } } }, "required": true, "x-bodyName": "changeCustomerNrActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeCustomerCdActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeCustomerCdActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ChangeCustomerCdActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ChangeCustomerCdActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}": { "get": { "tags": [ "CustomerContract" ], "summary": "Get a specific Customer Contract", "description": "Data for the customer contract

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "CustomerContract_GetCustomerContractBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Identifies the customer contract", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerContractDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerContractDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CustomerContract" ], "summary": "Update a specific CustomerContract", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerContract_PutBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Identifies the CustomerContract to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the CustomerContract to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } } }, "required": true, "x-bodyName": "customerContract" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer contract version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract": { "get": { "tags": [ "CustomerContract" ], "summary": "Get a range of Customer Contracts, a filter needs to be specified - ScreenId=CT301000", "operationId": "CustomerContract_GetAll", "parameters": [ { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "schema": { "type": "string" } }, { "name": "contractTemplate", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "enum": [ "Draft", "InApproval", "Active", "Expired", "Canceled", "Completed", "InUpgrade", "PendingActivation" ], "type": "string" } }, { "name": "customer", "in": "query", "schema": { "type": "string" } }, { "name": "expandSummary", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandDetails", "in": "query", "schema": { "type": "boolean" } }, { "name": "attributes", "in": "query", "description": " Attributes (additional information) connected to the entity.\r\n Examples:\r\n{{base}}/customerContract?attributes={\"AttributeID\":\"ValueID\",\"AttributeID\":\"ValueID\"}\r\n{{base}}/customerContract?attributes={\"AttributeID\":\"ValueID1,ValueID2\"}", "schema": { "type": "string" } }, { "name": "expandAttributes", "in": "query", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContractDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContractDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CustomerContract" ], "summary": "Create a CustomerContract", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "CustomerContract_CreateCustomerContract", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the CustomerContract to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerContractUpdateDto" } } }, "required": true, "x-bodyName": "customerContract" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}/summary": { "get": { "tags": [ "CustomerContract" ], "summary": "Get a specific Customer Contract Summary", "operationId": "CustomerContract_GetCustomerContractSummaryBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Identifies the customer contract", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerContractSummaryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerContractSummaryDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractSummaryDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractSummaryDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}/details": { "get": { "tags": [ "CustomerContract" ], "summary": "Get a specific Customer Contract Details", "operationId": "CustomerContract_GetCustomerContractDetailsBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Identifies the customer contract", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerContractDetailsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerContractDetailsDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractDetailsDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractDetailsDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}/recurringSummary": { "get": { "tags": [ "CustomerContract" ], "summary": "Get a specific Customer Contract Recurring Summary", "operationId": "CustomerContract_GetCustomerContractRecurringSummaryBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Identifies the customer contract", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerContractRecurringSummaryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerContractRecurringSummaryDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractRecurringSummaryDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerContractRecurringSummaryDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}/action/setupContract": { "post": { "tags": [ "CustomerContract" ], "summary": "Setup contract operation", "description": "Response Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerContract_SetupContractBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Reference number of the customer contract to be set up", "required": true, "schema": { "type": "string" } }, { "name": "setupDate", "in": "query", "description": "Optional Setup Date", "schema": { "type": "string", "format": "date-time" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer contract version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}/action/activateContract": { "post": { "tags": [ "CustomerContract" ], "summary": "Activate contract operation", "description": "Response Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerContract_ActivateContractBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Reference number of the customer contract to be activated", "required": true, "schema": { "type": "string" } }, { "name": "activationDate", "in": "query", "description": "Optional Activation Date", "schema": { "type": "string", "format": "date-time" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer contract version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}/action/setupAndActivateContract": { "post": { "tags": [ "CustomerContract" ], "summary": "Setup and Activate contract operation", "description": "Response Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header", "operationId": "CustomerContract_SetupAndActivateContractBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Reference number of the customer contract to be setup and activated", "required": true, "schema": { "type": "string" } }, { "name": "activationDate", "in": "query", "description": "Optional Activation Date", "schema": { "type": "string", "format": "date-time" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer contract version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}/action/terminateContract": { "post": { "tags": [ "CustomerContract" ], "summary": "Terminate contract operation", "description": "Response Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerContract_TerminateContractBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Reference number of the customer contract to be terminated", "required": true, "schema": { "type": "string" } }, { "name": "terminationDate", "in": "query", "description": "Optional Termination Date", "schema": { "type": "string", "format": "date-time" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer contract version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}/action/upgradeContract": { "post": { "tags": [ "CustomerContract" ], "summary": "Upgrade contract operation", "description": "Response Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header", "operationId": "CustomerContract_UpgradeContractBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Reference number of the customer contract to be upgraded", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer contract version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerContract/{contractId}/action/activateUpgrade": { "post": { "tags": [ "CustomerContract" ], "summary": "Activate upgrade contract operation", "description": "Response Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerContract_ActivateUpgradeBycontractId", "parameters": [ { "name": "contractId", "in": "path", "description": "Reference number of the customer contract to be activated", "required": true, "schema": { "type": "string" } }, { "name": "activationDate", "in": "query", "description": "Optional Activation Date", "schema": { "type": "string", "format": "date-time" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer contract version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerCreditNote/{creditNoteNumber}": { "get": { "tags": [ "CustomerCreditNote" ], "summary": "Get a specific Customer Credit Note", "description": "Data for Customer Credit Note

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "CustomerCreditNote_GetBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the Customer Credit Note", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CustomerCreditNote" ], "summary": "Update a specific Credit Note", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerCreditNote_UpdateBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the Credit Note to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Credit Note to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } } }, "required": true, "x-bodyName": "creditNote" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer credit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "CustomerCreditNote" ], "summary": "Deletes a specific Customer Credit Note", "description": "Response Message has StatusCode NoContent if DELETE operation succeed", "operationId": "CustomerCreditNote_DeleteBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the Customer Credit Note to delete", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerCreditNote": { "get": { "tags": [ "CustomerCreditNote" ], "summary": "Get a range of Customer Credit Notes - ScreenId=AR301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "description": "Data for Customer Credit Note", "operationId": "CustomerCreditNote_GetAll", "parameters": [ { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerCreditNoteDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerCreditNoteDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CustomerCreditNote" ], "summary": "Create a Credit Note. Method is deprecated and will be removed starting May 2021 - start using new method CustomerCreditNoteV2 endpoint.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "CustomerCreditNote_Create", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Credit Note to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } } }, "required": true, "x-bodyName": "creditNote" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerCreditNote/{creditNoteNumber}/print": { "get": { "tags": [ "CustomerCreditNote" ], "summary": "Get the print report of a Customer Credit Note", "description": "The File is in Content of the message", "operationId": "CustomerCreditNote_PrintBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the customer credit note", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerCreditNote/{creditNoteNumber}/action/release": { "post": { "tags": [ "CustomerCreditNote" ], "summary": "Release credit note operation", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerCreditNote_ReleaseDocumentBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Reference number of the credit note to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer credit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "200": { "description": "If invoked without header erp-api-background set, operation starts in the background and 200-OK is returned with a reference. No notification is sent when action is done.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseCustomerCreditNoteActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseCustomerCreditNoteActionResultDto" } } } }, "202": { "description": "If invoked with header erp-api-background set, operation starts in the background, 202-Accepted will be returned and a webhook will be posted upon action done event.", "content": { "application/json": { }, "text/json": { } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerCreditNote/{creditNoteNumber}/action/sendToAutoInvoice": { "post": { "tags": [ "CustomerCreditNote" ], "summary": "SendToAutoInvoice credit note operation", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerCreditNote_SendToAutoInvoiceBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Reference number of the credit note to be send to AutoInvoice", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer credit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerCreditNote/{creditNoteNumber}/attachment": { "post": { "tags": [ "CustomerCreditNote" ], "summary": "Creates an attachment and associates it with a credit note. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.\r\n

Request Format:

\r\nThis endpoint expects a multipart/form-data request with the following parts:

\r\n1. file (required): The attachment file to upload

\r\n2. metadata (optional): JSON object with additional settings



Example metadata JSON:

\r\n{\r\n \"includeAttachmentInvoiceEmail\": true\r\n}\r\n", "operationId": "CustomerCreditNote_CreateHeaderAttachmentBycreditNoteNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the credit note", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer credit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerCreditNote/{creditNoteNumber}/{lineNumber}/attachment": { "post": { "tags": [ "CustomerCreditNote" ], "summary": "Creates an attachment and associates it with a certain credit note line. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.\r\n

Request Format:

\r\nThis endpoint expects a multipart/form-data request with the following parts:

\r\n1. file (required): The attachment file to upload

\r\n2. metadata (optional): JSON object with additional settings



Example metadata JSON:

\r\n{\r\n \"includeAttachmentInvoiceEmail\": true\r\n}\r\n", "operationId": "CustomerCreditNote_CreateLineAttachmentBycreditNoteNumberlineNumber", "parameters": [ { "name": "creditNoteNumber", "in": "path", "description": "Identifies the credit note", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer credit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/customerCreditNote": { "post": { "tags": [ "CustomerCreditNoteV2" ], "summary": "Create a Customer Credit Note. ScreenID=AR301000", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "CustomerCreditNoteV2_Create", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Credit Note to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerCreditNoteUpdateDto" } } }, "required": true, "x-bodyName": "creditNote" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerCreditWriteOff/{creditWriteOffNumber}": { "get": { "tags": [ "CustomerCreditWriteOff" ], "summary": "Get a specific Customer Credit WriteOff", "description": "Data for Customer Credit WriteOff

\r\n The response headers include an ETag after a successful GET operation.", "operationId": "CustomerCreditWriteOff_GetBycreditWriteOffNumber", "parameters": [ { "name": "creditWriteOffNumber", "in": "path", "description": "Identifies the Customer Credit WriteOff", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditWriteOffDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerCreditWriteOffDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerCreditWriteOff": { "get": { "tags": [ "CustomerCreditWriteOff" ], "summary": "Get a range of Customer Credit WriteOffs - ScreenId=AR301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "description": "Data for Customer Credit WriteOff", "operationId": "CustomerCreditWriteOff_GetAll", "parameters": [ { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerCreditWriteOffDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerCreditWriteOffDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerDebitNote/{debitNoteNumber}": { "get": { "tags": [ "CustomerDebitNote" ], "summary": "Get a specific Customer Debit Note", "description": "Data for Customer Debit Note

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "CustomerDebitNote_GetBydebitNoteNumber", "parameters": [ { "name": "debitNoteNumber", "in": "path", "description": "Identifies the Customer Debit Note", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CustomerDebitNote" ], "summary": "Update a specific Debit Note", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerDebitNote_UpdateBydebitNoteNumber", "parameters": [ { "name": "debitNoteNumber", "in": "path", "description": "Identifies the Debit Note to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Debit Note to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } } }, "required": true, "x-bodyName": "debitNote" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer debit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerDebitNote": { "get": { "tags": [ "CustomerDebitNote" ], "summary": "Get a range of Customer Debit Notes - ScreenId=AR301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "description": "Data for Customer Debit Note", "operationId": "CustomerDebitNote_GetAll", "parameters": [ { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDebitNoteDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDebitNoteDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CustomerDebitNote" ], "summary": "Create a Debit Note. Method is deprecated and will be removed starting May 2021 - start using new method CustomerDebitNoteV2 endpoint.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "CustomerDebitNote_Create", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Debit Note to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } } }, "required": true, "x-bodyName": "debitNote" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerDebitNote/{debitNoteNumber}/action/release": { "post": { "tags": [ "CustomerDebitNote" ], "summary": "Release debit note operation", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerDebitNote_ReleaseDocumentBydebitNoteNumber", "parameters": [ { "name": "debitNoteNumber", "in": "path", "description": "Reference number of the debit note to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer debit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "200": { "description": "If invoked without header erp-api-background set, operation starts in the background and 200-OK is returned with a reference. No notification is sent when action is done.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseCustomerDebitNoteActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseCustomerDebitNoteActionResultDto" } } } }, "202": { "description": "If invoked with header erp-api-background set, operation starts in the background, 202-Accepted will be returned and a webhook will be posted upon action done event.", "content": { "application/json": { }, "text/json": { } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerDebitNote/{debitNoteNumber}/action/sendToAutoInvoice": { "post": { "tags": [ "CustomerDebitNote" ], "summary": "SendToAutoInvoice debit note operation", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerDebitNote_SendToAutoInvoiceBydebitNoteNumber", "parameters": [ { "name": "debitNoteNumber", "in": "path", "description": "Reference number of the debit note to be send to AutoInvoice", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer debit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerDebitNote/{debitNoteNumber}/attachment": { "post": { "tags": [ "CustomerDebitNote" ], "summary": "Creates an attachment and associates it with a debit note. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.\r\n

Request Format:

\r\nThis endpoint expects a multipart/form-data request with the following parts:

\r\n1. file (required): The attachment file to upload

\r\n2. metadata (optional): JSON object with additional settings



Example metadata JSON:

\r\n{\r\n \"includeAttachmentInvoiceEmail\": true\r\n}\r\n", "operationId": "CustomerDebitNote_CreateHeaderAttachmentBydebitNoteNumber", "parameters": [ { "name": "debitNoteNumber", "in": "path", "description": "Identifies the debit note", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer debit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerDebitNote/{debitNoteNumber}/{lineNumber}/attachment": { "post": { "tags": [ "CustomerDebitNote" ], "summary": "Creates an attachment and associates it with a certain debit note line. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.\r\n

Request Format:

\r\nThis endpoint expects a multipart/form-data request with the following parts:

\r\n1. file (required): The attachment file to upload

\r\n2. metadata (optional): JSON object with additional settings



Example metadata JSON:

\r\n{\r\n \"includeAttachmentInvoiceEmail\": true\r\n}\r\n", "operationId": "CustomerDebitNote_CreateLineAttachmentBydebitNoteNumberlineNumber", "parameters": [ { "name": "debitNoteNumber", "in": "path", "description": "Identifies the debit note", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer debit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerDebitNote/{debitNoteNumber}/print": { "get": { "tags": [ "CustomerDebitNote" ], "summary": "Get the print report of a Customer Debit Note", "description": "The File is in Content of the message", "operationId": "CustomerDebitNote_PrintBydebitNoteNumber", "parameters": [ { "name": "debitNoteNumber", "in": "path", "description": "Identifies the customer debit note", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer debit note version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/customerDebitNote": { "post": { "tags": [ "CustomerDebitNoteV2" ], "summary": "Create a Customer Debit Note. ScreenID=AR301000", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "CustomerDebitNoteV2_Create", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Debit Note to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerDebitNoteUpdateDto" } } }, "required": true, "x-bodyName": "debitNote" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerdocument": { "get": { "tags": [ "CustomerDocument" ], "summary": "Gets a range of Customer Documents - ScreenId=AR301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2020-May:Added forced pagination", "description": "Data for Customer Document", "operationId": "CustomerDocument_GetAllDocuments", "parameters": [ { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDocumentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDocumentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/worktypes": { "get": { "tags": [ "CustomerInvoice" ], "summary": "Get all Work Types", "description": "Data for the Work Type", "operationId": "CustomerInvoice_GetWorkTypes", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTypeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTypeDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTypeDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTypeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{invoiceNumber}": { "get": { "tags": [ "CustomerInvoice" ], "summary": "Get a specific Invoice", "description": "Data for Customer Invoice\r\n The response headers include an ETag after a successful GET operation.", "operationId": "CustomerInvoice_GetByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the Invoice", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CustomerInvoice" ], "summary": "Update a specific Invoice", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerInvoice_UpdateByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the Invoice to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Invoice to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } } }, "required": true, "x-bodyName": "invoice" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "CustomerInvoice" ], "summary": "Deletes a specific Customer Invoice", "description": "Response Message has StatusCode NoContent if DELETE operation succeed", "operationId": "CustomerInvoice_DeleteByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the Customer Invoice to delete", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{refNbr}/rotrut": { "get": { "tags": [ "CustomerInvoice" ], "summary": "Get Rot Rut informations for a Customer Invoice", "description": "Data for the Rot Rut", "operationId": "CustomerInvoice_GetRotRutByrefNbr", "parameters": [ { "name": "refNbr", "in": "path", "description": "Identify the customer invoice for which to return data", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotRutDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RotRutDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{refNbr}/print": { "get": { "tags": [ "CustomerInvoice" ], "summary": "Get the print report of a Customer Invoice", "description": "The File is in Content of the message", "operationId": "CustomerInvoice_PrintInvoiceByrefNbr", "parameters": [ { "name": "refNbr", "in": "path", "description": "Identifies the customer invoice", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice": { "get": { "tags": [ "CustomerInvoice" ], "summary": "Get a range of Invoices - ScreenId=AR301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2020-May:Added forced pagination", "description": "Data for Customer Invoice", "operationId": "CustomerInvoice_GetAll", "parameters": [ { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInvoiceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInvoiceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CustomerInvoice" ], "summary": "Create an Invoice. Method is deprecated and will be removed starting May 2021 - start using new method CustomerInvoiceV2 endpoint.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "CustomerInvoice_Create", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Invoice to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } } }, "required": true, "x-bodyName": "invoice" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{invoiceNumber}/attachment": { "post": { "tags": [ "CustomerInvoice" ], "summary": "Creates an attachment and associates it with an invoice. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.

\r\nThe response headers include an ETag after a successful POST operation.\r\n

Request Format:

\r\nThis endpoint expects a multipart/form-data request with the following parts:

\r\n1. file (required): The attachment file to upload

\r\n2. metadata (optional): JSON object with additional settings



Example metadata JSON:

\r\n{\r\n \"includeAttachmentInvoiceEmail\": true\r\n}\r\n", "operationId": "CustomerInvoice_CreateHeaderAttachmentByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the invoice", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{invoiceNumber}/{lineNumber}/attachment": { "post": { "tags": [ "CustomerInvoice" ], "summary": "Creates an attachment and associates it with a certain invoice line. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.

\r\nThe response headers include an ETag after a successful POST operation.\r\n

Request Format:

\r\nThis endpoint expects a multipart/form-data request with the following parts:

\r\n1. file (required): The attachment file to upload

\r\n2. metadata (optional): JSON object with additional settings



Example metadata JSON:

\r\n{\r\n \"includeAttachmentInvoiceEmail\": true\r\n}\r\n", "operationId": "CustomerInvoice_CreateLineAttachmentByinvoiceNumberlineNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the invoice", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{invoiceNumber}/action/release": { "post": { "tags": [ "CustomerInvoice" ], "summary": "Release invoice operation", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerInvoice_ReleaseInvoiceByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Reference number of the invoice to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "200": { "description": "If invoked without header erp-api-background set, operation starts in the background and 200-OK is returned with a reference. No notification is sent when action is done.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInvoiceActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseInvoiceActionResultDto" } } } }, "202": { "description": "If invoked with header erp-api-background set, operation starts in the background, 202-Accepted will be returned and a webhook will be posted upon action done event.", "content": { "application/json": { }, "text/json": { } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{invoiceNumber}/action/sendToAutoInvoice": { "post": { "tags": [ "CustomerInvoice" ], "summary": "SendToAutoInvoice invoice operation", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerInvoice_SendToAutoInvoiceByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Reference number of the invoice to be send to AutoInvoice", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{invoiceNumber}/action/correct": { "post": { "tags": [ "CustomerInvoice" ], "summary": "Create a correction document for a released document", "description": "Response Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.

\r\nThe response headers include an ETag for the new corrected invoice after a successful POST operation.", "operationId": "CustomerInvoice_CorrectInvoiceByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{invoiceNumber}/action/reverse": { "post": { "tags": [ "CustomerInvoice" ], "summary": "Reverse an Invoice", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.

\r\nThe response headers include an ETag for the returned credit note after a successful POST operation.", "operationId": "CustomerInvoice_ReverseInvoiceByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Reference number of the released invoice to be reversed", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The action the dto use to condition the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } } }, "required": true, "x-bodyName": "reverseActionDto" }, "responses": { "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerinvoice/{invoiceNumber}/action/reverseandapplytonote": { "post": { "tags": [ "CustomerInvoice" ], "summary": "Reverse and Apply to Note", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.

\r\nThe response headers include an ETag for the returned credit note after a successful POST operation.", "operationId": "CustomerInvoice_ReverseInvoiceAndApplyToNoteByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Reference number of the released invoice to be reversed and applied to Memo", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The action the dto use to condition the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReverseInvoiceActionDto" } } }, "required": true, "x-bodyName": "reverseActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/customerinvoice": { "post": { "tags": [ "CustomerInvoiceV2" ], "summary": "Create an Invoice. ScreenID=AR301000", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "CustomerInvoiceV2_Create", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Invoice to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerInvoiceUpdateDto" } } }, "required": true, "x-bodyName": "invoice" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerOverdueCharge/{overdueChargeNumber}": { "get": { "tags": [ "CustomerOverdueCharge" ], "summary": "Get a specific Customer Overdue Charge", "description": "Data for Customer Overdue Charge

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "CustomerOverdueCharge_GetByoverdueChargeNumber", "parameters": [ { "name": "overdueChargeNumber", "in": "path", "description": "Identifies the Customer Overdue Charge", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerOverdueChargeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerOverdueChargeDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CustomerOverdueCharge" ], "summary": "Update a specific Overdue Charge", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerOverdueCharge_UpdateByoverdueChargeNumber", "parameters": [ { "name": "overdueChargeNumber", "in": "path", "description": "Identifies the Overdue Charge to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Overdue Charge to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerOverdueChargeUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerOverdueChargeUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerOverdueChargeUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerOverdueChargeUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerOverdueChargeUpdateDto" } } }, "required": true, "x-bodyName": "overdueCharge" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer overdue charge version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerOverdueCharge": { "get": { "tags": [ "CustomerOverdueCharge" ], "summary": "Get a range of Customer Overdue Charges - ScreenId=AR301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "description": "Data for Customer Overdue Charge", "operationId": "CustomerOverdueCharge_GetAll", "parameters": [ { "name": "documentType", "in": "query", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint.", "schema": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "dunningLevel", "in": "query", "description": "The dunning level of the document.", "schema": { "type": "integer", "format": "int32" } }, { "name": "closedFinancialPeriod", "in": "query", "description": "The date of the closing of the financial period.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTime", "in": "query", "description": "The date and time for when the document last released a dunning letter.", "schema": { "type": "string" } }, { "name": "dunningLetterDateTimeCondition", "in": "query", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame.", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "The project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApplications", "in": "query", "description": "True if you want to see all dunning information regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandDunningInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandAttachments", "in": "query", "description": "True if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandTaxDetails", "in": "query", "description": "True if you want to see all VAT details regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandInvoiceAddress", "in": "query", "description": "True if you want to see all information regarding the invoice address for this document.", "schema": { "type": "boolean" } }, { "name": "financialPeriod", "in": "query", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM.", "schema": { "type": "string" } }, { "name": "documentDueDate", "in": "query", "description": "The date when payment for the document is due, in accordance with the credit terms.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "externalReference", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "paymentReference", "in": "query", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window..", "schema": { "type": "string" } }, { "name": "customerRefNumber", "in": "query", "description": "The top part > External reference > The external reference used in AutoInvoice.", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "documentDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "documentDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOverdueChargeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOverdueChargeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerOverdueCharge/{overdueChargeNumber}/action/release": { "post": { "tags": [ "CustomerOverdueCharge" ], "summary": "Release overdue charge operation", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerOverdueCharge_ReleaseDocumentByoverdueChargeNumber", "parameters": [ { "name": "overdueChargeNumber", "in": "path", "description": "Reference number of the overdue charge to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Customer overdue charge version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "200": { "description": "If invoked without header erp-api-background set, operation starts in the background and 200-OK is returned with a reference. No notification is sent when action is done.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseCustomerOverdueChargeActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseCustomerOverdueChargeActionResultDto" } } } }, "202": { "description": "If invoked with header erp-api-background set, operation starts in the background, 202-Accepted will be returned and a webhook will be posted upon action done event.", "content": { "application/json": { }, "text/json": { } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerOverdueCharge/{overdueChargeNumber}/attachment": { "post": { "tags": [ "CustomerOverdueCharge" ], "summary": "Creates an attachment and associates it with an overdue charge. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerOverdueCharge_CreateHeaderAttachmentByoverdueChargeNumber", "parameters": [ { "name": "overdueChargeNumber", "in": "path", "description": "Identifies the overdue charge", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer overdue charge version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerOverdueCharge/{overdueChargeNumber}/{lineNumber}/attachment": { "post": { "tags": [ "CustomerOverdueCharge" ], "summary": "Creates an attachment and associates it with a certain overdue charge line. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerOverdueCharge_CreateLineAttachmentByoverdueChargeNumberlineNumber", "parameters": [ { "name": "overdueChargeNumber", "in": "path", "description": "Identifies the overdue charge", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer overdue charge version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerPayment/{paymentNumber}": { "get": { "tags": [ "CustomerPayment" ], "summary": "Get a specific Payment", "description": "Data for Payment

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "CustomerPayment_GetBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Identifies the Payment", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CustomerPayment" ], "summary": "Update a specific Payment", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerPayment_PutBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Identifies the Payment to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Payment to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } } }, "required": true, "x-bodyName": "payment" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerPayment": { "get": { "tags": [ "CustomerPayment" ], "summary": "Get a range of Payments. - SceenId=AR302000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "CustomerPayment_GetAllPayments", "parameters": [ { "name": "paymentNbr", "in": "query", "description": "Payment number", "schema": { "type": "string" } }, { "name": "paymentType", "in": "query", "description": "Select Type", "schema": { "enum": [ "Payment", "CreditNote", "Prepayment", "Refund", "VoidPayment", "SmallBalanceWo", "VoidRefund", "Undefined" ], "type": "string" } }, { "name": "customer", "in": "query", "description": "Enter Customer", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Enter the from-value for Ref. no.", "schema": { "type": "string" } }, { "name": "invoiceRefNbr", "in": "query", "description": "Enter Invoice Ref Nbr", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "Enter field to order your records by.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "docDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "docDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "financialPeriod", "in": "query", "description": "Filter by financial period, format YYYYPP", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CustomerPayment" ], "summary": "Create a Payment", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "CustomerPayment_CreatePayment", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Payment to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } } }, "required": true, "x-bodyName": "payment" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerPayment/{paymentNumber}/action/release": { "post": { "tags": [ "CustomerPayment" ], "summary": "Release payment operation", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerPayment_ReleasePaymentBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Reference number of the payment to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Contains the type of the payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } } }, "required": true, "x-bodyName": "releaseActionDto" }, "responses": { "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerPayment/{paymentNumber}/action/void": { "post": { "tags": [ "CustomerPayment" ], "summary": "Void payment operation", "description": "The action result dto contains information about the result of running the action

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerPayment_VoidPaymentBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Reference number of the payment to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Contains the type of the payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } } }, "required": true, "x-bodyName": "voidActionDto" }, "responses": { "412": { "description": "Customer invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerpaymentmethod/{customerId}/{customerPaymentMethodId}": { "get": { "tags": [ "CustomerPaymentMethod" ], "summary": "Get one specific Customer payment method for one specific customer. ScreenId=AR303010", "description": "Data for Customer payment method

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "CustomerPaymentMethod_GetCustomerPaymentMethodBycustomerIdcustomerPaymentMethodId", "parameters": [ { "name": "customerId", "in": "path", "description": "Identifies the Customer", "required": true, "schema": { "type": "string" } }, { "name": "customerPaymentMethodId", "in": "path", "description": "Identifies the Customer payment method", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPaymentMethodDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerPaymentMethodDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CustomerPaymentMethod" ], "summary": "Update a specific Customer payment method", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerPaymentMethod_UpdateCustomerPaymentMethodBycustomerIdcustomerPaymentMethodId", "parameters": [ { "name": "customerId", "in": "path", "description": "Identifies the Customer", "required": true, "schema": { "type": "string" } }, { "name": "customerPaymentMethodId", "in": "path", "description": "Identifies the Customer payment method to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Customer payment method to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPaymentMethodUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerPaymentMethodUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerPaymentMethodUpdateDto" } } }, "required": true, "x-bodyName": "paymentMethod" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer payment method version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerpaymentmethod/{customerId}": { "get": { "tags": [ "CustomerPaymentMethod" ], "summary": "Get all Customer payment methods for one specific customer. ScreenId=AR303010 and AR303000", "operationId": "CustomerPaymentMethod_GetCustomerPaymentMethodsBycustomerId", "parameters": [ { "name": "customerId", "in": "path", "description": "Identifies the Customer", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPaymentMethodDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPaymentMethodDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerpaymentmethod": { "get": { "tags": [ "CustomerPaymentMethod" ], "summary": "Get Customer payment methods", "operationId": "CustomerPaymentMethod_GetCustomerPaymentMethods", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPaymentMethodsDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPaymentMethodsDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CustomerPaymentMethod" ], "summary": "Create a Customer payment method", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "CustomerPaymentMethod_CreateCustomerPaymentMethod", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Customer payment method to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerPaymentMethodCreateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerPaymentMethodCreateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerPaymentMethodCreateDto" } } }, "required": true, "x-bodyName": "paymentMethod" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerSalesPrice": { "get": { "tags": [ "CustomerSalesPrice" ], "summary": "Get a range of Customer Sales Prices - ScreenId=AR202000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "CustomerSalesPrice_GetCustomerSalesPrices", "parameters": [ { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "priceType", "in": "query", "schema": { "enum": [ "All", "Base", "Customer", "CustomerPriceClass" ], "type": "string" } }, { "name": "priceCode", "in": "query", "schema": { "type": "string" } }, { "name": "inventoryId", "in": "query", "schema": { "type": "string" } }, { "name": "effectiveAsOf", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSalesPriceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSalesPriceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "CustomerSalesPrice" ], "summary": "Create a new Customer Sales Price", "description": "Response Message has StatusCode Created if POST operation succeed

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "CustomerSalesPrice_PostCustomerSalesPrice", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The CustomerSalesPriceUpdateDto to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } } }, "required": true, "x-bodyName": "customerSalesPriceDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/customerSalesPrice/{recordId}": { "get": { "tags": [ "CustomerSalesPrice" ], "summary": "Get a specific Customer Sales Price by recordId", "description": "The response headers include an ETag after a successful GET operation.", "operationId": "CustomerSalesPrice_GetCustomerSalesPriceByrecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "The recordId of the Customer Sales Price", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "CustomerSalesPrice" ], "summary": "Update an existing Customer Sales Price", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "CustomerSalesPrice_PutCustomerSalesPriceByrecordId", "parameters": [ { "name": "recordId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The CustomerSalesPriceUpdateDto to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CustomerSalesPriceUpdateDto" } } }, "required": true, "x-bodyName": "customerSalesPriceDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Customer sales price version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/customer/balance": { "get": { "tags": [ "CustomerV2" ], "summary": "Get the balance for one or multiple customers", "operationId": "CustomerV2_GetAllCustomerBalance", "parameters": [ { "name": "branchNumber", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "customer", "in": "query", "description": "Filter by Customer", "schema": { "type": "string" } }, { "name": "fromFinPeriod", "in": "query", "description": "Filter from financial period, format YYYYPP\r\nThe filte is inclusive, the records for the specified period will be included in the results.\r\nThis filter is required.", "required": true, "schema": { "type": "string" } }, { "name": "toFinPeriod", "in": "query", "description": "Filter to financial period, format YYYYPP\r\nThe filte is inclusive, the records for the specified period will be included in the results.\r\nThis filter is required.", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceV2Dto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceV2Dto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceV2Dto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerBalanceV2Dto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/deferralCode/{deferralCodeId}": { "get": { "tags": [ "DeferralCode" ], "summary": "Get a specific DeferralCode", "operationId": "DeferralCode_GetDeferralCodeBydeferralCodeId", "parameters": [ { "name": "deferralCodeId", "in": "path", "description": "Identifies the DeferralCode", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeferralCodeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DeferralCodeDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/deferralCode": { "get": { "tags": [ "DeferralCode" ], "summary": "Get a range of DeferralCodes - ScreenId=DR2020PL\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "DeferralCode_GetDeferralCodes", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeferralCodeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DeferralCodeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/department/{departmentId}": { "get": { "tags": [ "Department" ], "summary": "Get a specific department", "description": "Data for a single department.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Department_GetDepartmentBydepartmentId", "parameters": [ { "name": "departmentId", "in": "path", "description": "Identifies the department", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DepartmentDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DepartmentDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DepartmentDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Department" ], "summary": "Updates a specific department", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "Department_UpdateDepartmentBydepartmentId", "parameters": [ { "name": "departmentId", "in": "path", "description": "Identifies the department to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update the department with", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } } }, "required": true, "x-bodyName": "departmentUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Department version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/department": { "get": { "tags": [ "Department" ], "summary": "Get a range of departments - ScreenId=EP201500", "operationId": "Department_GetAllDepartmentDtos", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "Greater-than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Department" ], "summary": "Creates a department", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "Department_CreateDepartment", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the department to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DepartmentUpdateBaseDto" } } }, "required": true, "x-bodyName": "departmentUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/dimension": { "get": { "tags": [ "Dimension" ], "summary": "Get a list of all Dimension names/IDs ScreenId=CS202000", "operationId": "Dimension_GetDimensionList", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/json": { "schema": { "type": "array", "items": { "type": "string" } } }, "application/xml": { "schema": { "type": "array", "items": { "type": "string" } } }, "text/xml": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/dimension/{dimensionId}": { "get": { "tags": [ "Dimension" ], "summary": "Get a specific Dimension", "operationId": "Dimension_GetDimensionBydimensionId", "parameters": [ { "name": "dimensionId", "in": "path", "description": "Identifies the dimension", "required": true, "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater-than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords. ///", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "expandSegmentsValues", "in": "query", "description": "Flag can be used to return data without the segment values.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DtoDimension" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DtoDimension" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DtoDimension" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DtoDimension" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/dimension/{dimensionId}/{segmentId}": { "get": { "tags": [ "Dimension" ], "summary": "Get a specific Segment for a specific Dimension", "description": "Data for Segment

\r\n The response header includes an ETag after a successful GET operation.", "operationId": "Dimension_GetSegmentBydimensionIdsegmentId", "parameters": [ { "name": "dimensionId", "in": "path", "description": "Identifies the Dimension", "required": true, "schema": { "type": "string" } }, { "name": "segmentId", "in": "path", "description": "Identifies the Segment", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DtoSegment" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DtoSegment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DtoSegment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DtoSegment" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Dimension" ], "summary": "Update a Segment", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\n The response headers include an ETag after a successful PUT operation.

\r\n Response Message has StatusCode InternalServerError if PUT operation failed", "operationId": "Dimension_UpdateSegmentBydimensionIdsegmentId", "parameters": [ { "name": "dimensionId", "in": "path", "description": "Identifies the Dimension for which the Segment is defined", "required": true, "schema": { "type": "string" } }, { "name": "segmentId", "in": "path", "description": "Identifies the Segment", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Segment to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DtoSegmentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DtoSegmentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DtoSegmentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DtoSegmentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DtoSegmentUpdateDto" } } }, "required": true, "x-bodyName": "update" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Segment version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/dimension/{dimensionId}/{segmentId}/{valueId}": { "get": { "tags": [ "Dimension" ], "summary": "Get a specific SegmentValue for a specific Segment for a specific Dimension", "operationId": "Dimension_GetSegmentValueBydimensionIdsegmentIdvalueId", "parameters": [ { "name": "dimensionId", "in": "path", "description": "Identifies the Dimension", "required": true, "schema": { "type": "string" } }, { "name": "segmentId", "in": "path", "description": "Identifies the Segment", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "valueId", "in": "path", "description": "Identifies the SegmentValue by Id. Must be Base64 encoded.", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DtoSegmentValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DtoSegmentValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DtoSegmentValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DtoSegmentValue" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/dimension/{dimensionId}/{segmentId}/publicid/{publicId}": { "get": { "tags": [ "Dimension" ], "summary": "Get a specific SegmentValue for a specific Segment for a specific Dimension", "operationId": "Dimension_GetSegmentValueBydimensionIdsegmentIdpublicId", "parameters": [ { "name": "dimensionId", "in": "path", "description": "Identifies the Dimension", "required": true, "schema": { "type": "string" } }, { "name": "segmentId", "in": "path", "description": "Identifies the Segment", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "publicId", "in": "path", "description": "Identifies the SegmentValue by its publicId", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DtoSegmentValue" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DtoSegmentValue" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DtoSegmentValue" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DtoSegmentValue" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/discount": { "get": { "tags": [ "Discount" ], "summary": "Get a range of discounts - ScreenId=AR209500", "operationId": "Discount_GetDiscounts", "parameters": [ { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "discountCode", "in": "query", "schema": { "type": "string" } }, { "name": "series", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfDiscountDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfDiscountDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Discount" ], "summary": "Creates a new discount", "description": "The response headers include an ETag after a successful POST operation.", "operationId": "Discount_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } } }, "required": true, "x-bodyName": "discountUpdateDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/discount/{discountCode}/{series}": { "put": { "tags": [ "Discount" ], "summary": "Update a discount", "description": "In this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "Discount_PutBydiscountCodeseries", "parameters": [ { "name": "discountCode", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "series", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/DiscountUpdateDto" } } }, "required": true, "x-bodyName": "discountUpdateDto" }, "responses": { "412": { "description": "Discount sequence version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "Discount" ], "operationId": "Discount_DeleteBydiscountCodeseries", "parameters": [ { "name": "discountCode", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "series", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/discount/{discountCode}/{series}/{filerDate}/action/updateDiscounts": { "post": { "tags": [ "Discount" ], "summary": "Update discounts using a filter date.", "description": "In this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "Discount_UpdateDiscountsBydiscountCodeseriesfilerDate", "parameters": [ { "name": "discountCode", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "series", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "filterDate", "in": "query", "description": "", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "filerDate", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Discount sequence version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/discount/{discountCode}/{series}/action/updateDiscounts": { "post": { "tags": [ "Discount" ], "summary": "Update discounts", "description": "In this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "Discount_UpdateDiscountsBydiscountCodeseries", "parameters": [ { "name": "discountCode", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "series", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Discount sequence version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/discountCode": { "get": { "tags": [ "DiscountCode" ], "summary": "Get a range of discount codes - ScreenId=AR209000", "operationId": "DiscountCode_GetDiscountCodes", "parameters": [ { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "discountCode", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfDiscountCodeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfDiscountCodeDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/discountCode": { "get": { "tags": [ "DiscountCodeV2" ], "summary": "Get a range of discount codes - ScreenId=AR209000", "operationId": "DiscountCodeV2_GetDiscountCodes", "parameters": [ { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "discountCode", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountCodeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountCodeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/discount": { "get": { "tags": [ "DiscountV2" ], "summary": "Get a range of discounts - ScreenId=AR209500", "operationId": "DiscountV2_GetDiscounts", "parameters": [ { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "discountCode", "in": "query", "schema": { "type": "string" } }, { "name": "series", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/earningtype/{typeCd}": { "get": { "tags": [ "EarningType" ], "summary": "Get a specific earning type", "operationId": "EarningType_GetEarningTypeBytypeCd", "parameters": [ { "name": "typeCd", "in": "path", "description": "Identifies the earning type", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EarningTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EarningTypeDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EarningTypeDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EarningTypeDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/earningtype": { "get": { "tags": [ "EarningType" ], "summary": "Get a range of earningtypes - ScreenId=EP102000", "operationId": "EarningType_GetAllEarningTypeDtos", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "Greater-than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EarningTypeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EarningTypeDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EarningTypeDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EarningTypeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/employee/{employeeCd}": { "get": { "tags": [ "Employee" ], "summary": "Get a specific employee", "description": "Data for a single employee.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Employee_GetEmployeeByemployeeCd", "parameters": [ { "name": "employeeCd", "in": "path", "description": "Identifies the employee", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmployeeDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Employee" ], "summary": "Updates a specific employee", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "Employee_PutByemployeeCd", "parameters": [ { "name": "employeeCd", "in": "path", "description": "Identifies the employee to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for the employee", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmployeeUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EmployeeUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EmployeeUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EmployeeUpdateDto" } } }, "required": true, "x-bodyName": "employeeDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Employee version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/employee": { "get": { "tags": [ "Employee" ], "summary": "Get a range of employees - ScreenId=EP203000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2021-October:Added forced pagination", "operationId": "Employee_GetAllEmployees", "parameters": [ { "name": "linkedToUser", "in": "query", "description": "If the employee is linked to a user.", "schema": { "type": "boolean" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater-than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Employee" ], "summary": "Create an employee", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "Employee_CreateEmployee", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the employee to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EmployeeCreateDTO" } }, "text/json": { "schema": { "$ref": "#/components/schemas/EmployeeCreateDTO" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/EmployeeCreateDTO" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/EmployeeCreateDTO" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/EmployeeCreateDTO" } } }, "required": true, "x-bodyName": "employee" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/employee/{EmployeeCd}/timecards": { "get": { "tags": [ "Employee" ], "summary": "Get a specific employee time cards", "operationId": "Employee_GetEmployeeTimeCards", "parameters": [ { "name": "employeeCd", "in": "query", "description": "Identifies the employee", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document.", "schema": { "enum": [ "Hold", "Open", "Approved", "Rejected", "Released" ], "type": "string" } }, { "name": "week", "in": "query", "description": "Identifies the week number of the time card", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Identifies the type of the time card (Normal, Corrected, NormalCorrected)", "schema": { "enum": [ "Normal", "Correction", "NormalCorrected" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater-than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "employeeCd", "in": "query", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeCardDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeCardDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/employee/{employeeCd}/expenseClaim": { "get": { "tags": [ "Employee" ], "summary": "Get expense claims for a specific employee", "operationId": "Employee_GetEmployeeExpenseClaimsByemployeeCd", "parameters": [ { "name": "employeeCd", "in": "path", "description": "Identifies the employee", "required": true, "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document.", "schema": { "enum": [ "Hold", "PendingApproval", "Approved", "Rejected", "Released" ], "type": "string" } }, { "name": "date", "in": "query", "description": "The date of the document", "schema": { "type": "string", "format": "date-time" } }, { "name": "customer", "in": "query", "description": "The customer from the document", "schema": { "type": "string" } }, { "name": "departmentId", "in": "query", "description": "Identifies the department", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater-than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseClaimDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseClaimDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/employee/{employeeCd}/expenseReceipt": { "get": { "tags": [ "Employee" ], "summary": "Get expense receipts for a specific employee", "operationId": "Employee_GetEmployeeExpenseReceiptsByemployeeCd", "parameters": [ { "name": "employeeCd", "in": "path", "description": "Identifies the employee", "required": true, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "The date of the document", "schema": { "type": "string" } }, { "name": "dateCondition", "in": "query", "schema": { "type": "string" } }, { "name": "inventory", "in": "query", "description": "Identifies the inventory item from the document", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "Identifies the project from the document", "schema": { "type": "string" } }, { "name": "claimedBy", "in": "query", "description": "Identifies the employee from the document", "schema": { "type": "string" } }, { "name": "projectTask", "in": "query", "description": "Filter on Task ID.", "schema": { "type": "string" } }, { "name": "invoiceable", "in": "query", "description": "If the document is invoiceable", "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "The status of the document.", "schema": { "enum": [ "Open", "Pending", "Approved", "Rejected", "Released" ], "type": "string" } }, { "name": "customer", "in": "query", "description": "Identifies the customer from the document", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseReceiptDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseReceiptDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/employee/action/changeEmployeeCd/{internalId}": { "post": { "tags": [ "Employee" ], "summary": "Updates the EmployeeNr for the specified employee", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "Employee_ChangeEmployeeNrActionByinternalId", "parameters": [ { "name": "internalId", "in": "path", "description": "Internal identifier of the employee for which the employee Nr will be changed", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the new employee Nr for the employee", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeEmployeeNrActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEmployeeNrActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ChangeEmployeeNrActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ChangeEmployeeNrActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ChangeEmployeeNrActionDto" } } }, "required": true, "x-bodyName": "changeEmployeeNrActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeEmployeeNrActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeEmployeeNrActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ChangeEmployeeNrActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ChangeEmployeeNrActionResultDto" } } } }, "412": { "description": "Employee version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/expenseClaim/{expenseClaimNbr}": { "get": { "tags": [ "ExpenseClaim" ], "summary": "Get a specific Expense Claim", "description": "Data for a single expense claim

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "ExpenseClaim_GetExpenseClaimByexpenseClaimNbr", "parameters": [ { "name": "expenseClaimNbr", "in": "path", "description": "Identifies the expense claim", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseClaimDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExpenseClaimDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "ExpenseClaim" ], "summary": "Update a specific ExpenseClaim", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "ExpenseClaim_PutByexpenseClaimNbr", "parameters": [ { "name": "expenseClaimNbr", "in": "path", "description": "Identifies the ExpenseClaim to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the ExpenseClaim to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseClaimUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExpenseClaimUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ExpenseClaimUpdateDto" } } }, "required": true, "x-bodyName": "expenseClaim" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Expense Claim version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "ExpenseClaim" ], "summary": "Deletes a specific ExpenseClaim", "description": "Response Message has StatusCode NoContent if DELETE operation succeed", "operationId": "ExpenseClaim_DeleteByexpenseClaimNbr", "parameters": [ { "name": "expenseClaimNbr", "in": "path", "description": "Identifies the ExpenseClaim to delete", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/expenseClaim": { "get": { "tags": [ "ExpenseClaim" ], "summary": "Get a range of Expense Claims, a filter needs to be specified. ScreenId=EP301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2021-October:Added forced pagination\r\n2022-December: Added the actual code to force pagination!", "operationId": "ExpenseClaim_GetAll", "parameters": [ { "name": "status", "in": "query", "description": "The status of the document.", "schema": { "enum": [ "Hold", "PendingApproval", "Approved", "Rejected", "Released" ], "type": "string" } }, { "name": "date", "in": "query", "description": "The date of the document", "schema": { "type": "string", "format": "date-time" } }, { "name": "customer", "in": "query", "description": "The customer from the document", "schema": { "type": "string" } }, { "name": "departmentId", "in": "query", "description": "Identifies the department", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater-than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseClaimDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseClaimDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "ExpenseClaim" ], "summary": "Create an ExpenseClaim", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "ExpenseClaim_CreateExpenseClaim", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the ExpenseClaim to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseClaimUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExpenseClaimUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ExpenseClaimUpdateDto" } } }, "required": true, "x-bodyName": "expenseClaim" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/expenseClaim/{expenseClaim}/action/hold": { "post": { "tags": [ "ExpenseClaim" ], "summary": "Put ExpenseClaim on hold", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can also be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "ExpenseClaim_PutExpenseClaimOnHoldByexpenseClaim", "parameters": [ { "name": "expenseClaim", "in": "path", "description": "Reference number of the ExpenseClaim to be put on hold", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutExpenseClaimOnHoldActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PutExpenseClaimOnHoldActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PutExpenseClaimOnHoldActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PutExpenseClaimOnHoldActionResultDto" } } } }, "412": { "description": "Expense Claim version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/expenseClaim/{expenseClaim}/action/submit": { "post": { "tags": [ "ExpenseClaim" ], "summary": "Submit Expense Claim operation", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can also be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "ExpenseClaim_SubmitExpenseClaimByexpenseClaim", "parameters": [ { "name": "expenseClaim", "in": "path", "description": "Reference number of the Expense Claim to be submitted", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitExpenseClaimActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubmitExpenseClaimActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SubmitExpenseClaimActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SubmitExpenseClaimActionResultDto" } } } }, "412": { "description": "Expense Claim version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/expenseClaim/{expenseClaim}/action/approval": { "post": { "tags": [ "ExpenseClaim" ], "summary": "Send Expense Claim to approval", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can also be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "ExpenseClaim_SendExpenseClaimToApprovalByexpenseClaim", "parameters": [ { "name": "expenseClaim", "in": "path", "description": "Reference number of the Expense Claim to be sent to approval", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendExpenseClaimToApprovalActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendExpenseClaimToApprovalActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SendExpenseClaimToApprovalActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SendExpenseClaimToApprovalActionResultDto" } } } }, "412": { "description": "Expense Claim version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/expenseReceipt/{receiptNumber}": { "get": { "tags": [ "ExpenseReceipt" ], "summary": "Get a specific ExpenseReceipt", "description": "Data for a single expense receipt

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "ExpenseReceipt_GetByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the ExpenseReceipt", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "ExpenseReceipt" ], "summary": "Update a Expense Receipt", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "ExpenseReceipt_PutByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the ExpenseReceipt", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Expense Receipt to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } } }, "required": true, "x-bodyName": "expenseReceiptUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Expense Receipt version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "ExpenseReceipt" ], "summary": "Deletes a specific Expense Receipt", "description": "Response Message has StatusCode NoContent if DELETE operation succeed", "operationId": "ExpenseReceipt_DeleteByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the Expense Receipt to delete", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/expenseReceipt": { "get": { "tags": [ "ExpenseReceipt" ], "summary": "Get a range of Expense Receipts, a filter needs to be specified. ScreenId=EP301020", "operationId": "ExpenseReceipt_GetAll", "parameters": [ { "name": "date", "in": "query", "description": "The date of the document", "schema": { "type": "string" } }, { "name": "dateCondition", "in": "query", "schema": { "type": "string" } }, { "name": "inventory", "in": "query", "description": "Identifies the inventory item from the document", "schema": { "type": "string" } }, { "name": "project", "in": "query", "description": "Identifies the project from the document", "schema": { "type": "string" } }, { "name": "claimedBy", "in": "query", "description": "Identifies the employee from the document", "schema": { "type": "string" } }, { "name": "projectTask", "in": "query", "description": "Filter on Task ID.", "schema": { "type": "string" } }, { "name": "invoiceable", "in": "query", "description": "If the document is invoiceable", "schema": { "type": "boolean" } }, { "name": "status", "in": "query", "description": "The status of the document.", "schema": { "enum": [ "Open", "Pending", "Approved", "Rejected", "Released" ], "type": "string" } }, { "name": "customer", "in": "query", "description": "Identifies the customer from the document", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseReceiptDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseReceiptDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "ExpenseReceipt" ], "summary": "Create a Expense Receipt", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "ExpenseReceipt_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Expense Receipt to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ExpenseReceiptUpdateDto" } } }, "required": true, "x-bodyName": "expenseReceiptUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/expenseReceipt/{receiptNumber}/attachment": { "post": { "tags": [ "ExpenseReceipt" ], "summary": "Creates an attachment and associates it with an expense receipt. If the file already exists, a new revision is created.", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "ExpenseReceipt_CreateAttachmentByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the credit note", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } }, "412": { "description": "Expense Receipt version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/financialPeriod": { "get": { "tags": [ "FinancialPeriod" ], "summary": "Get a range of Financial Periods - ScreenId=GL201000", "operationId": "FinancialPeriod_GetAll", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "Enter the year or year-period lower than the first period or year you want, format YYYY or YYYYPP", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriodDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriodDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriodDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriodDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/financialPeriod/{financialPeriodId}": { "get": { "tags": [ "FinancialPeriod" ], "summary": "Get a specific Financial Period - ScreenId=GL201000", "operationId": "FinancialPeriod_GetByfinancialPeriodId", "parameters": [ { "name": "financialPeriodId", "in": "path", "description": "Returns the financial period for the specified FinancialPeriodId, format YYYYPP", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FinancialPeriodDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FinancialPeriodDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/FinancialPeriodDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/FinancialPeriodDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/firstTimeStartup/status": { "get": { "tags": [ "FirstTimeStartup" ], "summary": "Get the status for FTS", "operationId": "FirstTimeStartup_Get", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FirstTimeStartupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FirstTimeStartupDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/fixedAsset/{FixedAssetID}": { "get": { "tags": [ "FixedAsset" ], "summary": "Get a specific Fixed Asset - Screen ID:FA303000", "operationId": "FixedAsset_GetByFixedAssetID", "parameters": [ { "name": "FixedAssetID", "in": "path", "description": "Identifies the fixed asset", "required": true, "schema": { "type": "string" } }, { "name": "ExpandAccounts", "in": "query", "description": "Set to True to include accounts and subaccounts. Default value is False", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixedAssetDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FixedAssetDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/fixedAsset": { "get": { "tags": [ "FixedAsset" ], "summary": "Get a range of Fixed Assets - Screen ID:FA303000", "operationId": "FixedAsset_GetAll", "parameters": [ { "name": "assetID", "in": "query", "description": "Fixed Asset ID that identifies the asset.", "schema": { "type": "string" } }, { "name": "classID", "in": "query", "description": "View all fixed assets with this Fixed Asset Class ID.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "View all fixed assets with this Status. Available statuses are: Active, Disposed, FullyDepriciated, Hold, Reversed, Suspended.", "schema": { "enum": [ "Active", "Disposed", "FullyDepreciated", "Hold", "Reversed", "Suspended" ], "type": "string" } }, { "name": "fromDate", "in": "query", "description": "From 'Placed in service date' inclusive. Date format: YYYY-MM-DD.", "schema": { "type": "string", "format": "date-time" } }, { "name": "toDate", "in": "query", "description": "To 'Placed in service date' inclusive. Date format: YYYY-MM-DD.", "schema": { "type": "string", "format": "date-time" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "expandAccounts", "in": "query", "description": "Set to True to include accounts and subaccounts. Default value is False", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/fixedAssetClass/{ClassID}": { "get": { "tags": [ "FixedAssetClass" ], "summary": "Get a specific Fixed Asset Class - Screen ID:FA201000", "operationId": "FixedAssetClass_GetByClassID", "parameters": [ { "name": "ClassID", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixedAssetClassDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FixedAssetClassDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/fixedAssetClass": { "get": { "tags": [ "FixedAssetClass" ], "summary": "Get a range of Fixed Asset Classes - Screen ID:FA201000", "operationId": "FixedAssetClass_GetAll", "parameters": [ { "name": "classID", "in": "query", "description": "Fixed Asset Class ID that identifies the fixed asset class.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetClassDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetClassDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/fixedAssetPropertyTaxGroup/{PropertyTaxID}": { "get": { "tags": [ "FixedAssetPropertyTaxGroup" ], "summary": "Get a specific Fixed Asset Property Tax Group - Screen ID: FA209000", "operationId": "FixedAssetPropertyTaxGroup_GetByPropertyTaxID", "parameters": [ { "name": "PropertyTaxID", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FixedAssetPropertyTaxDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FixedAssetPropertyTaxDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/fixedAssetPropertyTaxGroup": { "get": { "tags": [ "FixedAssetPropertyTaxGroup" ], "summary": "Get a range of Fixed Asset Property Tax Groups - Screen ID: FA209000", "operationId": "FixedAssetPropertyTaxGroup_GetAll", "parameters": [ { "name": "propertyTaxID", "in": "query", "description": "Property Tax ID that identifies the property tax group.", "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Set to True to select active fixed asset property tax groups.", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetPropertyTaxDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetPropertyTaxDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/fixedAssetTransaction/{RefNo}": { "get": { "tags": [ "FixedAssetTransaction" ], "summary": "Get transactions for a specific Asset - Screen ID:FA301000", "operationId": "FixedAssetTransaction_GetByRefNo", "parameters": [ { "name": "RefNo", "in": "path", "description": "Identifies the fixed asset by reference number", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetTransactionDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetTransactionDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/fixedAssetTransaction": { "get": { "tags": [ "FixedAssetTransaction" ], "summary": "Get a range of transactions - Screen ID:FA301000", "operationId": "FixedAssetTransaction_GetAll", "parameters": [ { "name": "refNo", "in": "query", "description": "View all transactions connected to this Reference number.", "schema": { "type": "string" } }, { "name": "assetID", "in": "query", "description": "View all transactions connected to this Asset ID.", "schema": { "type": "string" } }, { "name": "bookID", "in": "query", "description": "View all transactions in this Book ID.", "schema": { "type": "string" } }, { "name": "fromPeriod", "in": "query", "description": "View all transactions from and including this Period. Format: YYYYMM.", "schema": { "type": "string" } }, { "name": "toPeriod", "in": "query", "description": "View all transactions to and including this Period. Format: YYYYMM.", "schema": { "type": "string" } }, { "name": "accountID", "in": "query", "description": "View all transactions for this Account ID.", "schema": { "type": "string" } }, { "name": "subAccountID", "in": "query", "description": "View all transactions for this Sub Account ID.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "View all transactions with this Status. Available statuses: Balanced, OnHold, Posted and UnPosted.", "schema": { "enum": [ "Balanced", "OnHold", "Posted", "Unposted" ], "type": "string" } }, { "name": "transactionType", "in": "query", "description": "View all transactions with this Transaction Type. Available types: PurchasingPlus, PurchasingMinus, DepreciationPlus, DepreciationMinus, CalculatedPlus, CalculatedMinu,SalePlus, SaleMinus,TransferPurchasing, TransferDepreciation, ReconciliationPlus, ReconciliationMinus, PurchasingDisposal, PurchasingReversal, AdjustingDeprPlus and AdjustingDeprMinus.", "schema": { "enum": [ "PurchasingPlus", "PurchasingMinus", "DepreciationPlus", "DepreciationMinus", "CalculatedPlus", "CalculatedMinus", "SalePlus", "SaleMinus", "TransferPurchasing", "TransferDepreciation", "ReconciliationPlus", "ReconciliationMinus", "PurchasingDisposal", "PurchasingReversal", "AdjustingDeprPlus", "AdjustingDeprMinus" ], "type": "string" } }, { "name": "transactionFromDate", "in": "query", "description": "View all transactions from and including this Transaction Date. Date format: YYYY-MM-DD.", "schema": { "type": "string" } }, { "name": "transactionToDate", "in": "query", "description": "View all transactions to and including this Transaction Date inclusive. Date format: YYYY-MM-DD .", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetTransactionDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetTransactionDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/generalLedgerBalance": { "get": { "tags": [ "GeneralLedgerBalanceV2" ], "summary": "Get a range of General Ledger Balances. Complete documentation can be found under 8.21 release notes. \r\nPlease use a page size lower or equal to the allowed max page size which is returned under metadata. \r\nIf pagesize is greater than the max page size, it will be limited to max page size.", "operationId": "GeneralLedgerBalanceV2_GetGeneralLedgerBalances", "parameters": [ { "name": "periodId", "in": "query", "description": "Period to retrieve balance for. Mandatory if 'LastModifiedDateTime' not provided. Format: 'yyyyMM'", "schema": { "type": "string" } }, { "name": "account", "in": "query", "description": "Account to retrieve balance for", "schema": { "type": "string" } }, { "name": "subaccount", "in": "query", "description": "Subaccount to retrieve balance for", "schema": { "type": "string" } }, { "name": "ledger", "in": "query", "description": "Ledger to retrieve balance for", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Branch to retrieve balance for", "schema": { "type": "string" } }, { "name": "balanceType", "in": "query", "description": "Balance Type of the ledger to be exported", "schema": { "enum": [ "Actual", "Report", "Statistical", "Budget" ], "type": "string" } }, { "name": "toggleBalanceSigns", "in": "query", "description": "Parameter can be used in order to change the balance sign for liability and income accounts", "schema": { "type": "boolean" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\nMandatory if 'PeriodId' is not provided.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```", "schema": { "type": "string", "format": "date-time" } }, { "name": "excludeYTDAccount", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralLedgerBalanceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralLedgerBalanceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/GeneralLedgerTransactions": { "get": { "tags": [ "GeneralLedgerTransactions" ], "summary": "Get a range of General Ledger Transactions - ScreenId=GL404000\r\nPlease use a page size lower or equal to the allowed max page size which is returned under metadata. \r\nIf pagesize is greater than the max page size, it will be limited to max page size.", "operationId": "GeneralLedgerTransactions_GetAll", "parameters": [ { "name": "branch", "in": "query", "description": "The branch CD", "schema": { "type": "string" } }, { "name": "ledger", "in": "query", "description": "Mandatory. The ledger in which you want to view the account balances.", "required": true, "schema": { "type": "string" } }, { "name": "fromPeriod", "in": "query", "description": "The financial period that begins the date range of the batches you want to view. Format YYYYPP", "schema": { "type": "string" } }, { "name": "toPeriod", "in": "query", "description": "The financial period that ends the date range of the batches you want to view. Format YYYYPP", "schema": { "type": "string" } }, { "name": "account", "in": "query", "description": "The account CD for which you want to view activities in the selected financial period.", "schema": { "type": "string" } }, { "name": "subaccountId", "in": "query", "description": "The Subaccount", "schema": { "type": "string" } }, { "name": "fromDate", "in": "query", "description": "The first date of the interval within the period. Format YYYY-MM-DD", "schema": { "type": "string" } }, { "name": "toDate", "in": "query", "description": "The last date of the interval within the selected period. Format YYYY-MM-DD", "schema": { "type": "string" } }, { "name": "includeUnposted", "in": "query", "description": "Checkmark indicating if unposted batches are included.", "schema": { "type": "boolean" } }, { "name": "includeUnreleased", "in": "query", "description": "Checkmark indicating if unreleased (balanced) batches are included.", "schema": { "type": "boolean" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "expandAccountInfo", "in": "query", "description": "By default, if no value is provided, False and the account information will include only Number, Description, Type and GlConsolAccountCD.\r\nIf True, each transaction returned will include extended information about account.", "schema": { "type": "boolean" } }, { "name": "expandBranchInfo", "in": "query", "description": "By default, if no value is provided, False and branch information will include only branch number.\r\nIf True, each transaction returned will include extended information about Branch (number and name).", "schema": { "type": "boolean" } }, { "name": "includeTransactionBalance", "in": "query", "description": "By default, if no value is provided, False and the transactions returned will not include their balances (fields BegBalance, EndingBalance, CurrBegBalance, CurrEndingBalance)\r\nIf True, each transaction returned will include its balance.", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralLedgerTransactionDetailsDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/GeneralLedgerTransactionDetailsDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/itemClass": { "get": { "tags": [ "Inventory" ], "summary": "Get Inventory Item Classes", "operationId": "Inventory_GetItemClasses", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemClassDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ItemClassDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/itemclass/{itemClassNumber}": { "get": { "tags": [ "Inventory" ], "summary": "Get Specific Inventory Item Class", "operationId": "Inventory_GetSpecificItemClassByitemClassNumber", "parameters": [ { "name": "itemClassNumber", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ItemClassDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ItemClassDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/itemPostClass": { "get": { "tags": [ "Inventory" ], "summary": "Get Inventory Item Post Classes", "operationId": "Inventory_GetItemPostClasses", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PostingClassDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PostingClassDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/internal/{inventoryId}": { "get": { "tags": [ "Inventory" ], "summary": "Get a specific Inventory item by its internal ID", "operationId": "Inventory_GetByinventoryId", "parameters": [ { "name": "inventoryId", "in": "path", "description": "Identifies the Inventory item", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/{inventoryNumber}": { "get": { "tags": [ "Inventory" ], "summary": "Get a specific Inventory item", "operationId": "Inventory_GetByinventoryNumber", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "Identifies the Inventory item", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Inventory" ], "summary": "Update a specific inventory item", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "Inventory_PutByinventoryNumber", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "Identifies the inventory item to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for inventory item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } } }, "required": true, "x-bodyName": "inventory" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory": { "get": { "tags": [ "Inventory" ], "summary": "Get a range of Inventory items - ScreenId=IN202000 and IN202500", "description": "Data for Inventory", "operationId": "Inventory_GetAll", "parameters": [ { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.\r\nMaxPageSize will be set to 5000 from 1. April 2022", "schema": { "type": "integer", "format": "int32" } }, { "name": "alternateID", "in": "query", "description": "Applies for both Stock and Non-stock items. Some fields in this filter applies only for one of these.", "schema": { "type": "string" } }, { "name": "inventoryNumber", "in": "query", "description": "The Item ID.", "schema": { "type": "string" } }, { "name": "salesCategory", "in": "query", "description": "The Category ID for the sales category, found on the Attributes tab.", "schema": { "type": "integer", "format": "int32" } }, { "name": "addCostPriceStatistics", "in": "query", "description": "This filter can be used only for stock items, from the Price/cost information tab.", "schema": { "type": "boolean" } }, { "name": "attributes", "in": "query", "description": " Attributes (additional information) connected to the entity.\r\n Examples:\r\n{{base}}/inventory?attributes={\"AttributeID\":\"ValueID\",\"AttributeID\":\"ValueID\"}\r\n{{base}}/inventory?attributes={\"AttributeID\":\"ValueID1,ValueID2\"}", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "A brief description of the stock item from the Top part of the window.", "schema": { "type": "string" } }, { "name": "availabilityLastModifiedDateTime", "in": "query", "description": "System retrieved information.", "schema": { "type": "string" } }, { "name": "availabilityLastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition.", "schema": { "type": "string" } }, { "name": "inventoryTypes", "in": "query", "description": "Filter on one or more inventory types: NonStockItem, LaborItem, ServiceItem, ChargeItem, ExpenseItem, FinishedGoodItem, ComponentPartItem or SubassemblyItem", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "expandCrossReference", "in": "query", "description": "These expand fields are by default set to true, but will be changed in the future. \r\nSet to true to retrieve information about the cross-references (item ID and suppliers/customers ID for the item connected to the item.", "schema": { "type": "boolean" } }, { "name": "expandAttachment", "in": "query", "description": "Set to true to retrieve information about the attachments connected to the item.", "schema": { "type": "boolean" } }, { "name": "expandAttribute", "in": "query", "description": "Set to true to retrieve the attribute descriptions used for the item.", "schema": { "type": "boolean" } }, { "name": "expandWarehouseDetail", "in": "query", "description": "Set to true to retrieve information about the warehouse connected to the item.", "schema": { "type": "boolean" } }, { "name": "expandAccountInformation", "in": "query", "description": "Set to true to retrieve information about the account information connected to the item.", "schema": { "type": "boolean" } }, { "name": "expandInventoryUnits", "in": "query", "description": "Set to true to retrieve information about the units of measure connected to the item.", "schema": { "type": "boolean" } }, { "name": "expandSupplierDetails", "in": "query", "description": "Set to true to retrieve details about the supplier connected to the item.", "schema": { "type": "boolean" } }, { "name": "expandSalesCategories", "in": "query", "description": "Set to true to retrieve details about the sales categories connected to the item.", "schema": { "type": "boolean" } }, { "name": "expandNote", "in": "query", "description": "Set to true to retrieve the note value connected to the item.", "schema": { "type": "boolean" } }, { "name": "attachmentLastModifiedDateTime", "in": "query", "description": "System retrieved information for last modified date and time for attachment.", "schema": { "type": "string" } }, { "name": "attachmentLastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition for attachment.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The inventory item status", "schema": { "enum": [ "Active", "NoSales", "NoPurchases", "NoRequest", "Inactive", "MarkedForDeletion" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryDto" } } } } }, "404": { "description": "NotFound", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Inventory" ], "summary": "Create an inventory item", "description": "Response Message has StatusCode Created if POST operation succed", "operationId": "Inventory_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the inventory item to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } } }, "required": true, "x-bodyName": "inventory" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/barcode/shipment/{shipmentNbr}": { "get": { "tags": [ "Inventory" ], "summary": "Get a range of barcodes for a specific shipment", "operationId": "Inventory_GetInventoryShipmentBarCodesByshipmentNbr", "parameters": [ { "name": "shipmentNbr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/barcode/salesorder/{orderNbr}": { "get": { "tags": [ "Inventory" ], "summary": "Get a range of barcodes for a specific sales order", "operationId": "Inventory_GetInventorySalesOrderBarCodesByorderNbr", "parameters": [ { "name": "orderNbr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/barcode/stocktake/{referenceNumber}": { "get": { "tags": [ "Inventory" ], "summary": "Get a range of barcodes for a specific stock count", "operationId": "Inventory_GetInventoryStockTakeBarCodesByreferenceNumber", "parameters": [ { "name": "referenceNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/barcode/purchasereceipt/{receiptNbr}": { "get": { "tags": [ "Inventory" ], "summary": "Get a range of barcodes for a specific purchase receipt", "operationId": "Inventory_GetInventoryPOReceiptTakeBarCodesByreceiptNbr", "parameters": [ { "name": "receiptNbr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BarCodeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/{inventoryNumber}/crossReferences": { "get": { "tags": [ "Inventory" ], "summary": "Get a range of cross-reference for a specific inventory", "operationId": "Inventory_GetInventoryCrossReferencesByinventoryNumber", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryCrossReferenceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryCrossReferenceDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryCrossReferenceDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryCrossReferenceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Inventory" ], "summary": "Creates a cross reference for a specific inventory", "operationId": "Inventory_CreateInventoryCrossReferencesByinventoryNumber", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } } }, "required": true, "x-bodyName": "crossReferenceUpdateDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/{inventoryCd}/action/updateCost": { "post": { "tags": [ "Inventory" ], "summary": "Update Cost action on Non-Stock Item", "description": "The action result dto contains information about the result of running the action", "operationId": "Inventory_UpdateCostNonStockItemByinventoryCd", "parameters": [ { "name": "inventoryCd", "in": "path", "description": "Identifies the inventory item to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCostActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateCostActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/UpdateCostActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateCostActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/{inventoryNumber}/attachment": { "post": { "tags": [ "Inventory" ], "summary": "Creates an attachment and associates it with a Inventory Item. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "Inventory_CreateInventoryAttachmentByinventoryNumber", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "Identifies the Inventory Item", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/action/changeInventoryNbr/{internalId}": { "post": { "tags": [ "Inventory" ], "summary": "Updates the InventoryNbr for the specified Inventory", "description": "The action result dto contains information about the result of running the action", "operationId": "Inventory_ChangeInventoryNbrActionByinternalId", "parameters": [ { "name": "internalId", "in": "path", "description": "Internal identifier of the Inventory for which the Inventory Nbr will be changed", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the new Inventory number for the Inventory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeInventoryNbrActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeInventoryNbrActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ChangeInventoryNbrActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ChangeInventoryNbrActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ChangeInventoryNbrActionDto" } } }, "required": true, "x-bodyName": "changeInventoryNbrActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeInventoryNbrActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeInventoryNbrActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ChangeInventoryNbrActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ChangeInventoryNbrActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/internal/{inventoryID}": { "put": { "tags": [ "Inventory" ], "summary": "Update a specific inventory item", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "Inventory_PutByinventoryID", "parameters": [ { "name": "inventoryID", "in": "path", "description": "Identifies the inventory item to update", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for inventory item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryUpdateDto" } } }, "required": true, "x-bodyName": "inventory" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventory/{inventoryNumber}/crossReferences/{alternateType}/{alternateId}": { "put": { "tags": [ "Inventory" ], "summary": "Updates a specific cross reference for a specific inventory", "operationId": "Inventory_UpdateInventoryCrossReferencesByinventoryNumberalternateTypealternateId", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "alternateType", "in": "path", "description": "", "required": true, "schema": { "enum": [ "CPN", "VPN", "Global", "Barcode" ], "type": "string" } }, { "name": "alternateId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryCrossReferenceUpdateDto" } } }, "required": true, "x-bodyName": "crossReferenceUpdateDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryadjustment/{inventoryAdjustmentNumber}": { "get": { "tags": [ "InventoryAdjustment" ], "summary": "Get a specific Inventory Adjustment document", "operationId": "InventoryAdjustment_GetByinventoryAdjustmentNumber", "parameters": [ { "name": "inventoryAdjustmentNumber", "in": "path", "description": "Identifies the Inventory Adjustment document", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "InventoryAdjustment" ], "summary": "Update a specific inventory item", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "InventoryAdjustment_PutByinventoryAdjustmentNumber", "parameters": [ { "name": "inventoryAdjustmentNumber", "in": "path", "description": "Identifies the inventory item to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for inventory item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } } }, "required": true, "x-bodyName": "adjustment" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryadjustment": { "get": { "tags": [ "InventoryAdjustment" ], "summary": "Get a range of Inventory Adjustment Dto - ScreenId=IN303000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "InventoryAdjustment_GetAll", "parameters": [ { "name": "status", "in": "query", "schema": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string" } }, { "name": "date", "in": "query", "description": "The date when the inventory document was created\r\n \r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dateCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records usind the __Date__ filter.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryAdjustmentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryAdjustmentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "InventoryAdjustment" ], "summary": "Create an inventory item", "description": "Response Message has StatusCode Created if POST operation succed", "operationId": "InventoryAdjustment_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the inventory adjustment to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryAdjustmentUpdateDto" } } }, "required": true, "x-bodyName": "inventoryAdjustment" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryadjustment/{adjRefNumber}/action/release": { "post": { "tags": [ "InventoryAdjustment" ], "summary": "Release inventory document action", "description": "The action result dto contains information about the result of running the action", "operationId": "InventoryAdjustment_ReleaseDocumentByadjRefNumber", "parameters": [ { "name": "adjRefNumber", "in": "path", "description": "Reference number of the released adjustment to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryissue/{inventoryIssueNumber}": { "get": { "tags": [ "InventoryIssue" ], "summary": "Get a specific Inventory Issue document", "operationId": "InventoryIssue_GetByinventoryIssueNumber", "parameters": [ { "name": "inventoryIssueNumber", "in": "path", "description": "Identifies the Inventory Issue document", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryIssueDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryIssueDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "InventoryIssue" ], "summary": "Update a specific inventory item", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "InventoryIssue_PutByinventoryIssueNumber", "parameters": [ { "name": "inventoryIssueNumber", "in": "path", "description": "Identifies the inventory item to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for inventory item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } } }, "required": true, "x-bodyName": "issue" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryissue": { "get": { "tags": [ "InventoryIssue" ], "summary": "Get a range of Inventory items - ScreenId=IN302000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "InventoryIssue_GetAll", "parameters": [ { "name": "status", "in": "query", "schema": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string" } }, { "name": "date", "in": "query", "description": "The date when the inventory document was created\r\n \r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dateCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records usind the __Date__ filter.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryIssueDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryIssueDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "InventoryIssue" ], "summary": "Create an inventory item", "description": "Response Message has StatusCode Created if POST operation succed", "operationId": "InventoryIssue_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the inventory issue to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryIssueUpdateDto" } } }, "required": true, "x-bodyName": "inventoryIssue" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryissue/{invoiceNumber}/action/release": { "post": { "tags": [ "InventoryIssue" ], "summary": "Release inventory operation", "description": "The action result dto contains information about the result of running the action", "operationId": "InventoryIssue_ReleaseDocumentByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Reference number of the released issue to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryReceipt/{inventoryReceiptNumber}": { "get": { "tags": [ "InventoryReceipt" ], "summary": "Get a specific Inventory Receipt document", "operationId": "InventoryReceipt_GetByinventoryReceiptNumber", "parameters": [ { "name": "inventoryReceiptNumber", "in": "path", "description": "Identifies the Inventory Issue document", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryReceiptDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryReceiptDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "InventoryReceipt" ], "summary": "Update a specific inventory item", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "InventoryReceipt_PutByinventoryReceiptNumber", "parameters": [ { "name": "inventoryReceiptNumber", "in": "path", "description": "Identifies the inventory receipt to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for inventory receipt", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } } }, "required": true, "x-bodyName": "receipt" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryReceipt": { "get": { "tags": [ "InventoryReceipt" ], "summary": "Get a range of Inventory Receipts - ScreenId=IN301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "InventoryReceipt_GetAll", "parameters": [ { "name": "status", "in": "query", "schema": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string" } }, { "name": "date", "in": "query", "description": "The date when the inventory document was created\r\n \r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dateCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records usind the __Date__ filter.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "InventoryReceipt" ], "summary": "Create an inventory item", "description": "Response Message has StatusCode Created if POST operation succed", "operationId": "InventoryReceipt_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the inventory issue to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryReceiptUpdateDto" } } }, "required": true, "x-bodyName": "inventoryReceipt" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryReceipt/{invoiceNumber}/action/release": { "post": { "tags": [ "InventoryReceipt" ], "summary": "Release inventory operation", "description": "The action result dto contains information about the result of running the action", "operationId": "InventoryReceipt_ReleaseDocumentByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Reference number of the released issue to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventorysummary/{inventoryNumber}": { "get": { "tags": [ "InventorySummary" ], "summary": "Get a range of InventorySummary - ScreenId=IN401000", "operationId": "InventorySummary_GetAllInventorySummaryByinventoryNumber", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "warehouse", "in": "query", "schema": { "type": "string" } }, { "name": "location", "in": "query", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventorySummaryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventorySummaryDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryTransfer/{inventoryTransferNumber}": { "get": { "tags": [ "InventoryTransfer" ], "summary": "Get a specific Inventory Transfer document", "operationId": "InventoryTransfer_GetByinventoryTransferNumber", "parameters": [ { "name": "inventoryTransferNumber", "in": "path", "description": "Identifies the Inventory Transfer document", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTransferDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTransferDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "InventoryTransfer" ], "summary": "Update a specific inventory transfer", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "InventoryTransfer_PutByinventoryTransferNumber", "parameters": [ { "name": "inventoryTransferNumber", "in": "path", "description": "Identifies the inventory transfer to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for inventory transfer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } } }, "required": true, "x-bodyName": "transfer" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryTransfer": { "get": { "tags": [ "InventoryTransfer" ], "summary": "Get a range of Inventory Transfers - ScreenId=IN304000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "InventoryTransfer_GetAll", "parameters": [ { "name": "warehouse", "in": "query", "description": "Inventory transfer's source warehouse", "schema": { "type": "string" } }, { "name": "toWarehouse", "in": "query", "description": "Inventory transfer's target warehouse", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string" } }, { "name": "date", "in": "query", "description": "The date when the inventory document was created\r\n \r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dateCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records usind the __Date__ filter.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTransferDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTransferDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "InventoryTransfer" ], "summary": "Create an inventory transfer", "description": "Response Message has StatusCode Created if POST operation succed", "operationId": "InventoryTransfer_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the inventory transfer to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/InventoryTransferUpdateDto" } } }, "required": true, "x-bodyName": "inventoryTransfer" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/inventoryTransfer/{transferNumber}/action/release": { "post": { "tags": [ "InventoryTransfer" ], "summary": "Release inventory operation", "description": "The action result dto contains information about the result of running the action", "operationId": "InventoryTransfer_ReleaseDocumentBytransferNumber", "parameters": [ { "name": "transferNumber", "in": "path", "description": "Reference number of the released transfer to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleaseInventoryDocumentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/journaltransaction/{journalTransactionNumber}": { "get": { "tags": [ "JournalTransactionV2" ], "summary": "Get a specific Journal Transaction", "description": "Data for Journal Transaction

\r\n The response headers include an ETag after a successful GET operation.", "operationId": "JournalTransactionV2_GetSpecificJournalTransactionsByjournalTransactionNumber", "parameters": [ { "name": "journalTransactionNumber", "in": "path", "description": "Identifies the Journal Transaction", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "JournalTransactionV2" ], "summary": "Update a Journal Transaction", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\n The response headers include an ETag after a successful PUT operation.

\r\n Response Message has StatusCode BadRequest if PUT operation failed", "operationId": "JournalTransactionV2_PutByjournalTransactionNumber", "parameters": [ { "name": "journalTransactionNumber", "in": "path", "description": "Identifies the Journal Transaction to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Journal Transaction to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } } }, "required": true, "x-bodyName": "journalTransaction" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "JournalTransaction version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/journaltransaction": { "get": { "tags": [ "JournalTransactionV2" ], "summary": "Get a range of Journal Transactions - ScreenId=GL301000. \r\nOn this particular endpoint, pagesize and totalcount denotes number of journaltransaction lines. \r\nWhen using pagination, the transactions for one specific batch can be split into several responses. \r\nPlease use a page size lower or equal to the allowed max page size which is returned under metadata. \r\nIf pagesize is greater than the max page size, it will be limited to max page size.", "description": "Data for Journal Transaction", "operationId": "JournalTransactionV2_GetAllJournalTransactions", "parameters": [ { "name": "periodId", "in": "query", "description": "Financial Period to query data for. Mandatory if 'LastModifiedDateTime' not provided. Format: YYYYPP", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\nMandatory if 'PeriodId' is not provided. \r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```", "schema": { "type": "string" } }, { "name": "module", "in": "query", "description": "Module to query data for. Allowed values: GL, AP, AR, CM, CA, IN, DR, FA, PM", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Journal transaction status to query data for. Available statuses : Hold, Balanced, Unposted, Posted, Voided, Scheduled, Unreleased.", "schema": { "enum": [ "Hold", "Balanced", "Unposted", "Posted", "Voided", "Scheduled", "Unreleased" ], "type": "string" } }, { "name": "expandAttachments", "in": "query", "description": "If true, includes all attachments for batch. Default is false.", "schema": { "type": "boolean" } }, { "name": "branch", "in": "query", "description": "Branch to query data for.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransactionDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransactionDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "JournalTransactionV2" ], "summary": "Create a Journal Transaction", "description": "Response Message has StatusCode Created if POST operation succeed

\r\n The response headers include an ETag after a successful POST operation.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed", "operationId": "JournalTransactionV2_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Journal Transaction to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/JournalTransactionUpdateDto" } } }, "required": true, "x-bodyName": "journalTransaction" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/journaltransaction/{journalTransactionNumber}/action/release": { "post": { "tags": [ "JournalTransactionV2" ], "summary": "Release journal transaction operation", "description": "The action result dto contains information about the result of running the action

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed", "operationId": "JournalTransactionV2_ReleaseJournalTransactionByjournalTransactionNumber", "parameters": [ { "name": "journalTransactionNumber", "in": "path", "description": "Reference number of the journal transaction to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "JournalTransaction version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/journaltransaction/module/{module}/{journalTransactionNumber}/attachment": { "post": { "tags": [ "JournalTransactionV2" ], "summary": "Creates an attachment and associates it with an journalTransaction. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\n Response Message has StatusCode BadRequest if POST operation failed", "operationId": "JournalTransactionV2_AddHeaderAttachmentBymodulejournalTransactionNumber", "parameters": [ { "name": "module", "in": "path", "description": "Identifies journal transaction module allowed values are: GL, AP, AR, CM, CA, IN, DR, FA, PM, TX, SO, PO.", "required": true, "schema": { "type": "string" } }, { "name": "journalTransactionNumber", "in": "path", "description": "Identifies the journal transaction number", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/journaltransaction/module/{module}/{journalTransactionNumber}/{lineNumber}/attachment": { "post": { "tags": [ "JournalTransactionV2" ], "summary": "Creates an attachment and associates it with a certain journalTransaction line. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed

\r\n Response Message has StatusCode BadRequest or NotFound if POST operation failed", "operationId": "JournalTransactionV2_AddLineAttachmentBymodulejournalTransactionNumberlineNumber", "parameters": [ { "name": "module", "in": "path", "description": "Identifies journal transaction module allowed values are: GL, AP, AR, CM, CA, IN, DR, FA, PM, TX, SO, PO.", "required": true, "schema": { "type": "string" } }, { "name": "journalTransactionNumber", "in": "path", "description": "Identifies the journalTransaction", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Identifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/kitassembly": { "get": { "tags": [ "KitAssembly" ], "summary": "Get a range of Kit Assemblies - ScreenId = IN307000", "operationId": "KitAssembly_GetKitAssemblies", "parameters": [ { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "refNo", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by Kit Assembly Status. Possible values: H (Hold), B (Balanced), R (Released)", "schema": { "enum": [ "H", "B", "R" ], "type": "string" } }, { "name": "expandStockComponents", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandNonStockComponents", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandKitAllocations", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfKitAssemblyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfKitAssemblyDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "KitAssembly" ], "summary": "Creates a Kit Assembly", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "KitAssembly_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Kit Assembly to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KitAssemblyInsertDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KitAssemblyInsertDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/KitAssemblyInsertDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/KitAssemblyInsertDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KitAssemblyInsertDto" } } }, "required": true, "x-bodyName": "kitAssemblyInsertDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/kitassembly/{type}/{refNo}": { "get": { "tags": [ "KitAssembly" ], "summary": "Get a Kit Assembly - ScreenId = IN307000", "operationId": "KitAssembly_GetKitAssemblyBytyperefNo", "parameters": [ { "name": "type", "in": "path", "description": "Kit Assembly Type", "required": true, "schema": { "type": "string" } }, { "name": "refNo", "in": "path", "description": "Kit Assembly Ref No", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KitAssemblyDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KitAssemblyDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "KitAssembly" ], "summary": "Updates a specific Kit Assembly document", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "KitAssembly_PutBytyperefNo", "parameters": [ { "name": "type", "in": "path", "description": "Kit Assembly Type", "required": true, "schema": { "type": "string" } }, { "name": "refNo", "in": "path", "description": "Kit Assembly Ref No", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for the Kit Assembly", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KitAssemblyUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KitAssemblyUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/KitAssemblyUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/KitAssemblyUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KitAssemblyUpdateDto" } } }, "required": true, "x-bodyName": "KitAssemblyUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "KitAssembly" ], "summary": "Delete a specific Kit Assembly Document", "description": "Response Message has StatusCode NoContent if DELETE operation succeed", "operationId": "KitAssembly_DeleteBytyperefNo", "parameters": [ { "name": "type", "in": "path", "description": "Kit Assembly Type", "required": true, "schema": { "type": "string" } }, { "name": "refNo", "in": "path", "description": "Kit Assembly Ref No", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/kitassembly/{type}/{refNo}/action/release": { "post": { "tags": [ "KitAssembly" ], "summary": "Release Kit Assembly", "description": "The action result dto contains information about the result of running the action", "operationId": "KitAssembly_ReleaseKitAssemblyBytyperefNo", "parameters": [ { "name": "type", "in": "path", "description": "Kit Assembly Type", "required": true, "schema": { "type": "string" } }, { "name": "refNo", "in": "path", "description": "Kit Assembly Ref No", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/KitSpecifications": { "get": { "tags": [ "KitSpecifications" ], "summary": "Get a range of Kit Specifications - ScreenId = IN209500", "operationId": "KitSpecifications_GetAll", "parameters": [ { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "kitInventoryID", "in": "query", "schema": { "type": "string" } }, { "name": "revisionID", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfKitSpecificationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfKitSpecificationDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "KitSpecifications" ], "summary": "Creates a KitSpecification", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "KitSpecifications_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the KitSpecification to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } } }, "required": true, "x-bodyName": "kitSpecificationUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/KitSpecifications/{kitInventoryID}/{revisionID}": { "get": { "tags": [ "KitSpecifications" ], "summary": "Get a specific KitSpecification", "description": "Data for the INKitSpecHdr", "operationId": "KitSpecifications_GetBykitInventoryIDrevisionID", "parameters": [ { "name": "kitInventoryID", "in": "path", "description": "kitInventoryID", "required": true, "schema": { "type": "string" } }, { "name": "revisionID", "in": "path", "description": "revisionID", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KitSpecificationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KitSpecificationDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "KitSpecifications" ], "summary": "Updates a specific KitSpecification", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "KitSpecifications_PutBykitInventoryIDrevisionID", "parameters": [ { "name": "kitInventoryID", "in": "path", "description": "kitInventoryID", "required": true, "schema": { "type": "string" } }, { "name": "revisionID", "in": "path", "description": "revisionID", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for the KitSpecification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/KitSpecificationUpdateDto" } } }, "required": true, "x-bodyName": "kitSpecificationUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/KitSpecifications/{kitInventoryID}": { "get": { "tags": [ "KitSpecifications" ], "summary": "Get all revisions for a specific KitSpecification", "description": "Data for the INKitSpecHdr", "operationId": "KitSpecifications_GetBykitInventoryID", "parameters": [ { "name": "kitInventoryID", "in": "path", "description": "kitInventoryID", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfKitSpecificationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfKitSpecificationDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/landedCostCode/{code}": { "get": { "tags": [ "LandedCostCode" ], "summary": "Get a specific Landed Costs - ScreenId=PO2020PL", "operationId": "LandedCostCode_GetAllLandedCostsBycode", "parameters": [ { "name": "code", "in": "path", "description": "Landed Cost Code Id", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LandedCostCodeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LandedCostCodeDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/landedCostCode": { "get": { "tags": [ "LandedCostCode" ], "summary": "Get a range of Landed Costs - ScreenId=PO2020PL", "operationId": "LandedCostCode_GetAllLandedCosts", "parameters": [ { "name": "code", "in": "query", "description": "Landed Cost Code", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Enter the from-value for Landed Cost Code", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LandedCostCodeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LandedCostCodeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/ledger": { "get": { "tags": [ "Ledger" ], "summary": "Get a range of Ledgers - ScreenId=GL201500", "operationId": "Ledger_GetAllLedgers", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "Excludes ledgers with value lower than entry", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LedgerDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/location/{bAccountId}/{locationId}": { "get": { "tags": [ "Location" ], "summary": "Get a specific Location of a Baccount", "operationId": "Location_GetLocationBybAccountIdlocationId", "parameters": [ { "name": "bAccountId", "in": "path", "description": "Identifies the BAccount", "required": true, "schema": { "type": "string" } }, { "name": "locationId", "in": "path", "description": "Identifies the Location", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocationDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Location" ], "summary": "Update a specific Location", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "Location_UpdateBybAccountIdlocationId", "parameters": [ { "name": "bAccountId", "in": "path", "description": "Identifies the BAccount", "required": true, "schema": { "type": "string" } }, { "name": "locationId", "in": "path", "description": "Identifies the Location", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for the Location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } } }, "required": true, "x-bodyName": "location" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/location/{bAccountId}": { "get": { "tags": [ "Location" ], "summary": "Get a range of Locations for a BAccount\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "description": "Data for the Locations", "operationId": "Location_GetLocationsForBaccountBybAccountId", "parameters": [ { "name": "bAccountId", "in": "path", "description": "Identifies the BAccount", "required": true, "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string" } }, { "name": "gln", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/location": { "get": { "tags": [ "Location" ], "summary": "Get a range of Locations - ScreenId=CR303010\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2020-May:Added forced pagination", "description": "Data for the Locations", "operationId": "Location_GetLocations", "parameters": [ { "name": "locationId", "in": "query", "schema": { "type": "string" } }, { "name": "gln", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Location" ], "summary": "Create a Location", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "Location_Create", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Location to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LocationUpdateDto" } } }, "required": true, "x-bodyName": "location" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/lotserialclass/{id}": { "get": { "tags": [ "LotSerialClass" ], "summary": "Get a specific", "operationId": "LotSerialClass_GetByid", "parameters": [ { "name": "id", "in": "path", "description": "Identifies the LotSerialClass", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LotSerialClassDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LotSerialClassDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/lotserialclass": { "get": { "tags": [ "LotSerialClass" ], "summary": "Get a range of lot serial classes - ScreenId=IN207000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size.", "operationId": "LotSerialClass_GetAllLotSerialClass", "parameters": [ { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "trackingMethod", "in": "query", "schema": { "enum": [ "NotNumbered", "LotNumbered", "SerialNumbered" ], "type": "string" } }, { "name": "trackExpirationDate", "in": "query", "schema": { "type": "boolean" } }, { "name": "requiredForDropShip", "in": "query", "schema": { "type": "boolean" } }, { "name": "assignmentMethod", "in": "query", "schema": { "enum": [ "WhenReceived", "WhenUsed" ], "type": "string" } }, { "name": "issueMethod", "in": "query", "schema": { "enum": [ "FIFO", "LIFO", "Sequential", "Expiration", "UserEnterable" ], "type": "string" } }, { "name": "autoIncrementalValueBetweenClasses", "in": "query", "schema": { "type": "boolean" } }, { "name": "autoIncrementalValue", "in": "query", "schema": { "type": "string" } }, { "name": "autoGenerateNextNumber", "in": "query", "schema": { "type": "boolean" } }, { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LotSerialClassDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LotSerialClassDto" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/multilanguage/inventory/{inventoryNumber}/{languageISO}": { "get": { "tags": [ "Multilanguage" ], "summary": "Get a specific translation of the description for a given item and language ISO code (screenId:IN202500 and IN202000)", "operationId": "Multilanguage_GetSpecificInventoryDescrTranslationByinventoryNumberlanguageISO", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "languageISO", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultilanguageDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MultilanguageDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/MultilanguageDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/MultilanguageDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Multilanguage" ], "summary": "Updates item description for given item and language ISO code (screenId:IN202500 and IN202000)", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "Multilanguage_PutSpecificInventoryDescrTranslationByinventoryNumberlanguageISO", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "Identifies the inventory to update", "required": true, "schema": { "type": "string" } }, { "name": "languageISO", "in": "path", "description": "Identifies the description language to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the fields and field values to be updated", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } } }, "required": true, "x-bodyName": "translationDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Multilanguage" ], "summary": "Creates item description for given item and language ISO code (screenId:IN202500 and IN202000)", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "Multilanguage_PostSpecificInventoryDescrTranslationByinventoryNumberlanguageISO", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "Identifies the inventory", "required": true, "schema": { "type": "string" } }, { "name": "languageISO", "in": "path", "description": "Identifies the description language", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the fields and field values to be set on created description", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/MultilanguageTranslationDto" } } }, "required": true, "x-bodyName": "translationDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "Multilanguage" ], "summary": "Deletes the description of an item with the specific language ISO code (screenId:IN202500 and IN202000)", "description": "Response Message has StatusCode NoContent if DEL operation succeed", "operationId": "Multilanguage_DeleteSpecificInventoryDescrTranslationByinventoryNumberlanguageISO", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "Identifies the inventory to update", "required": true, "schema": { "type": "string" } }, { "name": "languageISO", "in": "path", "description": "Identifies the description language to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/multilanguage/inventory/{inventoryNumber}": { "get": { "tags": [ "Multilanguage" ], "summary": "Get all translations for a given item (screenId:IN202500 and IN202000)", "operationId": "Multilanguage_GetInventoryTranslationsByinventoryNumber", "parameters": [ { "name": "inventoryNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MultilanguageDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MultilanguageDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MultilanguageDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MultilanguageDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/multilanguage/languages": { "get": { "tags": [ "Multilanguage" ], "summary": "Get all languages (screenId:SM200550)", "operationId": "Multilanguage_GetAllActiveLanguages", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveMultilanguageDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveMultilanguageDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveMultilanguageDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActiveMultilanguageDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/multilanguage/defaultlanguage": { "put": { "tags": [ "Multilanguage" ], "summary": "Set default language (screenId:SM200550). We recommend to activate multilanguage for the first time using the System Locale screen (Screenid SM200550). Please use API only to switch default", "operationId": "Multilanguage_AddDefaultLanguage", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LanguageUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LanguageUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/LanguageUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/LanguageUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/LanguageUpdateDto" } } }, "required": true, "x-bodyName": "languageUpdateDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/numberSequence/{numberingId}": { "get": { "tags": [ "NumberSequence" ], "summary": "Get a specific Numbering", "operationId": "NumberSequence_GetBynumberingId", "parameters": [ { "name": "numberingId", "in": "path", "description": "Identifies the Numbering", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NumberingDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NumberingDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/NumberingDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/NumberingDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/numberSequence": { "get": { "tags": [ "NumberSequence" ], "summary": "Get a specific Numbering - ScreenId=CS201010", "operationId": "NumberSequence_GetAll", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberingDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberingDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberingDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/NumberingDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/organization/{organizationNumber}": { "get": { "tags": [ "Organization" ], "summary": "Get organisation information by organization number.", "description": "Data for a single organization.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Organization_GetByOrganizationCdByorganizationNumber", "parameters": [ { "name": "organizationNumber", "in": "path", "description": "The organisation code.", "required": true, "schema": { "type": "string" } }, { "name": "expandBranches", "in": "query", "description": "True to expand all Branches related to this Organization.", "schema": { "type": "boolean" } }, { "name": "expandBankSettings", "in": "query", "description": "True to expand payment settings for organization.", "schema": { "type": "boolean" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtendedOrganizationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExtendedOrganizationDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/organization": { "get": { "tags": [ "Organization" ], "summary": "Get all organisations", "operationId": "Organization_GetAll", "parameters": [ { "name": "expandBranches", "in": "query", "description": "True to expand all Branches related to this Organization.", "schema": { "type": "boolean" } }, { "name": "expandBankSettings", "in": "query", "description": "True to expand payment settings for organization.", "schema": { "type": "boolean" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedOrganizationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExtendedOrganizationDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/organization/{organizationNumber}/BankSettings": { "put": { "tags": [ "Organization" ], "summary": "Update bank settings for organization", "description": "Response Message has StatusCode No Content if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "Organization_PutBankSettingsForOrganizationByorganizationNumber", "parameters": [ { "name": "organizationNumber", "in": "path", "description": "organization number to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the bank settings to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/BankSettingsUpdateDto" } } }, "required": true, "x-bodyName": "bankSettings" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Organisation version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/packagingType/{boxId}": { "get": { "tags": [ "PackagingType" ], "summary": "Get a specific PackagingType", "operationId": "PackagingType_GetByboxId", "parameters": [ { "name": "boxId", "in": "path", "description": "Identifies the PackagingType", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PackagingTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PackagingTypeDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/packagingType": { "get": { "tags": [ "PackagingType" ], "summary": "Get a range of SO PackagingTypes - ScreenId=CS207600", "operationId": "PackagingType_GetAllPackagingTypes", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PackagingTypeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PackagingTypeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/payment/{paymentNumber}": { "get": { "tags": [ "Payment" ], "summary": "Get a specific Payment\r\nPayment is deprecated, please use CustomerPayment instead.", "operationId": "Payment_GetBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Identifies the Payment", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Payment" ], "summary": "Update a specific Payment\r\nPayment is deprecated, please use CustomerPayment instead.", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "Payment_PutBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Identifies the Payment to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Payment to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } } }, "required": true, "x-bodyName": "payment" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/payment": { "get": { "tags": [ "Payment" ], "summary": "Get a range of Payments - ScreenId=AP302000\r\nPayment is deprecated, please use CustomerPayment instead.", "operationId": "Payment_GetAllPayments", "parameters": [ { "name": "paymentNbr", "in": "query", "description": "Payment number", "schema": { "type": "string" } }, { "name": "paymentType", "in": "query", "description": "Select Type", "schema": { "enum": [ "Payment", "CreditNote", "Prepayment", "Refund", "VoidPayment", "SmallBalanceWo", "VoidRefund", "Undefined" ], "type": "string" } }, { "name": "customer", "in": "query", "description": "Enter Customer", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Enter the from-value for Ref. no.", "schema": { "type": "string" } }, { "name": "invoiceRefNbr", "in": "query", "description": "Enter Invoice Ref Nbr", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document. Use the dropdown to select status.", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "Enter field to order your records by.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "docDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "docDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "financialPeriod", "in": "query", "description": "Filter by financial period, format YYYYPP", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Payment" ], "summary": "Create a Payment\r\nPayment is deprecated, please use CustomerPayment instead.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "Payment_CreatePayment", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Payment to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PaymentUpdateDto" } } }, "required": true, "x-bodyName": "payment" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/payment/{paymentNumber}/action/release": { "post": { "tags": [ "Payment" ], "summary": "Release payment operation\r\nPayment is deprecated, please use CustomerPayment instead.", "description": "The action result dto contains information about the result of running the action", "operationId": "Payment_ReleasePaymentBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Reference number of the payment to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Contains the type of the payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionDto" } } }, "required": true, "x-bodyName": "releaseActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleasePaymentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/payment/{paymentNumber}/action/void": { "post": { "tags": [ "Payment" ], "summary": "Void payment operation\r\nPayment is deprecated, please use CustomerPayment instead.", "description": "The action result dto contains information about the result of running the action", "operationId": "Payment_VoidPaymentBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Reference number of the payment to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Contains the type of the payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionDto" } } }, "required": true, "x-bodyName": "voidActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VoidPaymentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/paymentmethod/{paymentMethodNumber}": { "get": { "tags": [ "PaymentMethod" ], "summary": "Get a specific Payment Method", "operationId": "PaymentMethod_GetBypaymentMethodNumber", "parameters": [ { "name": "paymentMethodNumber", "in": "path", "description": "Identifies the Payment Method", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PaymentMethodDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethodDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PaymentMethodDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/paymentmethod": { "get": { "tags": [ "PaymentMethod" ], "summary": "Get a range of Payment Method - ScreenId=CA204000", "operationId": "PaymentMethod_GetAllPaymentMethod", "parameters": [ { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/project/{projectID}": { "get": { "tags": [ "Project" ], "summary": "Get a specific Project", "description": "Data for a single project

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Project_GetByprojectID", "parameters": [ { "name": "projectID", "in": "path", "description": "Identifies the Project", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/project/internal/{internalID}": { "get": { "tags": [ "Project" ], "summary": "Get a specific Project by internal ID", "description": "Data for a single project

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Project_GetByinternalID", "parameters": [ { "name": "internalID", "in": "path", "description": "Identifies the Project", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/project": { "get": { "tags": [ "Project" ], "summary": "Get a range of Projects - ScreenId=PM301000\r\nThe requested page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "Project_GetAll", "parameters": [ { "name": "status", "in": "query", "description": "Use drop down and select Status.", "schema": { "enum": [ "Planned", "Active", "Completed", "Cancelled", "OnHold", "PendingApproval" ], "type": "string" } }, { "name": "systemTemplate", "in": "query", "description": "If the project is a template", "schema": { "type": "boolean" } }, { "name": "visibleInAP", "in": "query", "description": "If the project is visible in AP", "schema": { "type": "boolean" } }, { "name": "startDate", "in": "query", "description": "Project’s start date", "schema": { "type": "string", "format": "date-time" } }, { "name": "expandAttribute", "in": "query", "description": "Expands project atributes", "schema": { "type": "boolean" } }, { "name": "attributes", "in": "query", "description": "Identifies the attributes", "schema": { "type": "string" } }, { "name": "taskStatus", "in": "query", "description": "Use drop down and select Status.", "schema": { "enum": [ "Planned", "Active", "Cancelled", "Canceled", "Completed" ], "type": "string" } }, { "name": "taskVisibleInAp", "in": "query", "description": "If the project task is visible in the Supplier ledger", "schema": { "type": "boolean" } }, { "name": "taskVisibleInAr", "in": "query", "description": "If the project task is visible in the Customer ledger", "schema": { "type": "boolean" } }, { "name": "taskVisibleInCa", "in": "query", "description": "If the project task is visible in the Cash management workspace", "schema": { "type": "boolean" } }, { "name": "taskVisibleInCr", "in": "query", "description": "If the project task is visible in the CRM workspace", "schema": { "type": "boolean" } }, { "name": "taskVisibleInEa", "in": "query", "description": "If the project task is visible in the Expense workspace", "schema": { "type": "boolean" } }, { "name": "taskVisibleInGl", "in": "query", "description": "If the project task is visible in the General ledger workspace", "schema": { "type": "boolean" } }, { "name": "taskVisibleInIn", "in": "query", "description": "If the project task is visible in the Inventory workspace", "schema": { "type": "boolean" } }, { "name": "taskVisibleInPo", "in": "query", "description": "If the project task is visible in the Purchases workspace", "schema": { "type": "boolean" } }, { "name": "taskVisibleInSo", "in": "query", "description": "If the project task is visible in the Sales workspace", "schema": { "type": "boolean" } }, { "name": "taskVisibleInTa", "in": "query", "description": "If the project task is visible in the Time entities workspace", "schema": { "type": "boolean" } }, { "name": "nonProject", "in": "query", "description": "Set to true to return the non-project.", "schema": { "type": "boolean" } }, { "name": "publicId", "in": "query", "description": "Identifies the Project by its publicId", "schema": { "type": "string", "format": "uuid" } }, { "name": "restrictedEmployee", "in": "query", "description": "ID of the employee where access restrictions apply", "schema": { "type": "string" } }, { "name": "restrictedUser", "in": "query", "description": "Id of the odp user where access restrictions apply", "schema": { "type": "integer", "format": "int64" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "The branch name.", "schema": { "type": "string" } }, { "name": "onHold", "in": "query", "description": "If the project is on hold", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Project" ], "summary": "Create an project", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "Project_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the project to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } } }, "required": true, "x-bodyName": "projectUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/project/tasks": { "get": { "tags": [ "Project" ], "summary": "Get all tasks for a project", "operationId": "Project_GetTasks", "parameters": [ { "name": "projectId", "in": "query", "description": "Identifies the Project", "schema": { "type": "string" } }, { "name": "publicId", "in": "query", "description": "Identifies the project by publicId", "schema": { "type": "string", "format": "uuid" } }, { "name": "projectInternalId", "in": "query", "description": "Identifies the project by internal id", "schema": { "type": "integer", "format": "int32" } }, { "name": "description", "in": "query", "description": "Identifies the Project task description", "schema": { "type": "string" } }, { "name": "taskCd", "in": "query", "description": "Identifies the Project task ID", "schema": { "type": "string" } }, { "name": "taskCdDesc", "in": "query", "description": "Identifies the Project task ID and description", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document.", "schema": { "enum": [ "Planned", "Active", "Cancelled", "Canceled", "Completed" ], "type": "string" } }, { "name": "expandAttribute", "in": "query", "description": "Expands project atributes", "schema": { "type": "boolean" } }, { "name": "visibleInAp", "in": "query", "description": "If the project task is visible in the Supplier ledger", "schema": { "type": "boolean" } }, { "name": "visibleInAr", "in": "query", "description": "If the project task is visible in the Customer ledger", "schema": { "type": "boolean" } }, { "name": "visibleInCa", "in": "query", "description": "If the project task is visible in the Cash management workspace", "schema": { "type": "boolean" } }, { "name": "visibleInCr", "in": "query", "description": "If the project task is visible in the CRM workspace", "schema": { "type": "boolean" } }, { "name": "visibleInEa", "in": "query", "description": "If the project task is visible in the Expense workspace", "schema": { "type": "boolean" } }, { "name": "visibleInGl", "in": "query", "description": "If the project task is visible in the General ledger workspace", "schema": { "type": "boolean" } }, { "name": "visibleInIn", "in": "query", "description": "If the project task is visible in the Inventory workspace", "schema": { "type": "boolean" } }, { "name": "visibleInPo", "in": "query", "description": "If the project task is visible in the Purchases workspace", "schema": { "type": "boolean" } }, { "name": "visibleInSo", "in": "query", "description": "If the project task is visible in the Sales workspace", "schema": { "type": "boolean" } }, { "name": "visibleInTa", "in": "query", "description": "If the project task is visible in the Time entities workspace", "schema": { "type": "boolean" } }, { "name": "restrictedEmployee", "in": "query", "description": "Id of the employee where access restrictions apply", "schema": { "type": "string" } }, { "name": "restrictedUser", "in": "query", "description": "Id of the Odp User where access restrictions apply", "schema": { "type": "integer", "format": "int64" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskExtendedDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskExtendedDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/project/action/changeProjectId/{internalId}": { "post": { "tags": [ "Project" ], "summary": "Updates the ProjectID for the specified project", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

", "operationId": "Project_ChangeProjectIDActionByinternalId", "parameters": [ { "name": "internalId", "in": "path", "description": "Internal identifier of the project for which the project ID will be changed", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the new project ID for the poject", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeProjectIdActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeProjectIdActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ChangeProjectIdActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ChangeProjectIdActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ChangeProjectIdActionDto" } } }, "required": true, "x-bodyName": "changeProjectIdActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeProjectIdActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ChangeProjectIdActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ChangeProjectIdActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ChangeProjectIdActionResultDto" } } } }, "412": { "description": "Project version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/project/{projectId}": { "put": { "tags": [ "Project" ], "summary": "Update a specific Project", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "Project_PutByprojectId", "parameters": [ { "name": "projectId", "in": "path", "description": "Identifies the Project", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Project to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } } }, "required": true, "x-bodyName": "projectUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Project version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/project/internal/{internalId}": { "put": { "tags": [ "Project" ], "summary": "Update a specific Project", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "Project_PutByinternalId", "parameters": [ { "name": "internalId", "in": "path", "description": "Identifies the Project by its internalID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Project to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectUpdateDto" } } }, "required": true, "x-bodyName": "projectUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Project version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/projectaccountgroup": { "get": { "tags": [ "ProjectAccountGroup" ], "summary": "Get a range of Project Account Groups - ScreenId=PM2010PL", "operationId": "ProjectAccountGroup_GetAll", "parameters": [ { "name": "expandAttribute", "in": "query", "description": "Expands project atributes", "schema": { "type": "boolean" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectAccountGroupDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectAccountGroupDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/projectaccountgroup/{accountGroupId}": { "get": { "tags": [ "ProjectAccountGroup" ], "summary": "Get spesific Project Account Group - ScreenId=PM201000", "operationId": "ProjectAccountGroup_GetByaccountGroupId", "parameters": [ { "name": "accountGroupId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectAccountGroupDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectAccountGroupDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/projectbasic": { "get": { "tags": [ "ProjectBasic" ], "summary": "Get a range of Projects - ScreenId=PM301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "ProjectBasic_GetAll", "parameters": [ { "name": "status", "in": "query", "description": "Select project status.", "schema": { "enum": [ "Planned", "Active", "Completed", "Cancelled", "OnHold", "PendingApproval" ], "type": "string" } }, { "name": "description", "in": "query", "description": "Project name/description", "schema": { "type": "string" } }, { "name": "projectId", "in": "query", "description": "Identifies the Project", "schema": { "type": "string" } }, { "name": "startDate", "in": "query", "description": "Project's start date", "schema": { "type": "string", "format": "date-time" } }, { "name": "nonProject", "in": "query", "description": "Set to true to return the non-project.", "schema": { "type": "boolean" } }, { "name": "projectIdDesc", "in": "query", "description": "Identifies the Project by ID and description", "schema": { "type": "string" } }, { "name": "publicId", "in": "query", "description": "Identifies the Project by its publicId", "schema": { "type": "string", "format": "uuid" } }, { "name": "restrictedEmployee", "in": "query", "description": "Id of the employee where access restrictions apply", "schema": { "type": "string" } }, { "name": "restrictedUser", "in": "query", "description": "Id of the odp user where access restrictions apply", "schema": { "type": "integer", "format": "int64" } }, { "name": "visibleInAp", "in": "query", "description": "If the project is visible in the Supplier ledger", "schema": { "type": "boolean" } }, { "name": "visibleInAr", "in": "query", "description": "If the project is visible in the Customer ledger", "schema": { "type": "boolean" } }, { "name": "visibleInCa", "in": "query", "description": "If the project is visible in the Cash management workspace", "schema": { "type": "boolean" } }, { "name": "visibleInCr", "in": "query", "description": "If the project is visible in the CRM workspace", "schema": { "type": "boolean" } }, { "name": "visibleInEa", "in": "query", "description": "If the project is visible in the Expense workspace", "schema": { "type": "boolean" } }, { "name": "visibleInGl", "in": "query", "description": "If the project is visible in the General ledger workspace", "schema": { "type": "boolean" } }, { "name": "visibleInIn", "in": "query", "description": "If the project is visible in the Inventory workspace", "schema": { "type": "boolean" } }, { "name": "visibleInPo", "in": "query", "description": "If the project is visible in the Purchases workspace", "schema": { "type": "boolean" } }, { "name": "visibleInSo", "in": "query", "description": "If the project is visible in the Sales workspace", "schema": { "type": "boolean" } }, { "name": "visibleInTa", "in": "query", "description": "If the project is visible in the Time entities workspace", "schema": { "type": "boolean" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBasicDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBasicDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/projectbudget": { "get": { "tags": [ "ProjectBudget" ], "summary": "Get a range of Project Budgets - ScreenId=PM309000", "operationId": "ProjectBudget_GetAll", "parameters": [ { "name": "project", "in": "query", "description": "Identifies the Project", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBudgetDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBudgetDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "ProjectBudget" ], "summary": "Creates a Project Budget", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "ProjectBudget_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the ProjectBudget to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } } }, "required": true, "x-bodyName": "projectBudgetUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/projectbudget/{project}/{projectTask}/{accountGroup}": { "put": { "tags": [ "ProjectBudget" ], "summary": "Update a Project Budget", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\nResponse Message has StatusCode BadRequest if PUT operation failed

", "operationId": "ProjectBudget_PutByprojectprojectTaskaccountGroup", "parameters": [ { "name": "project", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "projectTask", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "accountGroup", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "inventoryItem", "in": "query", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectBudgetUpdateDto" } } }, "required": true, "x-bodyName": "projectBudgetUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/projecttask/{internalId}": { "get": { "tags": [ "ProjectTask" ], "summary": "Get project task information by internal id.", "description": "Data for a single project task.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "ProjectTask_GetTaskByinternalId", "parameters": [ { "name": "internalId", "in": "path", "description": "The organisation code.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TaskExtendedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TaskExtendedDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "ProjectTask" ], "summary": "Update a specific Task", "description": "Response Message has StatusCode No Content if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "ProjectTask_PutByinternalId", "parameters": [ { "name": "internalId", "in": "path", "description": "Identifies the task by its internalID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Task to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } } }, "required": true, "x-bodyName": "projectTaskUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Project Task version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "ProjectTask" ], "summary": "Create a Task", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "ProjectTask_PostByinternalId", "parameters": [ { "name": "internalId", "in": "path", "description": "Identifies the project by its internalID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Task to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectTaskUpdateDto" } } }, "required": true, "x-bodyName": "projectTaskUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/projecttask": { "get": { "tags": [ "ProjectTask" ], "summary": "Get all project tasks for one project.", "operationId": "ProjectTask_GetAllTasks", "parameters": [ { "name": "projectId", "in": "query", "description": "Identifies the Project", "schema": { "type": "string" } }, { "name": "publicId", "in": "query", "description": "Identifies the project by publicId", "schema": { "type": "string", "format": "uuid" } }, { "name": "projectInternalId", "in": "query", "description": "Identifies the project by internal id", "schema": { "type": "integer", "format": "int32" } }, { "name": "description", "in": "query", "description": "Identifies the Project task description", "schema": { "type": "string" } }, { "name": "taskCd", "in": "query", "description": "Identifies the Project task ID", "schema": { "type": "string" } }, { "name": "taskCdDesc", "in": "query", "description": "Identifies the Project task ID and description", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document.", "schema": { "enum": [ "Planned", "Active", "Cancelled", "Canceled", "Completed" ], "type": "string" } }, { "name": "expandAttribute", "in": "query", "description": "Expands project atributes", "schema": { "type": "boolean" } }, { "name": "visibleInAp", "in": "query", "description": "If the project task is visible in the Supplier ledger", "schema": { "type": "boolean" } }, { "name": "visibleInAr", "in": "query", "description": "If the project task is visible in the Customer ledger", "schema": { "type": "boolean" } }, { "name": "visibleInCa", "in": "query", "description": "If the project task is visible in the Cash management workspace", "schema": { "type": "boolean" } }, { "name": "visibleInCr", "in": "query", "description": "If the project task is visible in the CRM workspace", "schema": { "type": "boolean" } }, { "name": "visibleInEa", "in": "query", "description": "If the project task is visible in the Expense workspace", "schema": { "type": "boolean" } }, { "name": "visibleInGl", "in": "query", "description": "If the project task is visible in the General ledger workspace", "schema": { "type": "boolean" } }, { "name": "visibleInIn", "in": "query", "description": "If the project task is visible in the Inventory workspace", "schema": { "type": "boolean" } }, { "name": "visibleInPo", "in": "query", "description": "If the project task is visible in the Purchases workspace", "schema": { "type": "boolean" } }, { "name": "visibleInSo", "in": "query", "description": "If the project task is visible in the Sales workspace", "schema": { "type": "boolean" } }, { "name": "visibleInTa", "in": "query", "description": "If the project task is visible in the Time entities workspace", "schema": { "type": "boolean" } }, { "name": "restrictedEmployee", "in": "query", "description": "Id of the employee where access restrictions apply", "schema": { "type": "string" } }, { "name": "restrictedUser", "in": "query", "description": "Id of the Odp User where access restrictions apply", "schema": { "type": "integer", "format": "int64" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskExtendedDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TaskExtendedDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/projecttransaction/{refNbr}": { "get": { "tags": [ "ProjectTransaction" ], "summary": "Get a specific Project transaction document", "description": "Data for project transaction

\r\n The response headers include an ETag after a successful GET operation.", "operationId": "ProjectTransaction_GetByrefNbr", "parameters": [ { "name": "refNbr", "in": "path", "description": "Identifies the project transaction document", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "ProjectTransaction" ], "summary": "Update a specific Project transaction document", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "ProjectTransaction_PutByrefNbr", "parameters": [ { "name": "refNbr", "in": "path", "description": "Identifies the Project transaction document to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Project transaction document to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } } }, "required": true, "x-bodyName": "projectTransactionDocumentUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Project transaction document version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/projecttransaction": { "get": { "tags": [ "ProjectTransaction" ], "summary": "Get a range of Project transaction documents - ScreenId=PM304000", "description": "Data for Project transactions", "operationId": "ProjectTransaction_GetAll", "parameters": [ { "name": "module", "in": "query", "description": "Select to filter on module; e.g. AR, AP, IN etc.", "schema": { "enum": [ "ModuleGL", "ModuleAP", "ModuleAR", "ModuleCA", "ModuleCM", "ModuleIN", "ModuleSO", "ModulePO", "ModuleDR", "ModuleFA", "ModuleEP", "ModulePM", "ModuleTX", "ModuleCR" ], "type": "string" } }, { "name": "status", "in": "query", "description": "The status of the document.", "schema": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string" } }, { "name": "project", "in": "query", "description": "Filter on project ID.", "schema": { "type": "string" } }, { "name": "projectTask", "in": "query", "description": "Filter on Task ID.", "schema": { "type": "string" } }, { "name": "billable", "in": "query", "description": "Filter invoiceable project tasks.", "schema": { "type": "boolean" } }, { "name": "branch", "in": "query", "description": "Filter on branch for the project transation.", "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Filter on the registration date for the project transaction.", "schema": { "type": "string", "format": "date-time" } }, { "name": "fromPeriod", "in": "query", "description": "Mandatory. Start date for the task.", "schema": { "type": "string" } }, { "name": "toPeriod", "in": "query", "description": "Mandatory. End date for the task.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "expandNote", "in": "query", "description": "Expands project transaction notes", "schema": { "type": "boolean" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTransactionDocumentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTransactionDocumentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "ProjectTransaction" ], "summary": "Create a project transaction document and lines", "description": "Response Message has StatusCode Created if POST operation succeed

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "ProjectTransaction_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the project transaction to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ProjectTransactionDocumentUpdateDto" } } }, "required": true, "x-bodyName": "projectTransactionDocumentUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/purchaseorder/{purchaseOrderNumber}": { "get": { "tags": [ "PurchaseOrder" ], "summary": "Get a specific Purchase Order", "description": "Data for a single Purchase Order.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "PurchaseOrder_GetOrderBypurchaseOrderNumber", "parameters": [ { "name": "purchaseOrderNumber", "in": "path", "description": "Identifies the Purchase Order", "required": true, "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Optional parameter to request custom free fields.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "PurchaseOrder" ], "summary": "Update a Purchase Order", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\nResponse Message has StatusCode BadRequest if PUT operation failed.

\r\nThe response headers include an ETag after a successful PUT operation.

", "operationId": "PurchaseOrder_PutBypurchaseOrderNumber", "parameters": [ { "name": "purchaseOrderNumber", "in": "path", "description": "Identifies the Purchase Order to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Purchase Order to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } } }, "required": true, "x-bodyName": "purchaseOrderUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Purchase order version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/purchaseorder": { "get": { "tags": [ "PurchaseOrder" ], "summary": "Get a range of Purchase Order - ScreenId=PO301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2020-May:Added forced pagination", "operationId": "PurchaseOrder_GetAllOrder", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "Filter on order no. and forward", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "orderType", "in": "query", "description": "Select and filter on Type.", "schema": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string" } }, { "name": "orderStatus", "in": "query", "description": "Select and filter on Status.", "schema": { "enum": [ "Balanced", "Cancelled", "Closed", "Hold", "Open", "PendingEmail", "PendingPrint", "Printed", "Voided" ], "type": "string" } }, { "name": "supplier", "in": "query", "description": "Filter on Supplier.", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter on Branch", "schema": { "type": "string" } }, { "name": "orderDate", "in": "query", "description": "This value indicates the order date. Use it to retrieve all records that have the order date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __OrderDate__ and __OrderDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "orderDateCondition", "in": "query", "description": "This value represents the condition to be applied to the order date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __OrderDate__ and __OrderDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "deliveryDate", "in": "query", "description": "This value indicates the date the document is due for delivery. Use it to retrieve all records that have the delivery date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __DeliveryDate__ and __DeliveryDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "deliveryDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DeliveryDate__ and __DeliveryDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "PurchaseOrder" ], "summary": "Create a Purchase Order", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.

", "operationId": "PurchaseOrder_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Purchase Order to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseOrderUpdateDto" } } }, "required": true, "x-bodyName": "purchaseOrderUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/purchaseorder/{purchaseorderNbr}/action/createpurchasereceipt": { "post": { "tags": [ "PurchaseOrder" ], "summary": "Creates a purchase receipt from an existing purchase order.", "operationId": "PurchaseOrder_CreatePurchaseReceiptFromPurchaseOrderBypurchaseorderNbr", "parameters": [ { "name": "purchaseorderNbr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseReceiptActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseReceiptActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreatePurchaseReceiptActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreatePurchaseReceiptActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePurchaseReceiptActionDto" } } }, "required": true, "x-bodyName": "createPurchaseReceiptActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/purchaseorderbasic/{purchaseOrderNumber}": { "get": { "tags": [ "PurchaseOrderBasic" ], "summary": "Get a specific Purchase Order", "description": "Data for a single Purchase Order Basic.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "PurchaseOrderBasic_GetPurchaseOrderBasicBypurchaseOrderNumber", "parameters": [ { "name": "purchaseOrderNumber", "in": "path", "description": "Identifies the Purchase Order", "required": true, "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Optional parameter to request custom free fields.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "PurchaseOrderBasic" ], "summary": "Update a Purchase Order Basic", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\nResponse Message has StatusCode BadRequest if PUT operation failed.

\r\nThe response headers include an ETag after a successful PUT operation.

", "operationId": "PurchaseOrderBasic_PutBypurchaseOrderNumber", "parameters": [ { "name": "purchaseOrderNumber", "in": "path", "description": "Identifies the Purchase Order to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Purchase Order to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } } }, "required": true, "x-bodyName": "purchaseOrderBasicUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Purchase order version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/purchaseorderbasic": { "get": { "tags": [ "PurchaseOrderBasic" ], "summary": "Get a range of Purchase Order - ScreenId=PO301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "PurchaseOrderBasic_GetAllOrderBasic", "parameters": [ { "name": "greaterThanValue", "in": "query", "description": "Filter on order no. and forward", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "orderType", "in": "query", "description": "Select and filter on Type.", "schema": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string" } }, { "name": "orderStatus", "in": "query", "description": "Select and filter on Status.", "schema": { "enum": [ "Balanced", "Cancelled", "Closed", "Hold", "Open", "PendingEmail", "PendingPrint", "Printed", "Voided" ], "type": "string" } }, { "name": "supplier", "in": "query", "description": "Filter on Supplier.", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter on Branch", "schema": { "type": "string" } }, { "name": "orderDate", "in": "query", "description": "This value indicates the order date. Use it to retrieve all records that have the order date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __OrderDate__ and __OrderDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "orderDateCondition", "in": "query", "description": "This value represents the condition to be applied to the order date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __OrderDate__ and __OrderDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "deliveryDate", "in": "query", "description": "This value indicates the date the document is due for delivery. Use it to retrieve all records that have the delivery date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __DeliveryDate__ and __DeliveryDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "deliveryDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DeliveryDate__ and __DeliveryDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderBasicDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderBasicDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "PurchaseOrderBasic" ], "summary": "Create a Purchase Order Basic", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.

", "operationId": "PurchaseOrderBasic_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Purchase Order to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseOrderBasicUpdateDto" } } }, "required": true, "x-bodyName": "purchaseOrderBasicUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceipt/{receiptNumber}": { "get": { "tags": [ "PurchaseReceipt" ], "summary": "Get a specific Purchase Receipt", "description": "Data for a single Purchase Receipt.

\r\nThe response headers include an ETag after a successful GET operation.This method will be removed starting 15th September 2026. Please use GET api/v2/PurchaseReceipt instead.", "operationId": "PurchaseReceipt_GetPurchaseReceiptBasicByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the Purchase Receipt", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "PurchaseReceipt" ], "summary": "Update a specific Purchase Receipt", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\nResponse Message has StatusCode BadRequest if PUT operation failed.

\r\nThe response headers include an ETag after a successful PUT operation.

", "operationId": "PurchaseReceipt_PutByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the Purchase Receipt to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Purchase Receipt to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } } }, "required": true, "x-bodyName": "poReceiptUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Purchase receipt version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceipt": { "get": { "tags": [ "PurchaseReceipt" ], "summary": "Get a range of Purchase Receipts - ScreenId=PO302000\r\nPlease use a page size lower or equal to the allowed max page size which is 500", "description": "This method will be removed starting 15th September 2026. Please use GET api/v2/PurchaseReceipt instead.", "operationId": "PurchaseReceipt_GetAllReceiptBasic", "parameters": [ { "name": "receiptType", "in": "query", "schema": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string" } }, { "name": "status", "in": "query", "schema": { "enum": [ "Hold", "Balanced", "Released", "Cancelled" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "supplier", "in": "query", "schema": { "type": "string" } }, { "name": "poOrderNbr", "in": "query", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "schema": { "type": "string" } }, { "name": "finPeriod", "in": "query", "description": "Filter by financial period, format YYYYPP", "schema": { "type": "string" } }, { "name": "receiptDate", "in": "query", "description": "This value indicates the receipt date. Use it to retrieve all records that have the receipt date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "receiptDateCondition", "in": "query", "description": "This value represents the condition to be applied to the order date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dueDate", "in": "query", "description": "This value indicates the date the document is due. Use it to retrieve all records that have the due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set\r\nWorks only with PurchaseRecieptBasic and v2 of PurchaseReceipts.", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "PurchaseReceipt" ], "summary": "Create a Purchase Receipt", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.

", "operationId": "PurchaseReceipt_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Purchase Receipt to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptUpdateDto" } } }, "required": true, "x-bodyName": "poReceiptUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceipt/{receiptNumber}/print": { "get": { "tags": [ "PurchaseReceipt" ], "summary": "Get the print report of a Purchase Receipt", "operationId": "PurchaseReceipt_PrintPurchaseReceiptByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the receipt", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceipt/{receiptNumber}/action/release": { "post": { "tags": [ "PurchaseReceipt" ], "summary": "Release purchase receipt operation", "description": "The action result dto contains information about the result of running the action", "operationId": "PurchaseReceipt_ReleaseReceiptByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Reference number of the receipt to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasePurchaseReceiptActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleasePurchaseReceiptActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleasePurchaseReceiptActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleasePurchaseReceiptActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceipt/{receiptNumber}/action/cancelReceipt": { "post": { "tags": [ "PurchaseReceipt" ], "summary": "Cancel purchase receipt operation", "operationId": "PurchaseReceipt_CancelReceiptByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorder": { "post": { "tags": [ "PurchaseReceipt" ], "summary": "Add purchase orders to receipt", "description": "The action result DTO contains information about the result of running the action", "operationId": "PurchaseReceipt_AddPurchaseOrdersByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Reference number of the receipt to which to add the orders", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Object containing an array of reference numbers of the orders to be added to the receipt", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderListUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderListUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderListUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderListUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderListUpdateDto" } } }, "required": true, "x-bodyName": "purchaseOrders" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddOrdersToPurchaseReceiptActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorderlines": { "post": { "tags": [ "PurchaseReceipt" ], "summary": "Add purchase order lines to receipt", "description": "The action result dto contains information about the result of running the action", "operationId": "PurchaseReceipt_AddPurchaseOrderLinesByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Reference number of the receipt to which to add the orders", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Object containing an array of reference numbers of the orders to be added to the receipt", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptOrderLinesListUpdateDto" } } }, "required": true, "x-bodyName": "purchaseOrderLinesList" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/AddOrderLinesToPurchaseReceiptActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceiptBasic/{receiptNumber}": { "get": { "tags": [ "PurchaseReceiptBasic" ], "summary": "Get a specific Purchase Receipt", "description": "Data for a single Purchase Receipt Basic.

\r\nThe response headers include an ETag after a successful GET operation.This method will be removed starting 15th September 2026. Please use GET api/v2/PurchaseReceipt instead.", "operationId": "PurchaseReceiptBasic_GetPurchaseReceiptBasicByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the Purchase Receipt", "required": true, "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Optional parameter to request custom free fields.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "PurchaseReceiptBasic" ], "summary": "Update a specific Purchase Receipt", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\nResponse Message has StatusCode BadRequest if PUT operation failed.

\r\nThe response headers include an ETag after a successful PUT operation.

", "operationId": "PurchaseReceiptBasic_PutByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the Purchase Receipt to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Purchase Receipt to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } } }, "required": true, "x-bodyName": "poReceiptUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Purchase receipt version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceiptBasic": { "get": { "tags": [ "PurchaseReceiptBasic" ], "summary": "Get a range with purchase receipts, ScreenId=PO302000\r\nPlease use a page size lower or equal to the allowed max page size which is 500", "description": "This method will be removed starting 15th September 2026. Please use GET api/v2/PurchaseReceipt instead.", "operationId": "PurchaseReceiptBasic_GetAllReceiptBasic", "parameters": [ { "name": "receiptType", "in": "query", "schema": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string" } }, { "name": "status", "in": "query", "schema": { "enum": [ "Hold", "Balanced", "Released", "Cancelled" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "supplier", "in": "query", "schema": { "type": "string" } }, { "name": "poOrderNbr", "in": "query", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "schema": { "type": "string" } }, { "name": "finPeriod", "in": "query", "description": "Filter by financial period, format YYYYPP", "schema": { "type": "string" } }, { "name": "receiptDate", "in": "query", "description": "This value indicates the receipt date. Use it to retrieve all records that have the receipt date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "receiptDateCondition", "in": "query", "description": "This value represents the condition to be applied to the order date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dueDate", "in": "query", "description": "This value indicates the date the document is due. Use it to retrieve all records that have the due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set\r\nWorks only with PurchaseRecieptBasic and v2 of PurchaseReceipts.", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptBasicDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptBasicDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "PurchaseReceiptBasic" ], "summary": "Create a Purchase Receipt", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.

", "operationId": "PurchaseReceiptBasic_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Purchase Receipt to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptBasicUpdateDto" } } }, "required": true, "x-bodyName": "poReceiptUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/PurchaseReceiptBasic/{receiptNumber}/action/release": { "post": { "tags": [ "PurchaseReceiptBasic" ], "summary": "Release purchase receipt operation", "description": "The action result dto contains information about the result of running the action", "operationId": "PurchaseReceiptBasic_ReleaseInvoiceByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Reference number of the receipt to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleasePurchaseReceiptActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleasePurchaseReceiptActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleasePurchaseReceiptActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleasePurchaseReceiptActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/PurchaseReceipt/{receiptNumber}": { "get": { "tags": [ "PurchaseReceiptV2" ], "summary": "Get a specific Purchase Receipt", "description": "Data for a single Purchase Receipt.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "PurchaseReceiptV2_GetPurchaseReceiptByreceiptNumber", "parameters": [ { "name": "receiptNumber", "in": "path", "description": "Identifies the Purchase Receipt", "required": true, "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Optional parameter to request custom free fields.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PurchaseReceiptDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/PurchaseReceipt": { "get": { "tags": [ "PurchaseReceiptV2" ], "summary": "Get a range of Purchase Receipts - ScreenId=PO302000\r\nPlease use a page size lower or equal to the allowed max page size which is 500", "operationId": "PurchaseReceiptV2_GetAllReceipts", "parameters": [ { "name": "receiptType", "in": "query", "schema": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string" } }, { "name": "status", "in": "query", "schema": { "enum": [ "Hold", "Balanced", "Released", "Cancelled" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "supplier", "in": "query", "schema": { "type": "string" } }, { "name": "poOrderNbr", "in": "query", "schema": { "type": "string" } }, { "name": "expandNote", "in": "query", "schema": { "type": "boolean" } }, { "name": "branch", "in": "query", "schema": { "type": "string" } }, { "name": "finPeriod", "in": "query", "description": "Filter by financial period, format YYYYPP", "schema": { "type": "string" } }, { "name": "receiptDate", "in": "query", "description": "This value indicates the receipt date. Use it to retrieve all records that have the receipt date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "receiptDateCondition", "in": "query", "description": "This value represents the condition to be applied to the order date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dueDate", "in": "query", "description": "This value indicates the date the document is due. Use it to retrieve all records that have the due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salescategory/{categoryId}": { "get": { "tags": [ "SalesCategory" ], "summary": "Get a Sales Category", "operationId": "SalesCategory_GetCategoryBycategoryId", "parameters": [ { "name": "categoryId", "in": "path", "description": "Identifies the Sales Category", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesCategoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesCategoryDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesCategoryDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesCategoryDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salescategory": { "get": { "tags": [ "SalesCategory" ], "summary": "Get Sales Categories - ScreenId=IN204060", "operationId": "SalesCategory_Get", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCategoryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCategoryDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCategoryDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCategoryDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salescategory/{categoryId}/item": { "get": { "tags": [ "SalesCategory" ], "summary": "Get a range of Inventory Items from a specific Sales Category", "operationId": "SalesCategory_GetItemsForCategoryBycategoryId", "parameters": [ { "name": "categoryId", "in": "path", "description": "Identifies the Sales Category", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{orderNbr}": { "get": { "tags": [ "SalesOrder" ], "summary": "Get a specific SO Order", "description": "Data for a single Sales Order. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrder_GetByorderNbr", "parameters": [ { "name": "orderNbr", "in": "path", "description": "Identifies the Sales Order Number", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "SalesOrder" ], "summary": "Update a specific Sale Order", "description": "Response Message has StatusCode NoContent if PUT operation succeed. Response Message has StatusCode BadRequest if PUT operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrder_PutByorderNbr", "parameters": [ { "name": "orderNbr", "in": "path", "description": "Identifies the Sale Order to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Sale Order to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } } }, "required": true, "x-bodyName": "saleOrderUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{orderType}/{orderNbr}": { "get": { "tags": [ "SalesOrder" ], "summary": "Get a specific type of Order", "description": "Data for a single Sales Order. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrder_GetOrderByTypeByorderTypeorderNbr", "parameters": [ { "name": "orderType", "in": "path", "description": "Identifies the Sales Order Type", "required": true, "schema": { "type": "string" } }, { "name": "orderNbr", "in": "path", "description": "Identifies the Sales Order Number", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{orderType}/{orderNbr}/rotrut": { "get": { "tags": [ "SalesOrder" ], "summary": "Get ROT/RUT details for a specific type of order", "description": "OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrder_GetROTRUTByorderTypeorderNbr", "parameters": [ { "name": "orderType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "orderNbr", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RotRutBasicDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RotRutBasicDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder": { "get": { "tags": [ "SalesOrder" ], "summary": "Get a range of SO Orders - ScreenId=SO301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2020-May:Added force pagination", "description": "Data for all Sales Orders. Response Message has StatusCode OK if GET operation succeed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrder_GetAllOrders", "parameters": [ { "name": "orderType", "in": "query", "description": "Filter by Order type.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Select to filter on status on order.", "schema": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Filter on Order no. greater than value.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "showNotes", "in": "query", "description": "Set to true to include notes.", "schema": { "type": "boolean" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "SalesOrder" ], "summary": "Create a Sale Order", "description": "Response Message has StatusCode Created if POST operation succeed. Response Message has StatusCode BadRequest or InternalServerError if POST operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrder_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Sale Order to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } } }, "required": true, "x-bodyName": "saleOrderUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{orderType}/{orderNbr}/commissions": { "get": { "tags": [ "SalesOrder" ], "summary": "Get Sales Order Commissions - ScreenId=SO301000, tab Commissions", "description": "Data for all Sales Order Commissions. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrder_GetCommissionsByorderTypeorderNbr", "parameters": [ { "name": "orderType", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "orderNbr", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SOCommissionDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SOCommissionDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SOCommissionDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SOCommissionDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{orderType}/{orderNumber}/printOrder": { "get": { "tags": [ "SalesOrder" ], "summary": "Get the print report of the Sales Order Quote", "description": "The File is in Content of the message", "operationId": "SalesOrder_PrintOrderByorderNumberorderType", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "Identifies the Sales Order Type", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{saleOrderNumber}/action/createShipment": { "post": { "tags": [ "SalesOrder" ], "summary": "Create shipment operation", "description": "The action result dto contains information about the result of running the action", "operationId": "SalesOrder_CreateShipmentActionBysaleOrderNumber", "parameters": [ { "name": "saleOrderNumber", "in": "path", "description": "Reference number of the sale oreder from which the shipment will be created", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } } }, "required": true, "x-bodyName": "createShipmentActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{saleOrderNumber}/action/cancelSalesOrder": { "post": { "tags": [ "SalesOrder" ], "summary": "Cancel Order action", "description": "The action result dto contains information about the result of running the action. Response Message has StatusCode BadRequest or InternalServerError if POST operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrder_CancelSalesOrderBysaleOrderNumber", "parameters": [ { "name": "saleOrderNumber", "in": "path", "description": "Reference number of the sale oreder that will be cancelled", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } } }, "required": true, "x-bodyName": "cancelSalesOrderActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{salesOrderNumber}/action/reopenSalesOrder": { "post": { "tags": [ "SalesOrder" ], "summary": "Reopen and update a specific Sales Order. This method requires a sales order update dto where the order type is initialised.", "description": "The action result dto contains information about the result of running the action. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrder_ReopenSalesOrderBysalesOrderNumber", "parameters": [ { "name": "salesOrderNumber", "in": "path", "description": "Identifies the Sale Order to reopen", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } } }, "required": true, "x-bodyName": "reopenSalesOrderActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{orderNumber}/attachment": { "post": { "tags": [ "SalesOrder" ], "summary": "Creates an attachment and associates it with a sales order. If the file already exists, a new revision is created.\r\n- Method is deprecated and will be removed in a future version. Please start using the new method with order type.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrder_CreateHeaderAttachmentByorderNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/orderType/{orderType}/{orderNumber}/attachment": { "post": { "tags": [ "SalesOrder" ], "summary": "Creates an attachment and associates it with a sales order on a specific order type. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrder_CreateHeaderAttachmentByorderNumberorderType", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{orderNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SalesOrder" ], "summary": "Creates an attachment and associates it with a certain sales order line. If the file already exists, a new revision is created.\r\n- Method is deprecated and will be removed in a future version. Please start using the new method with order type.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrder_CreateLineAttachmentByorderNumberlineNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SalesOrder" ], "summary": "Creates an attachment and associates it with a certain sales order line on a specific order type. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrder_CreateLineAttachmentByorderNumberorderTypelineNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{orderType}/{orderNumber}/{lineNumber}/attachment/{fileId}": { "delete": { "tags": [ "SalesOrder" ], "summary": "Delete an attachment and remove associates it with a certain sales order line on a specific order type.", "description": "Response Message has StatusCode OK if DELETE operation succeed", "operationId": "SalesOrder_DeleteLineAttachmentByorderNumberorderTypelineNumberfileId", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "Identifies the sales order type", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "description": "Specifies the id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorder/{orderType}/{orderNumber}/attachment/{fileId}": { "delete": { "tags": [ "SalesOrder" ], "summary": "Delete an attachment and remove associates it with a certain sales order on a specific order type.", "description": "Response Message has StatusCode OK if DELETE operation succeed", "operationId": "SalesOrder_DeleteOrderAttachmentByorderNumberorderTypefileId", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "Identifies the sales order type", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "description": "Specifies the id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic/{orderNbr}": { "get": { "tags": [ "SalesOrderBasic" ], "summary": "Get a specific SO Order", "description": "Data for a single Sales Order Basic. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderBasic_GetByorderNbr", "parameters": [ { "name": "orderNbr", "in": "path", "description": "Identifies the Sales Order Number", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "SalesOrderBasic" ], "summary": "Update a specific Sale Order", "description": "Response Message has StatusCode NoContent if PUT operation succeed. Response Message has StatusCode BadRequest if PUT operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderBasic_PutByorderNbr", "parameters": [ { "name": "orderNbr", "in": "path", "description": "Identifies the Sale Order to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Sale Order to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } } }, "required": true, "x-bodyName": "saleOrderUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic/{orderType}/{orderNbr}": { "get": { "tags": [ "SalesOrderBasic" ], "summary": "Get a specific type of Order", "description": "Data for a single Sales Order Basic. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderBasic_GetOrderByTypeByorderTypeorderNbr", "parameters": [ { "name": "orderType", "in": "path", "description": "Identifies the Sales Order Type", "required": true, "schema": { "type": "string" } }, { "name": "orderNbr", "in": "path", "description": "Identifies the Sales Order Number", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic": { "get": { "tags": [ "SalesOrderBasic" ], "summary": "Get a range of Sale Orders - ScreenId=SO301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "description": "Data for all Sales Order Basic. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderBasic_GetAllOrders", "parameters": [ { "name": "orderType", "in": "query", "description": "Filter by Order type.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Select to filter on status on order.", "schema": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Filter on Order no. greater than value.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "showNotes", "in": "query", "description": "Set to true to include notes.", "schema": { "type": "boolean" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderBasicDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderBasicDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "SalesOrderBasic" ], "summary": "Create a Sale Order", "description": "Response Message has StatusCode Created if POST operation succeed. Response Message has StatusCode BadRequest or InternalServerError if POST operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderBasic_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Sale Order to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } } }, "required": true, "x-bodyName": "saleOrderUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic/{saleOrderNumber}/action/createShipment": { "post": { "tags": [ "SalesOrderBasic" ], "summary": "Crete shipment operation", "description": "The action result dto contains information about the result of running the action", "operationId": "SalesOrderBasic_CreateShipmentActionBysaleOrderNumber", "parameters": [ { "name": "saleOrderNumber", "in": "path", "description": "Reference number of the sale oreder from which the shipment will be created", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } } }, "required": true, "x-bodyName": "createShipmentActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic/{orderNumber}/attachment": { "post": { "tags": [ "SalesOrderBasic" ], "summary": "Creates an attachment and associates it with a sales order. If the file already exists, a new revision is created.\r\n- Method is deprecated and will be removed in a future version. Please start using the new method with order type.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderBasic_CreateHeaderAttachmentByorderNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic/orderType/{orderType}/{orderNumber}/attachment": { "post": { "tags": [ "SalesOrderBasic" ], "summary": "Creates an attachment and associates it with a sales order on a specific order type. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderBasic_CreateHeaderAttachmentByorderNumberorderType", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "Identifies the sales order type", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic/{orderNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SalesOrderBasic" ], "summary": "Creates an attachment and associates it with a certain sales order line. If the file already exists, a new revision is created.\r\n- Method is deprecated and will be removed in a future version. Please start using the new method with order type.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderBasic_CreateLineAttachmentByorderNumberlineNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SalesOrderBasic" ], "summary": "Creates an attachment and associates it with a certain sales order line on a specific order type. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderBasic_CreateLineAttachmentByorderNumberorderTypelineNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "Identifies the sales order type", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic/{orderType}/{orderNumber}/{lineNumber}/attachment/{fileId}": { "delete": { "tags": [ "SalesOrderBasic" ], "summary": "Delete an attachment and remove associates it with a certain sales order line on a specific order type.", "description": "Response Message has StatusCode OK if DELETE operation succeed", "operationId": "SalesOrderBasic_DeleteLineAttachmentByorderNumberorderTypelineNumberfileId", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "Identifies the sales order type", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "fileId", "in": "path", "description": "Specifies the id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesorderbasic/{orderType}/{orderNumber}/attachment/{fileId}": { "delete": { "tags": [ "SalesOrderBasic" ], "summary": "Delete an attachment and remove associates it with a certain sales order on a specific order type.", "description": "Response Message has StatusCode OK if DELETE operation succeed", "operationId": "SalesOrderBasic_DeleteOrderAttachmentByorderNumberorderTypefileId", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "Identifies the sales order type", "required": true, "schema": { "type": "string" } }, { "name": "fileId", "in": "path", "description": "Specifies the id of the file", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Deleted", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorderbasic/{saleOrderNumber}/action/createShipment": { "post": { "tags": [ "SalesOrderBasicV2" ], "summary": "Crete shipment operation", "description": "The action result dto contains information about the result of running the action", "operationId": "SalesOrderBasicV2_CreateShipmentActionBysaleOrderNumber", "parameters": [ { "name": "saleOrderNumber", "in": "path", "description": "Reference number of the sale oreder from which the shipment will be created", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } } }, "required": true, "x-bodyName": "createShipmentActionDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "409": { "description": "Conflict. Order cannot be shipped in full, shipping rule Ship Complete requires all items to be in stock.", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorderbasic/{orderType}/{orderNumber}/action/prepareInvoice": { "post": { "tags": [ "SalesOrderBasicV2" ], "summary": "Prepare Invoice operation", "description": "The action result dto contains information about the result of running the action", "operationId": "SalesOrderBasicV2_PrepareInvoiceActionByorderTypeorderNumber", "parameters": [ { "name": "orderType", "in": "path", "description": "Order Type of the sale order from which the invoice will be created", "required": true, "schema": { "type": "string" } }, { "name": "orderNumber", "in": "path", "description": "Reference number of the sale order from which the invoice will be created", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareInvoiceActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepareInvoiceActionResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorderbasic/{orderType}/{orderNumber}/action/sendbymail": { "post": { "tags": [ "SalesOrderBasicV2" ], "summary": "Send by mail operation", "description": "The action result dto contains information about the result of running the action", "operationId": "SalesOrderBasicV2_SendEmailActionByorderTypeorderNumber", "parameters": [ { "name": "orderType", "in": "path", "description": "The type of sale order from which the email will be dispatched.", "required": true, "schema": { "type": "string" } }, { "name": "orderNumber", "in": "path", "description": "The number of sale order from which the email will be dispatched.", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmailActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendEmailActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SendEmailActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SendEmailActionResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorderbasic/{orderNumber}/attachment": { "post": { "tags": [ "SalesOrderBasicV2" ], "summary": "Creates an attachment and associates it with a sales order. If the file already exists, a new revision is created.\r\n- Method is deprecated and will be removed in a future version. Please start using the new method with order type.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderBasicV2_CreateHeaderAttachmentByorderNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorderbasic/orderType/{orderType}/{orderNumber}/attachment": { "post": { "tags": [ "SalesOrderBasicV2" ], "summary": "Creates an attachment and associates it with a sales order on a specific order type. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderBasicV2_CreateHeaderAttachmentByorderNumberorderType", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "Identifies the sales order type", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorderbasic/{orderNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SalesOrderBasicV2" ], "summary": "Creates an attachment and associates it with a certain sales order line. If the file already exists, a new revision is created.\r\n- Method is deprecated and will be removed in a future version. Please start using the new method with order type.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderBasicV2_CreateLineAttachmentByorderNumberlineNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorderbasic/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SalesOrderBasicV2" ], "summary": "Creates an attachment and associates it with a certain sales order line on a specific order type. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderBasicV2_CreateLineAttachmentByorderNumberorderTypelineNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "Identifies the sales order type", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorderbasic": { "post": { "tags": [ "SalesOrderBasicV2" ], "summary": "Create a Sale Order", "description": "Response Message has StatusCode Created if POST operation succeed. Response Message has StatusCode BadRequest or InternalServerError if POST operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderBasicV2_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Sale Order to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SalesOrderBasicUpdateDto" } } }, "required": true, "x-bodyName": "saleOrderUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesordertype/{orderType}": { "get": { "tags": [ "SalesOrderType" ], "summary": "Get a specific SO OrderType", "operationId": "SalesOrderType_GetSalesOrderTypeByorderType", "parameters": [ { "name": "orderType", "in": "path", "description": "Identifies the SO OrderType", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderTypeDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderTypeDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesordertype": { "get": { "tags": [ "SalesOrderType" ], "summary": "Get a range of SO OrderTypes - ScreenId=SO201000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "SalesOrderType_GetAllSalesOrderTypes", "parameters": [ { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderTypeDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderTypeDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/{orderNbr}": { "get": { "tags": [ "SalesOrderV2" ], "summary": "Get a specific SO Order", "description": "Data for a single Sales Order. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderV2_GetByorderNbr", "parameters": [ { "name": "orderNbr", "in": "path", "description": "Identifies the Sales Order Number", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder": { "get": { "tags": [ "SalesOrderV2" ], "summary": "Get a range of SO Orders - ScreenId=SO301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "description": "Data for all Sales Orders. Response Message has StatusCode OK if GET operation succeed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderV2_GetAllOrders_V2", "parameters": [ { "name": "orderType", "in": "query", "description": "Filter by Order type.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Select to filter on status on order.", "schema": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Filter on Order no. greater than value.", "schema": { "type": "string" } }, { "name": "showNotes", "in": "query", "description": "Set to true to include notes.", "schema": { "type": "boolean" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "SalesOrderV2" ], "summary": "Create a Sale Order", "description": "Response Message has StatusCode Created if POST operation succeed. Response Message has StatusCode BadRequest or InternalServerError if POST operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderV2_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Sale Order to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SalesOrderUpdateDto" } } }, "required": true, "x-bodyName": "saleOrderUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/{saleOrderNumber}/action/createShipment": { "post": { "tags": [ "SalesOrderV2" ], "summary": "Create shipment operation", "description": "The action result dto contains information about the result of running the action", "operationId": "SalesOrderV2_CreateShipmentActionBysaleOrderNumber", "parameters": [ { "name": "saleOrderNumber", "in": "path", "description": "Reference number of the sale oreder from which the shipment will be created", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionDto" } } }, "required": true, "x-bodyName": "createShipmentActionDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateShipmentActionResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "409": { "description": "Conflict. Order cannot be shipped in full, shipping rule Ship Complete requires all items to be in stock.", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/{orderType}/{orderNumber}/action/prepareInvoice": { "post": { "tags": [ "SalesOrderV2" ], "summary": "Prepare Invoice operation", "description": "The action result dto contains information about the result of running the action", "operationId": "SalesOrderV2_PrepareInvoiceActionByorderTypeorderNumber", "parameters": [ { "name": "orderType", "in": "path", "description": "Order Type of the sale order from which the invoice will be created", "required": true, "schema": { "type": "string" } }, { "name": "orderNumber", "in": "path", "description": "Reference number of the sale order from which the invoice will be created", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrepareInvoiceActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrepareInvoiceActionResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/{orderType}/{orderNumber}/action/sendbymail": { "post": { "tags": [ "SalesOrderV2" ], "summary": "Send by mail operation", "description": "The action result dto contains information about the result of running the action", "operationId": "SalesOrderV2_SendEmailActionByorderTypeorderNumber", "parameters": [ { "name": "orderType", "in": "path", "description": "The type of sale order from which the email will be dispatched.", "required": true, "schema": { "type": "string" } }, { "name": "orderNumber", "in": "path", "description": "The number of sale order from which the email will be dispatched.", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmailActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendEmailActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SendEmailActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SendEmailActionResultDto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/{saleOrderNumber}/action/createPurchaseOrders": { "post": { "tags": [ "SalesOrderV2" ], "summary": "This will create 0..n PO based on SO according to the following rules for the lines on the SO\r\n- Only issue lines\r\n- Only create PO based on lines with supplier\r\n- Create PO (0..n) for each supplier on the SO lines\r\n- Create PO type purchase/drop shipment based on PO Source on SO line\r\n- If no supplier on inventory item exist the SO line will not have a corresponding PO line (response should point to lines with no supplier in either SO line or inventory item)\r\n- If 'createPurchaseOrderActionDto.preferSupplierFromSOLine' is false then the default supplier for SOLine inventory item will be used if any\r\n- If 'createPurchaseOrderActionDto.preferSupplierFromSOLine' is true then the supplier from the SOLine inventory item will be used; if there is no supplier on SOLine then the default supplier for SOLine inventory item will be used if any", "description": "The action result dto contains list of created purchase order numbers and list of errors if any", "operationId": "SalesOrderV2_CreatePurchaseOrdersActionBysaleOrderNumber", "parameters": [ { "name": "saleOrderNumber", "in": "path", "description": "Reference number of the sale oreder from which the purchase order will be created", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CreatePurchaseOrderActionDto" } } }, "required": true, "x-bodyName": "createPurchaseOrderActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "207": { "description": "Multi-Status", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/{saleOrderNumber}/action/cancelSalesOrder": { "post": { "tags": [ "SalesOrderV2" ], "summary": "Cancel Order action", "description": "The action result dto contains information about the result of running the action. Response Message has StatusCode BadRequest or InternalServerError if POST operation failed. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderV2_CancelSalesOrderBysaleOrderNumber", "parameters": [ { "name": "saleOrderNumber", "in": "path", "description": "Reference number of the sale oreder that will be cancelled", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionDto" } } }, "required": true, "x-bodyName": "cancelSalesOrderActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/CancelSalesOrderActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/{salesOrderNumber}/action/reopenSalesOrder": { "post": { "tags": [ "SalesOrderV2" ], "summary": "Reopen and update a specific Sales Order. This method requires a sales order update dto where the order type is initialised.", "description": "The action result dto contains information about the result of running the action. OBS: End of life March 31 2026. REPLACED BY v3 ENDPOINT. SEE https://salesorder.visma.net/swagger/index.html", "operationId": "SalesOrderV2_ReopenSalesOrderBysalesOrderNumber", "parameters": [ { "name": "salesOrderNumber", "in": "path", "description": "Identifies the Sale Order to reopen", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionDto" } } }, "required": true, "x-bodyName": "reopenSalesOrderActionDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReopenSalesOrderActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/{orderNumber}/attachment": { "post": { "tags": [ "SalesOrderV2" ], "summary": "Creates an attachment and associates it with a sales order. If the file already exists, a new revision is created.\r\n- Method is deprecated and will be removed in a future version. Please start using the new method with order type.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderV2_CreateHeaderAttachmentByorderNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/orderType/{orderType}/{orderNumber}/attachment": { "post": { "tags": [ "SalesOrderV2" ], "summary": "Creates an attachment and associates it with a sales order on a specific order type. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderV2_CreateHeaderAttachmentByorderNumberorderType", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/{orderNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SalesOrderV2" ], "summary": "Creates an attachment and associates it with a certain sales order line. If the file already exists, a new revision is created.\r\n- Method is deprecated and will be removed in a future version. Please start using the new method with order type.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderV2_CreateLineAttachmentByorderNumberlineNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "deprecated": true, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesorder/orderType/{orderType}/{orderNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SalesOrderV2" ], "summary": "Creates an attachment and associates it with a certain sales order line on a specific order type. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesOrderV2_CreateLineAttachmentByorderNumberorderTypelineNumber", "parameters": [ { "name": "orderNumber", "in": "path", "description": "Identifies the sales order", "required": true, "schema": { "type": "string" } }, { "name": "orderType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesperson/{salespersonCd}": { "get": { "tags": [ "SalesPerson" ], "summary": "Get a specific Salesperson - screen ID: AR205000", "operationId": "SalesPerson_GetSalespersonBysalespersonCd", "parameters": [ { "name": "salespersonCd", "in": "path", "description": "Identifies the Salesperson", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesPersonDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesPersonDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "SalesPerson" ], "summary": "Update a specific Salesperson", "description": "Response Message has StatusCode NoContent if PUT operation succeed", "operationId": "SalesPerson_UpdateSalespersonBysalespersonCd", "parameters": [ { "name": "salespersonCd", "in": "path", "description": "Identifies the Salesperson to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Salesperson to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } } }, "required": true, "x-bodyName": "salesperson" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/salesperson": { "get": { "tags": [ "SalesPerson" ], "summary": "Get all or a range of Salespersons - screen ID: AR205000\r\nPlease use a page size lower or equal to the allowed max page size which is returned under metadata. \r\nIf pagesize is greater than the max page size, it will be limited to max page size.", "operationId": "SalesPerson_GetSalespersons", "parameters": [ { "name": "salespersonCD", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "commissionPct", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "salesSub", "in": "query", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfSalesPersonDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BasePaginationDtoOfSalesPersonDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "SalesPerson" ], "summary": "Create a Salesperson", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "SalesPerson_CreateSalesperson", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Salesperson to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SalesPersonUpdateDto" } } }, "required": true, "x-bodyName": "salesperson" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesperson/{salespersonCd}": { "get": { "tags": [ "SalesPersonV2" ], "summary": "Get a specific Salesperson - screen ID: AR205000", "operationId": "SalesPersonV2_GetSalespersonBysalespersonCd", "parameters": [ { "name": "salespersonCd", "in": "path", "description": "Identifies the Salesperson", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SalesPersonDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SalesPersonDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/salesperson": { "get": { "tags": [ "SalesPersonV2" ], "summary": "Get all or a range of Salespersons - screen ID: AR205000\r\nPlease use a page size lower or equal to the allowed max page size which is returned under metadata. \r\nIf pagesize is greater than the max page size, it will be limited to max page size.", "operationId": "SalesPersonV2_GetSalespersons", "parameters": [ { "name": "salespersonCD", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "isActive", "in": "query", "schema": { "type": "boolean" } }, { "name": "commissionPct", "in": "query", "schema": { "type": "number", "format": "double" } }, { "name": "salesSub", "in": "query", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesPersonDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SalesPersonDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNbr}": { "get": { "tags": [ "Shipment" ], "summary": "Get a specific Shipment", "description": "Data for a single Shipment.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Shipment_GetByshipmentNbr", "parameters": [ { "name": "shipmentNbr", "in": "path", "description": "Identifies the Shipment", "required": true, "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Optional parameter to request custom free fields.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Shipment" ], "summary": "Update a specific Shipment", "description": "Response Message has StatusCode NoContent if PUT operation succeeded.

\r\nResponse Message has StatusCode BadRequest if PUT operation failed.

\r\nThe response headers include an ETag after a successful PUT operation.

", "operationId": "Shipment_PutByshipmentNbr", "parameters": [ { "name": "shipmentNbr", "in": "path", "description": "Identifies the Shipment to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Shipment to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDto" } } }, "required": true, "x-bodyName": "shipmentUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Shipment version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment": { "get": { "tags": [ "Shipment" ], "summary": "Get a range of SO Shipments - ScreenId=SO302000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "Shipment_GetAllShipments", "parameters": [ { "name": "customerId", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "customerNumber", "in": "query", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The GreaterThanValue parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "enum": [ "Open", "Hold", "Completed", "Cancelled", "Confirmed", "Invoiced", "Receipted", "AutoGenerated", "PartiallyInvoiced" ], "type": "string" } }, { "name": "pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageNumber", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "shipmentType", "in": "query", "description": "Filter by Shipment Type", "schema": { "enum": [ "Issue", "DropShip", "Transfer" ], "type": "string" } }, { "name": "shipmentDate", "in": "query", "description": "Shipment Date\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __ShipmentDate__ and __ShipmentDate__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "shipmentDateCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __ShipmentDate__ and __ShipmentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "includeCustomFreeFields", "in": "query", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Shipment" ], "summary": "Create a Shipment", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.

", "operationId": "Shipment_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Shipment to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentCreateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentCreateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ShipmentCreateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ShipmentCreateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShipmentCreateDto" } } }, "required": true, "x-bodyName": "shipmentCreateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNbr}/printShipmentConfirmation": { "get": { "tags": [ "Shipment" ], "summary": "Get the shipment confirmation report", "operationId": "Shipment_PrintShipmentConfirmationByshipmentNbr", "parameters": [ { "name": "shipmentNbr", "in": "path", "description": "Identifies the shipment", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNbr}/printPickList": { "get": { "tags": [ "Shipment" ], "summary": "Get the pick list report", "operationId": "Shipment_PrintPickListByshipmentNbr", "parameters": [ { "name": "shipmentNbr", "in": "path", "description": "Identifies the shipment", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNumber}/action/addSOLine": { "post": { "tags": [ "Shipment" ], "summary": "Adds a Sales Order Line to a specific Shipment", "description": "Response Message has StatusCode NoContent if POST operation succeeded", "operationId": "Shipment_AddSOLineByshipmentNumber", "parameters": [ { "name": "shipmentNumber", "in": "path", "description": "Identifies the Shipment to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Sales Order Line to add", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentSOLine" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentSOLine" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ShipmentSOLine" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ShipmentSOLine" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShipmentSOLine" } } }, "required": true, "x-bodyName": "shipmentSOLine" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNumber}/action/addSOOrder": { "post": { "tags": [ "Shipment" ], "summary": "Adds a Sales Order to a specific Shipment", "description": "Response Message has StatusCode NoContent if POST operation succeeded", "operationId": "Shipment_AddSOOrderByshipmentNumber", "parameters": [ { "name": "shipmentNumber", "in": "path", "description": "Identifies the Shipment to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Sales Order to add", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentSOOrder" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentSOOrder" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ShipmentSOOrder" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ShipmentSOOrder" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShipmentSOOrder" } } }, "required": true, "x-bodyName": "shipmentSOOrder" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNumber}/action/confirmShipment": { "post": { "tags": [ "Shipment" ], "summary": "Confirm shipment operation", "description": "The action result dto contains information about the result of running the action", "operationId": "Shipment_ConfirmShipmentByshipmentNumber", "parameters": [ { "name": "shipmentNumber", "in": "path", "description": "Reference number of the shipment to be confirmed", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfirmShipmentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ConfirmShipmentActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ConfirmShipmentActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ConfirmShipmentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNumber}/action/correctShipment": { "post": { "tags": [ "Shipment" ], "summary": "Correct shipment operation", "description": "Response Message has StatusCode BadRequest or InternalServerError if POST operation failed", "operationId": "Shipment_CorrectShipmentByshipmentNumber", "parameters": [ { "name": "shipmentNumber", "in": "path", "description": "Reference number of the shipment to be corrected", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNumber}/action/addLine": { "post": { "tags": [ "Shipment" ], "summary": "Adds a new Shipment Line to a specific Shipment", "description": "Response Message has StatusCode NoContent if POST operation succeeded", "operationId": "Shipment_AddLineByshipmentNumber", "parameters": [ { "name": "shipmentNumber", "in": "path", "description": "Identifies the Shipment to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the new Shipment Line to add", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentDetailLineAddDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentDetailLineAddDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ShipmentDetailLineAddDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ShipmentDetailLineAddDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShipmentDetailLineAddDto" } } }, "required": true, "x-bodyName": "shipmentDetailLineAddDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNumber}/action/deleteLine/{lineNumber}": { "post": { "tags": [ "Shipment" ], "summary": "Deletes a Shipment Line from a specific Shipment", "description": "Response Message has StatusCode NoContent if POST operation succeeded", "operationId": "Shipment_DeleteLineByshipmentNumberlineNumber", "parameters": [ { "name": "shipmentNumber", "in": "path", "description": "Identifies the Shipment to update", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Identifies the Shipment line to delete", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines if SOLine should be deleted or not - where applicable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDeleteLineDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDeleteLineDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDeleteLineDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDeleteLineDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ShipmentUpdateDeleteLineDto" } } }, "required": true, "x-bodyName": "shipmentUpdateDeleteLineDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/shipment/{shipmentNumber}/action/cancelShipment": { "post": { "tags": [ "Shipment" ], "summary": "Cancel shipment operation", "operationId": "Shipment_CancelShipmentByshipmentNumber", "parameters": [ { "name": "shipmentNumber", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/stocktake/{referenceNumber}": { "get": { "tags": [ "StocktakeV2" ], "summary": "Get a specific", "operationId": "StocktakeV2_GetByreferenceNumber", "parameters": [ { "name": "referenceNumber", "in": "path", "description": "Identifies the Stocktake", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StocktakeV2Dto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StocktakeV2Dto" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "StocktakeV2" ], "summary": "Update a specific stocktake", "description": "Response Message has StatusCode NoContent if PUT operation succeed\r\n\r\nResponse Message has StatusCode BadRequest if PUT operation failed \r\n\r\nIf PUT operation failed, Response body contains all stocktake line details (the ones that have values), the error message and also an error code (The first member of StocktakeExceptionErrorCode will be 0, and the value of each successive enum member is increased by 1)", "operationId": "StocktakeV2_PutByreferenceNumber", "parameters": [ { "name": "referenceNumber", "in": "path", "description": "Identifies the stocktake to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for stocktake", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StocktakeUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StocktakeUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/StocktakeUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/StocktakeUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/StocktakeUpdateDto" } } }, "required": true, "x-bodyName": "stocktake" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StocktakeV2ExceptionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/StocktakeV2ExceptionDto" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "403": { "description": "Forbidden", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/stocktake": { "get": { "tags": [ "StocktakeV2" ], "summary": "Get a range of stocktakes - ScreenId=IN305000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information. If requested page size is greater than allowed max page size, request will be limited to max page size.", "operationId": "StocktakeV2_GetAllStocktakes", "parameters": [ { "name": "warehouse", "in": "query", "description": "Filter by Warehouse.", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Filter by Location.", "schema": { "type": "string" } }, { "name": "inventory", "in": "query", "description": "Filter by Inventory.", "schema": { "type": "string" } }, { "name": "lotSerialNumber", "in": "query", "description": "Filter by LotSerialNumber.", "schema": { "type": "string" } }, { "name": "summaryStatus", "in": "query", "description": "Filter by SummaryStatus.", "schema": { "enum": [ "Cancelled", "Completed", "Counting", "Entering" ], "type": "string" } }, { "name": "startWithLine", "in": "query", "description": "Filter by LineNumber GreaterEqual StartWithLine.", "schema": { "type": "integer", "format": "int32" } }, { "name": "endWithLine", "in": "query", "description": "Filter by by LineNumber LessEqual EndWithLine.", "schema": { "type": "integer", "format": "int32" } }, { "name": "freezeDateTime", "in": "query", "description": "Filter by FreezeDateTime.", "schema": { "type": "string" } }, { "name": "freezeDateTimeCondition", "in": "query", "description": "Filter by FreezeDateTimeCondition.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present..", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "System retrieved information for state/condition.", "schema": { "type": "string" } }, { "name": "expirationDateTime", "in": "query", "description": "Filter by ExpirationDateTime.", "schema": { "type": "string" } }, { "name": "expirationDateTimeCondition", "in": "query", "description": "Filter by ExpirationDateTimeCondition.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by StocktakeLineStatus.", "schema": { "enum": [ "NotEntered", "Entered", "Skipped" ], "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StocktakeV2Dto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StocktakeV2Dto" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { }, "text/json": { } } }, "401": { "description": "Unauthorized", "content": { "application/json": { }, "text/json": { } } }, "404": { "description": "Not Found", "content": { "application/json": { }, "text/json": { } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/subaccount/{subAccountNumber}": { "get": { "tags": [ "Subaccount" ], "summary": "Get a specific SubAccount", "description": "Data for SubAccount

\r\n The response headers include an ETag after a successful GET operation.", "operationId": "Subaccount_GetSubaccountBysubAccountNumber", "parameters": [ { "name": "subAccountNumber", "in": "path", "description": "Identifies the SubAccount", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubAccountDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubAccountDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Subaccount" ], "summary": "Update a specific Subaccount", "description": "Response Message has StatusCode NoContent if PUT operation succeed

\r\n Response Message has StatusCode BadRequest if PUT operation failed

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "Subaccount_PutBysubAccountNumber", "parameters": [ { "name": "subAccountNumber", "in": "path", "description": "Identifies the Subaccount to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Subaccount to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } } }, "required": true, "x-bodyName": "subAccountUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "SubAccount version does not match with If-Match header.", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/subaccount": { "get": { "tags": [ "Subaccount" ], "summary": "Get all SubAccounts - ScreenId=GL203000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2020-May:Added force pagination.", "description": "Data for SubAccount

\r\n Response Message has StatusCode OK if GET operation succeed", "operationId": "Subaccount_GetAllSubaccounts", "parameters": [ { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "If the SubAccount is active", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubAccountDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SubAccountDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Subaccount" ], "summary": "Create a Subaccount", "description": "Response Message has StatusCode Created if POST operation succeed

\r\n The response headers include an ETag after a successful POST operation.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed", "operationId": "Subaccount_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for Subaccount to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SubAccountUpdateDto" } } }, "required": true, "x-bodyName": "subAccountUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/supplierClass": { "get": { "tags": [ "Supplier" ], "summary": "Get supplier classes", "operationId": "Supplier_GetAllSupplierClasses", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierClassDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierClassDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/supplierClass/{supplierClassId}": { "get": { "tags": [ "Supplier" ], "summary": "Get a specific supplier class", "description": "Data for a single supplier class.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Supplier_GetSpecificSupplierClassBysupplierClassId", "parameters": [ { "name": "supplierClassId", "in": "path", "description": "Identifies the supplier class", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierClassDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierClassDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/balance": { "get": { "tags": [ "Supplier" ], "summary": "Get the balance of a range of suppliers", "operationId": "Supplier_GetAllSupplierBalance", "parameters": [ { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierBalanceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierBalanceDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierBalanceDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierBalanceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/POBalance": { "get": { "tags": [ "Supplier" ], "summary": "Get the PO balance of a range of suppliers", "operationId": "Supplier_GetAllSupplierPOBalance", "parameters": [ { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPOBalanceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPOBalanceDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPOBalanceDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPOBalanceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/{supplierCd}": { "get": { "tags": [ "Supplier" ], "summary": "Get a specific supplier", "description": "Data for a single supplier.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "Supplier_GetBysupplierCd", "parameters": [ { "name": "supplierCd", "in": "path", "description": "Identifies the supplier", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "Supplier" ], "summary": "Update a specific supplier", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "Supplier_PutBysupplierCd", "parameters": [ { "name": "supplierCd", "in": "path", "description": "Identifies the supplier to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for supplier", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } } }, "required": true, "x-bodyName": "supplier" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Supplier version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier": { "get": { "tags": [ "Supplier" ], "summary": "Get a range of suppliers - ScreenId=AP303000", "operationId": "Supplier_GetAll", "parameters": [ { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Contains supplier name.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "enum": [ "Active", "OnHold", "HoldPayments", "Inactive", "OneTime" ], "type": "string" } }, { "name": "vatRegistrationId", "in": "query", "schema": { "type": "string" } }, { "name": "corporateId", "in": "query", "schema": { "type": "string" } }, { "name": "attributes", "in": "query", "schema": { "type": "string" } }, { "name": "expandAccountInformation", "in": "query", "schema": { "type": "boolean" } }, { "name": "expandNote", "in": "query", "schema": { "type": "boolean" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "Supplier" ], "summary": "Create a supplier", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "Supplier_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the supplier to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SupplierUpdateDto" } } }, "required": true, "x-bodyName": "supplier" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/inboxrules": { "get": { "tags": [ "Supplier" ], "summary": "Export the suppliers inbox rules for the current company as a JSON file", "operationId": "Supplier_GetInboxRulesAsync", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/{supplierNumber}/invoice": { "get": { "tags": [ "Supplier" ], "summary": "Get a range of invoices for a specific supplier\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2020-May:Added forced pagination", "operationId": "Supplier_GetAllInvoicesForSupplierBysupplierNumber", "parameters": [ { "name": "supplierNumber", "in": "path", "description": "Identifies the supplier for which to return data", "required": true, "schema": { "type": "string" } }, { "name": "expandAttachment", "in": "query", "description": "Set to true if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandLandedCosts", "in": "query", "description": "Expland landed cost lines", "schema": { "type": "boolean" } }, { "name": "documentType", "in": "query", "description": "By type of document.", "schema": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "project", "in": "query", "description": "Filter by the project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApproval", "in": "query", "description": "Set to true to include approval information.", "schema": { "type": "boolean" } }, { "name": "expandNote", "in": "query", "description": "Set to true to include description.", "schema": { "type": "boolean" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "The status of the document", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string" } }, { "name": "expandLinePrebookAccounts", "in": "query", "description": "Expland line-level pre-booking account and sub-account information.", "schema": { "type": "boolean" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "financialPeriod", "in": "query", "description": "Filter by Financial Period, format YYYYPP", "schema": { "type": "string" } }, { "name": "dueDate", "in": "query", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "dueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "docDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "docDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "item", "in": "query", "description": "Filter by Item used into the document lines", "schema": { "type": "string" } }, { "name": "balance", "in": "query", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "number", "format": "double" } }, { "name": "balanceCondition", "in": "query", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierInvoiceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierInvoiceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/{supplierNumber}/document": { "get": { "tags": [ "Supplier" ], "summary": "Gets a range of documents for a specific supplier", "operationId": "Supplier_GetAllDocumentsForSupplierBysupplierNumber", "parameters": [ { "name": "supplierNumber", "in": "path", "description": "Identifies the supplier for which to return data", "required": true, "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "description": "By type of document.", "schema": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "project", "in": "query", "description": "Filter by the project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApproval", "in": "query", "description": "Set to true to include approval information.", "schema": { "type": "boolean" } }, { "name": "expandNote", "in": "query", "description": "Set to true to include description.", "schema": { "type": "boolean" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "The status of the document", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string" } }, { "name": "expandLinePrebookAccounts", "in": "query", "description": "Expland line-level pre-booking account and sub-account information.", "schema": { "type": "boolean" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "financialPeriod", "in": "query", "description": "Filter by Financial Period, format YYYYPP", "schema": { "type": "string" } }, { "name": "dueDate", "in": "query", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "dueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "docDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "docDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "item", "in": "query", "description": "Filter by Item used into the document lines", "schema": { "type": "string" } }, { "name": "balance", "in": "query", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "number", "format": "double" } }, { "name": "balanceCondition", "in": "query", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierDocumentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierDocumentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/{supplierCd}/balance": { "get": { "tags": [ "Supplier" ], "summary": "Get a specific supplier's PO balance", "operationId": "Supplier_GetSupplierBalanceBysupplierCd", "parameters": [ { "name": "supplierCd", "in": "path", "description": "Indentifies the supplier for witch to return data", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierBalanceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierBalanceDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierBalanceDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierBalanceDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/{supplierCd}/POBalance": { "get": { "tags": [ "Supplier" ], "summary": "Get a specific supplier's PO balance", "operationId": "Supplier_GetSupplierPOBalanceBysupplierCd", "parameters": [ { "name": "supplierCd", "in": "path", "description": "Indentifies the supplier for witch to return data", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierPOBalanceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierPOBalanceDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierPOBalanceDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierPOBalanceDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplier/{supplierCd}/contact": { "get": { "tags": [ "Supplier" ], "summary": "Get a range of a Supplier of a specific supplier", "operationId": "Supplier_GetAllContactForSupplierBysupplierCd", "parameters": [ { "name": "supplierCd", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "displayName", "in": "query", "schema": { "type": "string" } }, { "name": "active", "in": "query", "schema": { "type": "string" } }, { "name": "firstName", "in": "query", "schema": { "type": "string" } }, { "name": "lastName", "in": "query", "schema": { "type": "string" } }, { "name": "businessAccount", "in": "query", "schema": { "type": "string" } }, { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplieraccount/{supplierId}": { "get": { "tags": [ "SupplierAccount" ], "summary": "Get expense accounts for a supplier", "operationId": "SupplierAccount_GetBysupplierId", "parameters": [ { "name": "supplierId", "in": "path", "description": "The id of the supplier", "required": true, "schema": { "type": "string" } }, { "name": "supplierItemId", "in": "query", "description": "The list of supplier itemIds to search the expense account for. If the list empty, then the general expense account for the specific supplier is returned", "style": "form", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "vatRegistrationId", "in": "query", "description": "The vat registration id of the supplier", "schema": { "type": "string" } }, { "name": "linesNonTaxable", "in": "query", "description": "Indicates if all lines are taxable or not. Default is false", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierAccountsDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierAccountsDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierdocument": { "get": { "tags": [ "SupplierDocument" ], "summary": "Gets a range of supplier documents - ScreenId=AP301000\r\nGet a range of Purchase Order - ScreenId=PO301000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nChange log:\r\n2020-May:Added forced pagination", "operationId": "SupplierDocument_GetAllDocumentsForSupplier", "parameters": [ { "name": "supplier", "in": "query", "description": "Filter by Supplier", "schema": { "type": "string" } }, { "name": "documentType", "in": "query", "description": "By type of document.", "schema": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "project", "in": "query", "description": "Filter by the project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApproval", "in": "query", "description": "Set to true to include approval information.", "schema": { "type": "boolean" } }, { "name": "expandNote", "in": "query", "description": "Set to true to include description.", "schema": { "type": "boolean" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "The status of the document", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string" } }, { "name": "expandLinePrebookAccounts", "in": "query", "description": "Expland line-level pre-booking account and sub-account information.", "schema": { "type": "boolean" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "financialPeriod", "in": "query", "description": "Filter by Financial Period, format YYYYPP", "schema": { "type": "string" } }, { "name": "dueDate", "in": "query", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "dueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "docDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "docDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "item", "in": "query", "description": "Filter by Item used into the document lines", "schema": { "type": "string" } }, { "name": "balance", "in": "query", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "number", "format": "double" } }, { "name": "balanceCondition", "in": "query", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierDocumentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierDocumentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{invoiceNumber}": { "get": { "tags": [ "SupplierInvoice" ], "summary": "GET a specific invoice. Only standard invoices are supported. Credit adjustments, credit notes or Prepayments are excluded.", "description": "Data for a single invoice.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "SupplierInvoice_GetByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the Invoice", "required": true, "schema": { "type": "string" } }, { "name": "expandLinePrebookAccounts", "in": "query", "description": "Expland line-level pre-booking account and sub-account information.", "schema": { "type": "boolean" } }, { "name": "expandLandedCosts", "in": "query", "description": "Expland landed costs information.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "SupplierInvoice" ], "summary": "Update a specific SupplierInvoice", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\nResponse Message has StatusCode BadRequest if PUT operation failed.

\r\nThe response headers include an ETag after a successful PUT operation.", "operationId": "SupplierInvoice_PutByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the SupplierInvoice to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Invoice to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } } }, "required": true, "x-bodyName": "supplierInvoice" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "SupplierInvoice" ], "summary": "Deletes a specific Supplier Invoice", "description": "Response Message has StatusCode NoContent if DELETE operation succeed", "operationId": "SupplierInvoice_DeleteByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the Supplier Invoice to delete", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{documentType}/{invoiceNumber}": { "get": { "tags": [ "SupplierInvoice" ], "summary": "Get a specific Invoice, DebitAdj, CreditAdj or Prepayment", "description": "Data for a single invoice.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "SupplierInvoice_GetByTypeBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "Identifies the Invoice", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Identifies the Invoice", "required": true, "schema": { "type": "string" } }, { "name": "expandLinePrebookAccounts", "in": "query", "description": "Expland line-level pre-booking account and sub-account information.", "schema": { "type": "boolean" } }, { "name": "expandLandedCosts", "in": "query", "description": "Expland landed costs information.", "schema": { "type": "boolean" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "SupplierInvoice" ], "summary": "Update a specific SupplierInvoice", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\nResponse Message has StatusCode BadRequest if PUT operation failed.

\r\nThe response headers include an ETag after a successful PUT operation.", "operationId": "SupplierInvoice_PutByTypeBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "Identifies the SupplierInvoice to update", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Identifies the SupplierInvoice to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Invoice to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } } }, "required": true, "x-bodyName": "supplierInvoice" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "delete": { "tags": [ "SupplierInvoice" ], "summary": "Deletes a specific Supplier Invoice", "description": "Response Message has StatusCode NoContent if DELETE operation succeed", "operationId": "SupplierInvoice_DeleteBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "Identifies the docType of Supplier Invoice to delete", "required": true, "schema": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Identifies the Supplier Invoice to delete", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice": { "get": { "tags": [ "SupplierInvoice" ], "summary": "Get a range of Invoices - ScreenId=AP301000. \r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "SupplierInvoice_GetAllInvoices", "parameters": [ { "name": "supplier", "in": "query", "description": "Filter by Supplier", "schema": { "type": "string" } }, { "name": "expandAttachment", "in": "query", "description": "Set to true if you want to see all attachments regarding this document.", "schema": { "type": "boolean" } }, { "name": "expandLandedCosts", "in": "query", "description": "Expland landed cost lines", "schema": { "type": "boolean" } }, { "name": "documentType", "in": "query", "description": "By type of document.", "schema": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string" } }, { "name": "released", "in": "query", "description": "Parameter for showing if invoice has been released or not.", "schema": { "type": "integer", "format": "int32" } }, { "name": "project", "in": "query", "description": "Filter by the project with which the document is associated.", "schema": { "type": "string" } }, { "name": "expandApproval", "in": "query", "description": "Set to true to include approval information.", "schema": { "type": "boolean" } }, { "name": "expandNote", "in": "query", "description": "Set to true to include description.", "schema": { "type": "boolean" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "The status of the document", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string" } }, { "name": "expandLinePrebookAccounts", "in": "query", "description": "Expland line-level pre-booking account and sub-account information.", "schema": { "type": "boolean" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "financialPeriod", "in": "query", "description": "Filter by Financial Period, format YYYYPP", "schema": { "type": "string" } }, { "name": "dueDate", "in": "query", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "dueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "docDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "docDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "item", "in": "query", "description": "Filter by Item used into the document lines", "schema": { "type": "string" } }, { "name": "balance", "in": "query", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "number", "format": "double" } }, { "name": "balanceCondition", "in": "query", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierInvoiceDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierInvoiceDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "SupplierInvoice" ], "summary": "Create an SupplierInvoice", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "SupplierInvoice_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the SupplierInvoice to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceUpdateDto" } } }, "required": true, "x-bodyName": "supplierInvoice" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/approval": { "get": { "tags": [ "SupplierInvoice" ], "summary": "Get an invoice based on the systemId. SystemID is used for approving supplier invoices", "description": "Data for a single invoice.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "SupplierInvoice_GetByApprovalDocumentId", "parameters": [ { "name": "systemId", "in": "query", "description": "SystemID referes to the approval document id created when the document is sent to approval", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierInvoiceDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{invoiceNumber}/action/release": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Release invoice operation", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "SupplierInvoice_ReleaseInvoiceByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Reference number of the document to be release", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{invoiceNumber}/action/correct": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Correct invoice operation", "description": "The response headers include an ETag after a successful POST operation.", "operationId": "SupplierInvoice_CorrectInvoiceByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Reference number of the document to be corrected", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/reverse": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Provides an action for reversing a supplier invoice/adjustment", "description": "The response headers include an ETag after a successful POST operation.", "operationId": "SupplierInvoice_ReverseInvoiceBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "Identifies the Invoice", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Identifies the Invoice", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/sendtoapproval": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Send invoice to approval", "description": "In this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "SupplierInvoice_SendToApprovalBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "Document type", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Document number", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/release": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Release invoice operation", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "SupplierInvoice_ReleaseInvoiceByTypeBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "Document type of the released document to be reversed", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Reference number of the document to be release", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/prebook": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Pre-Book invoice operation", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "SupplierInvoice_PrebookInvoiceBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "Document type of the document to be Pre-Booked", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Reference number of the document to be Pre-Booked", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Optional dto for updating the prebooking account and subaccount", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PrebookingUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PrebookingUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PrebookingUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PrebookingUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/PrebookingUpdateDto" } } }, "required": true, "x-bodyName": "prebookingUpdateDto" }, "responses": { "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/voidinvoice": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Void invoice operation", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "SupplierInvoice_VoidInvoiceBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "Document type of the document to be Voided", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Reference number of the document to be Voided", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{documentType}/{invoiceNumber}/action/writeoff": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Write-off invoice operation", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "SupplierInvoice_WriteoffInvoiceBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "Document type of the document to be Written Off", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Reference number of the document to be Written Off", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } }, "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{invoiceNumber}/attachment": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Creates an attachment and associates it with a supplier invoice. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "SupplierInvoice_CreateHeaderAttachmentByinvoiceNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the supplier invoice", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/{invoiceNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Creates an attachment and associates it with a certain supplier invoice line. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "SupplierInvoice_CreateLineAttachmentByinvoiceNumberlineNumber", "parameters": [ { "name": "invoiceNumber", "in": "path", "description": "Identifies the supplier invoice", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Specifies line number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/documentType/{documentType}/{invoiceNumber}/attachment": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Creates an attachment and associates it with a supplier invoice. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "SupplierInvoice_CreateHeaderAttachmentByTypeBydocumentTypeinvoiceNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Identifies the supplier invoice", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierInvoice/documentType/{documentType}/{invoiceNumber}/{lineNumber}/attachment": { "post": { "tags": [ "SupplierInvoice" ], "summary": "Creates an attachment and associates it with a certain supplier invoice line. If the file already exists, a new revision is created.", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "SupplierInvoice_CreateLineAttachmentByTypeBydocumentTypeinvoiceNumberlineNumber", "parameters": [ { "name": "documentType", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "invoiceNumber", "in": "path", "description": "Identifies the supplier invoice", "required": true, "schema": { "type": "string" } }, { "name": "lineNumber", "in": "path", "description": "Identifies the supplier invoice line", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Supplier invoice version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierlocation/{bAccountId}/{locationId}": { "get": { "tags": [ "SupplierLocation" ], "summary": "Get a specific Location of a Baccount", "description": "Data for a single supplier location.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "SupplierLocation_GetLocationBybAccountIdlocationId", "parameters": [ { "name": "bAccountId", "in": "path", "description": "Identifies the BAccount", "required": true, "schema": { "type": "string" } }, { "name": "locationId", "in": "path", "description": "Identifies the Location", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierLocationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierLocationDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "SupplierLocation" ], "summary": "Update a specific Location", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\nResponse Message has StatusCode BadRequest if PUT operation failed.

\r\nThe response headers include an ETag after a successful PUT operation.", "operationId": "SupplierLocation_UpdateBybAccountIdlocationId", "parameters": [ { "name": "bAccountId", "in": "path", "description": "Identifies the BAccount", "required": true, "schema": { "type": "string" } }, { "name": "locationId", "in": "path", "description": "Identifies the Location", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update for the Location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } } }, "required": true, "x-bodyName": "location" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Supplier location version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierlocation/{bAccountId}": { "get": { "tags": [ "SupplierLocation" ], "summary": "Get a range of Locations for a BAccount\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "description": "Data for the Locations", "operationId": "SupplierLocation_GetLocationsForBaccountBybAccountId", "parameters": [ { "name": "bAccountId", "in": "path", "description": "Identifies the BAccount", "required": true, "schema": { "type": "string" } }, { "name": "locationId", "in": "query", "schema": { "type": "string" } }, { "name": "gln", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierLocationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierLocationDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierlocation": { "get": { "tags": [ "SupplierLocation" ], "summary": "Get a range of Locations - List screen=AP3030P1, Entry screen=AP303010\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "description": "Data for the Locations", "operationId": "SupplierLocation_GetLocations", "parameters": [ { "name": "locationId", "in": "query", "schema": { "type": "string" } }, { "name": "gln", "in": "query", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierLocationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierLocationDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "SupplierLocation" ], "summary": "Create a Location", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "SupplierLocation_Create", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Location to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SupplierLocationUpdateDto" } } }, "required": true, "x-bodyName": "location" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierPayment/{paymentNumber}": { "get": { "tags": [ "SupplierPayment" ], "summary": "Get a specific SupplierPayment", "description": "Data for a single supplier payment.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "SupplierPayment_GetBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Identifies the SupplierPayment", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierPaymentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierPaymentDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "SupplierPayment" ], "summary": "Update a specific SupplierPayment", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\nResponse Message has StatusCode BadRequest if PUT operation failed.

\r\nThe response headers include an ETag after a successful PUT operation.", "operationId": "SupplierPayment_PutBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Identifies the Payment to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the Payment to update", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } } }, "required": true, "x-bodyName": "payment" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Supplier payment version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierPayment/{paymentType}/{paymentNumber}": { "get": { "tags": [ "SupplierPayment" ], "summary": "Get a specific SupplierPayment by type and number", "description": "Data for a single supplier payment.

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "SupplierPayment_GetByTypeBypaymentTypepaymentNumber", "parameters": [ { "name": "paymentType", "in": "path", "description": "Identifies the Supplier document type", "required": true, "schema": { "type": "string" } }, { "name": "paymentNumber", "in": "path", "description": "Identifies the Supplier document number", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierPaymentDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierPaymentDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierPayment": { "get": { "tags": [ "SupplierPayment" ], "summary": "Get all SupplierPayments.\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size\r\nScreenId=AP302000", "operationId": "SupplierPayment_GetAllPayments", "parameters": [ { "name": "invoiceRefNbr", "in": "query", "schema": { "type": "string" } }, { "name": "paymentType", "in": "query", "description": "The top part > Type >The type of supplier ledger payment document. The following types are available: Payment, PUrchase credit note, Prepayment, Supplier refund, Voided payment.", "schema": { "enum": [ "Payment", "DebitAdj", "Prepayment", "Refund", "VoidPayment", "VoidRefund" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Enter the from-value for Ref. no.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "supplier", "in": "query", "description": "Filter by Supplier", "schema": { "type": "string" } }, { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "docDate", "in": "query", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "docDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "dueDate", "in": "query", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "schema": { "type": "string", "format": "date-time" } }, { "name": "dueDateCondition", "in": "query", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "financialPeriod", "in": "query", "description": "Filter by financial period, format YYYYPP", "schema": { "type": "string" } }, { "name": "balance", "in": "query", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "number", "format": "double" } }, { "name": "balanceCondition", "in": "query", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Filter by document status", "schema": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "PendingApproval", "Rejected", "Reserved", "PendingPrint" ], "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPaymentDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPaymentDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "SupplierPayment" ], "summary": "Create a SupplierPayment", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nThe response headers include an ETag after a successful POST operation.", "operationId": "SupplierPayment_CreateSupplierPayment", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the SupplierPayment to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/SupplierPaymentUpdateDto" } } }, "required": true, "x-bodyName": "payment" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierPayment/{paymentNumber}/action/release": { "post": { "tags": [ "SupplierPayment" ], "summary": "Release payment operation", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "SupplierPayment_ReleasePaymentBypaymentNumber", "parameters": [ { "name": "paymentNumber", "in": "path", "description": "Reference number of the payment to be released", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "Contains the type of the payment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReleaseSupplierPaymentActionDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ReleaseSupplierPaymentActionDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/ReleaseSupplierPaymentActionDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/ReleaseSupplierPaymentActionDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/ReleaseSupplierPaymentActionDto" } } }, "required": true, "x-bodyName": "releaseActionDto" }, "responses": { "412": { "description": "Supplier payment version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/supplierPayment/{paymentType}/{paymentNumber}/action/writeoff": { "post": { "tags": [ "SupplierPayment" ], "summary": "Write-off payment operation", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "SupplierPayment_WriteoffPaymentBypaymentTypepaymentNumber", "parameters": [ { "name": "paymentType", "in": "path", "description": "The type of the payment to be written off", "required": true, "schema": { "type": "string" } }, { "name": "paymentNumber", "in": "path", "description": "Reference number of the payment to be written off", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Operation accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteoffPaymentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WriteoffPaymentActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WriteoffPaymentActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/WriteoffPaymentActionResultDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WriteoffPaymentActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WriteoffPaymentActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WriteoffPaymentActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/WriteoffPaymentActionResultDto" } } } }, "412": { "description": "Supplier payment version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v2/supplier/balance": { "get": { "tags": [ "SupplierV2" ], "summary": "Get the balance for one or multiple suppliers", "operationId": "SupplierV2_GetAllSupplierBalance", "parameters": [ { "name": "branch", "in": "query", "description": "Filter by Branch", "schema": { "type": "string" } }, { "name": "supplier", "in": "query", "description": "Filter by Supplier", "schema": { "type": "string" } }, { "name": "fromFinPeriod", "in": "query", "description": "Filter from financial period, format YYYYPP\r\nThe filte is inclusive, the records for the specified period will be included in the results.\r\nThis filter is required.", "required": true, "schema": { "type": "string" } }, { "name": "toFinPeriod", "in": "query", "description": "Filter to financial period, format YYYYPP\r\nThe filte is inclusive, the records for the specified period will be included in the results.\r\nThis filter is required.", "required": true, "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierBalanceV2Dto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierBalanceV2Dto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierBalanceV2Dto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierBalanceV2Dto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/timeCard/{referenceNumber}": { "get": { "tags": [ "TimeCard" ], "summary": "Get a specific employee time card", "description": "Data for a single employee time card

\r\nThe response headers include an ETag after a successful GET operation.", "operationId": "TimeCard_GetEmployeeTimeCardByreferenceNumber", "parameters": [ { "name": "referenceNumber", "in": "path", "description": "Identifies the time card", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeCardDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TimeCardDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "put": { "tags": [ "TimeCard" ], "summary": "Updates a specific time card", "description": "Response Message has StatusCode NoContent if PUT operation succeed.

\r\n Response Message has StatusCode BadRequest if PUT operation failed.

\r\n The response headers include an ETag after a successful PUT operation.", "operationId": "TimeCard_UpdateTimeCardByreferenceNumber", "parameters": [ { "name": "referenceNumber", "in": "path", "description": "Identifies the time card to update", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "requestBody": { "description": "The data to update the time card with", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeCardUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TimeCardUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TimeCardUpdateDto" } } }, "required": true, "x-bodyName": "timeCardUpdateDto" }, "responses": { "204": { "description": "NoContent", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "412": { "description": "Timecard version does not match with If-Match header", "content": { "application/json": { }, "text/json": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/timeCard": { "get": { "tags": [ "TimeCard" ], "summary": "Get all employee time cards, a filter needs to be specified - ScreenId=EP305000", "operationId": "TimeCard_GetAllEmployeeTimeCards", "parameters": [ { "name": "status", "in": "query", "description": "The status of the document.", "schema": { "enum": [ "Hold", "Open", "Approved", "Rejected", "Released" ], "type": "string" } }, { "name": "week", "in": "query", "description": "Identifies the week number of the time card", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Identifies the type of the time card (Normal, Corrected, NormalCorrected)", "schema": { "enum": [ "Normal", "Correction", "NormalCorrected" ], "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater-than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "orderBy", "in": "query", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "employeeCd", "in": "query", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeCardDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeCardDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] }, "post": { "tags": [ "TimeCard" ], "summary": "Creates a time card", "description": "Response Message has StatusCode Created if POST operation succeed.

\r\n Response Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\n The response headers include an ETag after a successful POST operation.", "operationId": "TimeCard_CreateTimeCard", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the data for the time card to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeCardUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TimeCardUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/TimeCardUpdateDto" } } }, "required": true, "x-bodyName": "timeCardUpdateDto" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/timeCard/{timeCardCd}/action/submit": { "post": { "tags": [ "TimeCard" ], "summary": "Submit time card operation", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can also be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "TimeCard_SubmitTimeCardBytimeCardCd", "parameters": [ { "name": "timeCardCd", "in": "path", "description": "Reference number of the time card to be submitted", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitTimeCardActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SubmitTimeCardActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SubmitTimeCardActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SubmitTimeCardActionResultDto" } } } }, "412": { "description": "Timecard version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/timeCard/{timeCardCd}/action/approval": { "post": { "tags": [ "TimeCard" ], "summary": "Send time card to approval", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can also be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "TimeCard_SendTimeCardToApprovalBytimeCardCd", "parameters": [ { "name": "timeCardCd", "in": "path", "description": "Reference number of the time card to be sent to approval", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendTimeCardToApprovalActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendTimeCardToApprovalActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/SendTimeCardToApprovalActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/SendTimeCardToApprovalActionResultDto" } } } }, "412": { "description": "Timecard version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/timeCard/{timeCardCd}/action/hold": { "post": { "tags": [ "TimeCard" ], "summary": "Put timecard on hold", "description": "The action result dto contains information about the result of running the action.

\r\nResponse Message has StatusCode BadRequest or InternalServerError if POST operation failed.

\r\nIn this endpoint, If-Match can also be checked against resource current version when calling with 'erp-api-background' HTTP header.", "operationId": "TimeCard_PutTimeCardOnHoldBytimeCardCd", "parameters": [ { "name": "timeCardCd", "in": "path", "description": "Reference number of the time card to be put on hold", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } }, { "name": "If-Match", "in": "header", "description": "The If-Match HTTP header allows clients to update a resource only if its current version matches a specific ETag. This mechanism helps prevent conflicts when multiple clients attempt to modify the same resource simultaneously.\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\n* If the ETag on the server does not match the value provided in the If-Match header, the server responds with 412 Precondition Failed.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PutTimeCardOnHoldActionResultDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PutTimeCardOnHoldActionResultDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/PutTimeCardOnHoldActionResultDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/PutTimeCardOnHoldActionResultDto" } } } }, "412": { "description": "Timecard version version does not match with If-Match header", "content": { "application/json": { }, "text/json": { }, "application/xml": { }, "text/xml": { } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/uiExtension/availableScreens": { "get": { "tags": [ "UiExtension" ], "summary": "Returns the list of available screenIds and their stepIds for Ui Extensions", "operationId": "UiExtension_GetAllUiExtensions", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UiExtensionScreenDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UiExtensionScreenDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UiExtensionScreenDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UiExtensionScreenDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/uiExtension/{ownerId}": { "get": { "tags": [ "UiExtension" ], "summary": "Returns the list of all Ui Extensions for current owner - ScreenId=SM205002", "operationId": "UiExtension_GetAllUiExtensionsByownerId", "parameters": [ { "name": "ownerId", "in": "path", "description": "", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "screenId", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "enum": [ "Action", "Menu" ], "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UiExtensionDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UiExtensionDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UiExtensionDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UiExtensionDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/uiExtension": { "post": { "tags": [ "UiExtension" ], "summary": "Create Ui Extension", "description": "Response Message has StatusCode Ok if POST operation succeed", "operationId": "UiExtension_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UiExtensionUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UiExtensionUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/UiExtensionUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/UiExtensionUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UiExtensionUpdateDto" } } }, "required": true, "x-bodyName": "uiExtension" }, "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/uiExtension/{ownerId}/{internalId}": { "delete": { "tags": [ "UiExtension" ], "summary": "Delete Menu Ui Extension", "description": "Response Message has StatusCode Ok if DELETE operation succeed", "operationId": "UiExtension_DeleteByownerIdinternalId", "parameters": [ { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "internalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/uiExtension/{ownerId}/{internalId}/{screenId}/{stepId}": { "delete": { "tags": [ "UiExtension" ], "summary": "Delete Action Ui Extension", "description": "Response Message has StatusCode Ok if DELETE operation succeed", "operationId": "UiExtension_DeleteByownerIdinternalIdscreenIdstepId", "parameters": [ { "name": "ownerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "internalId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "screenId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "stepId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ok", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/unitofmeasure": { "get": { "tags": [ "UnitOfMeasure" ], "summary": "Get a range of Units of Measure - ScreenId=CS203100", "operationId": "UnitOfMeasure_GetAllUnitsOfMeasure", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOfMeasureDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOfMeasureDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOfMeasureDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/UnitOfMeasureDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/vat/{vatId}": { "get": { "tags": [ "Vat" ], "summary": "Get a specific Vat - TX205000", "operationId": "Vat_GetVatByvatId", "parameters": [ { "name": "vatId", "in": "path", "description": "Mandatory. Value for VatID to be looked for.", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VatInformationDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VatInformationDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/vat": { "get": { "tags": [ "Vat" ], "summary": "Get a range of Vats - ScreenId=TX205000", "operationId": "Vat_GetAllVats", "parameters": [ { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatInformationDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatInformationDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/vat/{vendorCd}/{taxPeriodId}/{revisionId}": { "put": { "tags": [ "Vat" ], "summary": "Update vat header note.", "operationId": "Vat_PutVatHeaderNoteByvendorCdtaxPeriodIdrevisionId", "parameters": [ { "name": "vendorCd", "in": "path", "description": "Identifies the tax agency.", "required": true, "schema": { "type": "string" } }, { "name": "taxPeriodId", "in": "path", "description": "Identifies the tax period.", "required": true, "schema": { "type": "string" } }, { "name": "revisionId", "in": "path", "description": "Identifies the tax revision.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Defines the note for the vat header to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } } }, "required": true, "x-bodyName": "noteDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/vat/{vendorCd}/{taxPeriodId}/{revisionId}/{lineNumber}": { "put": { "tags": [ "Vat" ], "summary": "", "operationId": "Vat_PutVatLineNoteByvendorCdtaxPeriodIdrevisionIdlineNumber", "parameters": [ { "name": "vendorCd", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "taxPeriodId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "revisionId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lineNumber", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/UpdateNoteDto" } } }, "required": true, "x-bodyName": "noteDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/vatCategory/{taxCategoryId}": { "get": { "tags": [ "VatCategory" ], "summary": "Get a specific VatCategory", "operationId": "VatCategory_GetVatCategoryBytaxCategoryId", "parameters": [ { "name": "taxCategoryId", "in": "path", "description": "Identifies the VatCategory", "required": true, "schema": { "type": "string" } }, { "name": "vendorCd", "in": "query", "description": "Optional vendor number (tax agency) parameter", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VatCategoryDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VatCategoryDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/VatCategoryDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/VatCategoryDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/vatCategory": { "get": { "tags": [ "VatCategory" ], "summary": "Get a range of VatCategories - ScreenId=TX205500", "operationId": "VatCategory_GetAllVatCategories", "parameters": [ { "name": "vendorCd", "in": "query", "description": "The vendor number associated with the VAT category line.", "schema": { "type": "string" } }, { "name": "greaterThanValue", "in": "query", "description": "Greater than value. The item which is the object for this, varies from API to API.", "schema": { "type": "string" } }, { "name": "numberToRead", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "skipRecords", "in": "query", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModifiedDateTime", "in": "query", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "lastModifiedDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTime", "in": "query", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "createdDateTimeCondition", "in": "query", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__.", "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatCategoryDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatCategoryDto" } } }, "application/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatCategoryDto" } } }, "text/xml": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatCategoryDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/vatZone/{vatZoneId}": { "get": { "tags": [ "VatZone" ], "summary": "Get a specific Vat Zone", "operationId": "VatZone_GetVatZoneByvatZoneId", "parameters": [ { "name": "vatZoneId", "in": "path", "description": "Identifies the Vat Zone", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VatZoneDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/VatZoneDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/vatZone": { "get": { "tags": [ "VatZone" ], "summary": "Get Tax Zones - ScreenId=TX206000\r\nRequest page size must be lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size", "operationId": "VatZone_GetVatZones", "parameters": [ { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatZoneDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/VatZoneDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/warehouse/{warehouseID}": { "get": { "tags": [ "Warehouse" ], "summary": "Get a specific Warehouse", "operationId": "Warehouse_GetBywarehouseID", "parameters": [ { "name": "warehouseID", "in": "path", "description": "Identifies the Warehouse", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehouseDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WarehouseDto" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/warehouse": { "get": { "tags": [ "Warehouse" ], "summary": "Get a range of Warehouses - ScreenId=IN204000", "operationId": "Warehouse_GetAll", "parameters": [ { "name": "active", "in": "query", "description": "Selects only the warehouses that are active/inactive.", "schema": { "type": "boolean" } }, { "name": "branch", "in": "query", "description": "Selects only the warehouses for the specified branch.", "schema": { "type": "string" } }, { "name": "pageNumber", "in": "query", "description": "Pagination parameter. Page number.", "schema": { "type": "integer", "format": "int32" } }, { "name": "pageSize", "in": "query", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "schema": { "type": "integer", "format": "int32" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseDto" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseDto" } } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/warehouse/{warehouseID}/location": { "post": { "tags": [ "Warehouse" ], "summary": "Post new location - ScreenId=IN204000", "operationId": "Warehouse_PostBywarehouseID", "parameters": [ { "name": "warehouseID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } } }, "required": true, "x-bodyName": "locationDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/warehouse/{warehouseID}/location/{locationID}": { "put": { "tags": [ "Warehouse" ], "summary": "Update location - ScreenId=IN204000", "operationId": "Warehouse_PutBywarehouseIDlocationID", "parameters": [ { "name": "warehouseID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "locationID", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WarehouseLocationUpdateDto" } } }, "required": true, "x-bodyName": "locationDto" }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } }, "/v1/webhooknotificationfeedback": { "post": { "tags": [ "WebhookNotificationFeedback" ], "summary": "Creates/Inserts a WebhookNotificationFeedback", "description": "Response Message has StatusCode Created if POST operation succeed", "operationId": "WebhookNotificationFeedback_Post", "parameters": [ { "name": "erp-api-background", "in": "header", "description": "Accepts the request and queues it to be executed in the background by our least busy worker. Responds with 202 Accepted and a document containing a JobId reference and details state location.\nSupported values:\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\n\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response payload of a background-api operation, if any, GET .. v1/background/{id}/content", "schema": { "type": "string" } } ], "requestBody": { "description": "Define the data for the WebhookNotificationFeedback to create", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookNotificationFeedbackDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WebhookNotificationFeedbackDto" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/WebhookNotificationFeedbackDto" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/WebhookNotificationFeedbackDto" } }, "application/x-www-form-urlencoded": { "schema": { "$ref": "#/components/schemas/WebhookNotificationFeedbackDto" } } }, "required": true, "x-bodyName": "webhookNotificationFeedback" }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object" } }, "text/json": { "schema": { "type": "object" } } } }, "202": { "description": "Server accepted and queued the request for background execution.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } }, "text/json": { "schema": { "$ref": "#/components/schemas/BackgroundApiAcceptedDto" } } } } }, "security": [ { "serviceapi": [ ] } ] } } }, "components": { "schemas": { "MetadataDto": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" }, "maxPageSize": { "type": "integer", "format": "int64" } } }, "ExternalCodeNumberDescriptionDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "externalCode1InfoInAccountDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Table SigmaExternalCodes1 > The information row connected through the ExternalCode1" }, "externalCode2InfoInAccountDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Table SigmaExternalCodes2 > The information row connected through the ExternalCode2" }, "analisysCodeInfoInAccountDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Table SigmaBIAnalysisCodes > The information row connected through the AnalysisCode" }, "AccountDto": { "type": "object", "properties": { "accountID": { "type": "integer", "description": "The table > AccountID > The Account ID is the actual ID that the account have in the database and are used in other tables as the relation between the Chart of accounts table and other tables.", "format": "int32" }, "accountCD": { "type": "string", "description": "Mandatory field: The table > Account* > The unique identifier of the general ledger account in the system." }, "accountGroupCD": { "type": "string", "description": "The table > Account group > The account group (used in project management if the Projects module has been activated) that includes this account." }, "accountClass": { "type": "string", "description": "The table > Account class > Optional. The account class to which the account is assigned." }, "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "The table > Type > The type of account: Asset, Liability, Income, or Expense." }, "active": { "type": "boolean", "description": "The table > Active > A check box that indicates that the account is active." }, "description": { "type": "string", "description": "The table > Description > An alphanumeric string of up to 30 characters that describes the account." }, "accountClassDescription": { "type": "string", "description": "The table > Desc > An alphanumeric string of up to 30 characters that describes the AccountClass." }, "useDefaultSub": { "type": "boolean", "description": "The table > Use default sub > A check box that causes the system (if selected) to set the default subaccount as the Subaccount if the account is selected." }, "postOption": { "type": "string", "description": "The table > Post option > An option that defines how transactions created in other workspaces are posted to this account. Summary (default) or Detail." }, "currency": { "type": "string", "description": "The table > Currency > Optional: This column appears only if support for multiple currencies has been activated for the system." }, "taxCategory": { "type": "string", "description": "The table > VAT category > A tax category that you define for the selected account. When you create a journal transaction manually in the GL301000 window, based on this VAT category, the taxable amount will be calculated for the journal entry." }, "cashAccount": { "type": "boolean", "description": "The table > Cash account > A check box that indicates (if selected) that the account has a cash account or multiple cash accounts linked to it." }, "publicCode1": { "type": "string", "description": "The table > Public code 1 > The authorities valid code mapped to the account. Used for example in SAF-T and in some nationals reporting to the authorities." }, "lastModifiedDateTime": { "type": "string", "description": "This information is not visible in the window. It is collected from the system.", "format": "date-time" }, "externalCode1Info": { "$ref": "#/components/schemas/externalCode1InfoInAccountDto" }, "externalCode2Info": { "$ref": "#/components/schemas/externalCode2InfoInAccountDto" }, "analisysCodeInfo": { "$ref": "#/components/schemas/analisysCodeInfoInAccountDto" }, "controlAccountModule": { "type": "string" }, "allowManualEntry": { "type": "boolean" }, "timeStamp": { "type": "string", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "BackgroundApiAcceptedDto": { "type": "object", "properties": { "id": { "type": "string" }, "stateLocation": { "type": "string" } } }, "DtoValueOfAccountTypes": { "type": "object", "properties": { "value": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string" } } }, "DtoValueOfBoolean": { "type": "object", "properties": { "value": { "type": "boolean" } } }, "DtoValueOfString": { "type": "object", "properties": { "value": { "type": "string" } } }, "AccountUpdateDto": { "type": "object", "properties": { "accountCD": { "$ref": "#/components/schemas/DtoValueOfString" }, "active": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "accountClass": { "$ref": "#/components/schemas/DtoValueOfString" }, "analysisCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "extenalCode1": { "$ref": "#/components/schemas/DtoValueOfString" }, "externalCode2": { "$ref": "#/components/schemas/DtoValueOfString" }, "accountGroupCD": { "$ref": "#/components/schemas/DtoValueOfString" }, "postOption": { "$ref": "#/components/schemas/DtoValueOfString" }, "publicCode1": { "$ref": "#/components/schemas/DtoValueOfString" }, "type": { "$ref": "#/components/schemas/DtoValueOfAccountTypes" }, "useDefaultSub": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "taxCategory": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "AccountQueryParameters": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Set to True to select active accounts." }, "includeAccountClassDescription": { "type": "boolean", "description": "Set to True to include AccountClass description." }, "greaterThanValue": { "type": "string", "description": "Enter the from-value for Account no." }, "publicCode": { "type": "string", "description": "Filter by the Public code 1, authorities mapped code to the account." }, "externalCode1": { "type": "string", "description": "Filter by External code 1 (field used for sorting and inquiries.)" }, "externalCode2": { "type": "string", "description": "Filter by External code 2 (field used for sorting and inquiries.)" }, "analysisCode": { "type": "string", "description": "Filter by Analysis code (field used for sorting and inquiries.)" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." } } }, "AttachmentMetadataUpdateDto": { "type": "object", "properties": { "sendToAutoinvoice": { "type": "object", "properties": { "value": { "type": "boolean" } }, "description": "The field SendToAutoinvoice only applies to files attached to Customer documents" } } }, "AttributeDetailDto": { "type": "object", "properties": { "valueId": { "type": "string" }, "description": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32" }, "disabled": { "type": "boolean" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "AttributeDto": { "type": "object", "properties": { "attributeID": { "type": "string" }, "description": { "type": "string" }, "controlType": { "enum": [ "Text", "Combo", "MultiSelectCombo", "Lookup", "Checkbox", "Datetime" ], "type": "string" }, "internal": { "type": "boolean" }, "entryMask": { "type": "string" }, "regExp": { "type": "string" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeDetailDto" } }, "createdDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents an attribute in AttributeController. Used for getting data." }, "DtoValueOfNullableOfInt16": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "AttributeDetailUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "valueId": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "sortOrder": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt16" }, "disabled": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" } } }, "DtoValueOfAttributeControlType": { "type": "object", "properties": { "value": { "enum": [ "Text", "Combo", "MultiSelectCombo", "Lookup", "Checkbox", "Datetime" ], "type": "string" } } }, "DtoValueOfNullableOfBoolean": { "type": "object", "properties": { "value": { "type": "boolean" } } }, "AttributeUpdateDto": { "type": "object", "properties": { "attributeID": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "internal": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "controlType": { "$ref": "#/components/schemas/DtoValueOfAttributeControlType" }, "entryMask": { "$ref": "#/components/schemas/DtoValueOfString" }, "regExp": { "$ref": "#/components/schemas/DtoValueOfString" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeDetailUpdateDto" } } } }, "AttributeQueryParameters": { "type": "object", "properties": { "attributeID": { "type": "string" }, "controlType": { "type": "string" }, "internal": { "type": "boolean" }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "BackgroundRequestStateDto": { "type": "object", "properties": { "id": { "type": "string", "description": "\r\nIdentifies a started background API operation" }, "status": { "type": "string", "description": "\r\nCurrent status of a background API operation. Possible values are 'Started', 'Finished' and 'Failed'." }, "statusCode": { "type": "integer", "description": "\r\nThe Http Status Code of the finished background API operation. Value is 0 when operation is not done.", "format": "int32" }, "receivedUtc": { "type": "string", "description": "\r\nTime when background API operation was requested", "format": "date-time" }, "startedUtc": { "type": "string", "description": "\r\nTime when processing of background API operation was started", "format": "date-time" }, "finishedUtc": { "type": "string", "description": "\r\nTime when background API operation was finished processing", "format": "date-time" }, "webhookAddress": { "type": "string", "description": "\r\nThe webhook uri used to notify when background API operation is finished, or 'none' if no notification is configured" }, "errorMessage": { "type": "string", "description": "\r\nAny error message during processing of background API operation request. Note that any error response from the actual endpoint can be obtained by calling the ContentLocation address from the webhook notifaction response or the background state document." }, "reference": { "type": "string" }, "originalUri": { "type": "string", "description": "\r\nThe endpoint that was requested to be processed as a background API operation." }, "hasResponseContent": { "type": "boolean", "description": "\r\nIndicates whether or not the background API operation ended with a response content. Value is updated only when background API operation is finished." }, "hasRequestContent": { "type": "boolean", "description": "\r\nIndicates whether or not the background API operation request has a request content." }, "contentLocation": { "type": "string", "description": "\r\nThe uri from where the client can get the response from the background API operation, if any is available.", "readOnly": true }, "responseHeaders": { "type": "object", "additionalProperties": { "type": "string" }, "description": "\r\nAny response headers from the finished background API operation." } } }, "Stream": { "type": "object", "properties": { "canRead": { "type": "boolean", "readOnly": true }, "canSeek": { "type": "boolean", "readOnly": true }, "canTimeout": { "type": "boolean", "readOnly": true }, "canWrite": { "type": "boolean", "readOnly": true }, "length": { "type": "integer", "format": "int64", "readOnly": true }, "position": { "type": "integer", "format": "int64" }, "readTimeout": { "type": "integer", "format": "int32" }, "writeTimeout": { "type": "integer", "format": "int32" } } }, "BlobMetadata": { "type": "object", "properties": { "blobId": { "type": "string", "format": "uuid" }, "blobName": { "type": "string" }, "contentType": { "type": "string" }, "mD5Hash": { "type": "string" }, "fileChecksum": { "type": "string" }, "size": { "type": "integer", "format": "int64" }, "countryCode": { "type": "string" }, "createdDateTimeUtc": { "type": "string", "format": "date-time" } } }, "PresignedUrlResponse": { "type": "object", "properties": { "preSignedUrl": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/BlobMetadata" } } }, "BranchByIdQueryParameters": { "type": "object", "properties": { "expandAddress": { "type": "boolean", "description": "True to get main address for branch." }, "expandContact": { "type": "boolean", "description": "True to get main contact for a branch." }, "expandCurrency": { "type": "boolean", "description": "True to get base currency for a branch." }, "expandVatZone": { "type": "boolean", "description": "True to get vat zone for a branch." }, "expandLedger": { "type": "boolean", "description": "True to get ledger for a branch." }, "expandIndustryCode": { "type": "boolean", "description": "True to get industry code for a branch." }, "expandDeliveryAddress": { "type": "boolean", "description": "True to get delivery address for a branch." }, "expandDeliveryContact": { "type": "boolean", "description": "True to get delivery contact for a branch." }, "expandDefaultCountry": { "type": "boolean", "description": "True to get default country for a branch." }, "expandBankSettings": { "type": "boolean", "description": "True to get payment settings for Branch." } } }, "CountyDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } } }, "BankSettingsDto": { "type": "object", "properties": { "bankName": { "type": "string", "description": "Bank name" }, "bankAddress1": { "type": "string", "description": "Bank address1" }, "bankAddress2": { "type": "string", "description": "BankAddress2" }, "bankAddress3": { "type": "string", "description": "BankAddress3" }, "bankCountry": { "type": "string", "description": "BankCountry" }, "iban": { "type": "string", "description": "IBAN" }, "bban": { "type": "string", "description": "BBAN" }, "bbaN2": { "type": "string", "description": "BBAN2" }, "bbaN3": { "type": "string", "description": "BBAN3" }, "bic": { "type": "string", "description": "BIC" }, "creditorId": { "type": "string", "description": "CreditorId" } }, "description": "" }, "LedgerDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "VatZoneIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "BranchCurrencyDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Currency Id." }, "description": { "type": "string", "description": "Currency description." }, "symbol": { "type": "string", "description": "Currency symbol." } }, "description": "Currency info for branch." }, "IndustryCodeDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "CountryDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166." }, "name": { "type": "string", "description": "Mandatory field: Country name* > The complete name of the country." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "ContactInfoDto": { "type": "object", "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } } }, "countryInAddressDto": { "properties": { "id": { "type": "string", "description": "Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166." }, "name": { "type": "string", "description": "Mandatory field: Country name* > The complete name of the country." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Country > The country." }, "countyInAddressDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "County > The county or province." }, "AddressDto": { "type": "object", "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } } }, "mainAddressInBranchDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "The Organisation details tab > The Main address section >" }, "mainContactInBranchDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "The Organisation details tab > The Main contact section >" }, "deliveryAddressInBranchDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "The Delivery settings tab > Delivery address section >" }, "deliveryContactInBranchDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "The Delivery settings tab > Delivery contact section >" }, "defaultCountryInBranchDto": { "properties": { "id": { "type": "string", "description": "Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166." }, "name": { "type": "string", "description": "Mandatory field: Country name* > The complete name of the country." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: The organisation details tab > Configuration settings section > Default country* > The default country, which is the country of most of the company's customers and suppliers." }, "industryCodeInBranchDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Organisation details tab > Configuration settings section > Industry code > The branch's industry code ID." }, "currencyInBranchDto": { "properties": { "id": { "type": "string", "description": "Currency Id." }, "description": { "type": "string", "description": "Currency description." }, "symbol": { "type": "string", "description": "Currency symbol." } }, "description": "The Organisation details tab > Base currency settings (shared) section > This group of elements holds information that is shared among all branches of the company." }, "vatZoneInBranchDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Delivery settings tab > Delivery instruction section > VAT zone ID > The VAT zone of the delivery location." }, "ledgerInBranchDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The ledgers tab > The ledger column and the Description column." }, "bankSettingsInBranchDto": { "properties": { "bankName": { "type": "string", "description": "Bank name" }, "bankAddress1": { "type": "string", "description": "Bank address1" }, "bankAddress2": { "type": "string", "description": "BankAddress2" }, "bankAddress3": { "type": "string", "description": "BankAddress3" }, "bankCountry": { "type": "string", "description": "BankCountry" }, "iban": { "type": "string", "description": "IBAN" }, "bban": { "type": "string", "description": "BBAN" }, "bbaN2": { "type": "string", "description": "BBAN2" }, "bbaN3": { "type": "string", "description": "BBAN3" }, "bic": { "type": "string", "description": "BIC" }, "creditorId": { "type": "string", "description": "CreditorId" } }, "description": "The payment settings tab." }, "BranchDto": { "type": "object", "properties": { "branchId": { "type": "integer", "description": "The top part > Branch ID* > The unique identifier of the Branch", "format": "int32" }, "number": { "type": "string", "description": "Mandatory field: The top part > Branch CD* > The branch number , which you compose according to the rules defined by the BIZACCT segmented key." }, "name": { "type": "string", "description": "The top part > Company name > The name of the company." }, "organizationId": { "type": "integer", "format": "int32" }, "isMainBranch": { "type": "boolean", "description": "The top part > Is main organisation > If you want this company to be the main company of your branches, select this check box." }, "isActive": { "type": "boolean", "description": "The top part > Is active branch." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information. This information is not visible in the window.", "format": "date-time" }, "corporateId": { "type": "string", "description": "The Organisation details tab > VAT registration info section > Corporate ID > The corporate ID of the company." }, "vatRegistrationId": { "type": "string", "description": "The Organisation details tab > VAT registration info section > VAT registration ID > The company registration ID for the country’s tax authority." }, "mainAddress": { "$ref": "#/components/schemas/mainAddressInBranchDto" }, "mainContact": { "$ref": "#/components/schemas/mainContactInBranchDto" }, "deliveryAddress": { "$ref": "#/components/schemas/deliveryAddressInBranchDto" }, "deliveryContact": { "$ref": "#/components/schemas/deliveryContactInBranchDto" }, "defaultCountry": { "$ref": "#/components/schemas/defaultCountryInBranchDto" }, "industryCode": { "$ref": "#/components/schemas/industryCodeInBranchDto" }, "currency": { "$ref": "#/components/schemas/currencyInBranchDto" }, "vatZone": { "$ref": "#/components/schemas/vatZoneInBranchDto" }, "ledger": { "$ref": "#/components/schemas/ledgerInBranchDto" }, "bankSettings": { "$ref": "#/components/schemas/bankSettingsInBranchDto" } } }, "BranchQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "Filter by branch ID (number) greater than." }, "orderBy": { "enum": [ "Id", "Number", "Name", "OrganizationId", "LastModifiedDateTime" ], "type": "string", "description": "Order by Branch ID" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__.", "format": "date-time" }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "expandAddress": { "type": "boolean", "description": "True to get main address for branch." }, "expandContact": { "type": "boolean", "description": "True to get main contact for a branch." }, "expandCurrency": { "type": "boolean", "description": "True to get base currency for a branch." }, "expandVatZone": { "type": "boolean", "description": "True to get vat zone for a branch." }, "expandLedger": { "type": "boolean", "description": "True to get ledger for a branch." }, "expandIndustryCode": { "type": "boolean", "description": "True to get industry code for a branch." }, "expandDeliveryAddress": { "type": "boolean", "description": "True to get delivery address for a branch." }, "expandDeliveryContact": { "type": "boolean", "description": "True to get delivery contact for a branch." }, "expandDefaultCountry": { "type": "boolean", "description": "True to get default country for a branch." }, "expandBankSettings": { "type": "boolean", "description": "True to get payment settings for Branch." } } }, "bankNameInBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Bank name" }, "bankAddress1InBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Bank address 1" }, "bankAddress2InBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Bank address 2" }, "bankAddress3InBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Bank address 3" }, "bankCountryInBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Bank country" }, "ibanInBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "IBAN" }, "bbanInBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "BBAN" }, "bbaN2InBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "BBAN 2" }, "bbaN3InBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "BBAN 3" }, "bicInBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "BIC" }, "creditorIdInBankSettingsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Creditor Id" }, "BankSettingsUpdateDto": { "type": "object", "properties": { "bankName": { "$ref": "#/components/schemas/bankNameInBankSettingsUpdateDto" }, "bankAddress1": { "$ref": "#/components/schemas/bankAddress1InBankSettingsUpdateDto" }, "bankAddress2": { "$ref": "#/components/schemas/bankAddress2InBankSettingsUpdateDto" }, "bankAddress3": { "$ref": "#/components/schemas/bankAddress3InBankSettingsUpdateDto" }, "bankCountry": { "$ref": "#/components/schemas/bankCountryInBankSettingsUpdateDto" }, "iban": { "$ref": "#/components/schemas/ibanInBankSettingsUpdateDto" }, "bban": { "$ref": "#/components/schemas/bbanInBankSettingsUpdateDto" }, "bbaN2": { "$ref": "#/components/schemas/bbaN2InBankSettingsUpdateDto" }, "bbaN3": { "$ref": "#/components/schemas/bbaN3InBankSettingsUpdateDto" }, "bic": { "$ref": "#/components/schemas/bicInBankSettingsUpdateDto" }, "creditorId": { "$ref": "#/components/schemas/creditorIdInBankSettingsUpdateDto" } }, "description": "Bank settings update Dto" }, "GeneralLedgerBudgetQueryParameters": { "required": [ "branch", "ledger", "financialYear" ], "type": "object", "properties": { "isReleased": { "type": "boolean", "description": "True to get released budgets." }, "greaterThanValue": { "type": "string", "description": "Filter by from date." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "orderBy": { "type": "string", "description": "Order by Last modified date and time." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "branch": { "type": "string", "description": "Mandatory. Filter by budgets Branch." }, "ledger": { "type": "string", "description": "Mandatory. The budgets Ledger" }, "financialYear": { "type": "string", "description": "The budgets financial year." }, "subaccount": { "type": "string", "description": "The Subaccount of the budget article." } } }, "BranchNumberDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } } }, "FinancialPeriodAmountDto": { "type": "object", "properties": { "periodId": { "type": "string" }, "amount": { "type": "number", "format": "double" } } }, "SubAccountDescriptionDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "AccountNumberDto": { "type": "object", "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "accountInBudgetDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: The budget area > The budget articles pane > Account* > The account of the budget article if the article is a leaf on the budget tree." }, "subaccountInBudgetDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The budget area > The budget articles pane > Subaccount* > The subaccount of the budget article if the article is a leaf on the budget tree." }, "branchNumberInBudgetDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Top part > Branch > Click the magnifier" }, "BudgetDto": { "type": "object", "properties": { "financialYear": { "type": "string", "description": "Mandatory field: The top part > Financial year* > The financial year of the budget." }, "released": { "type": "boolean", "description": "The budget area > The budget articles pane > Released > A check box that indicates (if selected) that the budget article has been released." }, "releasedAmount": { "type": "number", "description": "The budget area > The budget articles pane > Released amount > The amount that has been released for this article.", "format": "double" }, "account": { "$ref": "#/components/schemas/accountInBudgetDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInBudgetDto" }, "description": { "type": "string", "description": "Mandatory field: The budget area > The budget articles pane > Description* > A description of the budget article.By default, this column displays the account description." }, "amount": { "type": "number", "description": "The budget area > The budget articles pane > Amount > The article amount.", "format": "double" }, "distributedAmount": { "type": "number", "description": "The budget area The budget articles pane > Distributed amount > The amount distributed over the periods.", "format": "double" }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriodAmountDto" }, "description": "The budget area The budget articles pane > Period XX > Amount per period within the financial year." }, "lastModifiedDateTime": { "type": "string", "description": "A system generated date/time not visible in the window.", "format": "date-time" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInBudgetDto" }, "timeStamp": { "type": "string", "description": "The timestamp of the budget article, used for concurrency control.", "format": "byte" } } }, "FinancialPeriodAmountUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "periodId": { "$ref": "#/components/schemas/DtoValueOfString" }, "amount": { "$ref": "#/components/schemas/DtoValueOfDecimal" } } }, "DtoValueOfDecimal": { "type": "object", "properties": { "value": { "type": "number", "format": "double" } } }, "SegmentUpdateDto": { "type": "object", "properties": { "segmentId": { "type": "integer", "format": "int32" }, "segmentValue": { "type": "string" } } }, "BudgetUpdateDto": { "type": "object", "properties": { "ledger": { "$ref": "#/components/schemas/DtoValueOfString" }, "financialYear": { "$ref": "#/components/schemas/DtoValueOfString" }, "account": { "$ref": "#/components/schemas/DtoValueOfString" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "amount": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "periods": { "type": "array", "items": { "$ref": "#/components/schemas/FinancialPeriodAmountUpdateDto" } } } }, "CarrierDto": { "type": "object", "properties": { "carrierId": { "type": "string", "description": "Mandatory field: The top part > Ship via* > The unique code associated with the non-integrated carrier, the method of the integrated carrier, or the shipping option of your company." }, "carrierDescription": { "type": "string", "description": "Mandatory field: The top part > Description* > A description of this shipping service or option." }, "lastModifiedDateTime": { "type": "string", "description": "This information is not visible in the window. It is collected from the system.", "format": "date-time" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Carrier in CarrierController. Used for getting data." }, "CarrierQueryParameters": { "type": "object", "properties": { "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "System retrieved information for state/condition." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "TaxCategoryNumberDescriptionDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "SegmentDto": { "type": "object", "properties": { "segmentId": { "type": "integer", "description": "The Segment values window > The Top part > The ID of the segment.", "format": "int32" }, "segmentDescription": { "type": "string", "description": "The Segment values window > The Top part > The description of the segment." }, "segmentValue": { "type": "string", "description": "The Segment values window > The table > The value of the segment, alphanumeric." }, "segmentValueDescription": { "type": "string", "description": "The Segment values window > The table > The description of the segment value." } } }, "VatZoneDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "SubAccountDto": { "type": "object", "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "AccountNumberTypeDescriptionDto": { "type": "object", "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "defaultOffsetAccountBranchInEntryTypeDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The branch to which the default offset account belongs." }, "defaultOffsetAccountInEntryTypeDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Default offset account > The account that is used by default as the offset account for this entry type." }, "defaultOffsetSubaccountInEntryTypeDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Default offset subaccount > The corresponding subaccount." }, "reclasificationAccountInEntryTypeDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Reclassification account > > The cash account that is used to temporary hold payments that came to the bank account but cannot be entered as valid payments because the customer or supplier is unknown.\r\nThe parameter is used together with the Use for payments reclassification check box." }, "businessAccountInEntryTypeDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Business account > The supplier account, if the entry type is used to record transactions that involve a particular supplier, or the customer account,\r\nif the entry type is used to record transactions that involve a particular customer." }, "reclasificationAccountOverrideInEntryTypeDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The account that should be used instead of the reclassification account specified as the default one on the Entry types tab." }, "offsetAccountOverrideInEntryTypeDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Reclassification account override > The account that should be used as the offset account for this entry type with this cash account instead of the default offset account specified on the Entry types tab. \r\nWe recommend that for the disbursement type of transaction, you specify an expense account. For the receipt type of transaction, specify an asset account." }, "offsetSubaccountOverrideInEntryTypeDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Offset account override > The subaccount for this entry type to be used with this cash account instead of the default offset subaccount specified in the Entry types window." }, "offsetAccountBranchInEntryTypeDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Default offset account branch > The branch to which the overriding offset account belongs." }, "vatZoneInEntryTypeDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "VAT zone > The VAT zone to be used by default with this entry type." }, "EntryTypeDto": { "type": "object", "properties": { "entryTypeId": { "type": "string", "description": "Entry type ID* > The entry type, selected by its identifier." }, "disableReceipt": { "enum": [ "Disbursement", "Receipt" ], "type": "string", "description": "Disb/receipt > The basic type of cash transaction designated by this entry type: Receipt or Disbursement." }, "module": { "type": "string", "description": "Module > The way the entry type is used in the system." }, "defaultOffsetAccountBranch": { "$ref": "#/components/schemas/defaultOffsetAccountBranchInEntryTypeDto" }, "defaultOffsetAccount": { "$ref": "#/components/schemas/defaultOffsetAccountInEntryTypeDto" }, "defaultOffsetSubaccount": { "$ref": "#/components/schemas/defaultOffsetSubaccountInEntryTypeDto" }, "reclasificationAccount": { "$ref": "#/components/schemas/reclasificationAccountInEntryTypeDto" }, "businessAccount": { "$ref": "#/components/schemas/businessAccountInEntryTypeDto" }, "description": { "type": "string", "description": "Description > A detailed description of the entry type that is used as transaction description by default." }, "useForPaymentsReclasification": { "type": "boolean", "description": "A check box that you select if this entry type is used to record unknown payments that need to be reclassified later." }, "reclasificationAccountOverride": { "$ref": "#/components/schemas/reclasificationAccountOverrideInEntryTypeDto" }, "offsetAccountOverride": { "$ref": "#/components/schemas/offsetAccountOverrideInEntryTypeDto" }, "offsetSubaccountOverride": { "$ref": "#/components/schemas/offsetSubaccountOverrideInEntryTypeDto" }, "offsetAccountBranch": { "$ref": "#/components/schemas/offsetAccountBranchInEntryTypeDto" }, "vatZone": { "$ref": "#/components/schemas/vatZoneInEntryTypeDto" }, "taxCalculationMode": { "enum": [ "TaxSetting", "Gross", "Net" ], "type": "string", "description": "Tax calculation mode > The tax calculation mode to be used by default with this entry type" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" } } }, "accountInCashAccountDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The account added to the cash account." }, "subaccountInCashAccountDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The subaccount to be used for the cash account." }, "CashAccountDto": { "type": "object", "properties": { "lastModifiedDateTime": { "type": "string", "description": "A system generated date/time to indicate when the document was last changed.", "format": "date-time" }, "entryTypes": { "type": "array", "items": { "$ref": "#/components/schemas/EntryTypeDto" }, "description": "The Entry types tab >" }, "currency": { "type": "string" }, "account": { "$ref": "#/components/schemas/accountInCashAccountDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInCashAccountDto" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "CashAccountQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "Filter Cass account identifier greater than." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." } } }, "VatCodeDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "ProjectIdDescriptionDto": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "LocationDescriptionDto": { "type": "object", "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } } }, "PaymentMethodIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "CustomerNumberDto": { "type": "object", "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } } }, "ArAdjustDto": { "type": "object", "properties": { "docType": { "type": "string" }, "customerCD": { "type": "string" }, "refNbr": { "type": "string" }, "amountPaid": { "type": "number", "format": "double" }, "cashDiscountTaken": { "type": "number", "format": "double" }, "balance": { "type": "number", "format": "double" }, "pendingPPD": { "type": "boolean" }, "released": { "type": "boolean" }, "hold": { "type": "boolean" }, "voided": { "type": "boolean" }, "ppdCrMemoRefNbr": { "type": "string" }, "paymentRef": { "type": "string" }, "status": { "type": "string" }, "applicationDate": { "type": "string", "format": "date-time" }, "applicationPeriod": { "type": "string" }, "invoiceText": { "type": "string" } } }, "CustomerDocumentContactDto": { "type": "object", "properties": { "contactId": { "type": "integer", "format": "int32" }, "businessName": { "type": "string" }, "attention": { "type": "string" }, "email": { "type": "string" }, "phone1": { "type": "string" }, "overrideContact": { "type": "boolean" } } }, "countryInCustomerDocumentAddressDto": { "properties": { "id": { "type": "string", "description": "Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166." }, "name": { "type": "string", "description": "Mandatory field: Country name* > The complete name of the country." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Country > The country." }, "countyInCustomerDocumentAddressDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "County > The county or province." }, "CustomerDocumentAddressDto": { "type": "object", "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInCustomerDocumentAddressDto" }, "county": { "$ref": "#/components/schemas/countyInCustomerDocumentAddressDto" }, "overrideAddress": { "type": "boolean", "description": "Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer." } } }, "SalesPersonIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "accountInCashSaleLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Account* > The sales account used for the transaction." }, "vatCodeInCashSaleLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "VAT category > The VAT category (if applied) for the transaction. The category represents the type of goods or services." }, "subaccountInCashSaleLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: Subaccount* > The corresponding subaccount used for this transaction." }, "sellerInCashSaleLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Salesperson ID > The identifier of the salesperson involved." }, "branchNumberInCashSaleLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Branch* > The branch that sells the line item or provides the service." }, "CashSaleLineDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "Line no. > A counter of lines in the overview of cash sales document overview.", "format": "int32" }, "inventoryNumber": { "type": "string", "description": "Item ID > The item ID of the line item, if applicable. Only a non-stock item can be selected." }, "description": { "type": "string", "description": "Transaction descr. > Any brief comment relevant to the transaction.The alphanumeric string may contain up to 30 characters." }, "quantity": { "type": "number", "description": "Quantity > The quantity of items (goods or services) of a particular type sold to the customer.", "format": "double" }, "unitPrice": { "type": "number", "description": "Unit price > The unit price set for the item or service. If you want to update the unit price\r\nautomatically to the current value(that is, the applicable sales or default price),\r\nyou can use the Recalculate Prices and Discounts action.If you have modified\r\nthe unit price and saved the document, the value will not be updated by the\r\nsystem if you change the document date.", "format": "double" }, "unitPriceInCurrency": { "type": "number", "description": "Background calculation giving you the Unit price in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualAmount": { "type": "number", "description": "Manual amount > a check box indicating that the amount has been entered manually.", "format": "double" }, "manualAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Manual amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "amount": { "type": "number", "description": "Amount > The amount after the discount has been applied. The value of this read-only box\r\nis calculated automatically by deducting the discount amount from the extended price.", "format": "double" }, "cost": { "type": "number", "description": "Cost > The total cost of the line in default currency. \r\nThe value will always be 0 for unreleased documents.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "account": { "$ref": "#/components/schemas/accountInCashSaleLineDto" }, "vatCode": { "$ref": "#/components/schemas/vatCodeInCashSaleLineDto" }, "uom": { "type": "string", "description": "UoM > The unit of measure (UoM) for the item." }, "discountPercent": { "type": "number", "description": "Discount percent > The percent of the line-level discount that has been applied manually or\r\nautomatically.The system selects the Manual Discount check box and\r\ncalculates the discount amount after you have entered the percent manually and\r\nsaved your changes or added a new line.", "format": "double" }, "discountAmount": { "type": "number", "description": "Discount amount > The amount of the line-level discount that has been applied manually or\r\nautomatically to this line.The system selects the Manual Discount check box\r\nand calculates the line amount after you have entered the discount amount\r\nmanually and save your changes or added a new line.", "format": "double" }, "discountAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Discount amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Manual discount > A check box that indicates (if selected) that the discount has been applied\r\nmanually.If you clear the check box, the system clears entered discount percent,\r\nor discount amount, or selected discount code." }, "subaccount": { "$ref": "#/components/schemas/subaccountInCashSaleLineDto" }, "salesperson": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use Seller instead" }, "seller": { "$ref": "#/components/schemas/sellerInCashSaleLineDto" }, "deferralSchedule": { "type": "integer", "description": "Original deferral schedule > A read-only column filled in by the system in the Cash return documents created by the reversing process. It shows the identifier of the deferral schedule associated with the original Cash sale document.", "format": "int32" }, "deferralCode": { "type": "string", "description": "The deferral code assigned to the stock item or non-stock item specified in this\r\ndocument line.Upon release of the document, the system generates a deferral\r\nschedule (or schedules) based on the settings defined in this deferral code." }, "discountCode": { "type": "string", "description": "The code of the line discount that has been applied to this line automatically or manually." }, "note": { "type": "string", "description": "Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order." }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCashSaleLineDto" }, "externalLink": { "type": "string" } } }, "CreditTermsDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "creditTermsInCashSaleDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The Financial details tab > Payment info section > Terms*" }, "salesPersonInCashSaleDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The document details tab > Salesperson ID > The salesperson involved." }, "invoiceAddressInCashSaleDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInCustomerDocumentAddressDto" }, "county": { "$ref": "#/components/schemas/countyInCustomerDocumentAddressDto" }, "overrideAddress": { "type": "boolean", "description": "Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer." } }, "description": "The Invoice address tab > The Invoice address section." }, "invoiceContactInCashSaleDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "businessName": { "type": "string" }, "attention": { "type": "string" }, "email": { "type": "string" }, "phone1": { "type": "string" }, "overrideContact": { "type": "boolean" } }, "description": "The Invoice address tab > The Invoice contact section." }, "customerInCashSaleDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer associated with the document." }, "paymentMethodInCashSaleDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The Payment information section > Payment method > The identifier for the payment method that the customer will use to pay the document." }, "locationInCashSaleDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Location > The location of the customer related to the document. By default, it is the default\r\nlocation of the selected customer or, if the invoice is created from an opportunity,\r\nit is the customer location specified for the opportunity." }, "branchNumberInCashSaleDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Financial details tab > Branch > The branch with which this invoice or memo is associated. The field is available if your company is set up with branches." }, "projectInCashSaleDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Project* > The identifier and description of the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window." }, "accountInCashSaleDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The Document details tab > Account * > The sales account used for the transaction." }, "subaccountInCashSaleDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The Document details tab > Subaccount* > The corresponding subaccount used for this transaction." }, "CashSaleDto": { "type": "object", "properties": { "creditTerms": { "$ref": "#/components/schemas/creditTermsInCashSaleDto" }, "cashSaleLines": { "type": "array", "items": { "$ref": "#/components/schemas/CashSaleLineDto" }, "description": "The Document details tab >" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the document is a draft. A document with the On Hold status may be edited and cannot be released." }, "discountTotal": { "type": "number", "description": "The top part > Discount total > The document discount total.", "format": "double" }, "discountTotalInCurrency": { "type": "number", "description": "The top part > Discount total > The document discount total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "detailTotal": { "type": "number", "description": "The top part > Detail total > The document total, which the system calculates for all line items in the Document details tab.", "format": "double" }, "detailTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Detail total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "vatTaxableTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT taxable total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt. total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the tax with the Include in VAT Exempt Total check box selected on the Taxes form.This box is available only if the VAT Reporting feature is enabled in your system.", "format": "double" }, "vatExemptTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT exempt. total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "salesPersonID": { "type": "integer", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead", "format": "int32" }, "salesPersonDescr": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead" }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInCashSaleDto" }, "paymentReference": { "type": "string", "description": "///The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window.." }, "invoiceAddress": { "$ref": "#/components/schemas/invoiceAddressInCashSaleDto" }, "invoiceContact": { "$ref": "#/components/schemas/invoiceContactInCashSaleDto" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ArAdjustDto" } }, "dontPrint": { "type": "boolean" }, "dontEmail": { "type": "boolean" }, "revoked": { "type": "boolean" }, "customer": { "$ref": "#/components/schemas/customerInCashSaleDto" }, "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off" }, "referenceNumber": { "type": "string", "description": "The Top part > Ref. no. > The reference number of the customer ledger document in the system." }, "postPeriod": { "type": "string", "description": "The top part > Post period > The period to which the document should be posted. Format YYYYMM." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "documentDate": { "type": "string", "description": "The top part > Date* > The date when the customer ledger document was created.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting \"Use Orig Invoice Date\" is active in AR Preferences.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email." }, "currencyId": { "type": "string", "description": "The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window." }, "amount": { "type": "number", "description": "The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.\r\nIf the check box is cleared, then the value appears when the document status is Open.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "balance": { "type": "number", "description": "The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. \r\nFor a document used in the application process, this is the balance after the payments were applied.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInCashSaleDto" }, "customerRefNumber": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "invoiceText": { "type": "string", "description": "The top part > Invoice text > Any user-provided description of the customer ledger document." }, "lastModifiedDateTime": { "type": "string", "description": "System generated field for last modification date/time of document.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "The Attachments tab > Creation time > The date the attachment was created.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "vatTotal": { "type": "number", "description": "The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "location": { "$ref": "#/components/schemas/locationInCashSaleDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCashSaleDto" }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "project": { "$ref": "#/components/schemas/projectInCashSaleDto" }, "account": { "$ref": "#/components/schemas/accountInCashSaleDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInCashSaleDto" }, "customerProject": { "type": "string", "description": "The top part > Customer project no. > The customer project no. used in AutoInvoice." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a invoice in InvoiceController. Used by getting data." }, "DtoValueOfInt32": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "DtoValueOfNullableOfInt32": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "DtoValueOfDateTime": { "type": "object", "properties": { "value": { "type": "string", "format": "date-time" } } }, "CashSaleLinesUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "unitPriceInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "accountNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatCodeId": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "discountAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "salesperson": { "$ref": "#/components/schemas/DtoValueOfString" }, "deferralSchedule": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "deferralCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "termStartDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "termEndDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "paymentReferenceInCashSaleUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory" }, "postPeriodInCashSaleUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "financialPeriodInCashSaleUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM." }, "salesPersonIDInCashSaleUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The field is deprecated for customer document endpoints, please use Salesperson instead" }, "salespersonInCashSaleUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The identifier of the salesperson involved." }, "CashSaleUpdateDto": { "type": "object", "properties": { "paymentMethodId": { "$ref": "#/components/schemas/DtoValueOfString" }, "creditTermsId": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentReference": { "$ref": "#/components/schemas/paymentReferenceInCashSaleUpdateDto" }, "cashSaleLines": { "type": "array", "items": { "$ref": "#/components/schemas/CashSaleLinesUpdateDto" } }, "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "childCustomerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "consolidateInvoices": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "documentDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "origInvoiceDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInCashSaleUpdateDto" }, "financialPeriod": { "$ref": "#/components/schemas/financialPeriodInCashSaleUpdateDto" }, "invoiceText": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPersonID": { "$ref": "#/components/schemas/salesPersonIDInCashSaleUpdateDto" }, "salesperson": { "$ref": "#/components/schemas/salespersonInCashSaleUpdateDto" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "dontPrint": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "dontEmail": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "DocumentQueryParameters": { "type": "object", "properties": { "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "The field is deprecated for specific customer document endpoints. It will only be usable from customer document endpoint." }, "released": { "type": "integer", "description": "Parameter for showing if invoice has been released or not.", "format": "int32" }, "dunningLevel": { "type": "integer", "description": "The dunning level of the document.", "format": "int32" }, "closedFinancialPeriod": { "type": "string", "description": "The date of the closing of the financial period." }, "dunningLetterDateTime": { "type": "string", "description": "The date and time for when the document last released a dunning letter." }, "dunningLetterDateTimeCondition": { "type": "string", "description": "Set time/date as before (<), after (>), before and including (=<) OR after and including (=>) to filter on time frame." }, "project": { "type": "string", "description": "The project with which the document is associated." }, "expandApplications": { "type": "boolean", "description": "True if you want to see all dunning information regarding this document." }, "expandDunningInformation": { "type": "boolean" }, "expandAttachments": { "type": "boolean", "description": "True if you want to see all attachments regarding this document." }, "expandTaxDetails": { "type": "boolean", "description": "True if you want to see all VAT details regarding this document." }, "expandInvoiceAddress": { "type": "boolean", "description": "True if you want to see all information regarding the invoice address for this document." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document is posted. Format YYYYMM." }, "documentDueDate": { "type": "string", "description": "The date when payment for the document is due, in accordance with the credit terms.", "format": "date-time" }, "documentDueDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The status of the document. Use the dropdown to select status." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "externalReference": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "paymentReference": { "type": "string", "description": "The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window.." }, "customerRefNumber": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "customer": { "type": "string", "description": "Filter by Customer" }, "branch": { "type": "string", "description": "Filter by Branch" }, "documentDate": { "type": "string", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__.", "format": "date-time" }, "documentDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__." }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "TaxNumberDescriptionDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "ProjectTaskIdDescriptionDto": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "InventoryNumberDescriptionDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "branchInFinancialsDetailDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Link to general ledger section > Branch > \tThe branch that initiated the transaction." }, "taxZoneInFinancialsDetailDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "VAT settings section > VAT zone > The VAT zone that applies to the transaction." }, "FinancialsDetailDto": { "type": "object", "properties": { "batchNumber": { "type": "string", "description": "Link to general ledger section > Batch number > The number of the batch generated to implement the cash transaction." }, "branch": { "$ref": "#/components/schemas/branchInFinancialsDetailDto" }, "cleared": { "type": "boolean", "description": "Link to general ledger section > Cleared > A check box that indicates (if selected) that the transaction was cleared." }, "clearDate": { "type": "string", "description": "Link to general ledger section > Clear date > \tThe date when the transaction was cleared.", "format": "date-time" }, "taxZone": { "$ref": "#/components/schemas/taxZoneInFinancialsDetailDto" }, "taxCalcMode": { "enum": [ "TaxSetting", "Gross", "Net" ], "type": "string", "description": "VAT settings section > VAT calculation > The VAT calculation mode, which defines which amounts (VAT-inclusive or VAT-exclusive) should be entered in the detail lines of a document." } } }, "taxInCashTranTaxDetailDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: VAT ID > The VAT that applies to the cash transaction." }, "CashTranTaxDetailDto": { "type": "object", "properties": { "tax": { "$ref": "#/components/schemas/taxInCashTranTaxDetailDto" }, "taxRate": { "type": "number", "description": "VAT rate > The rate of the VAT.", "format": "double" }, "taxableAmount": { "type": "number", "description": "Taxable amount > The taxable amount of the transaction.", "format": "double" }, "taxAmount": { "type": "number", "description": "VAT amount > The VAT amount calculated for the transaction.", "format": "double" }, "deductibleTaxRate": { "type": "number", "description": "Deductible VAT rate > The percent of deduction that applies to the VAT amount paid to the supplier for specific purchases.", "format": "double" }, "expenseAmount": { "type": "number", "description": "Expense amount > The percentage that is deducted from the VAT amount paid to the supplier for specific purchases.", "format": "double" }, "includeInVatExemptTotal": { "type": "boolean", "description": "Include in VAT exempt total > A check box that indicates (if selected) that this value-added VAT has a zero rate and is used to calculate a document subtotal that is actually exempt from VAT." }, "pendingVat": { "type": "boolean", "description": "Pending VAT > A check box that indicates (if selected) that the VAT that should be calculated in documents, but should not be recorded to the VAT report until the VAT invoice is received." }, "statisticalVat": { "type": "boolean", "description": "Statistical VAT > A check box that indicates (if selected) that the VAT on documents will be calculated only for statistical purposes or will be reported only but not actually paid." }, "reverseVat": { "type": "boolean", "description": "Reverse VAT > A check box that indicates (if selected) that this is a reverse VAT." }, "taxType": { "enum": [ "Sales", "Use", "Vat", "Withholding" ], "type": "string", "description": "VAT type > The type of VAT." } } }, "branchInTransactionDetailDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Branch > The branch that created the transaction." }, "itemInTransactionDetailDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Item ID > The ID of the non-stock item specified as the transaction subject." }, "offsetCashAccountInTransactionDetailDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Offset cash account > The cash account to be used for the transaction." }, "offsetAccountInTransactionDetailDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Offset account* > The account to be updated by the transaction." }, "offsetSubAccountInTransactionDetailDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: Offset subaccount* > The corresponding subaccount to be used for the transaction." }, "taxCategoryInTransactionDetailDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "VAT category > The category that applies to the transaction." }, "projectInTransactionDetailDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project > The project with which this transaction is associated, or the code indicating that this transaction is not associated with any project." }, "projectTaskInTransactionDetailDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project task > The particular task of the project with which this transaction is associated." }, "TransactionDetailDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "The line number in the table.", "format": "int32" }, "branch": { "$ref": "#/components/schemas/branchInTransactionDetailDto" }, "item": { "$ref": "#/components/schemas/itemInTransactionDetailDto" }, "description": { "type": "string", "description": "Description > The description provided for the item." }, "quantity": { "type": "number", "description": "Quantity > The quantity of the item.", "format": "double" }, "uom": { "type": "string", "description": "UoM > The unit of measure of the item." }, "price": { "type": "number", "description": "Price > The unit price for the item.", "format": "double" }, "amount": { "type": "number", "description": "Amount > The total amount for all units or items.", "format": "double" }, "offsetCashAccount": { "$ref": "#/components/schemas/offsetCashAccountInTransactionDetailDto" }, "offsetAccount": { "$ref": "#/components/schemas/offsetAccountInTransactionDetailDto" }, "offsetSubAccount": { "$ref": "#/components/schemas/offsetSubAccountInTransactionDetailDto" }, "taxCategory": { "$ref": "#/components/schemas/taxCategoryInTransactionDetailDto" }, "nonBillable": { "type": "boolean", "description": "Non-invoiceable > A check box that indicates (if selected) that this transaction is non-invoiceable in the project." }, "project": { "$ref": "#/components/schemas/projectInTransactionDetailDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInTransactionDetailDto" } } }, "EmployeeNumberNameDto": { "type": "object", "properties": { "internalId": { "type": "string" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "This class represents an Employee with its Number and Name. Used for getting data." }, "EntryTypeIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "cashAccountInCashTransactionDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: The top part > Cash account* > The cash account that is a source account for the transaction." }, "entryTypeInCashTransactionDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part > Entry type* > The user-defined transaction type." }, "ownerInCashTransactionDto": { "properties": { "internalId": { "type": "string" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "The top part > Owner > The user who created the cash transaction." }, "financialsDetailInCashTransactionDto": { "properties": { "batchNumber": { "type": "string", "description": "Link to general ledger section > Batch number > The number of the batch generated to implement the cash transaction." }, "branch": { "$ref": "#/components/schemas/branchInFinancialsDetailDto" }, "cleared": { "type": "boolean", "description": "Link to general ledger section > Cleared > A check box that indicates (if selected) that the transaction was cleared." }, "clearDate": { "type": "string", "description": "Link to general ledger section > Clear date > \tThe date when the transaction was cleared.", "format": "date-time" }, "taxZone": { "$ref": "#/components/schemas/taxZoneInFinancialsDetailDto" }, "taxCalcMode": { "enum": [ "TaxSetting", "Gross", "Net" ], "type": "string", "description": "VAT settings section > VAT calculation > The VAT calculation mode, which defines which amounts (VAT-inclusive or VAT-exclusive) should be entered in the detail lines of a document." } }, "description": "Financial details tab >" }, "CashTransactionDto": { "type": "object", "properties": { "tranType": { "enum": [ "TransferOut", "TransferIn", "TransferExp", "Adjustment" ], "type": "string", "description": "The top part > Trans type > \tThe type of cash transaction." }, "referenceNbr": { "type": "string", "description": "The top part > Ref. no. > The unique identifier assigned to the cash transaction in accordance with the numbering sequence." }, "status": { "enum": [ "Balanced", "Hold", "Released", "Pending", "Rejected" ], "type": "string", "description": "The top part > Status > The status of the transaction, which is automatically assigned by the system." }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that, if selected, indicates that the transaction is on hold, which means it may be edited but cannot be released." }, "tranDate": { "type": "string", "description": "Mandatory field: The top part > Trans. date* > The date of the transaction.", "format": "date-time" }, "finPeriod": { "type": "string", "description": "The property is now considered obsolete. Use Financial Period instead" }, "financialPeriod": { "type": "string", "description": "Mandatory field: The top part > Period* > The financial period to which the transaction should be posted." }, "cashAccount": { "$ref": "#/components/schemas/cashAccountInCashTransactionDto" }, "currency": { "type": "string", "description": "The top part > Currency > The currency of the cash account." }, "entryType": { "$ref": "#/components/schemas/entryTypeInCashTransactionDto" }, "disbReceipt": { "enum": [ "Disbursement", "Receipt" ], "type": "string", "description": "The top part > Disb./receipt > The basic type of the transaction." }, "documentRef": { "type": "string", "description": "The top part > Document ref. > The external document reference number." }, "owner": { "$ref": "#/components/schemas/ownerInCashTransactionDto" }, "description": { "type": "string", "description": "The top part > Description > A detailed description of the transaction." }, "amount": { "type": "number", "description": "The top part > Amount > The amount of the transaction.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt total > The document total that is exempt from VAT.", "format": "double" }, "taxTotal": { "type": "number", "description": "The top part > VAT total > The total amount of tax paid in the document.", "format": "double" }, "controlTotal": { "type": "number", "description": "Mandatory field: The top part > Control total > The control total of the transaction.", "format": "double" }, "taxAmount": { "type": "number", "description": "The top part > VAT amount > The VAT amount to be paid for the document. A user enters this amount manually.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "transactionDetails": { "type": "array", "items": { "$ref": "#/components/schemas/TransactionDetailDto" }, "description": "Transaction details tab >" }, "taxDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CashTranTaxDetailDto" }, "description": "VAT details tab >" }, "financialsDetail": { "$ref": "#/components/schemas/financialsDetailInCashTransactionDto" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" } } }, "CashTransactionTaxDetailUpdateDto": { "type": "object", "properties": { "vatId": { "$ref": "#/components/schemas/DtoValueOfString" }, "taxableAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "vatAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "expenseAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" } } }, "CashTransactionDetailUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "price": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "amount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "offsetAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "offsetSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "vatCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "notInvoiceable": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "project": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTask": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "DtoValueOfNullableOfTaxCalcMode": { "type": "object", "properties": { "value": { "enum": [ "TaxSetting", "Gross", "Net" ], "type": "string" } } }, "DtoValueOfNullableOfDecimal": { "type": "object", "properties": { "value": { "type": "number", "format": "double" } } }, "DtoValueOfNullableOfDateTime": { "type": "object", "properties": { "value": { "type": "string", "format": "date-time" } } }, "finanacialPeriodInCashTransactionUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The property is now considered obsolete. Use Financial Period instead" }, "financialPeriodInCashTransactionUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM." }, "CashTransactionUpdateDto": { "type": "object", "properties": { "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "tranDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "finanacialPeriod": { "$ref": "#/components/schemas/finanacialPeriodInCashTransactionUpdateDto" }, "financialPeriod": { "$ref": "#/components/schemas/financialPeriodInCashTransactionUpdateDto" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "entryType": { "$ref": "#/components/schemas/DtoValueOfString" }, "documentRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "controlTotal": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "vatAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "vatZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "taxCalculationMode": { "$ref": "#/components/schemas/DtoValueOfNullableOfTaxCalcMode" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "cashTransactionDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CashTransactionDetailUpdateDto" } }, "cashTransactionTaxDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CashTransactionTaxDetailUpdateDto" } } } }, "CashTransactionQueryParameters": { "type": "object", "properties": { "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ReleaseCashTransactionActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "ReverseCashTransactionActionDto": { "type": "object", "properties": { "returnCashTransaction": { "type": "boolean" } } }, "ReverseCashTransactionActionResultDto": { "type": "object", "properties": { "referenceNbr": { "type": "string" }, "cashTransaction": { "$ref": "#/components/schemas/CashTransactionDto" }, "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "addressInContactDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "The Details tab > Address section >" }, "ContactDto": { "type": "object", "properties": { "displayName": { "type": "string" }, "active": { "type": "boolean", "description": "The top part > Active > A check box that indicates (if selected) that the contact is active." }, "title": { "enum": [ "Doctor", "Miss", "Mr", "Mrs", "Ms", "Prof" ], "type": "string", "description": "The top part > First name > The contact's courtesy title." }, "firstName": { "type": "string", "description": "The top part > First name > The first name of the contact." }, "lastName": { "type": "string", "description": "Mandatory field: The top part > Last name* > The last name of the contact." }, "position": { "type": "string", "description": "The top part > Job title > The contact’s job title or position." }, "businessAccount": { "type": "string", "description": "The top part > Business account > The business account associated with the contact." }, "businessAccountType": { "type": "string", "description": "The top part > Business account > The business account type of the business account associated with the contact." }, "sameAsAccount": { "type": "boolean", "description": "The Details tab > Same as in account > A check box that indicates (if selected) that the contact's address is the same as the address of the business account." }, "address": { "$ref": "#/components/schemas/addressInContactDto" }, "email": { "type": "string", "description": "The Details tab > Contact section > Email > The email address of the contact." }, "web": { "type": "string", "description": "The Details tab > Contact section > Web > The website of the contact, if any." }, "phone1": { "type": "string", "description": "The Details tab > Contact section > Business 1/Business 2/Business 3/Business assistant 1/Business fax /Home/Home fax/Mobile > The primary phone number of the contact. Select the type from the drop down." }, "phone2": { "type": "string", "description": "The Details tab > Contact section > Business 1/Business 2/Business 3/Business assistant 1/Business fax /Home/Home fax/Mobile > The primary phone number of the contact. Select the type from the drop down." }, "phone3": { "type": "string", "description": "The Details tab > Contact section > Business 1/Business 2/Business 3/Business assistant 1/Business fax /Home/Home fax/Mobile > The primary phone number of the contact. Select the type from the drop down." }, "fax": { "type": "string", "description": "The Details tab > Contact section > Business fax > The fax number of the contact." }, "contactMethod": { "enum": [ "Any", "Email", "Mail", "Fax", "Phone" ], "type": "string", "description": "CRM section not available in Visma.net ERP" }, "doNotCall": { "type": "boolean", "description": "CRM section not available in Visma.net ERP" }, "doNotFax": { "type": "boolean", "description": "CRM section not available in Visma.net ERP" }, "doNotEmail": { "type": "boolean", "description": "CRM section not available in Visma.net ERP" }, "doNotMail": { "type": "boolean", "description": "CRM section not available in Visma.net ERP" }, "noMassMail": { "type": "boolean", "description": "CRM section not available in Visma.net ERP" }, "noMarketing": { "type": "boolean", "description": "CRM section not available in Visma.net ERP" }, "lastModifiedDateTime": { "type": "string", "description": "Background information: The date and time when the details of the contact were last updated.", "format": "date-time" }, "contactId": { "type": "integer", "description": "The top part > Contact ID > The unique identifier of the contact, which the system generates automatically.", "format": "int32" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a contact in ContactController. Used by getting data." }, "AddressUpdateDto": { "type": "object", "properties": { "addressLine1": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine2": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine3": { "$ref": "#/components/schemas/DtoValueOfString" }, "postalCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "city": { "$ref": "#/components/schemas/DtoValueOfString" }, "countryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "county": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "DtoValueOfContactMethods": { "type": "object", "properties": { "value": { "enum": [ "Any", "Email", "Mail", "Fax", "Phone" ], "type": "string" } } }, "DtoValueOfAddressUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/AddressUpdateDto" } } }, "DtoValueOfEmployeeTitles": { "type": "object", "properties": { "value": { "enum": [ "Doctor", "Miss", "Mr", "Mrs", "Ms", "Prof" ], "type": "string" } } }, "ContactUpdateDto": { "type": "object", "properties": { "active": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "title": { "$ref": "#/components/schemas/DtoValueOfEmployeeTitles" }, "firstName": { "$ref": "#/components/schemas/DtoValueOfString" }, "lastName": { "$ref": "#/components/schemas/DtoValueOfString" }, "position": { "$ref": "#/components/schemas/DtoValueOfString" }, "businessAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "sameAsAccount": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "address": { "$ref": "#/components/schemas/DtoValueOfAddressUpdateDto" }, "email": { "$ref": "#/components/schemas/DtoValueOfString" }, "web": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone1": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone2": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone3": { "$ref": "#/components/schemas/DtoValueOfString" }, "fax": { "$ref": "#/components/schemas/DtoValueOfString" }, "contactMethod": { "$ref": "#/components/schemas/DtoValueOfContactMethods" }, "doNotCall": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "doNotFax": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "doNotEmail": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "doNotMail": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "noMassMail": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "noMarketing": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "ContactQueryParameters": { "type": "object", "properties": { "displayName": { "type": "string" }, "active": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "businessAccount": { "type": "string" }, "email": { "type": "string" }, "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "format": "int32" }, "skipRecords": { "type": "integer", "format": "int32" }, "orderBy": { "type": "string" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." } } }, "ContractTemplateQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "format": "int32" }, "skipRecords": { "type": "integer", "format": "int32" }, "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string" }, "expandAttributes": { "type": "boolean" } } }, "ClassAttributeDetailDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "ClassAttributeDto": { "type": "object", "properties": { "attributeId": { "type": "string", "description": "The Attributes tab > Attribute ID > The identifier of the attribute." }, "description": { "type": "string", "description": "The Attributes tab > Description > A read-only column that displays the detailed description of the attribute." }, "sortOrder": { "type": "integer", "description": "The Attributes tab > Sort order > A number that represents the order of the attribute in the list of class attributes.The lower the number, the higher the attribute will be in the list of class attributes.", "format": "int32" }, "required": { "type": "boolean", "description": "The Attributes tab > Required > This check box indicates (if selected) that the attribute value is required for items of the class." }, "attributeType": { "enum": [ "Text", "Combo", "MultiSelectCombo", "Lookup", "Checkbox", "Datetime" ], "type": "string" }, "defaultValue": { "type": "string", "description": "The Attributes tab > Default value > The default value of the attribute." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ClassAttributeDetailDto" } } } }, "ContractTemplateDto": { "type": "object", "properties": { "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassAttributeDto" } }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "branchInContractUsageLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Both tabs > Branch >" }, "itemInContractUsageLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Both tabs" }, "ContractUsageLineDto": { "type": "object", "properties": { "transactionNumber": { "type": "integer", "format": "int32" }, "billed": { "type": "boolean", "description": "Information indicating that the contract is collected from the Transaction history tab and the contract is invoiced. Not indicated on screen CT303000." }, "branch": { "$ref": "#/components/schemas/branchInContractUsageLineDto" }, "item": { "$ref": "#/components/schemas/itemInContractUsageLineDto" }, "description": { "type": "string", "description": "Both tabs > Description > A description of the non-stock item." }, "uom": { "type": "string", "description": "Both tabs > UoM > The unit of measure used for the item." }, "quantity": { "type": "number", "description": "Both tabs > Quantity > A number of units used for the item.", "format": "double" }, "date": { "type": "string", "description": "Mandatory field: Both tabs > Date* > The date of the activity, case, applied labour, or other usage (for the item).", "format": "date-time" }, "type": { "type": "string", "description": "Transaction history tab > Type > The type of the customer ledger document." }, "referenceNbr": { "type": "string", "description": "Transaction history tab > Ref. no. > The reference number of the document/invoice." }, "billingDate": { "type": "string", "description": "Transaction history tab > Invoicing date > The date when the invoice was issued.", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "description": "A system generated date/time that indicates the last change for the document.", "format": "date-time" } } }, "ContractUsageDto": { "type": "object", "properties": { "contract": { "type": "string" }, "transaction": { "type": "array", "items": { "$ref": "#/components/schemas/ContractUsageLineDto" }, "description": "Transactions not yet invoiced tab or Transaction history tab" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" } } }, "ContractUsageLineUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "transactionNumber": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "inventory": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" } }, "description": "This class represent a Contract Usage Line in Contract Usage Controller. Used to pass data to server for creating or updating an Contract Usage Line" }, "ContractUsageUpdateDto": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/ContractUsageLineUpdateDto" } } }, "description": "This class represent a Contract Usage in Contract Usage Controller. Used to pass data to server for creating or updating an Contract Usage" }, "ContractUsageQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "format": "int32" }, "skipRecords": { "type": "integer", "format": "int32" }, "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string" } } }, "CountryQueryParameters": { "type": "object", "properties": { "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "accountInCreditNoteLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Account* > The sales account used for the transaction." }, "vatCodeInCreditNoteLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "VAT category > The VAT category (if applied) for the transaction. The category represents the type of goods or services." }, "subaccountInCreditNoteLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: Subaccount* > The corresponding subaccount used for this transaction." }, "sellerInCreditNoteLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Salesperson ID > The identifier of the salesperson involved." }, "branchNumberInCreditNoteLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Branch* > The branch that sells the line item or provides the service." }, "CreditNoteLineDto": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "projectTask": { "$ref": "#/components/schemas/ProjectTaskIdDescriptionDto" }, "lineNumber": { "type": "integer", "description": "Line no. > A counter of lines in the overview of cash sales document overview.", "format": "int32" }, "inventoryNumber": { "type": "string", "description": "Item ID > The item ID of the line item, if applicable. Only a non-stock item can be selected." }, "description": { "type": "string", "description": "Transaction descr. > Any brief comment relevant to the transaction.The alphanumeric string may contain up to 30 characters." }, "quantity": { "type": "number", "description": "Quantity > The quantity of items (goods or services) of a particular type sold to the customer.", "format": "double" }, "unitPrice": { "type": "number", "description": "Unit price > The unit price set for the item or service. If you want to update the unit price\r\nautomatically to the current value(that is, the applicable sales or default price),\r\nyou can use the Recalculate Prices and Discounts action.If you have modified\r\nthe unit price and saved the document, the value will not be updated by the\r\nsystem if you change the document date.", "format": "double" }, "unitPriceInCurrency": { "type": "number", "description": "Background calculation giving you the Unit price in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualAmount": { "type": "number", "description": "Manual amount > a check box indicating that the amount has been entered manually.", "format": "double" }, "manualAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Manual amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "amount": { "type": "number", "description": "Amount > The amount after the discount has been applied. The value of this read-only box\r\nis calculated automatically by deducting the discount amount from the extended price.", "format": "double" }, "cost": { "type": "number", "description": "Cost > The total cost of the line in default currency. \r\nThe value will always be 0 for unreleased documents.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "account": { "$ref": "#/components/schemas/accountInCreditNoteLineDto" }, "vatCode": { "$ref": "#/components/schemas/vatCodeInCreditNoteLineDto" }, "uom": { "type": "string", "description": "UoM > The unit of measure (UoM) for the item." }, "discountPercent": { "type": "number", "description": "Discount percent > The percent of the line-level discount that has been applied manually or\r\nautomatically.The system selects the Manual Discount check box and\r\ncalculates the discount amount after you have entered the percent manually and\r\nsaved your changes or added a new line.", "format": "double" }, "discountAmount": { "type": "number", "description": "Discount amount > The amount of the line-level discount that has been applied manually or\r\nautomatically to this line.The system selects the Manual Discount check box\r\nand calculates the line amount after you have entered the discount amount\r\nmanually and save your changes or added a new line.", "format": "double" }, "discountAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Discount amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Manual discount > A check box that indicates (if selected) that the discount has been applied\r\nmanually.If you clear the check box, the system clears entered discount percent,\r\nor discount amount, or selected discount code." }, "subaccount": { "$ref": "#/components/schemas/subaccountInCreditNoteLineDto" }, "salesperson": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use Seller instead" }, "seller": { "$ref": "#/components/schemas/sellerInCreditNoteLineDto" }, "deferralSchedule": { "type": "integer", "description": "Original deferral schedule > A read-only column filled in by the system in the Cash return documents created by the reversing process. It shows the identifier of the deferral schedule associated with the original Cash sale document.", "format": "int32" }, "deferralCode": { "type": "string", "description": "The deferral code assigned to the stock item or non-stock item specified in this\r\ndocument line.Upon release of the document, the system generates a deferral\r\nschedule (or schedules) based on the settings defined in this deferral code." }, "discountCode": { "type": "string", "description": "The code of the line discount that has been applied to this line automatically or manually." }, "note": { "type": "string", "description": "Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order." }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCreditNoteLineDto" }, "externalLink": { "type": "string" } } }, "AttachmentDto": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the attachment." }, "id": { "type": "string", "description": "The ID of the attachment", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "revision": { "type": "integer", "description": "The version of the attachment.", "format": "int32" } } }, "ContactIdNameDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } } }, "salesPersonInCreditNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The document details tab > Salesperson ID > The salesperson involved." }, "invoiceAddressInCreditNoteDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInCustomerDocumentAddressDto" }, "county": { "$ref": "#/components/schemas/countyInCustomerDocumentAddressDto" }, "overrideAddress": { "type": "boolean", "description": "Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer." } }, "description": "The Invoice address tab > The Invoice address section." }, "invoiceContactInCreditNoteDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "businessName": { "type": "string" }, "attention": { "type": "string" }, "email": { "type": "string" }, "phone1": { "type": "string" }, "overrideContact": { "type": "boolean" } }, "description": "The Invoice address tab > The Invoice contact section." }, "customerInCreditNoteDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer associated with the document." }, "paymentMethodInCreditNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The Payment information section > Payment method > The identifier for the payment method that the customer will use to pay the document." }, "locationInCreditNoteDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Location > The location of the customer related to the document. By default, it is the default\r\nlocation of the selected customer or, if the invoice is created from an opportunity,\r\nit is the customer location specified for the opportunity." }, "branchNumberInCreditNoteDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Financial details tab > Branch > The branch with which this invoice or memo is associated. The field is available if your company is set up with branches." }, "projectInCreditNoteDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Project* > The identifier and description of the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window." }, "accountInCreditNoteDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The Document details tab > Account * > The sales account used for the transaction." }, "subaccountInCreditNoteDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The Document details tab > Subaccount* > The corresponding subaccount used for this transaction." }, "CreditNoteDto": { "type": "object", "properties": { "externalReference": { "type": "string" }, "contact": { "$ref": "#/components/schemas/ContactIdNameDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNoteLineDto" } }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the document is a draft. A document with the On Hold status may be edited and cannot be released." }, "discountTotal": { "type": "number", "description": "The top part > Discount total > The document discount total.", "format": "double" }, "discountTotalInCurrency": { "type": "number", "description": "The top part > Discount total > The document discount total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "detailTotal": { "type": "number", "description": "The top part > Detail total > The document total, which the system calculates for all line items in the Document details tab.", "format": "double" }, "detailTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Detail total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "vatTaxableTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT taxable total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt. total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the tax with the Include in VAT Exempt Total check box selected on the Taxes form.This box is available only if the VAT Reporting feature is enabled in your system.", "format": "double" }, "vatExemptTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT exempt. total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "salesPersonID": { "type": "integer", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead", "format": "int32" }, "salesPersonDescr": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead" }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInCreditNoteDto" }, "paymentReference": { "type": "string", "description": "///The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window.." }, "invoiceAddress": { "$ref": "#/components/schemas/invoiceAddressInCreditNoteDto" }, "invoiceContact": { "$ref": "#/components/schemas/invoiceContactInCreditNoteDto" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ArAdjustDto" } }, "dontPrint": { "type": "boolean" }, "dontEmail": { "type": "boolean" }, "revoked": { "type": "boolean" }, "customer": { "$ref": "#/components/schemas/customerInCreditNoteDto" }, "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off" }, "referenceNumber": { "type": "string", "description": "The Top part > Ref. no. > The reference number of the customer ledger document in the system." }, "postPeriod": { "type": "string", "description": "The top part > Post period > The period to which the document should be posted. Format YYYYMM." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "documentDate": { "type": "string", "description": "The top part > Date* > The date when the customer ledger document was created.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting \"Use Orig Invoice Date\" is active in AR Preferences.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email." }, "currencyId": { "type": "string", "description": "The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window." }, "amount": { "type": "number", "description": "The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.\r\nIf the check box is cleared, then the value appears when the document status is Open.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "balance": { "type": "number", "description": "The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. \r\nFor a document used in the application process, this is the balance after the payments were applied.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInCreditNoteDto" }, "customerRefNumber": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "invoiceText": { "type": "string", "description": "The top part > Invoice text > Any user-provided description of the customer ledger document." }, "lastModifiedDateTime": { "type": "string", "description": "System generated field for last modification date/time of document.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "The Attachments tab > Creation time > The date the attachment was created.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "vatTotal": { "type": "number", "description": "The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "location": { "$ref": "#/components/schemas/locationInCreditNoteDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCreditNoteDto" }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "project": { "$ref": "#/components/schemas/projectInCreditNoteDto" }, "account": { "$ref": "#/components/schemas/accountInCreditNoteDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInCreditNoteDto" }, "customerProject": { "type": "string", "description": "The top part > Customer project no. > The customer project no. used in AutoInvoice." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a invoice in InvoiceController. Used by getting data." }, "CreditNoteLineUpdateDto": { "type": "object", "properties": { "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "taskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "unitPriceInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "accountNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatCodeId": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "discountAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "salesperson": { "$ref": "#/components/schemas/DtoValueOfString" }, "deferralSchedule": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "deferralCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "termStartDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "termEndDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "postPeriodInCreditNoteUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "financialPeriodInCreditNoteUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM." }, "salesPersonIDInCreditNoteUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The field is deprecated for customer document endpoints, please use Salesperson instead" }, "salespersonInCreditNoteUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The identifier of the salesperson involved." }, "CreditNoteUpdateDto": { "type": "object", "properties": { "currencyId": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerRefNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "externalReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "contact": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/CreditNoteLineUpdateDto" } }, "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "childCustomerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "consolidateInvoices": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "documentDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "origInvoiceDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInCreditNoteUpdateDto" }, "financialPeriod": { "$ref": "#/components/schemas/financialPeriodInCreditNoteUpdateDto" }, "invoiceText": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPersonID": { "$ref": "#/components/schemas/salesPersonIDInCreditNoteUpdateDto" }, "salesperson": { "$ref": "#/components/schemas/salespersonInCreditNoteUpdateDto" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "dontPrint": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "dontEmail": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "ReleaseInvoiceActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "CreditTermQueryParameters": { "type": "object", "properties": { "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string", "description": "System retrieved information for state/condition." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "termsId": { "type": "string" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "InstalmentSchedule": { "type": "object", "properties": { "days": { "type": "integer", "format": "int32" }, "percent": { "type": "number", "format": "double" } } }, "CreditTermDto": { "type": "object", "properties": { "termsId": { "type": "string" }, "description": { "type": "string" }, "visibleTo": { "type": "string", "description": "VisibleTo: AL - All, VE - Suppliers, CU - Customers, DS - Disabled" }, "dueDateType": { "type": "string", "description": "Due Date Type , values:\r\nN - Fixed Number of Days, \r\nD - Day of Next Month, \r\nE - End of the Month, \r\nM - End of Next Month, \r\nT - Day of the Month, \r\nP - Fixed Number of Days starting Next Month, \r\nC - Custom." }, "moveDueDateIfOnTheWeekend": { "type": "string", "description": "Move Due Date If On The Weekend, values:\r\n1 - Keep the exact date, \r\n2 - Day before (Friday), \r\n3 - Day after (Monday)." }, "dueDay1": { "type": "integer", "format": "int32" }, "dueDay1DayFrom1": { "type": "integer", "format": "int32" }, "dueDay1DayTo1": { "type": "integer", "format": "int32" }, "dueDay2": { "type": "integer", "format": "int32" }, "dueDay2DayFrom1": { "type": "integer", "format": "int32" }, "dueDay2DayTo1": { "type": "integer", "format": "int32" }, "discountType": { "type": "string", "description": "Discount Type , values:\r\nN - Fixed Number of Days, \r\nD - Day of Next Month, \r\nE - End of the Month, \r\nM - End of Next Month, \r\nT - Day of the Month, \r\nP - Fixed Number of Days starting Next Month." }, "discountDay": { "type": "integer", "format": "int32" }, "discountPercent": { "type": "number", "format": "double" }, "delayDays": { "type": "integer", "format": "int32" }, "calculationType": { "type": "string", "description": "Calculation Type: G - Gross amount, N - Net amount" }, "instalmentType": { "type": "string", "description": "Instalment Type: S - Simple, M - Multiple" }, "numberOfInstalments": { "type": "integer", "format": "int32" }, "instalmentFrequency": { "type": "string", "description": "Instalment Frequency, values:\r\nW - Weekly,\r\nM - Monthly,\r\nB - Semi-monthly (the second installment comes a half a month after the first one, and so on)." }, "instalmentMethod": { "type": "string", "description": "Instalment Method, values:\r\nE - Equal Parts,\r\nA - All Tax in First Installment (the total amount before tax is split equally between installments and the entire amount of tax is added to the first installment),\r\nS - Split by Percents in Table (the days and amounts of installments are defined by the related Instalments Schedule records)." }, "instalmentsSchedule": { "type": "array", "items": { "$ref": "#/components/schemas/InstalmentSchedule" } }, "createdDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" } } }, "BasePaginationDtoOfCreditTermDto": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/CreditTermDto" } } } }, "CurrencyDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Currency Id." }, "description": { "type": "string", "description": "Currency description." }, "symbol": { "type": "string", "description": "Currency symbol." }, "isBaseCurrency": { "type": "boolean", "description": "Identify if the currency is the base currency." }, "decimalPrecision": { "type": "integer", "description": "Decimal precision.", "format": "int32" }, "isUsedForAccounting": { "type": "boolean", "description": "Identify if is used for accounting." } }, "description": "Mandatory field: The top part > Currency ID* > The unique identifier for the currency." }, "CurrencyRateParameters": { "type": "object", "properties": { "fromDate": { "type": "string", "description": "From effective date.", "format": "date-time" }, "toDate": { "type": "string", "description": "To effective date.", "format": "date-time" }, "fromCurrency": { "type": "string", "description": "Identifies from currency." }, "toCurrency": { "type": "string", "description": "Identifies to currency." }, "rateType": { "type": "string", "description": "Identifies rate type." } } }, "CurrencyRateDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Currency rate Id.", "format": "int32" }, "fromCurrencyId": { "type": "string", "description": "From Currency Id." }, "toCurrencyId": { "type": "string", "description": "To Currency Id." }, "rateType": { "type": "string", "description": "Currency rate type." }, "rate": { "type": "number", "description": "Currency rate.", "format": "double" }, "effectiveDate": { "type": "string", "description": "EffectiveDate", "format": "date-time" }, "multDiv": { "type": "string", "description": "Mult/Div" }, "rateReciprocal": { "type": "number", "description": "Rate reciprocal", "format": "double" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" } } }, "DtoValueOfCurrencyMultDiv": { "type": "object", "properties": { "value": { "enum": [ "Multiply", "Divide" ], "type": "string" } } }, "fromCurrencyIdInCreateCurrencyRateDto": { "properties": { "value": { "type": "string" } }, "description": "From currency id." }, "toCurrencyIdInCreateCurrencyRateDto": { "properties": { "value": { "type": "string" } }, "description": "To currency id." }, "rateTypeInCreateCurrencyRateDto": { "properties": { "value": { "type": "string" } }, "description": "Currency rate type." }, "effectiveDateInCreateCurrencyRateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "Currency effective date." }, "rateInCreateCurrencyRateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "Currency rate." }, "multDivInCreateCurrencyRateDto": { "properties": { "value": { "enum": [ "Multiply", "Divide" ], "type": "string" } }, "description": "Mult/Div." }, "CreateCurrencyRateDto": { "type": "object", "properties": { "fromCurrencyId": { "$ref": "#/components/schemas/fromCurrencyIdInCreateCurrencyRateDto" }, "toCurrencyId": { "$ref": "#/components/schemas/toCurrencyIdInCreateCurrencyRateDto" }, "rateType": { "$ref": "#/components/schemas/rateTypeInCreateCurrencyRateDto" }, "effectiveDate": { "$ref": "#/components/schemas/effectiveDateInCreateCurrencyRateDto" }, "rate": { "$ref": "#/components/schemas/rateInCreateCurrencyRateDto" }, "multDiv": { "$ref": "#/components/schemas/multDivInCreateCurrencyRateDto" } } }, "rateInUpdateCurrencyRateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "Currency rate." }, "multDivInUpdateCurrencyRateDto": { "properties": { "value": { "enum": [ "Multiply", "Divide" ], "type": "string" } }, "description": "Mult/Div." }, "UpdateCurrencyRateDto": { "type": "object", "properties": { "rate": { "$ref": "#/components/schemas/rateInUpdateCurrencyRateDto" }, "multDiv": { "$ref": "#/components/schemas/multDivInUpdateCurrencyRateDto" } } }, "CurrencyRateTypeDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Currency rate type Id." }, "description": { "type": "string", "description": "Description." }, "daysEffective": { "type": "integer", "description": "Days effective.", "format": "int32" } } }, "idInCreateCurrencyRateTypeDto": { "properties": { "value": { "type": "string" } }, "description": "Currency rate type id." }, "descriptionInCreateCurrencyRateTypeDto": { "properties": { "value": { "type": "string" } }, "description": "Description." }, "daysEffectiveInCreateCurrencyRateTypeDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "Days effective." }, "CreateCurrencyRateTypeDto": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/idInCreateCurrencyRateTypeDto" }, "description": { "$ref": "#/components/schemas/descriptionInCreateCurrencyRateTypeDto" }, "daysEffective": { "$ref": "#/components/schemas/daysEffectiveInCreateCurrencyRateTypeDto" } } }, "CustomerClassDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The top part > Class ID > The unique identifier of the class. You can use an alphanumeric string of up to 10 characters." }, "description": { "type": "string", "description": "The top part > Description > A detailed description of the customer class." }, "taxZoneId": { "type": "string", "description": "The General information tab > VAT zone ID > The default VAT zone for customers of the class." }, "requiredTaxzoneId": { "type": "boolean", "description": "The General information tab > Require VAT zone > A check box that means (if selected) that the VAT zone value is required for customers of the class." }, "paymentMethodId": { "type": "string", "description": "The General information tab > Payment method > The payment method used by default in relations with these customers." }, "invoiceOrdersSeparately": { "type": "boolean", "description": "The General information tab > Default general settings section > Invoice orders separately > Indicates whether customers in the class should default to separate invoicing." }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassAttributeDto" } } } }, "CustomerDescriptionDto": { "type": "object", "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } } }, "CustomerBalanceDto": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/CustomerDescriptionDto" }, "balance": { "type": "number", "format": "double" }, "totalOrder": { "type": "number", "format": "double" }, "totalLoan": { "type": "number", "format": "double" }, "totalSalePeriod": { "type": "number", "format": "double" }, "totalSaleYear": { "type": "number", "format": "double" }, "totalDiscountPeriod": { "type": "number", "format": "double" }, "totalDiscountYear": { "type": "number", "format": "double" }, "lastModified": { "type": "string", "format": "date-time" } } }, "CustomerDirectDebitDto": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mandateId": { "type": "string" }, "mandateDescription": { "type": "string" }, "dateOfSignature": { "type": "string", "format": "date-time" }, "isDefault": { "type": "boolean" }, "oneTime": { "type": "boolean" }, "bic": { "type": "string" }, "iban": { "type": "string" }, "lastCollectionDate": { "type": "string", "format": "date-time" }, "maxAmount": { "type": "number", "format": "double" }, "expirationDate": { "type": "string", "format": "date-time" }, "branch": { "type": "string" } } }, "SalesOrderQueryParameters": { "type": "object", "properties": { "orderType": { "type": "string", "description": "Filter by Order type." }, "status": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string", "description": "Select to filter on status on order." }, "greaterThanValue": { "type": "string", "description": "Filter on Order no. greater than value." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "showNotes": { "type": "boolean", "description": "Set to true to include notes." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ParentRecordDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } } }, "SalesOrderShipmentDto": { "type": "object", "properties": { "shipmentType": { "type": "string" }, "shipmentNo": { "type": "string" }, "shipmentDate": { "type": "string", "format": "date-time" }, "shippedQty": { "type": "number", "format": "double" }, "shippedWeight": { "type": "number", "format": "double" }, "shippedVolume": { "type": "number", "format": "double" }, "invoiceType": { "type": "string" }, "invoiceNo": { "type": "string" }, "inventoryDocType": { "type": "string" }, "inventoryRefNo": { "type": "string" } } }, "salesPersonInSalesOrderLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Salesperson ID > The salesperson associated with the sale of the line item." }, "subaccountInSalesOrderLineDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Subaccount > A subcategory of the account that carries identifying information." }, "SalesOrderLineDto": { "type": "object", "properties": { "invoiceNbr": { "type": "string", "description": "The reference number of the invoice generated for this order. This number is collected from the system and not visible on the sales order line." }, "operation": { "enum": [ "Issue", "Receipt" ], "type": "string", "description": "The operation to be performed in the workspace to fulfil the order. This information is collected from the system and not visible on the sales order line." }, "freeItem": { "type": "boolean", "description": "A check box that indicates (if selected) that the stock item specified in the row is a free item. This information is collected from the system and not visible on the sales order line." }, "requestedOn": { "type": "string", "description": "Mandatory field: The top part > Requested on* > The date when the customer wants to receive the goods. The default value is the current business date.", "format": "date-time" }, "shipOn": { "type": "string", "description": "Ship on > The date when the item is to be shipped.", "format": "date-time" }, "shipComplete": { "enum": [ "BackOrderAllowed", "CancelRemainder", "ShipComplete" ], "type": "string", "description": "Shipping rule > An option that controls whether incomplete and partial shipments for the order are allowed. (Values: Ship complete, Back order allowed, Cancel remainder)" }, "undershipThreshold": { "type": "number", "description": "Undership threshold (%) > The minimal percentage of goods shipped (with respect to the ordered quantity) to consider the order shipped completely.", "format": "double" }, "overshipThreshold": { "type": "number", "description": "Overship threshold (%) > The maximum percentage of goods shipped (with respect to the ordered quantity) allowed by the customer.", "format": "double" }, "completed": { "type": "boolean", "description": "Completed > A check box that can be selected to indicate to the system that this line is completed." }, "markForPO": { "type": "boolean", "description": "Mark for purchase order > A check box that indicates (if selected) that the order line was marked for purchasing (if it has not been shipped completely)." }, "poSource": { "enum": [ "DropShipToOrder", "Manufactured", "None", "Purchased", "PurchaseToOrder", "Transfer" ], "type": "string", "description": "Purchase order source > The purchase order source to be used to fulfill this line, which can be one of the following options: Purchase to order, Drop-shipment." }, "lotSerialNbr": { "type": "string", "description": "Lot/serial no. > The lot or serial number of the item for returns" }, "expirationDate": { "type": "string", "description": "Expiration date > The expiration date for the item with the specified lot number.", "format": "date-time" }, "reasonCode": { "type": "string", "description": "Reason code > The reason code to be used for creation or cancellation of the order, if applicable." }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInSalesOrderLineDto" }, "taxCategory": { "type": "string", "description": "VAT code > The VAT category of the goods mentioned in this line." }, "commissionable": { "type": "boolean", "description": "VAT code > The VAT category of the goods mentioned in this line." }, "alternateID": { "type": "string", "description": "Alternate ID > The alternate ID for the item, such as the item ID used by the customer." }, "projectTask": { "type": "integer", "description": "Project task > The particular task of the project with which this document is associated.", "format": "int32" }, "projectTaskCd": { "type": "string", "description": "Project task code > The particular task code of the project with which this document is associated." }, "subaccount": { "$ref": "#/components/schemas/subaccountInSalesOrderLineDto" }, "externalLink": { "type": "string" }, "isRotRutDeductible": { "type": "boolean" }, "lineNbr": { "type": "integer", "description": "Document details tab > Line no. > The line number of the document.", "format": "int32" }, "sortOrder": { "type": "integer", "description": "Document details tab > Line order > The order number of the document line. The system regenerates this number automatically when you reorder the lines in the table.", "format": "int32" }, "inventory": { "$ref": "#/components/schemas/InventoryNumberDescriptionDto" }, "warehouse": { "$ref": "#/components/schemas/WarehouseIdDescriptionDto" }, "uom": { "type": "string", "description": "Mandatory field: Document details tab > UoM* > The unit of measure (UoM) used for the item with this item ID." }, "quantity": { "type": "number", "description": "Document details tab > Quantity > The quantity of the item sold, measured in the UoM.", "format": "double" }, "qtyOnShipments": { "type": "number", "description": "Document details tab > Qty. on shipments > A read-only column that displays the quantity of the stock item being prepared for shipment and already shipped for this order.", "format": "double" }, "openQty": { "type": "number", "description": "Document details tab > Open qty. > The quantity of the item to be shipped; that is, the total quantity minus the quantity shipped according to closed shipment documents.", "format": "double" }, "unitCost": { "type": "number", "description": "Document details tab > Unit Cost > The cost of the unit on the sales order.", "format": "double" }, "unitPrice": { "type": "number", "description": "Document details tab > Unit price > The price of the unit on the sales order.", "format": "double" }, "unitPriceInBaseCurrency": { "type": "number", "format": "double" }, "discountCode": { "type": "string", "description": "Mandatory field: Document details tab > Discount details tab > Discount code* > The code of the discount that has been applied to this line." }, "discountPercent": { "type": "number", "description": "Document details tab > Discount percent > The percent of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).", "format": "double" }, "discountAmount": { "type": "number", "description": "Document details tab > Discount amount > The amount of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Document details tab > Manual discount > A check box that indicates (if selected) that the discount has been applied manually." }, "discUnitPrice": { "type": "number", "description": "Document details tab > Disc. unit price > The unit price, which has been recalculated after the application of discounts.", "format": "double" }, "extPrice": { "type": "number", "description": "Document details tab > Extended cost > The extended price, which is the unit price multiplied by the quantity.", "format": "double" }, "unbilledAmount": { "type": "number", "description": "Document details tab > Amount not yet invoiced > The amount of cancelled shipments and cancelled remainders.", "format": "double" }, "lineDescription": { "type": "string", "description": "Document details tab > Line description > The description of the unit." }, "branchNumber": { "$ref": "#/components/schemas/BranchNumberDto" }, "note": { "type": "string", "description": "Tables in tab > Icon Notes > Pop-up window for providing any user-defined text connected to the order." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "The data containing information about the document attachments" } } }, "SigmaIntrastatTransactionDescriptionDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Click on the magnifier. > The identifier.", "format": "int32" }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "ShippingZoneDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "ShippingTermsDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "FOBPointDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "CarrierDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "WarehouseIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "EmployeeDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Employee internal user ID. This is the ID of the user linked to the employee", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "employeeId": { "type": "string", "description": "The Financial settings tab > The Financial information section > Owner > Click the magnifier > Employee ID > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEEsegmented key. This information is retrieved from window EP203000." }, "name": { "type": "string", "description": "The Financial settings tab > The Financial information section > Owner > Click the magnifier > Employee name > The name of this employee. This information is retrieved from window EP203000." } } }, "countryInSalesOrderAddressDto": { "properties": { "id": { "type": "string", "description": "Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166." }, "name": { "type": "string", "description": "Mandatory field: Country name* > The complete name of the country." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Country > The country." }, "countyInSalesOrderAddressDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "County > The county or province." }, "SalesOrderAddressDto": { "type": "object", "properties": { "overrideAddress": { "type": "boolean", "description": "Override address > A check box indicating that you want to override the default address information." }, "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInSalesOrderAddressDto" }, "county": { "$ref": "#/components/schemas/countyInSalesOrderAddressDto" } } }, "SalesOrderContactDto": { "type": "object", "properties": { "overrideContact": { "type": "boolean", "description": "Override contact > A check box indicating that you want to override the default contact information." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } } }, "soBillingContactInSalesOrderDto": { "properties": { "overrideContact": { "type": "boolean", "description": "Override contact > A check box indicating that you want to override the default contact information." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "The Financial settings tab > The Invoice address section or on the Delivery address section" }, "soBillingAddressInSalesOrderDto": { "properties": { "overrideAddress": { "type": "boolean", "description": "Override address > A check box indicating that you want to override the default address information." }, "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInSalesOrderAddressDto" }, "county": { "$ref": "#/components/schemas/countyInSalesOrderAddressDto" } }, "description": "Financial settings tab > Invoice address section" }, "customerVATZoneInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Financial settings tab > Financial information section > Customer VAT zone > The customers VAT zone to be used to process customer sales orders, which generally is the zone associated with the customer's delivery address." }, "termsInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Financial settings tab > Financial information section > Terms* > The credit terms used in relations with the customer. See also window CS206500." }, "salesPersonInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Commissions tab > Salesperson ID > The salesperson." }, "ownerInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Employee internal user ID. This is the ID of the user linked to the employee", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "employeeId": { "type": "string", "description": "The Financial settings tab > The Financial information section > Owner > Click the magnifier > Employee ID > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEEsegmented key. This information is retrieved from window EP203000." }, "name": { "type": "string", "description": "The Financial settings tab > The Financial information section > Owner > Click the magnifier > Employee name > The name of this employee. This information is retrieved from window EP203000." } }, "description": "The Financial settings tab > Financial information section > Owner > The user in the work group who is responsible for the sales order." }, "soShippingContactInSalesOrderDto": { "properties": { "overrideContact": { "type": "boolean", "description": "Override contact > A check box indicating that you want to override the default contact information." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Delivery settings tab > Delivery address contact section" }, "soShippingAddressInSalesOrderDto": { "properties": { "overrideAddress": { "type": "boolean", "description": "Override address > A check box indicating that you want to override the default address information." }, "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInSalesOrderAddressDto" }, "county": { "$ref": "#/components/schemas/countyInSalesOrderAddressDto" } }, "description": "Delivery settings tab > Delivery address section" }, "preferredWarehouseInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Delivery settings tab > The shipping information section > Preferred warehouse ID" }, "shipViaInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Delivery settings tab > Shipping information section > Ship via > The Ship via code that represents the carrier and its service to be used for shipping the ordered goods." }, "fobPointInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Shipping information section > FOB point > The point where ownership of the goods is transferred to the customer." }, "shippingTermsInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Shipping information section > Shipping terms" }, "shippingZoneInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Shipping information section > Shipping zone" }, "transactionTypeInSalesOrderDto": { "properties": { "id": { "type": "integer", "description": "Click on the magnifier. > The identifier.", "format": "int32" }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Intrastat section > Transaction type" }, "paymentMethodInSalesOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Payment settings tab > Payment method" }, "customerInSalesOrderDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "The top part > Customer > The customer that has ordered the goods or services." }, "locationInSalesOrderDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part > Location* > The customer location from which the goods or services have been ordered or, if the sales order is created from an opportunity, the customer location specified for the opportunity." }, "branchNumberInSalesOrderDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Document details tab > Branch* > The branch of the company." }, "SalesOrderDto": { "type": "object", "properties": { "projectCD": { "type": "string", "description": "Mandatory field: The top part > Project* > The field consists of Project ID and Project description. Project ID: The identifier for the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window." }, "printDescriptionOnInvoice": { "type": "boolean", "description": "The top part > Print description on invoice > A check box" }, "printNoteOnExternalDocuments": { "type": "boolean", "description": "The top part > Print note on external sales documents > A check box" }, "printNoteOnInternalDocuments": { "type": "boolean", "description": "The top part > Print line note on internal sales documents > A check box" }, "soBillingContact": { "$ref": "#/components/schemas/soBillingContactInSalesOrderDto" }, "soBillingAddress": { "$ref": "#/components/schemas/soBillingAddressInSalesOrderDto" }, "customerVATZone": { "$ref": "#/components/schemas/customerVATZoneInSalesOrderDto" }, "invoiceSeparately": { "type": "boolean", "description": "Financial settings tab > Financial information section > Invoice separately > A check box that indicating that this document is to be invoiced separately (if that is required)." }, "invoiceNbr": { "type": "string", "description": "Financial settings tab > Financial information section > Invoice no.> The invoice number of the invoice generated for this order." }, "invoiceDate": { "type": "string", "description": "Financial settings tab > Financial information section > Invoice date> The date of the invoice generated for the order.", "format": "date-time" }, "terms": { "$ref": "#/components/schemas/termsInSalesOrderDto" }, "dueDate": { "type": "string", "description": "Financial settings tab > Financial information section > Due date > The due date of the invoice according to the credit terms.", "format": "date-time" }, "cashDiscountDate": { "type": "string", "description": "Financial settings tab > Financial information section > Cash discount date > The date when the cash discount is available for the invoice based on the credit terms.", "format": "date-time" }, "postPeriod": { "type": "string", "description": "The Financial settings tab > Financial information section > Post period > The period to post the transactions generated by the invoice. Format MMYYYY." }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInSalesOrderDto" }, "commissionPercent": { "type": "string", "description": "The Commissions tab > Commission (%) > The percentage of commission generally earned by the salesperson." }, "commissionAmount": { "type": "string", "description": "The Commissions tab > Commission amt. >\tThe commission amount earned by the salesperson on this document." }, "commissionableAmount": { "type": "string", "description": "The Commissions tab > Commissionable amount\t> The amount used to calculate the commission." }, "owner": { "$ref": "#/components/schemas/ownerInSalesOrderDto" }, "origOrderType": { "type": "string", "description": "Mandatory field: The top part > Order type* > The type of the document, which is one of the predefined order types or a custom order type created by using the window SO201000." }, "origOrderNbr": { "type": "string", "description": "The top part > Order no. > The order number of the document." }, "soShippingContact": { "$ref": "#/components/schemas/soShippingContactInSalesOrderDto" }, "soShippingAddress": { "$ref": "#/components/schemas/soShippingAddressInSalesOrderDto" }, "schedShipment": { "type": "string", "description": "Delivery settings tab > Shipping information section > Sched. shipment > The date when the ordered goods are scheduled to be shipped.", "format": "date-time" }, "shipSeparately": { "type": "boolean", "description": "Delivery settings tab > Shipping information section > Ship separately > This check box indicates that the goods for the customer should be shipped separately for each sales order." }, "shipComplete": { "enum": [ "BackOrderAllowed", "CancelRemainder", "ShipComplete" ], "type": "string", "description": "Delivery settings tab > Shipping information section > Shipping rule > An option that controls whether incomplete and partial shipments for the order are allowed." }, "cancelBy": { "type": "string", "description": "Delivery settings tab > Shipping information section > Cancel by > The date when the order should be cancelled if the Back order allowed option has been selected in the Shipping rule field.", "format": "date-time" }, "canceled": { "type": "boolean", "description": "The Delivery settings tab > The Shipping information section > Cancelled > A check box that indicates that the order has been cancelled on the date specified in Cancel by." }, "preferredWarehouse": { "$ref": "#/components/schemas/preferredWarehouseInSalesOrderDto" }, "shipVia": { "$ref": "#/components/schemas/shipViaInSalesOrderDto" }, "fobPoint": { "$ref": "#/components/schemas/fobPointInSalesOrderDto" }, "priority": { "type": "integer", "description": "Delivery settings tab > Shipping information section > Priority > Field only for informational purposes. The level of priority for processing order of this customer, as specified for the customer on the Shipping settings tab on the AR303000 window.", "format": "int32" }, "shippingTerms": { "$ref": "#/components/schemas/shippingTermsInSalesOrderDto" }, "shippingZone": { "$ref": "#/components/schemas/shippingZoneInSalesOrderDto" }, "residentialDelivery": { "type": "boolean", "description": "Delivery settings tab > Shipping information section > Residential delivery > A check box that you select to indicate that the shipment should be delivered to a residential area." }, "saturdayDelivery": { "type": "boolean", "description": "Delivery settings tab > Shipping information section > Saturday delivery > A check box that indicates that the order may be delivered on Saturday." }, "insurance": { "type": "boolean", "description": "Delivery settings tab > Shipping information section > Insurance > A check box that you select to indicate that insurance is required for this order." }, "transactionType": { "$ref": "#/components/schemas/transactionTypeInSalesOrderDto" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInSalesOrderDto" }, "cashAccount": { "type": "string", "description": "Payment settings tab > Cash account" }, "paymentRef": { "type": "string", "description": "Payment settings tab > Payment ref." }, "isRotRutDeductible": { "type": "boolean", "description": "A check box indicating if the document is Rot/rut deductible (applicable for the Swedish markets)" }, "emailed": { "type": "boolean", "description": "A check box indicating if the document is emailed" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderLineDto" }, "description": "Document details tab >" }, "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderShipmentDto" }, "description": "Shipment tab >" }, "orderType": { "type": "string", "description": "Mandatory field: The top part > Order type > The type of the document, which is one of the predefined order types or a custom order type created by using the (SO201000) window." }, "orderNo": { "type": "string", "description": "The top part > Order no.: > The reference number of the document." }, "status": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following options: On hold, Credit hold, Pending aååroval, Rejected, Open, Cancelled, Shipping, Back order, Invoiced, Completed." }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that you select if the document is on hold and should not be processed further at this time." }, "date": { "type": "string", "description": "Mandatory field: The top part > Date* > The date of the document.", "format": "date-time" }, "requestOn": { "type": "string", "description": "Mandatory field: The top part > Requested on > The date when the customer wants to receive the goods; this date provides the default values for the Requested on dates for order lines.", "format": "date-time" }, "customerOrder": { "type": "string", "description": "The top part > Customer order > The reference number of the original customer document that the sales order is based on." }, "customerRefNo": { "type": "string", "description": "The top part > External reference > The reference number of the sales order in a third-party application if Visma.net Financials is integrated with such an application and imports the sales orders from it." }, "customer": { "$ref": "#/components/schemas/customerInSalesOrderDto" }, "contactId": { "type": "integer", "description": "The top part > Contact > The contact person of the customer.", "format": "int32" }, "location": { "$ref": "#/components/schemas/locationInSalesOrderDto" }, "currency": { "type": "string", "description": "The top part > Currency > The currency of the document." }, "description": { "type": "string", "description": "The top part > Description > A brief description of the document." }, "orderTotal": { "type": "number", "description": "The top part > Order total > The total amount of the document, which is calculated as follows:\r\nLine Total + Misc.Charges + Freight + Premium Freight – Discount Total+ Tax Total", "format": "double" }, "orderTotalInBaseCurrency": { "type": "number", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subject to VAT.", "format": "double" }, "vatTaxableTotalInBaseCurrency": { "type": "number", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt total > The document total that is exempt from VAT.", "format": "double" }, "vatExemptTotalInBaseCurrency": { "type": "number", "format": "double" }, "taxTotal": { "type": "number", "description": "The top part > VAT total > The total amount of tax paid on the document.", "format": "double" }, "taxTotalInBaseCurrency": { "type": "number", "format": "double" }, "exchangeRate": { "type": "number", "format": "double" }, "discountTotal": { "type": "number", "format": "double" }, "discountTotalInBaseCurrency": { "type": "number", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "Background information collected from the system.", "format": "date-time" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInSalesOrderDto" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the order." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "The data containing information about the document attachments" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a SOOrder in SOOrderController. Used by getting data." }, "SalesOrderDocumentLineDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "description": "Document details tab > Line no. > The line number of the document.", "format": "int32" }, "sortOrder": { "type": "integer", "description": "Document details tab > Line order > The order number of the document line. The system regenerates this number automatically when you reorder the lines in the table.", "format": "int32" }, "inventory": { "$ref": "#/components/schemas/InventoryNumberDescriptionDto" }, "warehouse": { "$ref": "#/components/schemas/WarehouseIdDescriptionDto" }, "uom": { "type": "string", "description": "Mandatory field: Document details tab > UoM* > The unit of measure (UoM) used for the item with this item ID." }, "quantity": { "type": "number", "description": "Document details tab > Quantity > The quantity of the item sold, measured in the UoM.", "format": "double" }, "qtyOnShipments": { "type": "number", "description": "Document details tab > Qty. on shipments > A read-only column that displays the quantity of the stock item being prepared for shipment and already shipped for this order.", "format": "double" }, "openQty": { "type": "number", "description": "Document details tab > Open qty. > The quantity of the item to be shipped; that is, the total quantity minus the quantity shipped according to closed shipment documents.", "format": "double" }, "unitCost": { "type": "number", "description": "Document details tab > Unit Cost > The cost of the unit on the sales order.", "format": "double" }, "unitPrice": { "type": "number", "description": "Document details tab > Unit price > The price of the unit on the sales order.", "format": "double" }, "unitPriceInBaseCurrency": { "type": "number", "format": "double" }, "discountCode": { "type": "string", "description": "Mandatory field: Document details tab > Discount details tab > Discount code* > The code of the discount that has been applied to this line." }, "discountPercent": { "type": "number", "description": "Document details tab > Discount percent > The percent of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).", "format": "double" }, "discountAmount": { "type": "number", "description": "Document details tab > Discount amount > The amount of the line-level discount that has been applied manually or automatically to this line item (if the item is not a free item).", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Document details tab > Manual discount > A check box that indicates (if selected) that the discount has been applied manually." }, "discUnitPrice": { "type": "number", "description": "Document details tab > Disc. unit price > The unit price, which has been recalculated after the application of discounts.", "format": "double" }, "extPrice": { "type": "number", "description": "Document details tab > Extended cost > The extended price, which is the unit price multiplied by the quantity.", "format": "double" }, "unbilledAmount": { "type": "number", "description": "Document details tab > Amount not yet invoiced > The amount of cancelled shipments and cancelled remainders.", "format": "double" }, "lineDescription": { "type": "string", "description": "Document details tab > Line description > The description of the unit." }, "branchNumber": { "$ref": "#/components/schemas/BranchNumberDto" }, "note": { "type": "string", "description": "Tables in tab > Icon Notes > Pop-up window for providing any user-defined text connected to the order." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "The data containing information about the document attachments" } }, "description": "This class represents a SOOrder in SOOrderController. Used by getting data." }, "customerInSalesOrderBasicDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "The top part > Customer > The customer that has ordered the goods or services." }, "locationInSalesOrderBasicDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part > Location* > The customer location from which the goods or services have been ordered or, if the sales order is created from an opportunity, the customer location specified for the opportunity." }, "branchNumberInSalesOrderBasicDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Document details tab > Branch* > The branch of the company." }, "SalesOrderBasicDto": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderDocumentLineDto" } }, "orderType": { "type": "string", "description": "Mandatory field: The top part > Order type > The type of the document, which is one of the predefined order types or a custom order type created by using the (SO201000) window." }, "orderNo": { "type": "string", "description": "The top part > Order no.: > The reference number of the document." }, "status": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following options: On hold, Credit hold, Pending aååroval, Rejected, Open, Cancelled, Shipping, Back order, Invoiced, Completed." }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that you select if the document is on hold and should not be processed further at this time." }, "date": { "type": "string", "description": "Mandatory field: The top part > Date* > The date of the document.", "format": "date-time" }, "requestOn": { "type": "string", "description": "Mandatory field: The top part > Requested on > The date when the customer wants to receive the goods; this date provides the default values for the Requested on dates for order lines.", "format": "date-time" }, "customerOrder": { "type": "string", "description": "The top part > Customer order > The reference number of the original customer document that the sales order is based on." }, "customerRefNo": { "type": "string", "description": "The top part > External reference > The reference number of the sales order in a third-party application if Visma.net Financials is integrated with such an application and imports the sales orders from it." }, "customer": { "$ref": "#/components/schemas/customerInSalesOrderBasicDto" }, "contactId": { "type": "integer", "description": "The top part > Contact > The contact person of the customer.", "format": "int32" }, "location": { "$ref": "#/components/schemas/locationInSalesOrderBasicDto" }, "currency": { "type": "string", "description": "The top part > Currency > The currency of the document." }, "description": { "type": "string", "description": "The top part > Description > A brief description of the document." }, "orderTotal": { "type": "number", "description": "The top part > Order total > The total amount of the document, which is calculated as follows:\r\nLine Total + Misc.Charges + Freight + Premium Freight – Discount Total+ Tax Total", "format": "double" }, "orderTotalInBaseCurrency": { "type": "number", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subject to VAT.", "format": "double" }, "vatTaxableTotalInBaseCurrency": { "type": "number", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt total > The document total that is exempt from VAT.", "format": "double" }, "vatExemptTotalInBaseCurrency": { "type": "number", "format": "double" }, "taxTotal": { "type": "number", "description": "The top part > VAT total > The total amount of tax paid on the document.", "format": "double" }, "taxTotalInBaseCurrency": { "type": "number", "format": "double" }, "exchangeRate": { "type": "number", "format": "double" }, "discountTotal": { "type": "number", "format": "double" }, "discountTotalInBaseCurrency": { "type": "number", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "Background information collected from the system.", "format": "date-time" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInSalesOrderBasicDto" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the order." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "The data containing information about the document attachments" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a SOOrder in SOOrderController. Used by getting data." }, "CustSalesPeopleQueryParameters": { "type": "object", "properties": { "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "CustSalesPersonsDto": { "type": "object", "properties": { "salePersonID": { "type": "string" }, "name": { "type": "string" }, "locationID": { "type": "string" }, "locationName": { "type": "string" }, "commisionPct": { "type": "number", "format": "double" }, "isDefault": { "type": "boolean" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "CustomerBalanceQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "format": "int32" }, "skipRecords": { "type": "integer", "format": "int32" }, "orderBy": { "type": "string" }, "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "NoteDto": { "type": "object", "properties": { "note": { "type": "string" } } }, "CustomerPaymentMethodInfoDto": { "type": "object", "properties": { "paymentMethodId": { "type": "string" }, "isDefault": { "type": "boolean" } } }, "EInvoiceContractDto": { "type": "object", "properties": { "fInvoiceContractID": { "type": "string" }, "fInvoiceIntermediatorID": { "type": "string" } } }, "CustomerGlAccountsDto": { "type": "object", "properties": { "customerLedgerAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "customerLedgerSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "salesAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "salesNonTaxableAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "salesEuAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "salesExportAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "salesSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "discountAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "discountSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "freightAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "freightSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "cashDiscountAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "cashDiscountSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "prepaymentAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "prepaymentSubaccount": { "$ref": "#/components/schemas/SubAccountDto" } } }, "PriceClassDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "AttributeIdValueDto": { "type": "object", "properties": { "id": { "type": "string" }, "value": { "type": "string", "description": "Value > The value of the attribute." }, "description": { "type": "string", "description": "Attribute > The description of the attribute." } } }, "ClassDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "mainAddressInCustomerDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "General information tab > Main address section >" }, "mainContactInCustomerDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "General information tab > Main contact section >" }, "customerClassInCustomerDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: General information tab > Financial settings section > Customer class* > The class to which the customer is assigned." }, "creditTermsInCustomerDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "General information tab > Financial settings section > Terms > The type of credit terms used in operations with the customer." }, "invoiceAddressInCustomerDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "Invoicing settings tab > Invoice address section >" }, "invoiceContactInCustomerDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Invoicing setting tab > Invoice contact section >" }, "deliveryAddressInCustomerDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "Delivery settings tab > Shipping address section >" }, "deliveryContactInCustomerDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Delivery settings tab > Shipping contact section >" }, "vatZoneInCustomerDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: Delivery settings tab > Default location settings section > VAT Zone* > The VAT zone of the customer's default location." }, "locationInCustomerDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Delivery settings tab > Default location settings section > Location name > A description of the customer location." }, "priceClassInCustomerDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Deliver settings tab > Default location settings section > Price class > The price class assigned to the customer." }, "glAccountsInCustomerDto": { "properties": { "customerLedgerAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "customerLedgerSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "salesAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "salesNonTaxableAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "salesEuAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "salesExportAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "salesSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "discountAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "discountSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "freightAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "freightSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "cashDiscountAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "cashDiscountSubaccount": { "$ref": "#/components/schemas/SubAccountDto" }, "prepaymentAccount": { "$ref": "#/components/schemas/AccountNumberTypeDescriptionDto" }, "prepaymentSubaccount": { "$ref": "#/components/schemas/SubAccountDto" } }, "description": "Information collected from the system. Some accounts visible in window, some not." }, "eInvoiceContractInCustomerDto": { "properties": { "fInvoiceContractID": { "type": "string" }, "fInvoiceIntermediatorID": { "type": "string" } }, "description": "Other invoice settings tab." }, "CustomerDto": { "type": "object", "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "Mandatory field: The top part > Customer ID* > The ID of the customer account, which is defined by the BIZACCT segmented key or by the CUSTOMER segmented key. When you are creating a new customer, you must specify an ID." }, "name": { "type": "string", "description": "Mandatory field: The top part > Customer name* > The name of the customer to appear in the system, which may be a trade name or a doing-business-as (DBA) name." }, "status": { "enum": [ "Active", "OnHold", "CreditHold", "Inactive", "OneTime" ], "type": "string", "description": "Mandatory field: The top part > Status* > The status of the customer account. You can select one of the following options: Active, On hold, Credit hold, Inactive, One time." }, "mainAddress": { "$ref": "#/components/schemas/mainAddressInCustomerDto" }, "mainContact": { "$ref": "#/components/schemas/mainContactInCustomerDto" }, "accountReference": { "type": "string", "description": "General information tab > Main contact section > Account ref. > Your company's account number in the customer's system." }, "parentRecord": { "$ref": "#/components/schemas/ParentRecordDto" }, "customerClass": { "$ref": "#/components/schemas/customerClassInCustomerDto" }, "invoiceOrdersSeparately": { "type": "boolean", "description": "The Billing settings tab > Order consolidation section > Invoice orders separately > Indicates whether the customer should be invoiced separately." }, "creditTerms": { "$ref": "#/components/schemas/creditTermsInCustomerDto" }, "currencyId": { "type": "string", "description": "The General information tab > Financial settings section > Currency ID > The currency used in operations with the customer, which you can select from the list of currencies defined in the system." }, "creditVerification": { "enum": [ "Disabled", "DaysPastDue", "CreditLimit", "LimitAndDaysPastDue" ], "type": "string", "description": "The General information tab > Credit verification rules > Credit verification > The credit rule applied to this customer. The following options are available: Days past due, Credit limit, Limit and days past due, disabled." }, "creditLimit": { "type": "number", "description": "The General information tab > Credit verification rules section > Credit limit > The amount, if applicable, that serves as a credit limit for the customer.", "format": "double" }, "creditDaysPastDue": { "type": "integer", "description": "General information tab > Credit verification rules section > Credit days past due > The maximum number of days by which the customer payment may exceed the invoice date.", "format": "int32" }, "invoiceAddress": { "$ref": "#/components/schemas/invoiceAddressInCustomerDto" }, "invoiceContact": { "$ref": "#/components/schemas/invoiceContactInCustomerDto" }, "printInvoices": { "type": "boolean", "description": "Invoicing settings > Print and email settings section > Print invoices > A check box that, if selected, indicates that invoices can be printed in the Print invoice (AR508000) window." }, "acceptAutoInvoices": { "type": "boolean", "description": "Invoicing settings > Print and email settings section > Send invoices to AutoInvoice > Select this check box if you are using AutoInvoice and want to send invoices directly to this service." }, "sendInvoicesByEmail": { "type": "boolean", "description": "Invoicing settings > Print and email settings section > Send invoices by email > A check box that, if selected, indicates that you can send invoices by email by using the Print invoices (AR508000) window." }, "sendDunningLettersViaEMail": { "type": "boolean", "description": "Invoicing settings > Print and email settings section > Print statements > A check box that, if selected, indicates that statements can be printed in the Print statements (AR503500) window." }, "printDunningLetters": { "type": "boolean", "description": "Invoicing settings > Email settings section > A check box that, if selected, indicates that statements can be send to email (AR503500) window." }, "printStatements": { "type": "boolean", "description": "Invoicing settings > Print settings section > A check box that, if selected, indicates that statements can be printed in the to email (AR503500) window." }, "sendStatementsByEmail": { "type": "boolean", "description": "Invoicing settings > Print and email settings section > Send statement by email > A check box that, if selected, indicates that statements can be sent by email to customers of the class in the Print statements (AR503500) window." }, "printMultiCurrencyStatements": { "type": "boolean", "description": "Invoicing settings > Print and email settings section > Multi-currency statements > A check box that indicates (if selected) that this customer's statements must be printed in multi-currency format." }, "statementType": { "enum": [ "OpenItem", "BalanceBroughtForward" ], "type": "string", "description": "Invoicing settings > Print and email settings section > Statement type > The statement type used by default in relations with the customer, which can be one of the following: Open item, Balance brought forward." }, "deliveryAddress": { "$ref": "#/components/schemas/deliveryAddressInCustomerDto" }, "deliveryContact": { "$ref": "#/components/schemas/deliveryContactInCustomerDto" }, "vatRegistrationId": { "type": "string", "description": "Deliver settings tab > Default location settings section > VAT registration ID > The customer's taxpayer ID associated with the location." }, "corporateId": { "type": "string", "description": "Delivery settings tab > Default location settings section > Corporate ID > The customers company ID, associated with the location." }, "gln": { "type": "string", "description": "Delivery settings tab > Default location settings section > GLN > The Global Location Number, associated with the location." }, "vatZone": { "$ref": "#/components/schemas/vatZoneInCustomerDto" }, "location": { "$ref": "#/components/schemas/locationInCustomerDto" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeIdValueDto" }, "description": "Information collected from the system. Not visible on the screen." }, "lastModifiedDateTime": { "type": "string", "description": "Information collected from the system. Not visible on the screen.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "Information collected from the system. Not visible on the screen.", "format": "date-time" }, "directDebitLines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDirectDebitDto" }, "description": "Information collected from the system. Not visible on the screen." }, "priceClass": { "$ref": "#/components/schemas/priceClassInCustomerDto" }, "glAccounts": { "$ref": "#/components/schemas/glAccountsInCustomerDto" }, "invoiceToDefaultLocation": { "type": "boolean", "description": "Delivery settings tab > Default location settings > Invoice to default location > A check box indicating that the default location is to be used." }, "eInvoiceContract": { "$ref": "#/components/schemas/eInvoiceContractInCustomerDto" }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPaymentMethodInfoDto" }, "description": "Payment methods tab." }, "defaultPaymentMethodId": { "type": "string", "description": "Invoicing settings tab > Default payment method section > The default payment method." }, "numberOfEmployees": { "type": "integer", "description": "Legal requirements that all companies with more than 250 employees keep track of their business accounts", "format": "int32" }, "excludeDebtCollection": { "type": "boolean", "description": "Exclude Debt Collection for Autocollect" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a customer in CustomerController. Used by getting data." }, "CustomerGlAccountsUpdateDto": { "type": "object", "properties": { "customerLedgerAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerLedgerSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "salesAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesNonTaxableAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesEuAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesExportAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "discountAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "discountSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "freightAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "freightSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "cashDiscountAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashDiscountSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "prepaymentAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "prepaymentSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } } } }, "CustomerDefaultPaymentMethodUpdateDto": { "type": "object", "properties": { "paymentMethodId": { "$ref": "#/components/schemas/DtoValueOfString" }, "isDefault": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" } } }, "EInvoiceContractUpdateDto": { "type": "object", "properties": { "fInvoiceContractID": { "$ref": "#/components/schemas/DtoValueOfString" }, "fInvoiceIntermediatorID": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "ContactInfoUpdateDto": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/DtoValueOfString" }, "attention": { "$ref": "#/components/schemas/DtoValueOfString" }, "email": { "$ref": "#/components/schemas/DtoValueOfString" }, "web": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone1": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone2": { "$ref": "#/components/schemas/DtoValueOfString" }, "fax": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "attributeIdInAttributeLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The ID of the attribute on the line." }, "AttributeLineUpdateDto": { "type": "object", "properties": { "attributeId": { "$ref": "#/components/schemas/attributeIdInAttributeLineUpdateDto" }, "attributeValue": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "CustomerSalesPersonUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "salesPersonID": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationID": { "$ref": "#/components/schemas/DtoValueOfString" }, "commissionPct": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "isDefault": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" } } }, "CustomerDirectDebitUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "id": { "type": "string", "format": "uuid" }, "mandateId": { "$ref": "#/components/schemas/DtoValueOfString" }, "mandateDescription": { "$ref": "#/components/schemas/DtoValueOfString" }, "dateOfSignature": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "isDefault": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "oneTime": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "bic": { "$ref": "#/components/schemas/DtoValueOfString" }, "iban": { "$ref": "#/components/schemas/DtoValueOfString" }, "lastCollectionDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "maxAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "DtoValueOfCustomerGlAccountsUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/CustomerGlAccountsUpdateDto" } } }, "DtoValueOfCustomerDefaultPaymentMethodUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/CustomerDefaultPaymentMethodUpdateDto" } } }, "DtoValueOfEInvoiceContractUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/EInvoiceContractUpdateDto" } } }, "DtoValueOfStatementTypes": { "type": "object", "properties": { "value": { "enum": [ "OpenItem", "BalanceBroughtForward" ], "type": "string" } } }, "DtoValueOfCreditRule": { "type": "object", "properties": { "value": { "enum": [ "Disabled", "DaysPastDue", "CreditLimit", "LimitAndDaysPastDue" ], "type": "string" } } }, "DtoValueOfContactInfoUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/ContactInfoUpdateDto" } } }, "DtoValueOfCustomerStatus": { "type": "object", "properties": { "value": { "enum": [ "Active", "OnHold", "CreditHold", "Inactive", "OneTime" ], "type": "string" } } }, "CustomerUpdateDto": { "type": "object", "properties": { "number": { "$ref": "#/components/schemas/DtoValueOfString" }, "name": { "$ref": "#/components/schemas/DtoValueOfString" }, "status": { "$ref": "#/components/schemas/DtoValueOfCustomerStatus" }, "accountReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "numberOfEmployees": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "parentRecordNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "currencyId": { "$ref": "#/components/schemas/DtoValueOfString" }, "creditLimit": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "creditDaysPastDue": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt16" }, "overrideWithClassValues": { "type": "boolean" }, "customerClassId": { "$ref": "#/components/schemas/DtoValueOfString" }, "invoiceOrdersSeparately": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "creditTermsId": { "$ref": "#/components/schemas/DtoValueOfString" }, "printInvoices": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "acceptAutoInvoices": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "sendInvoicesByEmail": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "sendDunningLettersViaEMail": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "printDunningLetters": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "printStatements": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "sendStatementsByEmail": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "printMultiCurrencyStatements": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "invoiceToDefaultLocation": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "vatRegistrationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "corporateId": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatZoneId": { "$ref": "#/components/schemas/DtoValueOfString" }, "gln": { "$ref": "#/components/schemas/DtoValueOfString" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "mainAddress": { "$ref": "#/components/schemas/DtoValueOfAddressUpdateDto" }, "mainContact": { "$ref": "#/components/schemas/DtoValueOfContactInfoUpdateDto" }, "creditVerification": { "$ref": "#/components/schemas/DtoValueOfCreditRule" }, "invoiceAddress": { "$ref": "#/components/schemas/DtoValueOfAddressUpdateDto" }, "invoiceContact": { "$ref": "#/components/schemas/DtoValueOfContactInfoUpdateDto" }, "statementType": { "$ref": "#/components/schemas/DtoValueOfStatementTypes" }, "deliveryAddress": { "$ref": "#/components/schemas/DtoValueOfAddressUpdateDto" }, "deliveryContact": { "$ref": "#/components/schemas/DtoValueOfContactInfoUpdateDto" }, "priceClassId": { "$ref": "#/components/schemas/DtoValueOfString" }, "eInvoiceContract": { "$ref": "#/components/schemas/DtoValueOfEInvoiceContractUpdateDto" }, "defaultPaymentMethod": { "$ref": "#/components/schemas/DtoValueOfCustomerDefaultPaymentMethodUpdateDto" }, "glAccounts": { "$ref": "#/components/schemas/DtoValueOfCustomerGlAccountsUpdateDto" }, "directDebitLines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDirectDebitUpdateDto" }, "description": "Update direct debit information for a customer(only for Netherlands)" }, "salesPersons": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerSalesPersonUpdateDto" }, "description": "Update sales persons for a customer" }, "attributeLines": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeLineUpdateDto" } }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "excludeDebtCollection": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "CustomerQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "This field does not work and has been deprecated. It will be removed in future versions." }, "numberToRead": { "type": "integer", "description": "[This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.]\r\nTells the service to return only {numberToRead} number of records.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "[This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.]\r\nTells the service to return only records after the first {skipRecords} number of records.", "format": "int32" }, "name": { "type": "string", "description": "Contains Customer name." }, "status": { "enum": [ "Active", "OnHold", "CreditHold", "Inactive", "OneTime" ], "type": "string", "description": "Drop down and select Status." }, "corporateId": { "type": "string", "description": "Equals Corporate ID from Delivery settings tab." }, "vatRegistrationId": { "type": "string", "description": "Equals VAT registration ID from Delivery settings tab." }, "email": { "type": "string", "description": "Equals Email for customer." }, "phone": { "type": "string", "description": "Equals Phone 1 for customer." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "expandAccountInformation": { "type": "boolean" }, "expandPaymentMethods": { "type": "boolean" }, "expandDirectDebit": { "type": "boolean", "description": "Expand direct debit info" }, "attributes": { "type": "string", "description": " Attributes (additional information) connected to the entity.\r\n Examples:\r\n{{base}}/customer?attributes={\"AttributeID\":\"ValueID\",\"AttributeID\":\"ValueID\"}\r\n{{base}}/customer?attributes={\"AttributeID\":\"ValueID1,ValueID2\"}" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "WorkTypeDto": { "type": "object", "properties": { "rutRotType": { "enum": [ "Rut", "Rot" ], "type": "string" }, "description": { "type": "string" }, "xmlTag": { "type": "string" } } }, "DebtCollectionDto": { "type": "object", "properties": { "caseNumber": { "type": "string", "description": "Debt Collection Case Number" }, "caseType": { "type": "string", "description": "Debt Collection Case Number" }, "caseStatus": { "type": "string", "description": "Debt Collection Case Number" }, "caseUrl": { "type": "string", "description": "Debt Collection Case Number" } }, "description": "This class represents a Debt Collection information for an invoice" }, "DirectDebitMandateDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Mandate Guid as stored in the database.", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "mandateId": { "type": "string", "description": "The id shown on Billing Address tab" }, "mandateDescription": { "type": "string", "description": "Mandate description show on Billing Address tab" } }, "description": "This class represents a Customer Mandate" }, "ChildRecordDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } } }, "CustomerDocumentVatZoneDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "accountInCustomerInvoiceLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Account* > The sales account used for the transaction." }, "vatCodeInCustomerInvoiceLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "VAT category > The VAT category (if applied) for the transaction. The category represents the type of goods or services." }, "subaccountInCustomerInvoiceLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: Subaccount* > The corresponding subaccount used for this transaction." }, "sellerInCustomerInvoiceLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Salesperson ID > The identifier of the salesperson involved." }, "branchNumberInCustomerInvoiceLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Branch* > The branch that sells the line item or provides the service." }, "CustomerInvoiceLineDto": { "type": "object", "properties": { "termStartDate": { "type": "string", "description": " Term start date > The date when the process of deferred revenue recognition should start for the selected item; this date can be specified manually if the deferral code assigned to the item is based on the Flexible by periods, prorate by days or Flexible by days in period recognition method.\r\nThis column only appears if the Deferred revenue management functionality is enabled in the(CS100000) window.", "format": "date-time" }, "termEndDate": { "type": "string", "description": " Term end date > The date when the process of the deferred revenue recognition should finish for the selected item; this date can be specified manually if the deferral code assigned to the item is based on the Flexible by periods, prorate by days or Flexible by days in period recognition method.\r\nThis column only appears if the Deferred revenue management functionality is enabled in the(CS100000) window.", "format": "date-time" }, "isRotRutDeductible": { "type": "boolean" }, "itemType": { "enum": [ "Service", "MaterialCost", "OtherCost" ], "type": "string" }, "typeOfWork": { "$ref": "#/components/schemas/WorkTypeDto" }, "deductableAmount": { "type": "number", "format": "double" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "projectTask": { "$ref": "#/components/schemas/ProjectTaskIdDescriptionDto" }, "lineType": { "type": "string", "description": "Transaction line type.\r\nPossible Values:\r\n-> Inventory = \"GI\";\r\n-> NonInventory = \"GN\";\r\n-> MiscCharge = \"MI\";\r\n-> Freight = \"FR\";\r\n-> Discount = \"DS\";\r\n-> Reallocation = \"RA\";" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "soShipmentNbr": { "type": "string" }, "soOrderType": { "type": "string" }, "soOrderNbr": { "type": "string" }, "lineNumber": { "type": "integer", "description": "Line no. > A counter of lines in the overview of cash sales document overview.", "format": "int32" }, "inventoryNumber": { "type": "string", "description": "Item ID > The item ID of the line item, if applicable. Only a non-stock item can be selected." }, "description": { "type": "string", "description": "Transaction descr. > Any brief comment relevant to the transaction.The alphanumeric string may contain up to 30 characters." }, "quantity": { "type": "number", "description": "Quantity > The quantity of items (goods or services) of a particular type sold to the customer.", "format": "double" }, "unitPrice": { "type": "number", "description": "Unit price > The unit price set for the item or service. If you want to update the unit price\r\nautomatically to the current value(that is, the applicable sales or default price),\r\nyou can use the Recalculate Prices and Discounts action.If you have modified\r\nthe unit price and saved the document, the value will not be updated by the\r\nsystem if you change the document date.", "format": "double" }, "unitPriceInCurrency": { "type": "number", "description": "Background calculation giving you the Unit price in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualAmount": { "type": "number", "description": "Manual amount > a check box indicating that the amount has been entered manually.", "format": "double" }, "manualAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Manual amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "amount": { "type": "number", "description": "Amount > The amount after the discount has been applied. The value of this read-only box\r\nis calculated automatically by deducting the discount amount from the extended price.", "format": "double" }, "cost": { "type": "number", "description": "Cost > The total cost of the line in default currency. \r\nThe value will always be 0 for unreleased documents.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "account": { "$ref": "#/components/schemas/accountInCustomerInvoiceLineDto" }, "vatCode": { "$ref": "#/components/schemas/vatCodeInCustomerInvoiceLineDto" }, "uom": { "type": "string", "description": "UoM > The unit of measure (UoM) for the item." }, "discountPercent": { "type": "number", "description": "Discount percent > The percent of the line-level discount that has been applied manually or\r\nautomatically.The system selects the Manual Discount check box and\r\ncalculates the discount amount after you have entered the percent manually and\r\nsaved your changes or added a new line.", "format": "double" }, "discountAmount": { "type": "number", "description": "Discount amount > The amount of the line-level discount that has been applied manually or\r\nautomatically to this line.The system selects the Manual Discount check box\r\nand calculates the line amount after you have entered the discount amount\r\nmanually and save your changes or added a new line.", "format": "double" }, "discountAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Discount amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Manual discount > A check box that indicates (if selected) that the discount has been applied\r\nmanually.If you clear the check box, the system clears entered discount percent,\r\nor discount amount, or selected discount code." }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerInvoiceLineDto" }, "salesperson": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use Seller instead" }, "seller": { "$ref": "#/components/schemas/sellerInCustomerInvoiceLineDto" }, "deferralSchedule": { "type": "integer", "description": "Original deferral schedule > A read-only column filled in by the system in the Cash return documents created by the reversing process. It shows the identifier of the deferral schedule associated with the original Cash sale document.", "format": "int32" }, "deferralCode": { "type": "string", "description": "The deferral code assigned to the stock item or non-stock item specified in this\r\ndocument line.Upon release of the document, the system generates a deferral\r\nschedule (or schedules) based on the settings defined in this deferral code." }, "discountCode": { "type": "string", "description": "The code of the line discount that has been applied to this line automatically or manually." }, "note": { "type": "string", "description": "Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order." }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerInvoiceLineDto" }, "externalLink": { "type": "string" } } }, "vatIdInTaxDetailDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "VAT ID > The ID of the specific VAT applied." }, "TaxDetailDto": { "type": "object", "properties": { "taxId": { "type": "string", "description": "Mandatory field: VAT ID* > The ID of the VAT applied to the document." }, "recordId": { "type": "integer", "description": "The id as stored in the database. It can be used when we want to update a VAT record.", "format": "int32" }, "vatId": { "$ref": "#/components/schemas/vatIdInTaxDetailDto" }, "vatRate": { "type": "number", "description": "VAT rate > The rate of the VAT.", "format": "double" }, "taxableAmount": { "type": "number", "description": "Taxable amount > The taxable amount for the VAT, which is calculated at the document level.", "format": "double" }, "vatAmount": { "type": "number", "description": "VAT > The VAT amount for the specific VAT, which is calculated at the document level.", "format": "double" }, "expenseAmount": { "type": "number", "description": "Expense Amount for the VAT type that has been added.", "format": "double" } }, "description": "This class represents a VAT Detail Line. Used for getting data." }, "creditTermsInCustomerInvoiceDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part > Terms* > The credit terms used in relations with the customer." }, "contactInCustomerInvoiceDto": { "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Contact > The contact associated with the customer." }, "customerVatZoneInCustomerInvoiceDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The VAT info section > Dunning letter date >" }, "debtCollectionInCustomerInvoiceDto": { "properties": { "caseNumber": { "type": "string", "description": "Debt Collection Case Number" }, "caseType": { "type": "string", "description": "Debt Collection Case Number" }, "caseStatus": { "type": "string", "description": "Debt Collection Case Number" }, "caseUrl": { "type": "string", "description": "Debt Collection Case Number" } }, "description": "Debt Collection information" }, "salesPersonInCustomerInvoiceDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The document details tab > Salesperson ID > The salesperson involved." }, "invoiceAddressInCustomerInvoiceDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInCustomerDocumentAddressDto" }, "county": { "$ref": "#/components/schemas/countyInCustomerDocumentAddressDto" }, "overrideAddress": { "type": "boolean", "description": "Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer." } }, "description": "The Invoice address tab > The Invoice address section." }, "invoiceContactInCustomerInvoiceDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "businessName": { "type": "string" }, "attention": { "type": "string" }, "email": { "type": "string" }, "phone1": { "type": "string" }, "overrideContact": { "type": "boolean" } }, "description": "The Invoice address tab > The Invoice contact section." }, "customerInCustomerInvoiceDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer associated with the document." }, "paymentMethodInCustomerInvoiceDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The Payment information section > Payment method > The identifier for the payment method that the customer will use to pay the document." }, "locationInCustomerInvoiceDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Location > The location of the customer related to the document. By default, it is the default\r\nlocation of the selected customer or, if the invoice is created from an opportunity,\r\nit is the customer location specified for the opportunity." }, "branchNumberInCustomerInvoiceDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Financial details tab > Branch > The branch with which this invoice or memo is associated. The field is available if your company is set up with branches." }, "projectInCustomerInvoiceDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Project* > The identifier and description of the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window." }, "accountInCustomerInvoiceDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The Document details tab > Account * > The sales account used for the transaction." }, "subaccountInCustomerInvoiceDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The Document details tab > Subaccount* > The corresponding subaccount used for this transaction." }, "CustomerInvoiceDto": { "type": "object", "properties": { "creditTerms": { "$ref": "#/components/schemas/creditTermsInCustomerInvoiceDto" }, "documentDueDate": { "type": "string", "description": "Mandatory field: The top part > Due date* > The date when payment for the document is due, in accordance with the credit terms.", "format": "date-time" }, "cashDiscountDate": { "type": "string", "description": "Mandatory field: The top part > Cash discount date * > The end date of the cash discount period, which the system calculates by using the credit terms.", "format": "date-time" }, "externalReference": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "isRotRutDeductible": { "type": "boolean", "description": "The top part > Domestic services deductible document > A check box indicating if the document is Rot/rut deductible (applicable for the Swedish markets)" }, "exchangeRate": { "type": "number", "format": "double" }, "dunningLetterDate": { "type": "string", "description": "The Financial details tab > The dunning info section > Dunning letter date > The date of the last released dunning letter in which the document was listed.", "format": "date-time" }, "dunningLetterLevel": { "type": "integer", "description": "The Financial details tab > The dunning info section > Dunning level > The dunning level of the document.", "format": "int32" }, "contact": { "$ref": "#/components/schemas/contactInCustomerInvoiceDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "taxDetails": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailDto" }, "description": "VAT details tab" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInvoiceLineDto" }, "description": "Documents details tab" }, "sendToAutoInvoice": { "type": "boolean", "description": "The Attachment tab > Send the file to AutoInvoice > The selected files will be attached to the invoice." }, "roundingDiff": { "type": "number", "description": "The top part > Rounding diff. > The difference between the original amount and the rounded amount.", "format": "double" }, "customerVatZone": { "$ref": "#/components/schemas/customerVatZoneInCustomerInvoiceDto" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "accountingCostRef": { "type": "string" }, "originatorDocRef": { "type": "string" }, "contractDocRef": { "type": "string" }, "childRecord": { "$ref": "#/components/schemas/ChildRecordDto" }, "directDebitMandate": { "$ref": "#/components/schemas/DirectDebitMandateDto" }, "excludeDebtCollection": { "type": "boolean", "description": "Exclude Debt Collection for Autocollect" }, "debtCollection": { "$ref": "#/components/schemas/debtCollectionInCustomerInvoiceDto" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the document is a draft. A document with the On Hold status may be edited and cannot be released." }, "discountTotal": { "type": "number", "description": "The top part > Discount total > The document discount total.", "format": "double" }, "discountTotalInCurrency": { "type": "number", "description": "The top part > Discount total > The document discount total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "detailTotal": { "type": "number", "description": "The top part > Detail total > The document total, which the system calculates for all line items in the Document details tab.", "format": "double" }, "detailTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Detail total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "vatTaxableTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT taxable total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt. total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the tax with the Include in VAT Exempt Total check box selected on the Taxes form.This box is available only if the VAT Reporting feature is enabled in your system.", "format": "double" }, "vatExemptTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT exempt. total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "salesPersonID": { "type": "integer", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead", "format": "int32" }, "salesPersonDescr": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead" }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInCustomerInvoiceDto" }, "paymentReference": { "type": "string", "description": "///The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window.." }, "invoiceAddress": { "$ref": "#/components/schemas/invoiceAddressInCustomerInvoiceDto" }, "invoiceContact": { "$ref": "#/components/schemas/invoiceContactInCustomerInvoiceDto" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ArAdjustDto" } }, "dontPrint": { "type": "boolean" }, "dontEmail": { "type": "boolean" }, "revoked": { "type": "boolean" }, "customer": { "$ref": "#/components/schemas/customerInCustomerInvoiceDto" }, "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off" }, "referenceNumber": { "type": "string", "description": "The Top part > Ref. no. > The reference number of the customer ledger document in the system." }, "postPeriod": { "type": "string", "description": "The top part > Post period > The period to which the document should be posted. Format YYYYMM." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "documentDate": { "type": "string", "description": "The top part > Date* > The date when the customer ledger document was created.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting \"Use Orig Invoice Date\" is active in AR Preferences.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email." }, "currencyId": { "type": "string", "description": "The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window." }, "amount": { "type": "number", "description": "The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.\r\nIf the check box is cleared, then the value appears when the document status is Open.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "balance": { "type": "number", "description": "The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. \r\nFor a document used in the application process, this is the balance after the payments were applied.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInCustomerInvoiceDto" }, "customerRefNumber": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "invoiceText": { "type": "string", "description": "The top part > Invoice text > Any user-provided description of the customer ledger document." }, "lastModifiedDateTime": { "type": "string", "description": "System generated field for last modification date/time of document.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "The Attachments tab > Creation time > The date the attachment was created.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "vatTotal": { "type": "number", "description": "The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "location": { "$ref": "#/components/schemas/locationInCustomerInvoiceDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerInvoiceDto" }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "project": { "$ref": "#/components/schemas/projectInCustomerInvoiceDto" }, "account": { "$ref": "#/components/schemas/accountInCustomerInvoiceDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerInvoiceDto" }, "customerProject": { "type": "string", "description": "The top part > Customer project no. > The customer project no. used in AutoInvoice." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents an invoice in InvoiceController. Used by getting data." }, "branchInCustomerDocumentDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Branch is deprecated, please use BranchNumber instead." }, "customerInCustomerDocumentDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer associated with the document." }, "paymentMethodInCustomerDocumentDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The Payment information section > Payment method > The identifier for the payment method that the customer will use to pay the document." }, "locationInCustomerDocumentDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Location > The location of the customer related to the document. By default, it is the default\r\nlocation of the selected customer or, if the invoice is created from an opportunity,\r\nit is the customer location specified for the opportunity." }, "branchNumberInCustomerDocumentDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Financial details tab > Branch > The branch with which this invoice or memo is associated. The field is available if your company is set up with branches." }, "projectInCustomerDocumentDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Project* > The identifier and description of the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window." }, "accountInCustomerDocumentDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The Document details tab > Account * > The sales account used for the transaction." }, "subaccountInCustomerDocumentDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The Document details tab > Subaccount* > The corresponding subaccount used for this transaction." }, "CustomerDocumentDto": { "type": "object", "properties": { "documentDueDate": { "type": "string", "format": "date-time" }, "branch": { "$ref": "#/components/schemas/branchInCustomerDocumentDto" }, "customer": { "$ref": "#/components/schemas/customerInCustomerDocumentDto" }, "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off" }, "referenceNumber": { "type": "string", "description": "The Top part > Ref. no. > The reference number of the customer ledger document in the system." }, "postPeriod": { "type": "string", "description": "The top part > Post period > The period to which the document should be posted. Format YYYYMM." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "documentDate": { "type": "string", "description": "The top part > Date* > The date when the customer ledger document was created.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting \"Use Orig Invoice Date\" is active in AR Preferences.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email." }, "currencyId": { "type": "string", "description": "The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window." }, "amount": { "type": "number", "description": "The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.\r\nIf the check box is cleared, then the value appears when the document status is Open.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "balance": { "type": "number", "description": "The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. \r\nFor a document used in the application process, this is the balance after the payments were applied.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInCustomerDocumentDto" }, "customerRefNumber": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "invoiceText": { "type": "string", "description": "The top part > Invoice text > Any user-provided description of the customer ledger document." }, "lastModifiedDateTime": { "type": "string", "description": "System generated field for last modification date/time of document.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "The Attachments tab > Creation time > The date the attachment was created.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "vatTotal": { "type": "number", "description": "The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "location": { "$ref": "#/components/schemas/locationInCustomerDocumentDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerDocumentDto" }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "project": { "$ref": "#/components/schemas/projectInCustomerDocumentDto" }, "account": { "$ref": "#/components/schemas/accountInCustomerDocumentDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerDocumentDto" }, "customerProject": { "type": "string", "description": "The top part > Customer project no. > The customer project no. used in AutoInvoice." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "CreateDunningLetterActionDto": { "type": "object", "properties": { "dunningLetterDate": { "type": "string", "format": "date-time" }, "levelFrom": { "type": "integer", "format": "int32" }, "levelTo": { "type": "integer", "format": "int32" } } }, "CreateDunningLetterActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "ChangeCustomerCdActionDto": { "type": "object", "properties": { "customerCd": { "type": "string" } } }, "ChangeCustomerCdActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "CustomerContractDetailsLineDto": { "type": "object", "properties": { "contractDetailId": { "type": "integer", "format": "int32" }, "itemCode": { "type": "string" }, "description": { "type": "string" }, "included": { "type": "number", "format": "double" }, "difference": { "type": "number", "format": "double" }, "setupPrice": { "type": "number", "format": "double" }, "setupDiscount": { "type": "number", "format": "double" }, "recurringPrice": { "type": "number", "format": "double" }, "extraUsagePrice": { "type": "number", "format": "double" }, "recurringDiscount": { "type": "number", "format": "double" }, "renewalPrice": { "type": "number", "format": "double" }, "renewalDiscount": { "type": "number", "format": "double" }, "invoiceType": { "enum": [ "None", "Prepaid", "Postpaid" ], "type": "string" } }, "description": "This class represents a CustomerContractDetailLine in CustomerContractController. Used for getting data." }, "PromoCodeIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "CustomerContractDetailsDto": { "type": "object", "properties": { "effectiveFrom": { "type": "string", "format": "date-time" }, "promoCode": { "$ref": "#/components/schemas/PromoCodeIdDescriptionDto" }, "pendingSetup": { "type": "number", "format": "double" }, "pendingRecurring": { "type": "number", "format": "double" }, "pendingRenewal": { "type": "number", "format": "double" }, "totalPending": { "type": "number", "format": "double" }, "currentSetup": { "type": "number", "format": "double" }, "currentRecurring": { "type": "number", "format": "double" }, "currentRenewal": { "type": "number", "format": "double" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContractDetailsLineDto" } } }, "description": "This class represents the CustomerContractDetails in CustomerContractController. Used for getting data." }, "invoiceAccountInCustomerContractSummaryDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Invoice information section > Account > \tThe specific account that is to be invoiced for contract services." }, "ownerInCustomerContractSummaryDto": { "properties": { "internalId": { "type": "string" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Contract management section > Owner > The owner of the contract." }, "salesPersonInCustomerContractSummaryDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Contract management > Salesperson > The salesperson associated with the contract." }, "caseCountItemInCustomerContractSummaryDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Contract management section > Case count item > A non-stock item used for counting cases associated with the contract." }, "CustomerContractSummaryDto": { "type": "object", "properties": { "setupDate": { "type": "string", "description": "Mandatory field: Contract settings section > Setup date* > The date of contract setup.", "format": "date-time" }, "activationDate": { "type": "string", "description": "Contract settings section > Activation date > The date to initiate the provision of the contract services.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "Contract settings section > Expiration date > The date when the contract expires.", "format": "date-time" }, "terminationDate": { "type": "string", "description": "Contract settings section > Termination date > The date when the contract will be cancelled; no services will be provided.", "format": "date-time" }, "massRenewal": { "type": "boolean", "description": "Contract settings section > Mass renewal > A check box indicating renewal of all contract at expiration date." }, "renewalPoint": { "type": "integer", "description": "Contract settings section > Renewal point > The number of days before expiration where the renewal process are to begin.", "format": "int32" }, "gracePeriod": { "type": "integer", "description": "Contract settings section > Grace period > The number of days after the expiration date where the contract can still be renewed.", "format": "int32" }, "currency": { "type": "string", "description": "Mandatory field: Contract settings section > Currency* > The currency used in the contract." }, "invoicingScheduleStartsOn": { "type": "string", "description": "Invoicing schedule section > Invoice schedule starts on > A read-only field that displays the start date of the first invoicing period.", "format": "date-time" }, "invoicingPeriod": { "enum": [ "Statement", "Quarterly", "Monthly", "Annual", "SemiAnnual", "Weekly", "OnDemand" ], "type": "string", "description": "Mandatory field: Invoicing schedule section > Invoicing period* > The type of invoicing schedule, which can be one of the following options: Weekly, Monthly; Quarterly, Half a year, Yearly, On demand, Statement based." }, "lastInvoicingDate": { "type": "string", "description": "Invoicing schedule section > Last invoicing date > A read-only field that shows the date when the invoicing was performed most recently.", "format": "date-time" }, "nextInvoicingDate": { "type": "string", "description": "Invoicing schedule section > Next invoicing date > The date of the next invoicing invoice, according to the invoicing schedule.", "format": "date-time" }, "invoiceTo": { "enum": [ "ParentAccount", "CustomerAccount", "SpecificAccount" ], "type": "string", "description": "Invoice information section > Invoice to > The setting that defines the customer account to be invoiced for a contract. The following options are available: Parent account, Customer account, Specific account." }, "invoiceAccount": { "$ref": "#/components/schemas/invoiceAccountInCustomerContractSummaryDto" }, "invoiceLocation": { "$ref": "#/components/schemas/LocationNameDescriptionDto" }, "owner": { "$ref": "#/components/schemas/ownerInCustomerContractSummaryDto" }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInCustomerContractSummaryDto" }, "caseCountItem": { "$ref": "#/components/schemas/caseCountItemInCustomerContractSummaryDto" } }, "description": "This class represents the CustomerContractSummary in CustomerContractController. Used for getting data." }, "LocationNameDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "ContractTemplateIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "contractTemplateInCustomerContractDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part > Contract template* > The contract template that is used as a base for the contract." }, "customerInCustomerContractDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: The top part > Customer* > The customer associated with the contract." }, "locationInCustomerContractDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Location > The customer location associated with the contract." }, "summaryInCustomerContractDto": { "properties": { "setupDate": { "type": "string", "description": "Mandatory field: Contract settings section > Setup date* > The date of contract setup.", "format": "date-time" }, "activationDate": { "type": "string", "description": "Contract settings section > Activation date > The date to initiate the provision of the contract services.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "Contract settings section > Expiration date > The date when the contract expires.", "format": "date-time" }, "terminationDate": { "type": "string", "description": "Contract settings section > Termination date > The date when the contract will be cancelled; no services will be provided.", "format": "date-time" }, "massRenewal": { "type": "boolean", "description": "Contract settings section > Mass renewal > A check box indicating renewal of all contract at expiration date." }, "renewalPoint": { "type": "integer", "description": "Contract settings section > Renewal point > The number of days before expiration where the renewal process are to begin.", "format": "int32" }, "gracePeriod": { "type": "integer", "description": "Contract settings section > Grace period > The number of days after the expiration date where the contract can still be renewed.", "format": "int32" }, "currency": { "type": "string", "description": "Mandatory field: Contract settings section > Currency* > The currency used in the contract." }, "invoicingScheduleStartsOn": { "type": "string", "description": "Invoicing schedule section > Invoice schedule starts on > A read-only field that displays the start date of the first invoicing period.", "format": "date-time" }, "invoicingPeriod": { "enum": [ "Statement", "Quarterly", "Monthly", "Annual", "SemiAnnual", "Weekly", "OnDemand" ], "type": "string", "description": "Mandatory field: Invoicing schedule section > Invoicing period* > The type of invoicing schedule, which can be one of the following options: Weekly, Monthly; Quarterly, Half a year, Yearly, On demand, Statement based." }, "lastInvoicingDate": { "type": "string", "description": "Invoicing schedule section > Last invoicing date > A read-only field that shows the date when the invoicing was performed most recently.", "format": "date-time" }, "nextInvoicingDate": { "type": "string", "description": "Invoicing schedule section > Next invoicing date > The date of the next invoicing invoice, according to the invoicing schedule.", "format": "date-time" }, "invoiceTo": { "enum": [ "ParentAccount", "CustomerAccount", "SpecificAccount" ], "type": "string", "description": "Invoice information section > Invoice to > The setting that defines the customer account to be invoiced for a contract. The following options are available: Parent account, Customer account, Specific account." }, "invoiceAccount": { "$ref": "#/components/schemas/invoiceAccountInCustomerContractSummaryDto" }, "invoiceLocation": { "$ref": "#/components/schemas/LocationNameDescriptionDto" }, "owner": { "$ref": "#/components/schemas/ownerInCustomerContractSummaryDto" }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInCustomerContractSummaryDto" }, "caseCountItem": { "$ref": "#/components/schemas/caseCountItemInCustomerContractSummaryDto" } }, "description": "Summary tab >" }, "detailsInCustomerContractDto": { "properties": { "effectiveFrom": { "type": "string", "format": "date-time" }, "promoCode": { "$ref": "#/components/schemas/PromoCodeIdDescriptionDto" }, "pendingSetup": { "type": "number", "format": "double" }, "pendingRecurring": { "type": "number", "format": "double" }, "pendingRenewal": { "type": "number", "format": "double" }, "totalPending": { "type": "number", "format": "double" }, "currentSetup": { "type": "number", "format": "double" }, "currentRecurring": { "type": "number", "format": "double" }, "currentRenewal": { "type": "number", "format": "double" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContractDetailsLineDto" } } }, "description": "Details tab >" }, "CustomerContractDto": { "type": "object", "properties": { "contractId": { "type": "string", "description": "Mandatory field: The top part > Contract ID* > The unique identifier of a contract." }, "contractTemplate": { "$ref": "#/components/schemas/contractTemplateInCustomerContractDto" }, "status": { "enum": [ "Draft", "InApproval", "Active", "Expired", "Canceled", "Completed", "InUpgrade", "PendingActivation" ], "type": "string", "description": "The top part > Status > The status of the contract, which is one of the following: Draft, Pending activation, Active, Expired, Cancelled, Pending update." }, "customer": { "$ref": "#/components/schemas/customerInCustomerContractDto" }, "location": { "$ref": "#/components/schemas/locationInCustomerContractDto" }, "description": { "type": "string", "description": "Mandatory field: The top part > Description* > The description of the contract, which includes any related comments." }, "balance": { "type": "number", "description": "The top part > Balance > A read-only field that displays the sum of the balances of open invoices associated with the contract.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information", "format": "date-time" }, "summary": { "$ref": "#/components/schemas/summaryInCustomerContractDto" }, "details": { "$ref": "#/components/schemas/detailsInCustomerContractDto" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeIdValueDto" }, "description": "Project attributes tab" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" } }, "description": "This class represents a CustomerContract in CustomerContractController. Used for getting data." }, "CustomerContractDetailsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "contractDetailId": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "itemCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "included": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "setupPrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "recurringPrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "extraUsagePrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "renewalPrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" } } }, "DtoValueOfNullableOfInvoiceToType": { "type": "object", "properties": { "value": { "enum": [ "ParentAccount", "CustomerAccount", "SpecificAccount" ], "type": "string" } } }, "contractIdInCustomerContractUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory for POST, not applicable for PUT." }, "contractTemplateInCustomerContractUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory for POST, not applicable for PUT." }, "customerInCustomerContractUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory for POST, not applicable for PUT." }, "CustomerContractUpdateDto": { "type": "object", "properties": { "contractId": { "$ref": "#/components/schemas/contractIdInCustomerContractUpdateDto" }, "contractTemplate": { "$ref": "#/components/schemas/contractTemplateInCustomerContractUpdateDto" }, "customer": { "$ref": "#/components/schemas/customerInCustomerContractUpdateDto" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "setupDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "activationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "massRenewal": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "renewalPoint": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "gracePeriod": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "invoiceTo": { "$ref": "#/components/schemas/DtoValueOfNullableOfInvoiceToType" }, "invoiceAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "invoiceLocation": { "$ref": "#/components/schemas/DtoValueOfString" }, "owner": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPerson": { "$ref": "#/components/schemas/DtoValueOfString" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContractDetailsUpdateDto" } }, "attributeLines": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeLineUpdateDto" } } } }, "CustomerContractQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "format": "int32" }, "skipRecords": { "type": "integer", "format": "int32" }, "orderBy": { "type": "string" }, "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string" }, "contractTemplate": { "type": "string" }, "status": { "enum": [ "Draft", "InApproval", "Active", "Expired", "Canceled", "Completed", "InUpgrade", "PendingActivation" ], "type": "string" }, "customer": { "type": "string" }, "expandSummary": { "type": "boolean" }, "expandDetails": { "type": "boolean" }, "attributes": { "type": "string", "description": " Attributes (additional information) connected to the entity.\r\n Examples:\r\n{{base}}/customerContract?attributes={\"AttributeID\":\"ValueID\",\"AttributeID\":\"ValueID\"}\r\n{{base}}/customerContract?attributes={\"AttributeID\":\"ValueID1,ValueID2\"}" }, "expandAttributes": { "type": "boolean" } } }, "CustomerContractRecurringSummaryLineDto": { "type": "object", "properties": { "itemCode": { "type": "string" }, "description": { "type": "string" }, "itemId": { "type": "string" }, "uom": { "type": "string" }, "invoiceType": { "enum": [ "None", "Prepay", "Usage", "Deposits" ], "type": "string" }, "included": { "type": "number", "format": "double" }, "recurringPrice": { "type": "number", "format": "double" }, "recurringDiscount": { "type": "number", "format": "double" }, "extraUsagePrice": { "type": "number", "format": "double" }, "unInvoiced": { "type": "number", "format": "double" }, "usedTotal": { "type": "number", "format": "double" } }, "description": "This class represents a CustomerContractRecurringSummaryLine in CustomerContractController. Used for getting data." }, "CustomerContractRecurringSummaryDto": { "type": "object", "properties": { "recurringTotal": { "type": "number", "format": "double" }, "extraUsageTotal": { "type": "number", "format": "double" }, "totalDue": { "type": "number", "format": "double" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerContractRecurringSummaryLineDto" } } }, "description": "This class represents the CustomerContractRecurringSummary in CustomerContractController. Used for getting data." }, "accountInCustomerCreditNoteLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Account* > The sales account used for the transaction." }, "vatCodeInCustomerCreditNoteLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "VAT category > The VAT category (if applied) for the transaction. The category represents the type of goods or services." }, "subaccountInCustomerCreditNoteLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: Subaccount* > The corresponding subaccount used for this transaction." }, "sellerInCustomerCreditNoteLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Salesperson ID > The identifier of the salesperson involved." }, "branchNumberInCustomerCreditNoteLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Branch* > The branch that sells the line item or provides the service." }, "CustomerCreditNoteLineDto": { "type": "object", "properties": { "termStartDate": { "type": "string", "description": "The date when the process of deferred revenue recognition should start for the\r\nselected item; this date can be specified manually if the deferral code assigned\r\nto the item is based on the Flexible by Periods, Prorate by days or Flexible by\r\nDays in Period recognition method.This column appears only if the Deferred\r\nRevenue Management feature is enabled on the Enable/Disable Features screen.", "format": "date-time" }, "termEndDate": { "type": "string", "description": "The date when the process of the deferred revenue recognition should finish\r\nfor the selected item; this date can be specified manually if the deferral code\r\nassigned to the item is based on the Flexible by Periods, Prorate by days or\r\nFlexible by Days in Period recognition method.This column appears only if the\r\nDeferred Revenue Management feature is enabled on the Enable/Disable Features form.", "format": "date-time" }, "isRotRutDeductible": { "type": "boolean" }, "itemType": { "enum": [ "Service", "MaterialCost", "OtherCost" ], "type": "string" }, "typeOfWork": { "$ref": "#/components/schemas/WorkTypeDto" }, "deductableAmount": { "type": "number", "format": "double" }, "soShipmentNbr": { "type": "string" }, "soOrderType": { "type": "string" }, "soOrderNbr": { "type": "string" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "projectTask": { "$ref": "#/components/schemas/ProjectTaskIdDescriptionDto" }, "lineNumber": { "type": "integer", "description": "Line no. > A counter of lines in the overview of cash sales document overview.", "format": "int32" }, "inventoryNumber": { "type": "string", "description": "Item ID > The item ID of the line item, if applicable. Only a non-stock item can be selected." }, "description": { "type": "string", "description": "Transaction descr. > Any brief comment relevant to the transaction.The alphanumeric string may contain up to 30 characters." }, "quantity": { "type": "number", "description": "Quantity > The quantity of items (goods or services) of a particular type sold to the customer.", "format": "double" }, "unitPrice": { "type": "number", "description": "Unit price > The unit price set for the item or service. If you want to update the unit price\r\nautomatically to the current value(that is, the applicable sales or default price),\r\nyou can use the Recalculate Prices and Discounts action.If you have modified\r\nthe unit price and saved the document, the value will not be updated by the\r\nsystem if you change the document date.", "format": "double" }, "unitPriceInCurrency": { "type": "number", "description": "Background calculation giving you the Unit price in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualAmount": { "type": "number", "description": "Manual amount > a check box indicating that the amount has been entered manually.", "format": "double" }, "manualAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Manual amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "amount": { "type": "number", "description": "Amount > The amount after the discount has been applied. The value of this read-only box\r\nis calculated automatically by deducting the discount amount from the extended price.", "format": "double" }, "cost": { "type": "number", "description": "Cost > The total cost of the line in default currency. \r\nThe value will always be 0 for unreleased documents.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "account": { "$ref": "#/components/schemas/accountInCustomerCreditNoteLineDto" }, "vatCode": { "$ref": "#/components/schemas/vatCodeInCustomerCreditNoteLineDto" }, "uom": { "type": "string", "description": "UoM > The unit of measure (UoM) for the item." }, "discountPercent": { "type": "number", "description": "Discount percent > The percent of the line-level discount that has been applied manually or\r\nautomatically.The system selects the Manual Discount check box and\r\ncalculates the discount amount after you have entered the percent manually and\r\nsaved your changes or added a new line.", "format": "double" }, "discountAmount": { "type": "number", "description": "Discount amount > The amount of the line-level discount that has been applied manually or\r\nautomatically to this line.The system selects the Manual Discount check box\r\nand calculates the line amount after you have entered the discount amount\r\nmanually and save your changes or added a new line.", "format": "double" }, "discountAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Discount amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Manual discount > A check box that indicates (if selected) that the discount has been applied\r\nmanually.If you clear the check box, the system clears entered discount percent,\r\nor discount amount, or selected discount code." }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerCreditNoteLineDto" }, "salesperson": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use Seller instead" }, "seller": { "$ref": "#/components/schemas/sellerInCustomerCreditNoteLineDto" }, "deferralSchedule": { "type": "integer", "description": "Original deferral schedule > A read-only column filled in by the system in the Cash return documents created by the reversing process. It shows the identifier of the deferral schedule associated with the original Cash sale document.", "format": "int32" }, "deferralCode": { "type": "string", "description": "The deferral code assigned to the stock item or non-stock item specified in this\r\ndocument line.Upon release of the document, the system generates a deferral\r\nschedule (or schedules) based on the settings defined in this deferral code." }, "discountCode": { "type": "string", "description": "The code of the line discount that has been applied to this line automatically or manually." }, "note": { "type": "string", "description": "Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order." }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerCreditNoteLineDto" }, "externalLink": { "type": "string" } } }, "creditTermsInCustomerCreditNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Terms* > The credit terms used in relations with the customer." }, "contactInCustomerCreditNoteDto": { "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Contact > The contact associated with the customer." }, "customerVatZoneInCustomerCreditNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The VAT info section > Customer VAT zone" }, "salesPersonInCustomerCreditNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The document details tab > Salesperson ID > The salesperson involved." }, "invoiceAddressInCustomerCreditNoteDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInCustomerDocumentAddressDto" }, "county": { "$ref": "#/components/schemas/countyInCustomerDocumentAddressDto" }, "overrideAddress": { "type": "boolean", "description": "Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer." } }, "description": "The Invoice address tab > The Invoice address section." }, "invoiceContactInCustomerCreditNoteDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "businessName": { "type": "string" }, "attention": { "type": "string" }, "email": { "type": "string" }, "phone1": { "type": "string" }, "overrideContact": { "type": "boolean" } }, "description": "The Invoice address tab > The Invoice contact section." }, "customerInCustomerCreditNoteDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer associated with the document." }, "paymentMethodInCustomerCreditNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The Payment information section > Payment method > The identifier for the payment method that the customer will use to pay the document." }, "locationInCustomerCreditNoteDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Location > The location of the customer related to the document. By default, it is the default\r\nlocation of the selected customer or, if the invoice is created from an opportunity,\r\nit is the customer location specified for the opportunity." }, "branchNumberInCustomerCreditNoteDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Financial details tab > Branch > The branch with which this invoice or memo is associated. The field is available if your company is set up with branches." }, "projectInCustomerCreditNoteDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Project* > The identifier and description of the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window." }, "accountInCustomerCreditNoteDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The Document details tab > Account * > The sales account used for the transaction." }, "subaccountInCustomerCreditNoteDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The Document details tab > Subaccount* > The corresponding subaccount used for this transaction." }, "CustomerCreditNoteDto": { "type": "object", "properties": { "creditTerms": { "$ref": "#/components/schemas/creditTermsInCustomerCreditNoteDto" }, "documentDueDate": { "type": "string", "description": "The top part > Due date* > The date when payment for the document is due, in accordance with the credit terms.", "format": "date-time" }, "cashDiscountDate": { "type": "string", "description": "The top part > Cash discount date* > The end date of the cash discount period, which the system calculates by using the credit terms.", "format": "date-time" }, "externalReference": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "isRotRutDeductible": { "type": "boolean", "description": "The top part > Domestic services deductible document > A check box indicating if the document is Rot/rut deductible (applicable for the Swedish markets)" }, "exchangeRate": { "type": "number", "description": "The top part > Currency > The middle field, click the down arrow > Exchange rate - To change the currency rate, click the arrow by the rate to invoke the Rate selection dialog box.", "format": "double" }, "dunningLetterDate": { "type": "string", "description": "The Financial details tab > The Dunning information section > Dunning letter date > The date of the last released dunning letter in which the document was listed.", "format": "date-time" }, "dunningLetterLevel": { "type": "integer", "description": "The Financial details tab > The Dunning information section > Dunning level > The dunning level of the document.", "format": "int32" }, "contact": { "$ref": "#/components/schemas/contactInCustomerCreditNoteDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "taxDetails": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailDto" } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerCreditNoteLineDto" } }, "roundingDiff": { "type": "number", "description": "The top part > Rounding diff. > The difference between the original amount and the rounded amount.", "format": "double" }, "customerVatZone": { "$ref": "#/components/schemas/customerVatZoneInCustomerCreditNoteDto" }, "sendToAutoInvoice": { "type": "boolean", "description": "The Attachment tab > Send the file to AutoInvoice > The selected files will be attached to the invoice." }, "childRecord": { "$ref": "#/components/schemas/ChildRecordDto" }, "timeStamp": { "type": "string", "format": "byte" }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the document is a draft. A document with the On Hold status may be edited and cannot be released." }, "discountTotal": { "type": "number", "description": "The top part > Discount total > The document discount total.", "format": "double" }, "discountTotalInCurrency": { "type": "number", "description": "The top part > Discount total > The document discount total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "detailTotal": { "type": "number", "description": "The top part > Detail total > The document total, which the system calculates for all line items in the Document details tab.", "format": "double" }, "detailTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Detail total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "vatTaxableTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT taxable total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt. total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the tax with the Include in VAT Exempt Total check box selected on the Taxes form.This box is available only if the VAT Reporting feature is enabled in your system.", "format": "double" }, "vatExemptTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT exempt. total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "salesPersonID": { "type": "integer", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead", "format": "int32" }, "salesPersonDescr": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead" }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInCustomerCreditNoteDto" }, "paymentReference": { "type": "string", "description": "///The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window.." }, "invoiceAddress": { "$ref": "#/components/schemas/invoiceAddressInCustomerCreditNoteDto" }, "invoiceContact": { "$ref": "#/components/schemas/invoiceContactInCustomerCreditNoteDto" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ArAdjustDto" } }, "dontPrint": { "type": "boolean" }, "dontEmail": { "type": "boolean" }, "revoked": { "type": "boolean" }, "customer": { "$ref": "#/components/schemas/customerInCustomerCreditNoteDto" }, "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off" }, "referenceNumber": { "type": "string", "description": "The Top part > Ref. no. > The reference number of the customer ledger document in the system." }, "postPeriod": { "type": "string", "description": "The top part > Post period > The period to which the document should be posted. Format YYYYMM." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "documentDate": { "type": "string", "description": "The top part > Date* > The date when the customer ledger document was created.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting \"Use Orig Invoice Date\" is active in AR Preferences.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email." }, "currencyId": { "type": "string", "description": "The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window." }, "amount": { "type": "number", "description": "The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.\r\nIf the check box is cleared, then the value appears when the document status is Open.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "balance": { "type": "number", "description": "The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. \r\nFor a document used in the application process, this is the balance after the payments were applied.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInCustomerCreditNoteDto" }, "customerRefNumber": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "invoiceText": { "type": "string", "description": "The top part > Invoice text > Any user-provided description of the customer ledger document." }, "lastModifiedDateTime": { "type": "string", "description": "System generated field for last modification date/time of document.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "The Attachments tab > Creation time > The date the attachment was created.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "vatTotal": { "type": "number", "description": "The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "location": { "$ref": "#/components/schemas/locationInCustomerCreditNoteDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerCreditNoteDto" }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "project": { "$ref": "#/components/schemas/projectInCustomerCreditNoteDto" }, "account": { "$ref": "#/components/schemas/accountInCustomerCreditNoteDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerCreditNoteDto" }, "customerProject": { "type": "string", "description": "The top part > Customer project no. > The customer project no. used in AutoInvoice." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "SalesInvoiceContactUpdateDto": { "type": "object", "properties": { "overrideContact": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "name": { "$ref": "#/components/schemas/DtoValueOfString" }, "attention": { "$ref": "#/components/schemas/DtoValueOfString" }, "email": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone1": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "SalesInvoiceAddressUpdateDto": { "type": "object", "properties": { "overrideAddress": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "addressLine1": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine2": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine3": { "$ref": "#/components/schemas/DtoValueOfString" }, "postalCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "city": { "$ref": "#/components/schemas/DtoValueOfString" }, "countryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "county": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "DtoValueOfCustomerDocumentTypes": { "type": "object", "properties": { "value": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" } } }, "DtoValueOfSalesInvoiceContactUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/SalesInvoiceContactUpdateDto" } } }, "DtoValueOfSalesInvoiceAddressUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/SalesInvoiceAddressUpdateDto" } } }, "PaymentLineBaseUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "documentType": { "$ref": "#/components/schemas/DtoValueOfCustomerDocumentTypes" }, "refNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "amountPaid": { "$ref": "#/components/schemas/DtoValueOfDecimal" } } }, "TaxDetailUpdateDto": { "type": "object", "properties": { "taxId": { "$ref": "#/components/schemas/DtoValueOfString" }, "taxableAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "vatAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "expenseAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" } }, "description": "This class represents a Tax Detail Line. Used to pass data to server for updating a tax line" }, "CustomerCreditNoteLineUpdateDto": { "type": "object", "properties": { "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "taskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "unitPriceInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "accountNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatCodeId": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "discountAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "salesperson": { "$ref": "#/components/schemas/DtoValueOfString" }, "deferralSchedule": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "deferralCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "termStartDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "termEndDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "postPeriodInCustomerCreditNoteUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "financialPeriodInCustomerCreditNoteUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM." }, "salesPersonIDInCustomerCreditNoteUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The field is deprecated for customer document endpoints, please use Salesperson instead" }, "salespersonInCustomerCreditNoteUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The identifier of the salesperson involved." }, "CustomerCreditNoteUpdateDto": { "type": "object", "properties": { "paymentMethodId": { "$ref": "#/components/schemas/DtoValueOfString" }, "currencyId": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerRefNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "externalReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "contact": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "project": { "$ref": "#/components/schemas/DtoValueOfString" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerCreditNoteLineUpdateDto" } }, "taxDetails": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailUpdateDto" } }, "applicationLines": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentLineBaseUpdateDto" } }, "customerVatZoneId": { "$ref": "#/components/schemas/DtoValueOfString" }, "invoiceAddress": { "$ref": "#/components/schemas/DtoValueOfSalesInvoiceAddressUpdateDto" }, "invoiceContact": { "$ref": "#/components/schemas/DtoValueOfSalesInvoiceContactUpdateDto" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "sendToAutoInvoice": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "startDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "endDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "accountingCostRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "originatorDocRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "contractDocRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "childCustomerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "consolidateInvoices": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "documentDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "origInvoiceDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInCustomerCreditNoteUpdateDto" }, "financialPeriod": { "$ref": "#/components/schemas/financialPeriodInCustomerCreditNoteUpdateDto" }, "invoiceText": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPersonID": { "$ref": "#/components/schemas/salesPersonIDInCustomerCreditNoteUpdateDto" }, "salesperson": { "$ref": "#/components/schemas/salespersonInCustomerCreditNoteUpdateDto" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "dontPrint": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "dontEmail": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "ReleaseCustomerCreditNoteActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "SendToAutoInvoiceArDocumentActionResultDto": { "type": "object", "properties": { "refNbr": { "type": "string" }, "documentType": { "type": "string" }, "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "customerVatZoneInCustomerCreditWriteOffDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The VAT info section > Customer VAT zone > If the invoice was created from an opportunity that has a VAT zone specified, the VAT zone specified for the opportunity." }, "customerInCustomerCreditWriteOffDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer associated with the document." }, "paymentMethodInCustomerCreditWriteOffDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The Payment information section > Payment method > The identifier for the payment method that the customer will use to pay the document." }, "locationInCustomerCreditWriteOffDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Location > The location of the customer related to the document. By default, it is the default\r\nlocation of the selected customer or, if the invoice is created from an opportunity,\r\nit is the customer location specified for the opportunity." }, "branchNumberInCustomerCreditWriteOffDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Financial details tab > Branch > The branch with which this invoice or memo is associated. The field is available if your company is set up with branches." }, "projectInCustomerCreditWriteOffDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Project* > The identifier and description of the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window." }, "accountInCustomerCreditWriteOffDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The Document details tab > Account * > The sales account used for the transaction." }, "subaccountInCustomerCreditWriteOffDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The Document details tab > Subaccount* > The corresponding subaccount used for this transaction." }, "CustomerCreditWriteOffDto": { "type": "object", "properties": { "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates if the document is a draft. A document with the On Hold status may be edited and cannot be released." }, "roundingDiff": { "type": "number", "description": "The top part > Rounding diff. > The difference between the original amount and the rounded amount.", "format": "double" }, "customerVatZone": { "$ref": "#/components/schemas/customerVatZoneInCustomerCreditWriteOffDto" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "customer": { "$ref": "#/components/schemas/customerInCustomerCreditWriteOffDto" }, "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off" }, "referenceNumber": { "type": "string", "description": "The Top part > Ref. no. > The reference number of the customer ledger document in the system." }, "postPeriod": { "type": "string", "description": "The top part > Post period > The period to which the document should be posted. Format YYYYMM." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "documentDate": { "type": "string", "description": "The top part > Date* > The date when the customer ledger document was created.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting \"Use Orig Invoice Date\" is active in AR Preferences.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email." }, "currencyId": { "type": "string", "description": "The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window." }, "amount": { "type": "number", "description": "The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.\r\nIf the check box is cleared, then the value appears when the document status is Open.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "balance": { "type": "number", "description": "The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. \r\nFor a document used in the application process, this is the balance after the payments were applied.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInCustomerCreditWriteOffDto" }, "customerRefNumber": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "invoiceText": { "type": "string", "description": "The top part > Invoice text > Any user-provided description of the customer ledger document." }, "lastModifiedDateTime": { "type": "string", "description": "System generated field for last modification date/time of document.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "The Attachments tab > Creation time > The date the attachment was created.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "vatTotal": { "type": "number", "description": "The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "location": { "$ref": "#/components/schemas/locationInCustomerCreditWriteOffDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerCreditWriteOffDto" }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "project": { "$ref": "#/components/schemas/projectInCustomerCreditWriteOffDto" }, "account": { "$ref": "#/components/schemas/accountInCustomerCreditWriteOffDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerCreditWriteOffDto" }, "customerProject": { "type": "string", "description": "The top part > Customer project no. > The customer project no. used in AutoInvoice." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "accountInCustomerDebitNoteLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Account* > The sales account used for the transaction." }, "vatCodeInCustomerDebitNoteLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "VAT category > The VAT category (if applied) for the transaction. The category represents the type of goods or services." }, "subaccountInCustomerDebitNoteLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: Subaccount* > The corresponding subaccount used for this transaction." }, "sellerInCustomerDebitNoteLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Salesperson ID > The identifier of the salesperson involved." }, "branchNumberInCustomerDebitNoteLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Branch* > The branch that sells the line item or provides the service." }, "CustomerDebitNoteLineDto": { "type": "object", "properties": { "termStartDate": { "type": "string", "description": "The date when the process of deferred revenue recognition should start for the\r\nselected item; this date can be specified manually if the deferral code assigned\r\nto the item is based on the Flexible by Periods, Prorate by days or Flexible by\r\nDays in Period recognition method.This column appears only if the Deferred\r\nRevenue Management feature is enabled on the Enable/Disable Features screen.", "format": "date-time" }, "termEndDate": { "type": "string", "description": "The date when the process of the deferred revenue recognition should finish\r\nfor the selected item; this date can be specified manually if the deferral code\r\nassigned to the item is based on the Flexible by Periods, Prorate by days or\r\nFlexible by Days in Period recognition method.This column appears only if the\r\nDeferred Revenue Management feature is enabled on the Enable/Disable Features form.", "format": "date-time" }, "isRotRutDeductible": { "type": "boolean", "description": "Domestic services deductible document > A check box indicating if the document is Rot/rut deductible (applicable for the Swedish markets)" }, "itemType": { "enum": [ "Service", "MaterialCost", "OtherCost" ], "type": "string" }, "typeOfWork": { "$ref": "#/components/schemas/WorkTypeDto" }, "deductableAmount": { "type": "number", "format": "double" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "soShipmentNbr": { "type": "string" }, "soOrderType": { "type": "string" }, "soOrderNbr": { "type": "string" }, "lineNumber": { "type": "integer", "description": "Line no. > A counter of lines in the overview of cash sales document overview.", "format": "int32" }, "inventoryNumber": { "type": "string", "description": "Item ID > The item ID of the line item, if applicable. Only a non-stock item can be selected." }, "description": { "type": "string", "description": "Transaction descr. > Any brief comment relevant to the transaction.The alphanumeric string may contain up to 30 characters." }, "quantity": { "type": "number", "description": "Quantity > The quantity of items (goods or services) of a particular type sold to the customer.", "format": "double" }, "unitPrice": { "type": "number", "description": "Unit price > The unit price set for the item or service. If you want to update the unit price\r\nautomatically to the current value(that is, the applicable sales or default price),\r\nyou can use the Recalculate Prices and Discounts action.If you have modified\r\nthe unit price and saved the document, the value will not be updated by the\r\nsystem if you change the document date.", "format": "double" }, "unitPriceInCurrency": { "type": "number", "description": "Background calculation giving you the Unit price in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualAmount": { "type": "number", "description": "Manual amount > a check box indicating that the amount has been entered manually.", "format": "double" }, "manualAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Manual amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "amount": { "type": "number", "description": "Amount > The amount after the discount has been applied. The value of this read-only box\r\nis calculated automatically by deducting the discount amount from the extended price.", "format": "double" }, "cost": { "type": "number", "description": "Cost > The total cost of the line in default currency. \r\nThe value will always be 0 for unreleased documents.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "account": { "$ref": "#/components/schemas/accountInCustomerDebitNoteLineDto" }, "vatCode": { "$ref": "#/components/schemas/vatCodeInCustomerDebitNoteLineDto" }, "uom": { "type": "string", "description": "UoM > The unit of measure (UoM) for the item." }, "discountPercent": { "type": "number", "description": "Discount percent > The percent of the line-level discount that has been applied manually or\r\nautomatically.The system selects the Manual Discount check box and\r\ncalculates the discount amount after you have entered the percent manually and\r\nsaved your changes or added a new line.", "format": "double" }, "discountAmount": { "type": "number", "description": "Discount amount > The amount of the line-level discount that has been applied manually or\r\nautomatically to this line.The system selects the Manual Discount check box\r\nand calculates the line amount after you have entered the discount amount\r\nmanually and save your changes or added a new line.", "format": "double" }, "discountAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Discount amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Manual discount > A check box that indicates (if selected) that the discount has been applied\r\nmanually.If you clear the check box, the system clears entered discount percent,\r\nor discount amount, or selected discount code." }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerDebitNoteLineDto" }, "salesperson": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use Seller instead" }, "seller": { "$ref": "#/components/schemas/sellerInCustomerDebitNoteLineDto" }, "deferralSchedule": { "type": "integer", "description": "Original deferral schedule > A read-only column filled in by the system in the Cash return documents created by the reversing process. It shows the identifier of the deferral schedule associated with the original Cash sale document.", "format": "int32" }, "deferralCode": { "type": "string", "description": "The deferral code assigned to the stock item or non-stock item specified in this\r\ndocument line.Upon release of the document, the system generates a deferral\r\nschedule (or schedules) based on the settings defined in this deferral code." }, "discountCode": { "type": "string", "description": "The code of the line discount that has been applied to this line automatically or manually." }, "note": { "type": "string", "description": "Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order." }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerDebitNoteLineDto" }, "externalLink": { "type": "string" } } }, "creditTermsInCustomerDebitNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The Top part > Terms* > The credit terms used in relations with the customer." }, "contactInCustomerDebitNoteDto": { "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The Top part > Contact > The contact associated with the customer." }, "customerVatZoneInCustomerDebitNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The VAT info section > Dunning letter date >" }, "salesPersonInCustomerDebitNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The document details tab > Salesperson ID > The salesperson involved." }, "invoiceAddressInCustomerDebitNoteDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInCustomerDocumentAddressDto" }, "county": { "$ref": "#/components/schemas/countyInCustomerDocumentAddressDto" }, "overrideAddress": { "type": "boolean", "description": "Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer." } }, "description": "The Invoice address tab > The Invoice address section." }, "invoiceContactInCustomerDebitNoteDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "businessName": { "type": "string" }, "attention": { "type": "string" }, "email": { "type": "string" }, "phone1": { "type": "string" }, "overrideContact": { "type": "boolean" } }, "description": "The Invoice address tab > The Invoice contact section." }, "customerInCustomerDebitNoteDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer associated with the document." }, "paymentMethodInCustomerDebitNoteDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The Payment information section > Payment method > The identifier for the payment method that the customer will use to pay the document." }, "locationInCustomerDebitNoteDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Location > The location of the customer related to the document. By default, it is the default\r\nlocation of the selected customer or, if the invoice is created from an opportunity,\r\nit is the customer location specified for the opportunity." }, "branchNumberInCustomerDebitNoteDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Financial details tab > Branch > The branch with which this invoice or memo is associated. The field is available if your company is set up with branches." }, "projectInCustomerDebitNoteDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Project* > The identifier and description of the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window." }, "accountInCustomerDebitNoteDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The Document details tab > Account * > The sales account used for the transaction." }, "subaccountInCustomerDebitNoteDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The Document details tab > Subaccount* > The corresponding subaccount used for this transaction." }, "CustomerDebitNoteDto": { "type": "object", "properties": { "creditTerms": { "$ref": "#/components/schemas/creditTermsInCustomerDebitNoteDto" }, "documentDueDate": { "type": "string", "description": "Mandatory field: The Top part > Due date* > The date when payment for the document is due, in accordance with the credit terms.", "format": "date-time" }, "cashDiscountDate": { "type": "string", "description": "Mandatory field: The Top part > Cash discount date* > The end date of the cash discount period, which the system calculates by using the credit terms.", "format": "date-time" }, "externalReference": { "type": "string", "description": "The Top part > External reference > The external reference used in AutoInvoice." }, "isRotRutDeductible": { "type": "boolean", "description": "The top part > Domestic services deductible document > A check box indicating if the document is Rot/rut deductible (applicable for the Swedish markets)" }, "exchangeRate": { "type": "number", "description": "The Top part > Currency > The middle field, click the down arrow > Exchange rate.", "format": "double" }, "dunningLetterDate": { "type": "string", "description": "The Financial details tab > The Dunning information section > Dunning letter date > The date of the last released dunning letter in which the document was listed.", "format": "date-time" }, "dunningLetterLevel": { "type": "integer", "description": "The Financial details tab > The Dunning information section > Dunning level > The dunning level of the document.", "format": "int32" }, "contact": { "$ref": "#/components/schemas/contactInCustomerDebitNoteDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "taxDetails": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailDto" } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDebitNoteLineDto" } }, "roundingDiff": { "type": "number", "description": "The Top part > Rounding diff. > The difference between the original amount and the rounded amount.", "format": "double" }, "customerVatZone": { "$ref": "#/components/schemas/customerVatZoneInCustomerDebitNoteDto" }, "childRecord": { "$ref": "#/components/schemas/ChildRecordDto" }, "timeStamp": { "type": "string", "format": "byte" }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the document is a draft. A document with the On Hold status may be edited and cannot be released." }, "discountTotal": { "type": "number", "description": "The top part > Discount total > The document discount total.", "format": "double" }, "discountTotalInCurrency": { "type": "number", "description": "The top part > Discount total > The document discount total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "detailTotal": { "type": "number", "description": "The top part > Detail total > The document total, which the system calculates for all line items in the Document details tab.", "format": "double" }, "detailTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Detail total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "vatTaxableTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT taxable total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt. total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the tax with the Include in VAT Exempt Total check box selected on the Taxes form.This box is available only if the VAT Reporting feature is enabled in your system.", "format": "double" }, "vatExemptTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT exempt. total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "salesPersonID": { "type": "integer", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead", "format": "int32" }, "salesPersonDescr": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead" }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInCustomerDebitNoteDto" }, "paymentReference": { "type": "string", "description": "///The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window.." }, "invoiceAddress": { "$ref": "#/components/schemas/invoiceAddressInCustomerDebitNoteDto" }, "invoiceContact": { "$ref": "#/components/schemas/invoiceContactInCustomerDebitNoteDto" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ArAdjustDto" } }, "dontPrint": { "type": "boolean" }, "dontEmail": { "type": "boolean" }, "revoked": { "type": "boolean" }, "customer": { "$ref": "#/components/schemas/customerInCustomerDebitNoteDto" }, "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off" }, "referenceNumber": { "type": "string", "description": "The Top part > Ref. no. > The reference number of the customer ledger document in the system." }, "postPeriod": { "type": "string", "description": "The top part > Post period > The period to which the document should be posted. Format YYYYMM." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "documentDate": { "type": "string", "description": "The top part > Date* > The date when the customer ledger document was created.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting \"Use Orig Invoice Date\" is active in AR Preferences.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email." }, "currencyId": { "type": "string", "description": "The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window." }, "amount": { "type": "number", "description": "The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.\r\nIf the check box is cleared, then the value appears when the document status is Open.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "balance": { "type": "number", "description": "The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. \r\nFor a document used in the application process, this is the balance after the payments were applied.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInCustomerDebitNoteDto" }, "customerRefNumber": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "invoiceText": { "type": "string", "description": "The top part > Invoice text > Any user-provided description of the customer ledger document." }, "lastModifiedDateTime": { "type": "string", "description": "System generated field for last modification date/time of document.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "The Attachments tab > Creation time > The date the attachment was created.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "vatTotal": { "type": "number", "description": "The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "location": { "$ref": "#/components/schemas/locationInCustomerDebitNoteDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerDebitNoteDto" }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "project": { "$ref": "#/components/schemas/projectInCustomerDebitNoteDto" }, "account": { "$ref": "#/components/schemas/accountInCustomerDebitNoteDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerDebitNoteDto" }, "customerProject": { "type": "string", "description": "The top part > Customer project no. > The customer project no. used in AutoInvoice." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Customer Debit Note. Used for getting data." }, "DtoValueOfNullableOfRutRotItemTypes": { "type": "object", "properties": { "value": { "enum": [ "Service", "MaterialCost", "OtherCost" ], "type": "string" } } }, "RotRutDistributionUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "personalId": { "$ref": "#/components/schemas/DtoValueOfString" }, "amount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "extra": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" } } }, "DtoValueOfNullableOfRutRotTypes": { "type": "object", "properties": { "value": { "enum": [ "Rut", "Rot" ], "type": "string" } } }, "CustomerDebitNoteLinesUpdateDto": { "type": "object", "properties": { "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "domesticServicesDeductible": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "itemType": { "$ref": "#/components/schemas/DtoValueOfNullableOfRutRotItemTypes" }, "typeOfWork": { "$ref": "#/components/schemas/DtoValueOfString" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "unitPriceInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "accountNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatCodeId": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "discountAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "salesperson": { "$ref": "#/components/schemas/DtoValueOfString" }, "deferralSchedule": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "deferralCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "termStartDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "termEndDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "RotRutUpdateDto": { "type": "object", "properties": { "distributedAutomaticaly": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "type": { "$ref": "#/components/schemas/DtoValueOfNullableOfRutRotTypes" }, "appartment": { "$ref": "#/components/schemas/DtoValueOfString" }, "estate": { "$ref": "#/components/schemas/DtoValueOfString" }, "organizationNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "distribution": { "type": "array", "items": { "$ref": "#/components/schemas/RotRutDistributionUpdateDto" } } } }, "postPeriodInCustomerDebitNoteUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "financialPeriodInCustomerDebitNoteUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM." }, "salesPersonIDInCustomerDebitNoteUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The field is deprecated for customer document endpoints, please use Salesperson instead" }, "salespersonInCustomerDebitNoteUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The identifier of the salesperson involved." }, "CustomerDebitNoteUpdateDto": { "type": "object", "properties": { "paymentMethodId": { "$ref": "#/components/schemas/DtoValueOfString" }, "creditTermsId": { "$ref": "#/components/schemas/DtoValueOfString" }, "currencyId": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerRefNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashDiscountDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "documentDueDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "externalReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "domesticServicesDeductibleDocument": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "paymentReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "contact": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "rotRutDetails": { "$ref": "#/components/schemas/RotRutUpdateDto" }, "taxDetailLines": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailUpdateDto" } }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerDebitNoteLinesUpdateDto" } }, "customerVatZoneId": { "$ref": "#/components/schemas/DtoValueOfString" }, "invoiceAddress": { "$ref": "#/components/schemas/DtoValueOfSalesInvoiceAddressUpdateDto" }, "invoiceContact": { "$ref": "#/components/schemas/DtoValueOfSalesInvoiceContactUpdateDto" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "startDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "endDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "accountingCostRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "originatorDocRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "contractDocRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "childCustomerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "consolidateInvoices": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "documentDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "origInvoiceDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInCustomerDebitNoteUpdateDto" }, "financialPeriod": { "$ref": "#/components/schemas/financialPeriodInCustomerDebitNoteUpdateDto" }, "invoiceText": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPersonID": { "$ref": "#/components/schemas/salesPersonIDInCustomerDebitNoteUpdateDto" }, "salesperson": { "$ref": "#/components/schemas/salespersonInCustomerDebitNoteUpdateDto" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "dontPrint": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "dontEmail": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "ReleaseCustomerDebitNoteActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "DtoValueOfNullableOfGuid": { "type": "object", "properties": { "value": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" } } }, "itemTypeInCustomerInvoiceLinesUpdateDto": { "properties": { "value": { "enum": [ "Service", "MaterialCost", "OtherCost" ], "type": "string" } }, "description": "The property is now considered obsolete. Please define ItemType on the item level instead." }, "typeOfWorkInCustomerInvoiceLinesUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The property is now considered obsolete. Please define typeOfWork on the item level instead." }, "CustomerInvoiceLinesUpdateDto": { "type": "object", "properties": { "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "domesticServicesDeductible": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "itemType": { "$ref": "#/components/schemas/itemTypeInCustomerInvoiceLinesUpdateDto" }, "typeOfWork": { "$ref": "#/components/schemas/typeOfWorkInCustomerInvoiceLinesUpdateDto" }, "taskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "startDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "endDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "unitPriceInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "accountNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatCodeId": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "discountAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "salesperson": { "$ref": "#/components/schemas/DtoValueOfString" }, "deferralSchedule": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "deferralCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "termStartDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "termEndDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "overrideNumberSeriesInCustomerInvoiceUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "Set this value to true if you need to create a new invoice and use supplied referenceNumber (Invoicenumber)" }, "postPeriodInCustomerInvoiceUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "financialPeriodInCustomerInvoiceUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM." }, "salesPersonIDInCustomerInvoiceUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The field is deprecated for customer document endpoints, please use Salesperson instead" }, "salespersonInCustomerInvoiceUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The identifier of the salesperson involved." }, "CustomerInvoiceUpdateDto": { "type": "object", "properties": { "paymentMethodId": { "$ref": "#/components/schemas/DtoValueOfString" }, "creditTermsId": { "$ref": "#/components/schemas/DtoValueOfString" }, "currencyId": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerRefNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashDiscountDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "documentDueDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "externalReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerProject": { "$ref": "#/components/schemas/DtoValueOfString" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "domesticServicesDeductibleDocument": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "rotRutDetails": { "$ref": "#/components/schemas/RotRutUpdateDto" }, "paymentReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "contact": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "project": { "$ref": "#/components/schemas/DtoValueOfString" }, "taxDetailLines": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailUpdateDto" } }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerInvoiceLinesUpdateDto" } }, "sendToAutoInvoice": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "customerVatZoneId": { "$ref": "#/components/schemas/DtoValueOfString" }, "billingAddress": { "$ref": "#/components/schemas/DtoValueOfSalesInvoiceAddressUpdateDto" }, "invoiceContact": { "$ref": "#/components/schemas/DtoValueOfSalesInvoiceContactUpdateDto" }, "startDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "endDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "accountingCostRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "originatorDocRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "contractDocRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "revoked": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "overrideNumberSeries": { "$ref": "#/components/schemas/overrideNumberSeriesInCustomerInvoiceUpdateDto" }, "directDebitMandateId": { "$ref": "#/components/schemas/DtoValueOfNullableOfGuid" }, "excludeDebtCollection": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "debtCollectionCaseNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "debtCollectionCaseStatus": { "$ref": "#/components/schemas/DtoValueOfString" }, "debtCollectionCaseType": { "$ref": "#/components/schemas/DtoValueOfString" }, "debtCollectionCaseUrl": { "$ref": "#/components/schemas/DtoValueOfString" }, "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "childCustomerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "consolidateInvoices": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "documentDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "origInvoiceDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInCustomerInvoiceUpdateDto" }, "financialPeriod": { "$ref": "#/components/schemas/financialPeriodInCustomerInvoiceUpdateDto" }, "invoiceText": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPersonID": { "$ref": "#/components/schemas/salesPersonIDInCustomerInvoiceUpdateDto" }, "salesperson": { "$ref": "#/components/schemas/salespersonInCustomerInvoiceUpdateDto" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "dontPrint": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "dontEmail": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "RotRutDistributionDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "format": "int32" }, "personalId": { "type": "string" }, "amount": { "type": "number", "format": "double" }, "extra": { "type": "boolean" } }, "description": "This class represents a RutRot Distribution Line For RutRot in RutRotController. Used for getting data." }, "RotRutDto": { "type": "object", "properties": { "docType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string" }, "refNbr": { "type": "string" }, "distributedAutomaticaly": { "type": "boolean" }, "type": { "enum": [ "Rut", "Rot" ], "type": "string" }, "totalDeductableAmount": { "type": "number", "format": "double" }, "otherCost": { "type": "number", "format": "double" }, "materialCost": { "type": "number", "format": "double" }, "workPrice": { "type": "number", "format": "double" }, "distributedAmount": { "type": "number", "format": "double" }, "appartment": { "type": "string" }, "estate": { "type": "string" }, "organizationNbr": { "type": "string" }, "distribution": { "type": "array", "items": { "$ref": "#/components/schemas/RotRutDistributionDto" } } }, "description": "This class represents a RutRot in RutRotController. Used for getting data." }, "CorrectArDocumentActionResultDto": { "type": "object", "properties": { "refNbr": { "type": "string" }, "documentType": { "type": "string" }, "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "ReverseInvoiceActionDto": { "type": "object", "properties": { "returnCreditNote": { "type": "boolean" } } }, "ReverseInvoiceActionResultDto": { "type": "object", "properties": { "referenceNumber": { "type": "string" }, "creditNoteDto": { "$ref": "#/components/schemas/CreditNoteDto" }, "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "accountInCustomerOverdueChargeLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Account* > The sales account used for the transaction." }, "vatCodeInCustomerOverdueChargeLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "VAT category > The VAT category (if applied) for the transaction. The category represents the type of goods or services." }, "subaccountInCustomerOverdueChargeLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: Subaccount* > The corresponding subaccount used for this transaction." }, "sellerInCustomerOverdueChargeLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Salesperson ID > The identifier of the salesperson involved." }, "branchNumberInCustomerOverdueChargeLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Branch* > The branch that sells the line item or provides the service." }, "CustomerOverdueChargeLineDto": { "type": "object", "properties": { "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "lineNumber": { "type": "integer", "description": "Line no. > A counter of lines in the overview of cash sales document overview.", "format": "int32" }, "inventoryNumber": { "type": "string", "description": "Item ID > The item ID of the line item, if applicable. Only a non-stock item can be selected." }, "description": { "type": "string", "description": "Transaction descr. > Any brief comment relevant to the transaction.The alphanumeric string may contain up to 30 characters." }, "quantity": { "type": "number", "description": "Quantity > The quantity of items (goods or services) of a particular type sold to the customer.", "format": "double" }, "unitPrice": { "type": "number", "description": "Unit price > The unit price set for the item or service. If you want to update the unit price\r\nautomatically to the current value(that is, the applicable sales or default price),\r\nyou can use the Recalculate Prices and Discounts action.If you have modified\r\nthe unit price and saved the document, the value will not be updated by the\r\nsystem if you change the document date.", "format": "double" }, "unitPriceInCurrency": { "type": "number", "description": "Background calculation giving you the Unit price in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualAmount": { "type": "number", "description": "Manual amount > a check box indicating that the amount has been entered manually.", "format": "double" }, "manualAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Manual amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "amount": { "type": "number", "description": "Amount > The amount after the discount has been applied. The value of this read-only box\r\nis calculated automatically by deducting the discount amount from the extended price.", "format": "double" }, "cost": { "type": "number", "description": "Cost > The total cost of the line in default currency. \r\nThe value will always be 0 for unreleased documents.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "account": { "$ref": "#/components/schemas/accountInCustomerOverdueChargeLineDto" }, "vatCode": { "$ref": "#/components/schemas/vatCodeInCustomerOverdueChargeLineDto" }, "uom": { "type": "string", "description": "UoM > The unit of measure (UoM) for the item." }, "discountPercent": { "type": "number", "description": "Discount percent > The percent of the line-level discount that has been applied manually or\r\nautomatically.The system selects the Manual Discount check box and\r\ncalculates the discount amount after you have entered the percent manually and\r\nsaved your changes or added a new line.", "format": "double" }, "discountAmount": { "type": "number", "description": "Discount amount > The amount of the line-level discount that has been applied manually or\r\nautomatically to this line.The system selects the Manual Discount check box\r\nand calculates the line amount after you have entered the discount amount\r\nmanually and save your changes or added a new line.", "format": "double" }, "discountAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Discount amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Manual discount > A check box that indicates (if selected) that the discount has been applied\r\nmanually.If you clear the check box, the system clears entered discount percent,\r\nor discount amount, or selected discount code." }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerOverdueChargeLineDto" }, "salesperson": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use Seller instead" }, "seller": { "$ref": "#/components/schemas/sellerInCustomerOverdueChargeLineDto" }, "deferralSchedule": { "type": "integer", "description": "Original deferral schedule > A read-only column filled in by the system in the Cash return documents created by the reversing process. It shows the identifier of the deferral schedule associated with the original Cash sale document.", "format": "int32" }, "deferralCode": { "type": "string", "description": "The deferral code assigned to the stock item or non-stock item specified in this\r\ndocument line.Upon release of the document, the system generates a deferral\r\nschedule (or schedules) based on the settings defined in this deferral code." }, "discountCode": { "type": "string", "description": "The code of the line discount that has been applied to this line automatically or manually." }, "note": { "type": "string", "description": "Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order." }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerOverdueChargeLineDto" }, "externalLink": { "type": "string" } } }, "creditTermsInCustomerOverdueChargeDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part > Terms* > The credit terms used in relations with the customer." }, "contactInCustomerOverdueChargeDto": { "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Contact > The contact associated with the customer." }, "customerVatZoneInCustomerOverdueChargeDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The VAT info section > Dunning letter date" }, "salesPersonInCustomerOverdueChargeDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The document details tab > Salesperson ID > The salesperson involved." }, "invoiceAddressInCustomerOverdueChargeDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInCustomerDocumentAddressDto" }, "county": { "$ref": "#/components/schemas/countyInCustomerDocumentAddressDto" }, "overrideAddress": { "type": "boolean", "description": "Override address > A check box that indicates (if selected) that the invoice address is not the default invoice address of the customer." } }, "description": "The Invoice address tab > The Invoice address section." }, "invoiceContactInCustomerOverdueChargeDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "businessName": { "type": "string" }, "attention": { "type": "string" }, "email": { "type": "string" }, "phone1": { "type": "string" }, "overrideContact": { "type": "boolean" } }, "description": "The Invoice address tab > The Invoice contact section." }, "customerInCustomerOverdueChargeDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer associated with the document." }, "paymentMethodInCustomerOverdueChargeDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > The Payment information section > Payment method > The identifier for the payment method that the customer will use to pay the document." }, "locationInCustomerOverdueChargeDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Location > The location of the customer related to the document. By default, it is the default\r\nlocation of the selected customer or, if the invoice is created from an opportunity,\r\nit is the customer location specified for the opportunity." }, "branchNumberInCustomerOverdueChargeDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Financial details tab > Branch > The branch with which this invoice or memo is associated. The field is available if your company is set up with branches." }, "projectInCustomerOverdueChargeDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Project* > The identifier and description of the project with which this document is associated, or the code indicating that this document is not associated with any project; the non-project code is specified in the Project accounting preferences (PM101000) window." }, "accountInCustomerOverdueChargeDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The Document details tab > Account * > The sales account used for the transaction." }, "subaccountInCustomerOverdueChargeDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The Document details tab > Subaccount* > The corresponding subaccount used for this transaction." }, "CustomerOverdueChargeDto": { "type": "object", "properties": { "creditTerms": { "$ref": "#/components/schemas/creditTermsInCustomerOverdueChargeDto" }, "documentDueDate": { "type": "string", "description": "Mandatory field: The Top part > Due date* > The date when payment for the document is due, in accordance with the credit terms.", "format": "date-time" }, "cashDiscountDate": { "type": "string", "description": "Madatory field: The top part > Cash discount date* > The end date of the cash discount period, which the system calculates by using the credit terms.", "format": "date-time" }, "externalReference": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "exchangeRate": { "type": "number", "description": "The top part > Currency > The currency of the document.", "format": "double" }, "dunningLetterDate": { "type": "string", "description": "Financial details tab > Dunning information section > Dunning letter date > The date of the last released dunning letter in which the document was listed.", "format": "date-time" }, "dunningLetterLevel": { "type": "integer", "description": "Financial details tab > Dunning information section > Dunning level > The dunning level of the document.", "format": "int32" }, "contact": { "$ref": "#/components/schemas/contactInCustomerOverdueChargeDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "Attachments tab" }, "taxDetails": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailDto" }, "description": "VAT details tab" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOverdueChargeLineDto" }, "description": "Document details tab" }, "roundingDiff": { "type": "number", "description": "The top part > Rounding diff. > The difference between the original amount and the rounded amount.", "format": "double" }, "customerVatZone": { "$ref": "#/components/schemas/customerVatZoneInCustomerOverdueChargeDto" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the document is a draft. A document with the On Hold status may be edited and cannot be released." }, "discountTotal": { "type": "number", "description": "The top part > Discount total > The document discount total.", "format": "double" }, "discountTotalInCurrency": { "type": "number", "description": "The top part > Discount total > The document discount total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "detailTotal": { "type": "number", "description": "The top part > Detail total > The document total, which the system calculates for all line items in the Document details tab.", "format": "double" }, "detailTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Detail total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "vatTaxableTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT taxable total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt. total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the tax with the Include in VAT Exempt Total check box selected on the Taxes form.This box is available only if the VAT Reporting feature is enabled in your system.", "format": "double" }, "vatExemptTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT exempt. total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "salesPersonID": { "type": "integer", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead", "format": "int32" }, "salesPersonDescr": { "type": "string", "description": "The field is deprecated for customer document endpoints, please use SalesPerson instead" }, "salesPerson": { "$ref": "#/components/schemas/salesPersonInCustomerOverdueChargeDto" }, "paymentReference": { "type": "string", "description": "///The top part > Payment ref. > The reference number of the document, as automatically generated by the system in accordance with the number series assigned to cash sales in the Customer ledger preferences window.." }, "invoiceAddress": { "$ref": "#/components/schemas/invoiceAddressInCustomerOverdueChargeDto" }, "invoiceContact": { "$ref": "#/components/schemas/invoiceContactInCustomerOverdueChargeDto" }, "applications": { "type": "array", "items": { "$ref": "#/components/schemas/ArAdjustDto" } }, "dontPrint": { "type": "boolean" }, "dontEmail": { "type": "boolean" }, "revoked": { "type": "boolean" }, "customer": { "$ref": "#/components/schemas/customerInCustomerOverdueChargeDto" }, "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "The top part > Type > The document type. The following types are available: invoice, debit note, credit note, overdue charge, credit write-off" }, "referenceNumber": { "type": "string", "description": "The Top part > Ref. no. > The reference number of the customer ledger document in the system." }, "postPeriod": { "type": "string", "description": "The top part > Post period > The period to which the document should be posted. Format YYYYMM." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "documentDate": { "type": "string", "description": "The top part > Date* > The date when the customer ledger document was created.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The top part > Orig invoice date > The date based on which the Due date and Cash discount date is calculated. Only used if setting \"Use Orig Invoice Date\" is active in AR Preferences.\r\nBy default, for a new document, it is the current business date, but you can change the date.", "format": "date-time" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The top part > Status > The status of the document, which can be one of the following: Hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email." }, "currencyId": { "type": "string", "description": "The top part > Currency > The currency of the document. By default, it is the customer’s default currency,but it can be changed if the Allow Currency Override check box is selected in the AR303000 window." }, "amount": { "type": "number", "description": "The top part > Amount > The amount paid by the document. The value appears for new documents if the Validate document totals on entry check box is selected on the AR101000 window.\r\nIf the check box is cleared, then the value appears when the document status is Open.", "format": "double" }, "amountInCurrency": { "type": "number", "description": "Background calculation giving you the Amount in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "balance": { "type": "number", "description": "The top part > Balance > For an open customer ledger document, the balance after any cash discount was taken. \r\nFor a document used in the application process, this is the balance after the payments were applied.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The top part > Cash discount > The cash discount amount that has been or will be taken on the document, which the system calculates based on the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInCustomerOverdueChargeDto" }, "customerRefNumber": { "type": "string", "description": "The top part > External reference > The external reference used in AutoInvoice." }, "invoiceText": { "type": "string", "description": "The top part > Invoice text > Any user-provided description of the customer ledger document." }, "lastModifiedDateTime": { "type": "string", "description": "System generated field for last modification date/time of document.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "The Attachments tab > Creation time > The date the attachment was created.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "vatTotal": { "type": "number", "description": "The top part > VAT total > The VAT amount of the document, as defined on the VAT details tab.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "location": { "$ref": "#/components/schemas/locationInCustomerOverdueChargeDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerOverdueChargeDto" }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "project": { "$ref": "#/components/schemas/projectInCustomerOverdueChargeDto" }, "account": { "$ref": "#/components/schemas/accountInCustomerOverdueChargeDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInCustomerOverdueChargeDto" }, "customerProject": { "type": "string", "description": "The top part > Customer project no. > The customer project no. used in AutoInvoice." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a invoice in CustomerOverdueChargeController. Used by getting data." }, "CustomerOverdueChargeLineUpdateDto": { "type": "object", "properties": { "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "domesticServicesDeductible": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "itemType": { "$ref": "#/components/schemas/DtoValueOfNullableOfRutRotItemTypes" }, "typeOfWork": { "$ref": "#/components/schemas/DtoValueOfString" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "unitPriceInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "accountNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatCodeId": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "discountAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "salesperson": { "$ref": "#/components/schemas/DtoValueOfString" }, "deferralSchedule": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "deferralCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "termStartDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "termEndDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "postPeriodInCustomerOverdueChargeUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "financialPeriodInCustomerOverdueChargeUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM." }, "salesPersonIDInCustomerOverdueChargeUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The field is deprecated for customer document endpoints, please use Salesperson instead" }, "salespersonInCustomerOverdueChargeUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The identifier of the salesperson involved." }, "CustomerOverdueChargeUpdateDto": { "type": "object", "properties": { "paymentMethodId": { "$ref": "#/components/schemas/DtoValueOfString" }, "creditTermsId": { "$ref": "#/components/schemas/DtoValueOfString" }, "currencyId": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerRefNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashDiscountDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "documentDueDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "externalReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "domesticServicesDeductibleDocument": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "paymentReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "contact": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerOverdueChargeLineUpdateDto" } }, "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "childCustomerNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "consolidateInvoices": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "documentDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "origInvoiceDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInCustomerOverdueChargeUpdateDto" }, "financialPeriod": { "$ref": "#/components/schemas/financialPeriodInCustomerOverdueChargeUpdateDto" }, "invoiceText": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPersonID": { "$ref": "#/components/schemas/salesPersonIDInCustomerOverdueChargeUpdateDto" }, "salesperson": { "$ref": "#/components/schemas/salespersonInCustomerOverdueChargeUpdateDto" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "dontPrint": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "dontEmail": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "ReleaseCustomerOverdueChargeActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "ReasonCodeDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "PaymentFinancialDetailsDto": { "type": "object", "properties": { "paymentDate": { "type": "string", "description": "Financial Details tab > Payment date", "format": "date-time" } }, "description": "This class represents an Financial Details in Payments" }, "OrderToApplyDto": { "type": "object", "properties": { "orderType": { "type": "string", "description": "Mandatory field: Order type* > The order type for which the payment is to be reserved." }, "orderNo": { "type": "string", "description": "Mandatory field: Order no.* > The reference number of the order for which the payment is reserved." }, "status": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string", "description": "Status > The status of the document, which is assigned automatically." }, "appliedToOrder": { "type": "number", "description": "Applied to order > The total amount reserved for the order.", "format": "double" }, "transferredToInvoice": { "type": "number", "description": "Transferred to invoice > The amount that has been applied to invoice.", "format": "double" }, "date": { "type": "string", "description": "Date > The creation date of the order.", "format": "date-time" }, "dueDate": { "type": "string", "description": "Due date > The due date of the order.", "format": "date-time" }, "cashDiscountDate": { "type": "string", "description": "Cash discount date > The date through which the customer can take a cash discount.", "format": "date-time" }, "balance": { "type": "number", "description": "Balance > The balance of the order after the cash discount is taken and the amount is paid.", "format": "double" }, "description": { "type": "string", "description": "Description > A description of the order." }, "orderTotal": { "type": "number", "description": "Order total > The total amount of the document.", "format": "double" }, "currency": { "type": "string", "description": "Currency > The currency of the document." }, "invoiceNbr": { "type": "string", "description": "Invoice no. > The reference number of the invoice generated for the order." }, "invoiceDate": { "type": "string", "description": "Invoice date > The date of the invoice.", "format": "date-time" } }, "description": "This class represents an OrderToApply in Payments" }, "writeOffReasonCodeInPaymentLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Write-off reason code > A reason code that defines an account and subaccount to be used for writing off credits or balances." }, "PaymentLineDto": { "type": "object", "properties": { "documentType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "Doc. type > The type of document to which the payment is applied." }, "refNbr": { "type": "string", "description": "Mandatory field: Ref. no.* > The reference number of the invoice or note to which the payment is applied." }, "amountPaid": { "type": "number", "description": "Amount paid > The amount to be paid which is displayed in the currency of the document that is selected in the window.", "format": "double" }, "cashDiscountTaken": { "type": "number", "description": "Cash discount taken > The cash discount to be taken.", "format": "double" }, "balanceWriteOff": { "type": "number", "description": "Balance write-off > The amount to be written off.", "format": "double" }, "writeOffReasonCode": { "$ref": "#/components/schemas/writeOffReasonCodeInPaymentLineDto" }, "date": { "type": "string", "description": "Date > The creation date of the customer ledger document.", "format": "date-time" }, "dueDate": { "type": "string", "description": "Due date > The due date of the customer ledger document.", "format": "date-time" }, "cashDiscountDate": { "type": "string", "description": "Cash disount date > The date through which the customer can take a cash discount.", "format": "date-time" }, "balance": { "type": "number", "description": "Balance > The balance of the document after the cash discount is taken and the amount is paid.", "format": "double" }, "cashDiscountBalance": { "type": "number", "description": "Cash discount balance > The unused amount of the cash discount, in case of partial payment.", "format": "double" }, "description": { "type": "string", "description": "Description > A description of the document." }, "currency": { "type": "string", "description": "Currency > The currency of the customer ledger document." }, "postPeriod": { "type": "string", "description": "Post period > The financial period to which the transactions recorded in the document should be posted. Format MMYYYY." }, "customerOrder": { "type": "string", "description": "Customer order > A reference to a document of the customer, such as a purchase order number." }, "crossRate": { "type": "number", "description": "Cross rate > A cross rate that you can optionally specify between the currency of the payment and currency of the original document.", "format": "double" } } }, "customerInPaymentDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: The top part > Customer* > The customer who issued the payment." }, "locationInPaymentDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part > Location* > The customer location associated with the sale." }, "paymentMethodInPaymentDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Payment method > The customer's default payment method; this field is not available for credit notes." }, "financialDetailsInPaymentDto": { "properties": { "paymentDate": { "type": "string", "description": "Financial Details tab > Payment date", "format": "date-time" } }, "description": "Financial Details" }, "PaymentDto": { "type": "object", "properties": { "type": { "enum": [ "Payment", "CreditNote", "Prepayment", "Refund", "VoidPayment", "SmallBalanceWo", "VoidRefund", "Undefined" ], "type": "string", "description": "The top part > Type > The type of a document. The following types are available: Payment, CreditNote, Prepayment, Customer refund, Void payment, Balance write-off" }, "refNbr": { "type": "string", "description": "The top part > Ref.no > The unique identifier for the payment. This number is automatically generated by the system for a new payment document, based on the number series\tin the AR101000 window." }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The top part > Status > The status of the customer payment, which for a new document is either Balanced or On hold. [On hold, Balanced, Voided, Scheduled, Open, Closed, Pending print, Pending email, Credit hold, CcHold, Reserved]" }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the document is a draft with the On hold status. This check box is unavailable for debit adjustments." }, "applicationDate": { "type": "string", "description": "Mandatory field: The top part > Date* > The date when a payment is applied to a document (invoice or note). The field display the current business date for tunapplied or partially applied payments and the latest application date for the closed payment", "format": "date-time" }, "applicationPeriod": { "type": "string", "description": "Mandatory field: The top part > Financial period* > The period to which the payment should be applied, which the system fills in based on the date." }, "paymentRef": { "type": "string", "description": "Mandatory field: The top part > Payment ref.* > A secondary payment reference identifier, which can be a system-generated number or an external reference number entered manually." }, "customer": { "$ref": "#/components/schemas/customerInPaymentDto" }, "location": { "$ref": "#/components/schemas/locationInPaymentDto" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInPaymentDto" }, "cashAccount": { "type": "string", "description": "Mandatory field: The top part > Cash account* > The default cash account associated with the payment method; this field is not available for credit notes." }, "currency": { "type": "string", "description": "The top part > Currency > The currency of the payment document." }, "paymentAmount": { "type": "number", "description": "The top part > Payment amount > The total of the payment that is entered manually.", "format": "double" }, "invoiceText": { "type": "string", "description": "The top part > Invoice text > A user-defined description of the payment. 50 alphanumeric characters." }, "appliedToDocuments": { "type": "number", "description": "The top part > Applied to documents > The total of the documents to which payment is to be applied.", "format": "double" }, "appliedToOrders": { "type": "number", "description": "The top part > Applied to orders > The total of the orders for which payment is reserved, minus the amount transferred to invoice.", "format": "double" }, "availableBalance": { "type": "number", "description": "The top part > Available balance > The amount that has not been applied.", "format": "double" }, "writeOffAmount": { "type": "number", "description": "The top part > Write-off amount > The amount that has been written off.", "format": "double" }, "financeCharges": { "type": "number", "description": "The top part > Finance charges > The total on all finance charges applied to this document.", "format": "double" }, "deductedCharges": { "type": "number", "description": "The top part > Deducted charges > The total amount of bank charges deducted by bank from the payment amount on your cash account (bank account).", "format": "double" }, "branch": { "type": "string" }, "lastModifiedDateTime": { "type": "string", "description": "Systemgenerated information.", "format": "date-time" }, "paymentLines": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentLineDto" }, "description": "Documents to apply tab >" }, "ordersToApply": { "type": "array", "items": { "$ref": "#/components/schemas/OrderToApplyDto" }, "description": "Orders to apply tab >" }, "financialDetails": { "$ref": "#/components/schemas/financialDetailsInPaymentDto" }, "paymentAmountInCurrency": { "type": "number", "description": "Payment amount calculated in your default (base) currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "availableBalanceInCurrency": { "type": "number", "description": "Available Balance calculated in your default (base) currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Payment in PaymentController. Used by getting data." }, "PaymentLinesUpdateDto": { "type": "object", "properties": { "cashDiscountTaken": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "balanceWriteOff": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "writeOffReasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "crossRate": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "documentType": { "$ref": "#/components/schemas/DtoValueOfCustomerDocumentTypes" }, "refNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "amountPaid": { "$ref": "#/components/schemas/DtoValueOfDecimal" } } }, "FinanceChargesUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "entryType": { "$ref": "#/components/schemas/DtoValueOfString" }, "offsetAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "offsetSubAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "amount": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfInt32" } } }, "PaymentOrdersLinesUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "orderType": { "$ref": "#/components/schemas/DtoValueOfString" }, "orderNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "appliedToOrder": { "$ref": "#/components/schemas/DtoValueOfDecimal" } } }, "DtoValueOfNullableOfPaymentTypes": { "type": "object", "properties": { "value": { "enum": [ "Payment", "CreditNote", "Prepayment", "Refund", "VoidPayment", "SmallBalanceWo", "VoidRefund", "Undefined" ], "type": "string" } } }, "referenceNumberInPaymentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The top part > Ref. no > Reference number for the document. Can be used when manual numbering is enabled." }, "typeInPaymentUpdateDto": { "properties": { "value": { "enum": [ "Payment", "CreditNote", "Prepayment", "Refund", "VoidPayment", "SmallBalanceWo", "VoidRefund", "Undefined" ], "type": "string" } }, "description": "The top part > Type > The type of a document: Payment, Credit note, Prepayment, Customer refund, Void payment, Balance write-off." }, "holdInPaymentUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "The top part > Hold > A check box that indicates (if selected) that the document is a draft with the On hold status." }, "applicationDateInPaymentUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "Mandatory field: The top part > Date* > The date when a payment is applied to a document (invoice or note). The current business date for unapplied or partially applied payments and the latest application date for the closed payment." }, "applicationPeriodInPaymentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field: The top part > Financial period* > The financial period to which the payment should be applied, which the system fills in based on the date." }, "paymentRefInPaymentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field: The top part > Payment ref.* > A secondary payment reference identifier, which can be a system-generated number or an external reference number entered manually." }, "customerInPaymentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field: The top part > Customer* > The customer who issued the payment." }, "locationInPaymentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field: The top part > Location* > The customer location associated with the sale. Once the customer is selected, this field displays the customer's default location." }, "paymentMethodInPaymentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The top part > Payment method > The customer's default payment method." }, "cashAccountInPaymentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field: The top part > Cash account* > The default cash account associated with the payment method." }, "currencyInPaymentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The top part > Currency > The currency of the payment document. Once the customer is selected, the system inserts the customer's default currency." }, "paymentAmountInPaymentUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The top part > Payment amount > The total of the documents to which payment is to be applied." }, "invoiceTextInPaymentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The top part > Invoice text > A user-defined description of the payment." }, "PaymentUpdateDto": { "type": "object", "properties": { "referenceNumber": { "$ref": "#/components/schemas/referenceNumberInPaymentUpdateDto" }, "type": { "$ref": "#/components/schemas/typeInPaymentUpdateDto" }, "hold": { "$ref": "#/components/schemas/holdInPaymentUpdateDto" }, "applicationDate": { "$ref": "#/components/schemas/applicationDateInPaymentUpdateDto" }, "applicationPeriod": { "$ref": "#/components/schemas/applicationPeriodInPaymentUpdateDto" }, "paymentRef": { "$ref": "#/components/schemas/paymentRefInPaymentUpdateDto" }, "customer": { "$ref": "#/components/schemas/customerInPaymentUpdateDto" }, "location": { "$ref": "#/components/schemas/locationInPaymentUpdateDto" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInPaymentUpdateDto" }, "cashAccount": { "$ref": "#/components/schemas/cashAccountInPaymentUpdateDto" }, "currency": { "$ref": "#/components/schemas/currencyInPaymentUpdateDto" }, "paymentAmount": { "$ref": "#/components/schemas/paymentAmountInPaymentUpdateDto" }, "invoiceText": { "$ref": "#/components/schemas/invoiceTextInPaymentUpdateDto" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "ordersToApply": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentOrdersLinesUpdateDto" }, "description": "The top part > Applied to orders > The total of the orders for which payment is reserved, minus the amount transferred to invoice." }, "financeCharges": { "type": "array", "items": { "$ref": "#/components/schemas/FinanceChargesUpdateDto" }, "description": "Financial Charges" }, "paymentLines": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentLinesUpdateDto" } } } }, "PaymentQueryParameters": { "type": "object", "properties": { "paymentNbr": { "type": "string", "description": "Payment number" }, "paymentType": { "enum": [ "Payment", "CreditNote", "Prepayment", "Refund", "VoidPayment", "SmallBalanceWo", "VoidRefund", "Undefined" ], "type": "string", "description": "Select Type" }, "customer": { "type": "string", "description": "Enter Customer" }, "greaterThanValue": { "type": "string", "description": "Enter the from-value for Ref. no." }, "invoiceRefNbr": { "type": "string", "description": "Enter Invoice Ref Nbr" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "PendingPrint", "PendingEmail", "CreditHold", "CcHold", "Reserved" ], "type": "string", "description": "The status of the document. Use the dropdown to select status." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "Enter field to order your records by." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "branch": { "type": "string", "description": "Filter by Branch" }, "docDate": { "type": "string", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__.", "format": "date-time" }, "docDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__." }, "financialPeriod": { "type": "string", "description": "Filter by financial period, format YYYYPP" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ReleasePaymentActionDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DtoValueOfNullableOfPaymentTypes" } } }, "ReleasePaymentActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "VoidPaymentActionDto": { "type": "object", "properties": { "type": { "enum": [ "Payment", "CreditNote", "Prepayment", "Refund", "VoidPayment", "SmallBalanceWo", "VoidRefund", "Undefined" ], "type": "string" }, "returnVoidPayment": { "type": "boolean" } } }, "VoidPaymentActionResultDto": { "type": "object", "properties": { "type": { "enum": [ "Payment", "CreditNote", "Prepayment", "Refund", "VoidPayment", "SmallBalanceWo", "VoidRefund", "Undefined" ], "type": "string" }, "refNbr": { "type": "string" }, "voidPayment": { "$ref": "#/components/schemas/PaymentDto" }, "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "CustomerPaymentMethodDetailDto": { "type": "object", "properties": { "detailId": { "type": "string" }, "description": { "type": "string", "description": "Payment method details tab > Description > A description of the selected payment method." }, "value": { "type": "string", "description": "Payment method details tab > Value > The value you enter. This must match the input validation mask set for the column." } } }, "CashAccountIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "CustomerIdNameDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } } }, "customerInCustomerPaymentMethodDto": { "properties": { "id": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part > Customer* > The customer whose payment method you want to view or add; select a customer from the list of customers defined in the system." }, "paymentMethodInCustomerPaymentMethodDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part > Payment method* > The payment method used as a template for a customer payment method you are currently viewing; select a payment method to use its settings for creating a new customer payment method." }, "cashAccountInCustomerPaymentMethodDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Cash account > The cash account to accrue customer payments made by this payment method, if it differs from the default cash account specified for the payment method selected." }, "CustomerPaymentMethodDto": { "type": "object", "properties": { "customer": { "$ref": "#/components/schemas/customerInCustomerPaymentMethodDto" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInCustomerPaymentMethodDto" }, "active": { "type": "boolean", "description": "The top part > Active > A check box that indicates (if selected) that the selected customer payment method is active (that is, available for recording payments)." }, "cashAccount": { "$ref": "#/components/schemas/cashAccountInCustomerPaymentMethodDto" }, "cardOrAccountNo": { "type": "string", "description": "The top part > Card/account no. > The identifier for the customer's payment method." }, "paymentMethodDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPaymentMethodDetailDto" }, "description": "Payment method details tab > The specific elements on this tab depend on the selected payment method, which is defined in the window." }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" } } }, "CustomerPaymentMethodDetailUpdateDto": { "type": "object", "properties": { "detailId": { "$ref": "#/components/schemas/DtoValueOfString" }, "value": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "CustomerPaymentMethodUpdateDto": { "type": "object", "properties": { "active": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "cashAccountId": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentMethodDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPaymentMethodDetailUpdateDto" } } } }, "CustomerPaymentMethodQueryParameters": { "type": "object", "properties": { "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "CustomerPaymentMethodsDto": { "type": "object", "properties": { "customerId": { "type": "string" }, "paymentMethods": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPaymentMethodDto" } } } }, "CustomerPaymentMethodCreateDto": { "type": "object", "properties": { "customerId": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentMethodId": { "$ref": "#/components/schemas/DtoValueOfString" }, "active": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "cashAccountId": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentMethodDetails": { "type": "array", "items": { "$ref": "#/components/schemas/CustomerPaymentMethodDetailUpdateDto" } } } }, "CustomerSalesPriceQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "priceType": { "enum": [ "All", "Base", "Customer", "CustomerPriceClass" ], "type": "string" }, "priceCode": { "type": "string" }, "inventoryId": { "type": "string" }, "effectiveAsOf": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "CustomerSalesPriceDto": { "type": "object", "properties": { "recordId": { "type": "integer", "description": "Mandatory field: The Sales price table > Item ID* > The ID of the stock or non-stock stock item for which price information is listed.", "format": "int32" }, "priceType": { "enum": [ "All", "Base", "Customer", "CustomerPriceClass" ], "type": "string", "description": "The Sales price table or the top part > Price type > The type of prices you want to view: All prices, Base, Customer, Customer price class." }, "priceCode": { "type": "string", "description": "The Sales price table or the top part > Price code > The customer or a customer price class for which you want to create or edit a price list." }, "inventoryId": { "type": "string", "description": "The Sales price table or the top part > Warehouse > The warehouse in which the price applies." }, "description": { "type": "string", "description": "The Sales price table > Description > The description of the stock item." }, "uoM": { "type": "string", "description": "Mandatory field: The Sales price table > UoM* > The unit of measure (UoM) used for the item." }, "promotion": { "type": "boolean", "description": "The Sales price table > Promotion > A check box that indicates (if selected) that the price for this item is promotional." }, "breakQty": { "type": "number", "description": "The Sales price table > Break quantity > The quantity to define a lower bound for a quantity tier with the specific price.", "format": "double" }, "price": { "type": "number", "description": "The Sales Price table > Price > The price for the item.", "format": "double" }, "currency": { "type": "string", "description": "Mandatory field: The Sales price table > Currency* > The currency in which this price is specified." }, "vat": { "type": "string", "description": "The Sales price table > VAT > The VAT amount that is included in the sales price." }, "effectiveDate": { "type": "string", "description": "The Sales price table > Effective date > The date when the price became effective.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "The Sales price table > Ecpiration date > The date when the price expires.", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "warehouse": { "type": "string" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a CustomerSalesPrice in CustomerSalesPriceController." }, "DtoValueOfNullableOfPriceTypesForUpdate": { "type": "object", "properties": { "value": { "enum": [ "Base", "Customer", "CustomerPriceClass" ], "type": "string" } } }, "CustomerSalesPriceUpdateDto": { "type": "object", "properties": { "priceType": { "$ref": "#/components/schemas/DtoValueOfNullableOfPriceTypesForUpdate" }, "priceCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "inventoryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "uoM": { "$ref": "#/components/schemas/DtoValueOfString" }, "promotion": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "breakQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "price": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "vat": { "$ref": "#/components/schemas/DtoValueOfString" }, "effectiveDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "warehouse": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "CustomerBalanceV2QueryParameters": { "required": [ "fromFinPeriod", "toFinPeriod" ], "type": "object", "properties": { "branchNumber": { "type": "string", "description": "Filter by Branch" }, "customer": { "type": "string", "description": "Filter by Customer" }, "fromFinPeriod": { "type": "string", "description": "Filter from financial period, format YYYYPP\r\nThe filte is inclusive, the records for the specified period will be included in the results.\r\nThis filter is required." }, "toFinPeriod": { "type": "string", "description": "Filter to financial period, format YYYYPP\r\nThe filte is inclusive, the records for the specified period will be included in the results.\r\nThis filter is required." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } }, "description": "Query parameters for Customers Balance - version 2" }, "branchNumberInCustomerBalanceV2Dto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Branch" }, "customerInCustomerBalanceV2Dto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Customer" }, "CustomerBalanceV2Dto": { "type": "object", "properties": { "branchNumber": { "$ref": "#/components/schemas/branchNumberInCustomerBalanceV2Dto" }, "customer": { "$ref": "#/components/schemas/customerInCustomerBalanceV2Dto" }, "beginBalance": { "type": "number", "description": "Begin balance", "format": "double" }, "sales": { "type": "number", "description": "Purchases", "format": "double" }, "paymentsAndPrepayments": { "type": "number", "description": "Payments and prepayments", "format": "double" }, "adjustmentsAndDiscounts": { "type": "number", "description": "Adjustments and discounts", "format": "double" }, "overdueCharges": { "type": "number", "description": "Overdue charges", "format": "double" }, "yearToDateBalance": { "type": "number", "description": "Year to date balance", "format": "double" } }, "description": "CustomerBalanceV2Dto" }, "AccountDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "deferralAccountInDeferralCodeDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Deferral account > The account used to hold the deferred amount until it is fully recognised." }, "deferralSubInDeferralCodeDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Deferral sub > The corresponding subaccount." }, "DeferralCodeDto": { "type": "object", "properties": { "deferralCode": { "type": "string", "description": "Mandatory field: Deferral code* > \tThe unique code for the deferral type." }, "description": { "type": "string", "description": "Description > The description of the deferral code." }, "deferredRevenueFromItem": { "type": "boolean", "description": "Deferred revenue from item > When this check box is selected, the deferred revenue of the code will be retrieved from the connected item." }, "recognitionMethod": { "enum": [ "EvenPeriods", "ProrateDays", "ExactDays", "FlexibileProrateDays", "FlexibileExactDays", "CashReceipt" ], "type": "string", "description": "Recognition method > The method used to distribute the document amount over the periods." }, "codeType": { "enum": [ "Income", "Expense" ], "type": "string", "description": "Code type > The type of the deferral code." }, "deferralAccount": { "$ref": "#/components/schemas/deferralAccountInDeferralCodeDto" }, "deferralSub": { "$ref": "#/components/schemas/deferralSubInDeferralCodeDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "DeferralCodeQueryParameters": { "type": "object", "properties": { "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "expenseAccountInDepartmentDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The table > Expense account > The expense account to be used for recording department-related expenses." }, "expenseSubaccountInDepartmentDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The table > Expense sub. > The subaccount to be used for recording department related expenses." }, "DepartmentDto": { "type": "object", "properties": { "departmentId": { "type": "string", "description": "Mandatory field : The table > Department ID* > The unique identifier for the department." }, "publicId": { "type": "string", "description": "Identifies the Department by its publicId", "format": "uuid" }, "description": { "type": "string", "description": "The table > Description > A detailed description of the department." }, "expenseAccount": { "$ref": "#/components/schemas/expenseAccountInDepartmentDto" }, "expenseSubaccount": { "$ref": "#/components/schemas/expenseSubaccountInDepartmentDto" }, "lastModifiedDateTime": { "type": "string", "description": "A system generated date/time that indicates the last change for the department.", "format": "date-time" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" } } }, "DepartmentUpdateBaseDto": { "type": "object", "properties": { "departmentId": { "type": "string" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } } } }, "DepartmentQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "Greater-than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." } } }, "DimensionQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "Greater-than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords. ///", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "expandSegmentsValues": { "type": "boolean", "description": "Flag can be used to return data without the segment values." } } }, "DtoSegmentValue": { "type": "object", "properties": { "internalId": { "type": "string", "description": "Unique identifier for the segment value", "format": "uuid" }, "segmentId": { "type": "integer", "description": "The top part > Segment ID > The system-generated number representing the order of the segment in the segmented key.", "format": "int32" }, "valueId": { "type": "string", "description": "The table > Value > The string that is the value of the selected segment." }, "description": { "type": "string", "description": "The table > Description > The user-defined segment description." }, "publicId": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "active": { "type": "boolean", "description": "The table > Active > A check box that indicates (if selected) that the value is active." }, "timeStamp": { "type": "string" }, "lastModified": { "type": "string", "format": "date-time" }, "mappedSegValue": { "type": "string" } } }, "DtoSegment": { "type": "object", "properties": { "internalId": { "type": "string", "description": "Unique identifier for the segment.", "format": "uuid" }, "segmentId": { "type": "integer", "description": "Segment ID > The system-generated number representing the order of the segment in the segmented key.", "format": "int32" }, "description": { "type": "string", "description": "Mandatory field: Description > The user-defined segment description." }, "length": { "type": "integer", "description": "Length > The maximum length of the segment.", "format": "int32" }, "publicId": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "timeStamp": { "type": "string" }, "lastModified": { "type": "string", "description": "System generated information.", "format": "date-time" }, "validate": { "type": "boolean", "description": "Validate > A check box that indicates (if selected) that validation of segment values is turned on." }, "segmentValues": { "type": "array", "items": { "$ref": "#/components/schemas/DtoSegmentValue" }, "description": "The table >" }, "isAutoNumber": { "type": "boolean", "description": "Select segment and click View segment > Auto number > A check box that indicates (if selected) that the number series selected in the Number series ID field will be used to generate values for this segment in IDs." }, "consolNumChar": { "type": "integer", "description": "Select segment and click View segment > Number of characters > The length (in characters) of the string in the parent's subaccount to which the segment value is mapped; this column is displayed for only the SUBACCOUNT key.", "format": "int32" }, "consolOrder": { "type": "integer", "description": "Select segment and click View segment > Consol. order > The number that represents the order of this string among other strings in the parent company's subaccount; this column is displayed for only the SUBACCOUNT key.", "format": "int32" } } }, "DtoDimension": { "type": "object", "properties": { "id": { "type": "string", "description": "Mandatory field: The top part > Segment key ID* > The ID of the segmented key. ACCGROUP, ACCOUNT, BIZACCT, CASHACCOUNT, CONTRACT, CONTRACTITEM, CUSTOMER, EMPLOYEE, INLOCATION, INSITE, INSUBITEM, INVENTORY, LOCATION, MLISTCD, PROJECT, PROTASK, SALESPER, SUBACCOUNT, TMCONTRACT, SUPLLIER" }, "length": { "type": "integer", "description": "The top part > Length > The total length of the key.", "format": "int32" }, "description": { "type": "string", "description": "Mandatory field: The top part > Description* > A detailed description of the segmented key." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/DtoSegment" }, "description": "The table >" } } }, "DtoSegmentValueUpdateDtoBase": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "value": { "type": "string" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "active": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "DtoSegmentUpdateDto": { "type": "object", "properties": { "segmentValues": { "type": "array", "items": { "$ref": "#/components/schemas/DtoSegmentValueUpdateDtoBase" } }, "dimensionId": { "type": "string" }, "segementId": { "type": "integer", "format": "int32" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "DiscountQueryParameters": { "type": "object", "properties": { "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string", "description": "System retrieved information for state/condition." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "discountCode": { "type": "string" }, "series": { "type": "string" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "DiscountBranchDto": { "type": "object", "properties": { "branch": { "type": "string" } } }, "DiscountItemPriceClassDto": { "type": "object", "properties": { "priceClassId": { "type": "string" } } }, "DiscountCustomerPriceClassDto": { "type": "object", "properties": { "priceClassId": { "type": "string" } } }, "DiscountWarehouseDto": { "type": "object", "properties": { "warehouse": { "type": "string" } } }, "DiscountItemDto": { "type": "object", "properties": { "itemId": { "type": "string" } } }, "DiscountCustomer2Dto": { "type": "object", "properties": { "customer": { "type": "string" } } }, "DiscountBreakpointDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "format": "int32" }, "active": { "type": "boolean", "description": "The top part > Active > A check box that indicates (if selected) that the series is active." }, "breakAmount": { "type": "number", "description": "Discount breakpoints tab > Break amount > The line amount (break point) that starts the new range for the currently effective series.", "format": "double" }, "amountTo": { "type": "number", "format": "double" }, "lastBreakAmount": { "type": "number", "description": "Discount breakpoints tab > Last break amount > The amount (break point) that started the new range for the previously effective series (the one that was used before the effective date).", "format": "double" }, "lastAmountTo": { "type": "number", "format": "double" }, "pendingBreakAmount": { "type": "number", "description": "Discount breakpoints tab > Pending break amount > The amount (break point) that starts the new range for the pending series (one that is not yet in effect).", "format": "double" }, "breakQuantity": { "type": "number", "description": "Discount breakpoints tab > Break quantity > The quantity of items (break quantity) that starts the new range for a discount level for the currently effective series. Any break quantity should be specified in the base units.", "format": "double" }, "quantityTo": { "type": "number", "format": "double" }, "lastBreakQuantity": { "type": "number", "description": "Discount breakpoints tab > Last break quantity > The quantity of item (break point) that started the range for the discount series used before the effective date.", "format": "double" }, "lastQuantityTo": { "type": "number", "format": "double" }, "pendingBreakQuantity": { "type": "number", "description": "Discount breakpoints tab > Pending break quantity > The quantity of items (break point) that starts the new range for the pending (not yet effective) series.", "format": "double" }, "discountAmount": { "type": "number", "description": "Discount breakpoints tab > Discount amount > The discount amount to be used for the quantities that exceed this break quantity if the Amount option is selected as Discount by.", "format": "double" }, "discountPercent": { "type": "number", "description": "Discount breakpoints tab > Discount percent > The discount percent to be currently used for the quantities that exceed this break quantity if the Percent option is selected as Discount by.", "format": "double" }, "lastDiscountAmount": { "type": "number", "description": "Discount breakpoints tab > Last discount amount > The amount used as the discount for the discount series that was in effect before the effective date.", "format": "double" }, "lastDiscountPercent": { "type": "number", "description": "Discount breakpoints tab > Last discount percent > The percentage used for the break point in the previously effective series.", "format": "double" }, "lastDiscount": { "type": "number", "description": "Discount breakpoints tab > Last discount amount > The amount used as the discount for the discount series that was in effect before the effective date.", "format": "double" }, "pendingDiscountAmount": { "type": "number", "description": "Discount breakpoints tab > Pending discount amount > The amount to be used as the discount for the pending series if the Amount option is selected as Discount by.", "format": "double" }, "pendingDiscountPercent": { "type": "number", "description": "Discount breakpoints tab > Pending discount percent > The discount percent to be used for the break point in the pending series.", "format": "double" }, "freeItemQty": { "type": "number", "description": "Discount breakpoints tab > Free item qty. > The quantity of the free item to be added as the discount to orders for this discount series.", "format": "double" }, "lastFreeItemQty": { "type": "number", "description": "Discount breakpoints tab > Last free item qty. > The quantity of the free item that was used as the discount for the previously effective series.", "format": "double" }, "pendingFreeItemQty": { "type": "number", "description": "Discount breakpoints tab > Pending free item qty. > The quantity of the free item to be added as the discount to orders for the pending discount series.", "format": "double" }, "pendingDate": { "type": "string", "format": "date-time" }, "effectiveDate": { "type": "string", "format": "date-time" } } }, "DiscountDto": { "type": "object", "properties": { "discountCode": { "type": "string", "description": "Mandatory field: The top part > Discount code > The code of the discount for which you want to create a new series or view an existing one." }, "series": { "type": "string", "description": "Mandatory field: The top part > Series > The ID of the series defined for the discount." }, "description": { "type": "string", "description": "The top part > Description > A brief description of the series." }, "discountBy": { "type": "string", "description": "The top part > Discount by > The way the discount for the series is specified. Percent, Amount, Free item." }, "breakBy": { "type": "string", "description": "The top part > Break by > The way the breakpoints for this discount series are specified. Quantity, Amount." }, "promotional": { "type": "boolean", "description": "The top part > Promotional > A check box that indicates (if selected) that the series is a promotional discount." }, "active": { "type": "boolean", "description": "The top part > Active > A check box that indicates (if selected) that the series is active." }, "prorateDiscount": { "type": "boolean", "description": "The top part > Prorate discount > A check box that indicates (if selected) that the discount can be prorated." }, "effectiveDate": { "type": "string", "description": "The top part > Effective date > The date when the series becomes effective; this field appears for promotional discount series only.", "format": "date-time" }, "expirationDate": { "type": "string", "description": "The top part > Expiration date > The date when the promotional discount expires. This field appears for the series if the Promotional check box is selected.", "format": "date-time" }, "lastUpdateDate": { "type": "string", "description": "The top part > Last update date > A read-only field that shows the date when the discount series was last updated.", "format": "date-time" }, "freeItem": { "type": "integer", "description": "Free item tab > Free item > The free item (by its item ID) that is added to orders as the discount for this series.", "format": "int32" }, "pendingFreeItem": { "type": "integer", "description": "Free item tab > Pending free item > The free item (by its item ID) that will be added to orders as the discount for this series, starting on the date specified in the Pending date column on the Discount breakpoints tab.", "format": "int32" }, "lastFreeItem": { "type": "integer", "description": "Free item tab > Last free item > The free item (by its item ID) that had been added to orders as the discount for this series before the date shown in the Last date column on the Discount breakpoints tab.", "format": "int32" }, "lineCntr": { "type": "integer", "description": "Free item tab > A line counter for the table.", "format": "int32" }, "createdDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "description": "Free item tab > Last update date > A read-only field that shows the date when this discount series has been updated last.", "format": "date-time" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "discountBreakpoints": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountBreakpointDto" } }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountCustomer2Dto" }, "description": "Customers tab > Customer > The customer to which the series is applicable." }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountItemDto" }, "description": "Items tab > Items ID > The stock or non-stock item, by its item ID, to which the series can be applied." }, "warehouses": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountWarehouseDto" }, "description": "Warehouses tab > Warehouse ID > The warehouse to which the series can be applied." }, "customerPriceClasses": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountCustomerPriceClassDto" }, "description": "Customer price classes tab > Customer price class ID > The customer price class to which the series is applicable." }, "itemPriceClasses": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountItemPriceClassDto" }, "description": "Item price classes tab > Price class ID > The item price class to which the series is applicable." }, "branches": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountBranchDto" }, "description": "Branches tab > Branch > The branch to which the series can be applied." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "BasePaginationDtoOfDiscountDto": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountDto" } } } }, "DiscountBreakpointUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "pendingBreakAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "pendingDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "pendingDiscountPercent": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "pendingDiscountAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "pendingBreakQuantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "breakAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" } } }, "DiscountUpdateDto": { "type": "object", "properties": { "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "series": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "discountBy": { "$ref": "#/components/schemas/DtoValueOfString" }, "breakBy": { "$ref": "#/components/schemas/DtoValueOfString" }, "promotional": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "active": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "prorateDiscount": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "effectiveDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "discountBreakpoints": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountBreakpointUpdateDto" } } } }, "UpdateDiscountsActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "DiscountCodeQueryParameters": { "type": "object", "properties": { "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string", "description": "System retrieved information for state/condition." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "discountCode": { "type": "string" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "DiscountCodeDto": { "type": "object", "properties": { "discountCode": { "type": "string" }, "description": { "type": "string" }, "discountType": { "type": "string", "description": "DiscountType: L - Line, G - Group, D - Document" }, "applicableTo": { "type": "string", "description": "Mandatory field: Discount codes table > Applicable to > The entity to which the discount may be applied.\r\nApplicable To values: \r\nCU - Customer,\r\nCI - Customer and Item,\r\nCP - Customer and Item Price Class,\r\nCE - Customer Price Class,\r\nPI - Customer Price Class and Item,\r\nPP - Customer Price Class and Item Price Class,\r\nCB - Customer and Branch,\r\nPB - Customer Price Class and Branch,\r\nWH - Warehouse,\r\nWI - Warehouse and Item,\r\nWC - Warehouse and Customer,\r\nWP - Warehouse and Item Price Class,\r\nWE - Warehouse and Customer Price Class,\r\nBR - Branch,\r\nIN - Item,\r\nIE - Item Price Class,\r\nUN - Unconditional" }, "applyToDeferredRevenue": { "type": "boolean", "description": "Discount codes table > Apply to deferred revenue > A check box that (if selected) indicates that a discount should be applied to a component price while computing a deferred revenue for the component." }, "manual": { "type": "boolean", "description": "Discount codes table > Manual > A check box that (if selected) indicates that this discount is excluded from automatic searches for the best available discount." }, "excludeFromDiscountableAmount": { "type": "boolean", "description": "Discount codes table > Exclude from discountable amount > A check box that (if selected) indicates that the line amount is excluded from the amount that is the base for any applicable Group or Document discount." }, "skipDocumentDiscounts": { "type": "boolean", "description": "Discount codes table > Skip document discounts > A check box that indicates (if selected) that after this discount has been applied, no other applicable discounts should be applied." }, "autoNumbering": { "type": "boolean", "description": "Discount codes table > Auto numbering > A check box that you select to use auto-numbering for generating IDs for series based on this discount code." }, "lastNumber": { "type": "string", "description": "Discount codes table > Last number > The last ID used for the series if series IDs are auto-numbered." }, "createdDateTime": { "type": "string", "description": "System generated value.", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "description": "System generated value.", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "BasePaginationDtoOfDiscountCodeDto": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountCodeDto" } } } }, "EarningTypeDto": { "type": "object", "properties": { "code": { "type": "string", "description": "Mandatory field: Code* > The unique ID of the type of hour." }, "description": { "type": "string", "description": "Mandatory field: Description > The brief description of the type of hour." }, "isOvertime": { "type": "boolean", "description": "Overtime > A check box that indicates (if selected) that the type of hour is treated as overtime." }, "isBillable": { "type": "boolean", "description": "Invoicable > A check box that indicates (if selected) that the type is treated as invoiceable by default." }, "isActive": { "type": "boolean", "description": "Active > A check box that indicates (if selected) that the type of hour is active and can be used." }, "overtimeMultiplier": { "type": "number", "description": "Multiplier > The value by which the employee cost for this type of hour is multiplied when the time activity is released.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" } } }, "EarningTypeQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "Greater-than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." } } }, "EmployeeContactDto": { "type": "object", "properties": { "employeeContact": { "type": "string", "description": "Employee contact > The link to the contact record associated with the employee." }, "title": { "enum": [ "Doctor", "Miss", "Mr", "Mrs", "Ms", "Prof" ], "type": "string", "description": "Title > The courtesy title to be used for the employee." }, "firstName": { "type": "string", "description": "First name > The first name of the employee." }, "midName": { "type": "string", "description": "Middle name > The middle name of the employee." }, "lastName": { "type": "string", "description": "Mandatory field: Last name* > The last name of the employee." }, "phone3": { "type": "string", "description": "Phone 3 > An additional phone number of the employee." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } } }, "contactInEmployeeDto": { "properties": { "employeeContact": { "type": "string", "description": "Employee contact > The link to the contact record associated with the employee." }, "title": { "enum": [ "Doctor", "Miss", "Mr", "Mrs", "Ms", "Prof" ], "type": "string", "description": "Title > The courtesy title to be used for the employee." }, "firstName": { "type": "string", "description": "First name > The first name of the employee." }, "midName": { "type": "string", "description": "Middle name > The middle name of the employee." }, "lastName": { "type": "string", "description": "Mandatory field: Last name* > The last name of the employee." }, "phone3": { "type": "string", "description": "Phone 3 > An additional phone number of the employee." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "General information tab > Contact section >" }, "addressInEmployeeDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "General information tab > Address info section >" }, "employeeClassInEmployeeDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Additional information about Employee User\r\n///" }, "EmployeeDto": { "type": "object", "properties": { "employeeUserId": { "type": "string", "description": "Employee internal user ID. This is the ID of the user linked to the employee", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "employeeId": { "type": "integer", "description": "Mandatory field: The top part > Employee ID* > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEE segmented key.", "format": "int32" }, "employeeNumber": { "type": "string", "description": "General information tab > Employee settings section > Employee ref. no. > A reference number for the employee." }, "employeeName": { "type": "string", "description": "The top part > Employee name > The name of this employee." }, "status": { "enum": [ "Active", "OnHold", "HoldPayments", "Inactive", "OneTime" ], "type": "string", "description": "Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time." }, "department": { "type": "string", "description": "Mandatory field: General information tab > Employee section > Department* > The department the employee works for." }, "contact": { "$ref": "#/components/schemas/contactInEmployeeDto" }, "address": { "$ref": "#/components/schemas/addressInEmployeeDto" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "employeeClass": { "$ref": "#/components/schemas/employeeClassInEmployeeDto" }, "branch": { "$ref": "#/components/schemas/BranchNumberDto" }, "calendarID": { "type": "string" }, "employeeLogin": { "type": "string" }, "workGroupDescription": { "type": "array", "items": { "type": "string" } }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents an Employee in EmployeeController. Used for getting data." }, "CompanyTreeInfoDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "active": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "owner": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "workGroupID": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "EmployeeContactUpdateDto": { "required": [ "lastName", "email" ], "type": "object", "properties": { "firstName": { "$ref": "#/components/schemas/DtoValueOfString" }, "lastName": { "$ref": "#/components/schemas/DtoValueOfString" }, "middleName": { "$ref": "#/components/schemas/DtoValueOfString" }, "email": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone1": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone2": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone3": { "$ref": "#/components/schemas/DtoValueOfString" }, "fax": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "DtoValueOfNullableOfEmployeeStatus": { "type": "object", "properties": { "value": { "enum": [ "Active", "Hold", "HoldPayments", "Inactive", "OneTime" ], "type": "string" } } }, "statusInEmployeeUpdateDto": { "properties": { "value": { "enum": [ "Active", "Hold", "HoldPayments", "Inactive", "OneTime" ], "type": "string" } }, "description": "Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time." }, "departmentInEmployeeUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field: General information tab > Employee section > Department* > The department the employee works for." }, "contactInEmployeeUpdateDto": { "properties": { "firstName": { "$ref": "#/components/schemas/DtoValueOfString" }, "lastName": { "$ref": "#/components/schemas/DtoValueOfString" }, "middleName": { "$ref": "#/components/schemas/DtoValueOfString" }, "email": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone1": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone2": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone3": { "$ref": "#/components/schemas/DtoValueOfString" }, "fax": { "$ref": "#/components/schemas/DtoValueOfString" } }, "description": "General information tab > Contact section >" }, "addressInEmployeeUpdateDto": { "properties": { "addressLine1": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine2": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine3": { "$ref": "#/components/schemas/DtoValueOfString" }, "postalCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "city": { "$ref": "#/components/schemas/DtoValueOfString" }, "countryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "county": { "$ref": "#/components/schemas/DtoValueOfString" } }, "description": "General information tab > Address info section >" }, "EmployeeUpdateDto": { "required": [ "contact" ], "type": "object", "properties": { "employeeClass": { "$ref": "#/components/schemas/DtoValueOfString" }, "status": { "$ref": "#/components/schemas/statusInEmployeeUpdateDto" }, "department": { "$ref": "#/components/schemas/departmentInEmployeeUpdateDto" }, "contact": { "$ref": "#/components/schemas/contactInEmployeeUpdateDto" }, "address": { "$ref": "#/components/schemas/addressInEmployeeUpdateDto" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "calendar": { "$ref": "#/components/schemas/DtoValueOfString" }, "companyTreeInfo": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTreeInfoDto" } } } }, "EmployeeQueryParameters": { "type": "object", "properties": { "linkedToUser": { "type": "boolean", "description": "If the employee is linked to a user." }, "greaterThanValue": { "type": "string", "description": "Greater-than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "statusInEmployeeCreateDTO": { "properties": { "value": { "enum": [ "Active", "Hold", "HoldPayments", "Inactive", "OneTime" ], "type": "string" } }, "description": "Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time." }, "EmployeeCreateDTO": { "required": [ "employeeCd", "department", "employeeClass", "branch", "calendar", "contact" ], "type": "object", "properties": { "employeeCd": { "$ref": "#/components/schemas/DtoValueOfString" }, "department": { "$ref": "#/components/schemas/DtoValueOfString" }, "employeeClass": { "$ref": "#/components/schemas/DtoValueOfString" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "calendar": { "$ref": "#/components/schemas/DtoValueOfString" }, "contact": { "$ref": "#/components/schemas/EmployeeContactUpdateDto" }, "address": { "$ref": "#/components/schemas/AddressUpdateDto" }, "status": { "$ref": "#/components/schemas/statusInEmployeeCreateDTO" } } }, "EmployeeTimeCardQueryParameters": { "type": "object", "properties": { "status": { "enum": [ "Hold", "Open", "Approved", "Rejected", "Released" ], "type": "string", "description": "The status of the document." }, "week": { "type": "string", "description": "Identifies the week number of the time card" }, "type": { "enum": [ "Normal", "Correction", "NormalCorrected" ], "type": "string", "description": "Identifies the type of the time card (Normal, Corrected, NormalCorrected)" }, "greaterThanValue": { "type": "string", "description": "Greater-than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "employeeCd": { "type": "string" } } }, "projectInTimeCardMaterialsDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Project* > The project that the employee worked on." }, "projectTaskInTimeCardMaterialsDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project task > The project task that the employee worked on." }, "TimeCardMaterialsDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "The time card line number", "format": "int32" }, "itemId": { "type": "string", "description": "Item Id" }, "description": { "type": "string", "description": "Description > The description of the reported quantity." }, "uoM": { "type": "string", "description": "The unit of measure of item" }, "project": { "$ref": "#/components/schemas/projectInTimeCardMaterialsDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInTimeCardMaterialsDto" }, "mon": { "type": "number", "description": "Mon > The quantity reported for Monday.", "format": "double" }, "tue": { "type": "number", "description": "Tue > The quantity reported for Tuesday.", "format": "double" }, "wed": { "type": "number", "description": "Wed > The quantity reported for Wednesday.", "format": "double" }, "thu": { "type": "number", "description": "Thu > The quantity reported for Thursday.", "format": "double" }, "fri": { "type": "number", "description": "Fri > The quantity reported for Friday.", "format": "double" }, "sat": { "type": "number", "description": "Sat > The quantity reported for Saturday.", "format": "double" }, "sun": { "type": "number", "description": "Sun > The quantity reported for Sunday.", "format": "double" }, "totalQty": { "type": "number", "description": "Total Qty", "format": "double" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" } } }, "earningTypeInTimeCardSummaryDto": { "properties": { "code": { "type": "string", "description": "Mandatory field: Code* > The unique ID of the type of hour." }, "description": { "type": "string", "description": "Mandatory field: Description > The brief description of the type of hour." }, "isOvertime": { "type": "boolean", "description": "Overtime > A check box that indicates (if selected) that the type of hour is treated as overtime." }, "isBillable": { "type": "boolean", "description": "Invoicable > A check box that indicates (if selected) that the type is treated as invoiceable by default." }, "isActive": { "type": "boolean", "description": "Active > A check box that indicates (if selected) that the type of hour is active and can be used." }, "overtimeMultiplier": { "type": "number", "description": "Multiplier > The value by which the employee cost for this type of hour is multiplied when the time activity is released.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" } }, "description": "Earning type > The type of the work time spent by the employee" }, "projectInTimeCardSummaryDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Project* > The project that the employee worked on." }, "projectTaskInTimeCardSummaryDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project task > The project task that the employee worked on." }, "TimeCardSummaryDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "The time card line number", "format": "int32" }, "lineId": { "type": "string", "description": "The time card line id", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "earningType": { "$ref": "#/components/schemas/earningTypeInTimeCardSummaryDto" }, "project": { "$ref": "#/components/schemas/projectInTimeCardSummaryDto" }, "mon": { "type": "integer", "description": "Mon > The work time reported for Monday, including overtime.", "format": "int32" }, "tue": { "type": "integer", "description": "Tue > The work time reported for Tuesday, including overtime.", "format": "int32" }, "wed": { "type": "integer", "description": "Wed > The work time reported for Wednesday, including overtime.", "format": "int32" }, "thu": { "type": "integer", "description": "Thu > The work time reported for Thursday, including overtime.", "format": "int32" }, "fri": { "type": "integer", "description": "Fri > The work time reported for Friday, including overtime.", "format": "int32" }, "sat": { "type": "integer", "description": "Sat > The work time reported for Saturday, including overtime.", "format": "int32" }, "sun": { "type": "integer", "description": "Sun > The work time reported for Sunday, including overtime.", "format": "int32" }, "invoiceable": { "type": "boolean", "description": "Invoicable > A check box that you select to indicate that these work hours are invoiceable." }, "projectTask": { "$ref": "#/components/schemas/projectTaskInTimeCardSummaryDto" }, "timeSpent": { "type": "integer", "description": "Time spent > The work time (regular and overtime) that the employee spent on the project and task during the week.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the reported work hours." }, "approvalStatus": { "enum": [ "New", "Canceled", "SentToApproval", "ReceivedByApproval", "InProgressApproval", "RejectedInApproval", "ApprovedInApproval", "ActiveWorkflowApproval" ], "type": "string", "description": "Approval status > The approval status, which indicates whether the summary row requires approval and, if it does, what the current state of approval is." }, "approver": { "type": "string", "description": "The identifier of the person authorized to approve the activity, if approval is required. This is either the approver of the project task or, if no approver is assigned to the project task, the project manager." }, "approvalStatusText": { "type": "string", "description": "last approval comment > The approval status text suitable for display" }, "lastModifiedDateTime": { "type": "string", "description": "The last time the time card line was modified", "format": "date-time" } } }, "WeekNumberDescriptionDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "weekInTimeCardDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The top part > Week > The week for which the time card has been created." }, "employeeInTimeCardDto": { "properties": { "internalId": { "type": "string" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "The top part > Employee > The name of the employee whose time card is currently open." }, "TimeCardDto": { "type": "object", "properties": { "refNbr": { "type": "string", "description": "The top part > Ref. no. > The unique reference number of the time card, which Acumatica ERP automatically assigns according to the numbering sequence specified as the Time Card Numbering Sequence on the Time and Expenses Preferences (EP.10.10.00) form." }, "status": { "enum": [ "Hold", "Open", "Approved", "Rejected", "Released" ], "type": "string", "description": "The top part > Status > The status of the time card" }, "approvalStatus": { "enum": [ "New", "Canceled", "SentToApproval", "ReceivedByApproval", "InProgressApproval", "RejectedInApproval", "ApprovedInApproval", "ActiveWorkflowApproval" ], "type": "string", "description": "The top part > Approval status > The approval status of the time card" }, "week": { "$ref": "#/components/schemas/weekInTimeCardDto" }, "employee": { "$ref": "#/components/schemas/employeeInTimeCardDto" }, "type": { "enum": [ "Normal", "Correction", "NormalCorrected" ], "type": "string", "description": "The top part > Type > The type of the time card. The following options are available:• Normal: Regular time card• Correction: Corrective time card, which is a time card that updates a released time card" }, "origRefNbr": { "type": "string", "description": "The top part > Orig. ref. no. > The reference number of the time card being corrected. This box is filled in only when Correction is specified in the Type box" }, "timeSpent": { "type": "integer", "description": "The top part > Regular column: Time spent > The work hours spent by the employee during the week on activities with the Regular Hours earning type.", "format": "int32" }, "invoiceable": { "type": "integer", "description": "The top part > Regular column: Invoicable > The invoiceable work hours spent by the employee during the week", "format": "int32" }, "overtimeSpent": { "type": "integer", "description": "The top part > Overtime column: Time spent > The work hours spent by the employee during the week on activities with the Overtime earning type.", "format": "int32" }, "invoiceableOvertime": { "type": "integer", "description": "The top part > Overtime column: Invoicable > The invoiceable overtime spent by the employee during the week", "format": "int32" }, "totalTimeSpent": { "type": "integer", "description": "The top part > Total column: Time spent > The total working time (regular and overtime) for the week", "format": "int32" }, "invoiceableTotalTime": { "type": "integer", "description": "The top part > Total column: Invoicable > The total invoiceable working time (regular and overtime) for the week", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information: The last time the time card line was modified", "format": "date-time" }, "summary": { "type": "array", "items": { "$ref": "#/components/schemas/TimeCardSummaryDto" }, "description": "Summary tab > Time Card summary information" }, "materials": { "type": "array", "items": { "$ref": "#/components/schemas/TimeCardMaterialsDto" }, "description": "Summary tab > Time Card materials information" }, "approvalStatusText": { "type": "string" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "ExpenseClaimQueryParameters": { "type": "object", "properties": { "status": { "enum": [ "Hold", "PendingApproval", "Approved", "Rejected", "Released" ], "type": "string", "description": "The status of the document." }, "date": { "type": "string", "description": "The date of the document", "format": "date-time" }, "customer": { "type": "string", "description": "The customer from the document" }, "departmentId": { "type": "string", "description": "Identifies the department" }, "greaterThanValue": { "type": "string", "description": "Greater-than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "expenseItemInExpenseClaimDetailDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Expense item* > The expense identifier, if an expense of this type is listed as an inventory nonstock item." }, "projectInExpenseClaimDetailDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Project > The project or customer contract associated with the expense claim, if the work performed was for a project or contract. Project Task The task associated with the contract or project." }, "projectTaskInExpenseClaimDetailDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project task > The task associated with the contract or project." }, "expenseAccountInExpenseClaimDetailDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Expense account > The expense account to which the system should record the part of the expense to be paid back to the employee." }, "expenseSubaccountInExpenseClaimDetailDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "MAndatory field: Expense sub. > The corresponding subaccount the system uses to record the part of the expense to be paid back to the employee." }, "branchInExpenseClaimDetailDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Branch > The branch that will reimburse the expenses to the employee." }, "taxCategoryInExpenseClaimDetailDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "VAT category > The VAT category associated with the expense item." }, "salesAccountInExpenseClaimDetailDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Sales account > The sales account to which the system should record the part of the amount to charge the customer for. This is applicable only when a customer has been specified." }, "salesSubaccountInExpenseClaimDetailDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Sales sub. > The corresponding subaccount the system uses to record the amount to charge the customer for. This is applicable only when a customer has been specified." }, "customerInExpenseClaimDetailDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Customer > The identifier of the customer associated with the expense." }, "locationInExpenseClaimDetailDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Location > The identifier of the customer location associated with the expense." }, "ExpenseClaimDetailDto": { "type": "object", "properties": { "claimDetailId": { "type": "integer", "description": "Identifies the expense claim detail id, necessary when updating detail information", "format": "int32" }, "lineId": { "type": "string", "description": "The expense claim line id", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "date": { "type": "string", "description": "Mandatory field: Date > The date when the expense was incurred.", "format": "date-time" }, "expenseItem": { "$ref": "#/components/schemas/expenseItemInExpenseClaimDetailDto" }, "description": { "type": "string", "description": "Mandatory field: Description* > A description of the transaction." }, "quantity": { "type": "number", "description": "Quantity > The quantity of this expense item.", "format": "double" }, "uom": { "type": "string", "description": "Mandatory field: UoM > The unit of measure in which the quantity is shown." }, "unitCost": { "type": "number", "description": "Unit cost > The cost of a unit of the item.", "format": "double" }, "currency": { "type": "string", "description": "Currency > The currency of the expense receipt. However, if you enter a claim line directly, the currency value is read-only and matching the claim currency." }, "totalAmount": { "type": "number", "description": "Amount > The total amount paid for the expense item in the specified quantity.", "format": "double" }, "invoiceable": { "type": "boolean", "description": "Invoicable > A check box that, if selected, indicates that the claim amount is invoiceable to the customer (the total amount minus the employee's part)." }, "claimAmount": { "type": "number", "description": "Claim amount > The amount claimed by the employee, which is calculated as the total claim amount minus the employee part.", "format": "double" }, "amountInClaimCurr": { "type": "number", "description": "Amount in claim currency > The amount claimed by the employee, which is expressed in the currency of the expense claim.", "format": "double" }, "project": { "$ref": "#/components/schemas/projectInExpenseClaimDetailDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInExpenseClaimDetailDto" }, "expenseAccount": { "$ref": "#/components/schemas/expenseAccountInExpenseClaimDetailDto" }, "expenseSubaccount": { "$ref": "#/components/schemas/expenseSubaccountInExpenseClaimDetailDto" }, "branch": { "$ref": "#/components/schemas/branchInExpenseClaimDetailDto" }, "taxCategory": { "$ref": "#/components/schemas/taxCategoryInExpenseClaimDetailDto" }, "refNbr": { "type": "string", "description": "Ref. no. > The identifier of the transaction." }, "salesAccount": { "$ref": "#/components/schemas/salesAccountInExpenseClaimDetailDto" }, "salesSubaccount": { "$ref": "#/components/schemas/salesSubaccountInExpenseClaimDetailDto" }, "employeePart": { "type": "number", "description": "Employee part > The part of the total amount that will not be paid back to the employee. The percentage depends on the company policy.", "format": "double" }, "customer": { "$ref": "#/components/schemas/customerInExpenseClaimDetailDto" }, "location": { "$ref": "#/components/schemas/locationInExpenseClaimDetailDto" }, "arReferenceNbr": { "type": "string", "description": "REef.no. customer > The reference number of the customer ledger document." }, "approvalStatus": { "enum": [ "New", "Canceled", "SentToApproval", "ReceivedByApproval", "InProgressApproval", "RejectedInApproval", "ApprovedInApproval", "ActiveWorkflowApproval" ], "type": "string", "description": "Approval status > The approval status, which indicates whether the detail row requires approval and, if it does, what the current state of approval is." }, "approvalStatusText": { "type": "string", "description": "Last approval comment > The approval status text suitable for display" }, "approver": { "type": "string", "description": "Pending approver > The identifier of the person authorized to approve the activity, if approval is required. This is either the approver of the project task or, if no approver is assigned to the project task, the project manager." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "Expense claim detail line attachtments" } } }, "DepartmentIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "claimedByInExpenseClaimDto": { "properties": { "internalId": { "type": "string" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: The top part > Claimed by > The employee who is claiming the expenses. If the claim is released, an Accounts Payable bill will be generated to this employee." }, "customerInExpenseClaimDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The applicable customer." }, "departmentInExpenseClaimDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part > Department ID > The department associated with the expense claim." }, "locationInExpenseClaimDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Location > The company location associated with the claim." }, "ExpenseClaimDto": { "type": "object", "properties": { "refNbr": { "type": "string", "description": "The top part > Ref. no. > The unique reference number of the expense claim document." }, "status": { "enum": [ "Hold", "PendingApproval", "Approved", "Rejected", "Released" ], "type": "string", "description": "The top part > Status > The current status of the expense claim: On Hold/Pending Approval/Approved/Rejected/Released." }, "approvalStatus": { "enum": [ "New", "Canceled", "SentToApproval", "ReceivedByApproval", "InProgressApproval", "RejectedInApproval", "ApprovedInApproval", "ActiveWorkflowApproval" ], "type": "string", "description": "The top part > Approval status > The status of the claim in Approval." }, "date": { "type": "string", "description": "Mandatory field: The top part > Date* > The date when the claim was entered.", "format": "date-time" }, "description": { "type": "string", "description": "Mandatory field: The top part > Description > A description of the claim." }, "claimedBy": { "$ref": "#/components/schemas/claimedByInExpenseClaimDto" }, "claimTotal": { "type": "number", "description": "The top part > Claim total > The total amount of the claim.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt total > The document total that is exempt from VAT.", "format": "double" }, "customer": { "$ref": "#/components/schemas/customerInExpenseClaimDto" }, "currency": { "type": "string", "description": "The top part > Currency > The currency of the claim." }, "approvalDate": { "type": "string", "description": "The top part > Approval date > The date when the claim was approved.", "format": "date-time" }, "department": { "$ref": "#/components/schemas/departmentInExpenseClaimDto" }, "location": { "$ref": "#/components/schemas/locationInExpenseClaimDto" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information: The lastest time the expense claim was modified", "format": "date-time" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseClaimDetailDto" }, "description": "Expence claim details tab >" }, "approvalStatusText": { "type": "string", "description": "The top part > Approval status > A text field." }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Expense Claim in ExpenseClaimController. Used for getting data." }, "ExpenseReceiptQueryParameters": { "type": "object", "properties": { "date": { "type": "string", "description": "The date of the document" }, "dateCondition": { "type": "string" }, "inventory": { "type": "string", "description": "Identifies the inventory item from the document" }, "project": { "type": "string", "description": "Identifies the project from the document" }, "claimedBy": { "type": "string", "description": "Identifies the employee from the document" }, "projectTask": { "type": "string", "description": "Filter on Task ID." }, "invoiceable": { "type": "boolean", "description": "If the document is invoiceable" }, "status": { "enum": [ "Open", "Pending", "Approved", "Rejected", "Released" ], "type": "string", "description": "The status of the document." }, "customer": { "type": "string", "description": "Identifies the customer from the document" } } }, "ExpenseClaimNumberDescriptionDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "CurrencyIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "currencyInExpenseReceiptDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Both tabs > Currency > The currency of the expense receipt." }, "claimedByInExpenseReceiptDto": { "properties": { "employeeUserId": { "type": "string", "description": "Employee internal user ID. This is the ID of the user linked to the employee", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "employeeId": { "type": "integer", "description": "Mandatory field: The top part > Employee ID* > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEE segmented key.", "format": "int32" }, "employeeNumber": { "type": "string", "description": "General information tab > Employee settings section > Employee ref. no. > A reference number for the employee." }, "employeeName": { "type": "string", "description": "The top part > Employee name > The name of this employee." }, "status": { "enum": [ "Active", "OnHold", "HoldPayments", "Inactive", "OneTime" ], "type": "string", "description": "Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time." }, "department": { "type": "string", "description": "Mandatory field: General information tab > Employee section > Department* > The department the employee works for." }, "contact": { "$ref": "#/components/schemas/contactInEmployeeDto" }, "address": { "$ref": "#/components/schemas/addressInEmployeeDto" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "employeeClass": { "$ref": "#/components/schemas/employeeClassInEmployeeDto" }, "branch": { "$ref": "#/components/schemas/BranchNumberDto" }, "calendarID": { "type": "string" }, "employeeLogin": { "type": "string" }, "workGroupDescription": { "type": "array", "items": { "type": "string" } }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: The top part > Claimed by* > \tThe name of the employee who is claiming the expenses." }, "branchInExpenseReceiptDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: The top part > Branch > The company branch that will incur the expenses." }, "expenseClaimInExpenseReceiptDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Receipt details tab > Expense details section > Expense claim > The expense claim with which the expense receipt is associated." }, "projectInExpenseReceiptDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Receipt details tab > Expense details section > Project/contract > The project or contract, which should be specified if the employee incurred the expenses while working on a particular project or contract." }, "projectTaskInExpenseReceiptDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Receipt details tab > Expense details section > Project task > The project task to which the expenses are related." }, "customerInExpenseReceiptDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Receipt details tab > Financial details section > Customer > The customer, which should be specified if the employee incurred the expenses while working for a particular customer." }, "locationInExpenseReceiptDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Receipt details tab > Financial details section > Location > The location of the customer related to the expenses." }, "expenseAccountInExpenseReceiptDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Receipt details tab > Financial details section > Expense account > The expense account to which the system records the part of the expense to be paid back to the employee." }, "expenseSubInExpenseReceiptDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Receipt details tab > Financial details section > Expense sub. > The corresponding subaccount the system uses to record the part of the expense to be paid back to the employee." }, "salesAccountInExpenseReceiptDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Receipt details tab > Financial details section > Sales account > The sales account to which the system records the part of the amount to charge the customer for." }, "salesSubInExpenseReceiptDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Receipt details tab > Financial details section > Sales sub. > The corresponding subaccount the system uses to record the amount to charge the customer for." }, "taxCategoryInExpenseReceiptDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Receipt details tab > Expense details section > VAT category > The tax category for the expense receipt." }, "imageInExpenseReceiptDto": { "properties": { "name": { "type": "string", "description": "The name of the attachment." }, "id": { "type": "string", "description": "The ID of the attachment", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "revision": { "type": "integer", "description": "The version of the attachment.", "format": "int32" } }, "description": "Receipt details tab > Image section" }, "ExpenseReceiptDto": { "type": "object", "properties": { "internalId": { "type": "integer", "format": "int32" }, "receiptId": { "type": "string", "description": "The top part > Employee > \tThe identifier of the employee whose expense receipts you want to manage." }, "date": { "type": "string", "description": "Both tabs > Date > The date of the expense receipt.", "format": "date-time" }, "taxTotal": { "type": "number", "description": "The top part > VAT total > The total amount of VAT or taxes calculated for the expense receipt.", "format": "double" }, "currency": { "$ref": "#/components/schemas/currencyInExpenseReceiptDto" }, "refNbr": { "type": "string", "description": "Both tabs > Ref. no. > The reference number, which usually matches the number of the original receipt." }, "inventory": { "$ref": "#/components/schemas/InventoryNumberDescriptionDto" }, "description": { "type": "string", "description": "Open the receipt\r\nMandatory field: Receipt details tab > Expense details section > Description* > The expense description, which is displayed as a link." }, "uom": { "type": "string", "description": "Receipt details tab > Expense details section > UoM > The unit of measure of the expense item." }, "quantity": { "type": "number", "description": "Receipt details tab > Expense details section > Quantity > The quantity of the expense item that the employee purchased according to the receipt.", "format": "double" }, "unitCost": { "type": "number", "description": "Receipt details tab > Expense details section > Unit cost > The cost of one unit of the expense item.", "format": "double" }, "totalAmount": { "type": "number", "description": "Receipt details tab > Expense details section > Amount > The total amount of the receipt (for VAT-inclusive taxes), or the total amount before taxes (for VAT-exclusive taxes).", "format": "double" }, "employeePart": { "type": "number", "description": "Receipt details tab > Expense details section > Employee part > The part of the total amount that will not be paid back to the employee.", "format": "double" }, "claimAmount": { "type": "number", "description": "Receipt details tab > Expense details section > Expense claim > The expense claim with which the expense receipt is associated.", "format": "double" }, "status": { "enum": [ "Open", "Pending", "Approved", "Rejected", "Released" ], "type": "string", "description": "Receipt details tab > Expense details section > Expense claim status > The current status of the associated expense claim, which can be one of the following options: On hold, Pending apporval, Approved, Rejected, Released." }, "claimedBy": { "$ref": "#/components/schemas/claimedByInExpenseReceiptDto" }, "branch": { "$ref": "#/components/schemas/branchInExpenseReceiptDto" }, "expenseClaim": { "$ref": "#/components/schemas/expenseClaimInExpenseReceiptDto" }, "invoiceable": { "type": "boolean", "description": "Receipt details tab > Financial details section > Invoiceable > A check box that indicates (if selected) that the customer should be invoiced for the claim amount." }, "project": { "$ref": "#/components/schemas/projectInExpenseReceiptDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInExpenseReceiptDto" }, "customer": { "$ref": "#/components/schemas/customerInExpenseReceiptDto" }, "location": { "$ref": "#/components/schemas/locationInExpenseReceiptDto" }, "expenseAccount": { "$ref": "#/components/schemas/expenseAccountInExpenseReceiptDto" }, "expenseSub": { "$ref": "#/components/schemas/expenseSubInExpenseReceiptDto" }, "salesAccount": { "$ref": "#/components/schemas/salesAccountInExpenseReceiptDto" }, "salesSub": { "$ref": "#/components/schemas/salesSubInExpenseReceiptDto" }, "taxCategory": { "$ref": "#/components/schemas/taxCategoryInExpenseReceiptDto" }, "image": { "$ref": "#/components/schemas/imageInExpenseReceiptDto" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" } }, "description": "This class represents a Expense Receipt in ExpenseReceiptController. Used by getting data." }, "ChangeEmployeeNrActionDto": { "type": "object", "properties": { "employeeNr": { "type": "string" } } }, "ChangeEmployeeNrActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "claimDetailIdInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "Identifies the expense claim detail line to update" }, "dateInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "The date when the expense was incurred." }, "expenseItemInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The expense identifier, if an expense of this type is listed as an inventory nonstock item." }, "descriptionInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A description of the transaction." }, "quantityInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The quantity of this expense item." }, "uomInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The unit of measure in which the quantity is shown." }, "unitCostInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The cost of a unit of the item." }, "invoiceableInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "The currency of the expense receipt. However, if you enter a claim line directly, the currency value is read-only and matching the claim currency." }, "projectInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The project or customer contract associated with the expense claim, if the work performed was for a project or contract. Project Task The task associated with the contract or project." }, "projectTaskInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The task associated with the contract or project." }, "expenseAccountInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The expense account to which the system should record the part of the expense to be paid back to the employee." }, "branchInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The branch that will reimburse the expenses to the employee." }, "taxCategoryInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The tax category associated with the expense item." }, "refNbrInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The identifier of the transaction." }, "employeePartInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The part of the total amount that will not be paid back to the employee. The percentage depends on the company policy." }, "customerInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The identifier of the customer associated with the expense." }, "locationInExpenseClaimDetailUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The identifier of the customer location associated with the expense." }, "ExpenseClaimDetailUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "claimDetailId": { "$ref": "#/components/schemas/claimDetailIdInExpenseClaimDetailUpdateDto" }, "date": { "$ref": "#/components/schemas/dateInExpenseClaimDetailUpdateDto" }, "expenseItem": { "$ref": "#/components/schemas/expenseItemInExpenseClaimDetailUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInExpenseClaimDetailUpdateDto" }, "quantity": { "$ref": "#/components/schemas/quantityInExpenseClaimDetailUpdateDto" }, "uom": { "$ref": "#/components/schemas/uomInExpenseClaimDetailUpdateDto" }, "unitCost": { "$ref": "#/components/schemas/unitCostInExpenseClaimDetailUpdateDto" }, "invoiceable": { "$ref": "#/components/schemas/invoiceableInExpenseClaimDetailUpdateDto" }, "project": { "$ref": "#/components/schemas/projectInExpenseClaimDetailUpdateDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInExpenseClaimDetailUpdateDto" }, "expenseAccount": { "$ref": "#/components/schemas/expenseAccountInExpenseClaimDetailUpdateDto" }, "expenseSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "The corresponding subaccount the system uses to record the part of the expense to be paid back to the employee." }, "branch": { "$ref": "#/components/schemas/branchInExpenseClaimDetailUpdateDto" }, "taxCategory": { "$ref": "#/components/schemas/taxCategoryInExpenseClaimDetailUpdateDto" }, "refNbr": { "$ref": "#/components/schemas/refNbrInExpenseClaimDetailUpdateDto" }, "employeePart": { "$ref": "#/components/schemas/employeePartInExpenseClaimDetailUpdateDto" }, "customer": { "$ref": "#/components/schemas/customerInExpenseClaimDetailUpdateDto" }, "location": { "$ref": "#/components/schemas/locationInExpenseClaimDetailUpdateDto" } } }, "dateInExpenseClaimUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "The date when the claim was entered." }, "descriptionInExpenseClaimUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A description of the claim." }, "claimedByInExpenseClaimUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The employee who is claiming the expenses. If the claim is released, an Accounts Payable bill will be generated to this employee." }, "customerInExpenseClaimUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The applicable customer." }, "locationInExpenseClaimUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The company location associated with the claim." }, "ExpenseClaimUpdateDto": { "type": "object", "properties": { "date": { "$ref": "#/components/schemas/dateInExpenseClaimUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInExpenseClaimUpdateDto" }, "claimedBy": { "$ref": "#/components/schemas/claimedByInExpenseClaimUpdateDto" }, "customer": { "$ref": "#/components/schemas/customerInExpenseClaimUpdateDto" }, "customerUpdateAnswer": { "enum": [ "SelectedCustomer", "AllLines", "Nothing" ], "type": "string", "description": "If the customer is updated the claim details customer information can be updated using the provided answer. By default 'SelectedCustomer' is selected." }, "location": { "$ref": "#/components/schemas/locationInExpenseClaimUpdateDto" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/ExpenseClaimDetailUpdateDto" }, "description": "Expense Claim detail information" } } }, "PutExpenseClaimOnHoldActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "SubmitExpenseClaimActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "SendExpenseClaimToApprovalActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "ExpenseReceiptUpdateDto": { "type": "object", "properties": { "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "refNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "inventory": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "unitCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "totalAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "employeePart": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "claimedBy": { "$ref": "#/components/schemas/DtoValueOfString" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseClaim": { "$ref": "#/components/schemas/DtoValueOfString" }, "invoiceable": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "project": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTask": { "$ref": "#/components/schemas/DtoValueOfString" }, "customer": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseSub": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesSub": { "$ref": "#/components/schemas/DtoValueOfString" }, "taxCategory": { "$ref": "#/components/schemas/DtoValueOfString" } }, "description": "This class represents a Expense Receipt in ExpenseReceiptController. Used to post data to server." }, "FinancialPeriodQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "Enter the year or year-period lower than the first period or year you want, format YYYY or YYYYPP" } } }, "FinancialPeriodDto": { "type": "object", "properties": { "year": { "type": "integer", "description": "Mandatory field: The top part > Financial year* > The financial year.", "format": "int32" }, "period": { "type": "string", "description": "The table > Period > The period no and the year." }, "startDate": { "type": "string", "description": "The table > Start date > The date when the financial period starts.", "format": "date-time" }, "endDate": { "type": "string", "description": "The table > End date > The date when the financial period ends.", "format": "date-time" }, "description": { "type": "string", "description": "The table > Description > The description of the financial period (such as the name of the month or the number of the quarter)." }, "active": { "type": "boolean", "description": "The table > Active > A check box that indicates (if selected) that the period can be used for posting transactions." }, "closedInSupplierLedger": { "type": "boolean", "description": "The table > Closed in Supplier ledger > A read-only check box that indicates (if selected) that the financial period is closed in the Supplier ledger workspace; if this check box is cleared, the period is active in the this workspace." }, "closedInCustomerLedger": { "type": "boolean", "description": "The table > Closed in Customer ledger > A read-only check box that indicates (if selected) that the financial period is closed in the Customer ledger workspace; if this check box is cleared, the period is active in this workspace." }, "closedInInventoryManagement": { "type": "boolean", "description": "The table > Closed in Inventory management > Inventory management\tA read-only check box that indicates (if selected) that the financial period is closed in the Inventory workspace; if this check box is cleared, the period is active in the workspace." }, "closedInGeneralLedger": { "type": "boolean", "description": "The table > Closed in General ledger > A read-only check box that indicates (if selected) that the financial period is closed in the General ledger workspace; if this check box is cleared, the period is active in the this workspace." }, "closedInCashManagement": { "type": "boolean", "description": "The table > Closed in Cash management > A read-only check box that indicates (if selected) that the financial period is closed in the Cash management; if this check box is cleared, the period is active in this workspace." }, "closedInFixedAssets": { "type": "boolean", "description": "The table > Closed in Fixed assets > A read-only check box that indicates (if selected) that the financial period is closed in the Fixed assets workspace; if this check box is cleared, the period is active in the this workspace." } }, "description": "This class represents a Financial Period in FinancialPeriodController. Used by getting data." }, "FirstTimeStartupDto": { "type": "object", "properties": { "financials": { "type": "boolean", "description": "FTS status for financials" }, "message": { "type": "string" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents an attribute in FirstTimeStartupController. Used for getting data." }, "BookDto": { "type": "object", "properties": { "bookID": { "type": "string", "description": "The book id of this fixed asset" }, "description": { "type": "string", "description": "The description of the book" } } }, "LeaseAndRentInfoDto": { "type": "object", "properties": { "lessorID": { "type": "string" }, "lessorName": { "type": "string" }, "leaseRentTerm": { "type": "integer", "format": "int32" }, "leaseNumber": { "type": "string" }, "rentAmount": { "type": "number", "format": "double" }, "retailCost": { "type": "number", "format": "double" }, "manufacturingYear": { "type": "string" } } }, "DisposalMethodDto": { "type": "object", "properties": { "description": { "type": "string", "description": "The description of the disposal method" } } }, "TypeDto": { "type": "object", "properties": { "assetTypeID": { "type": "string", "description": "The type id of this fixed asset" }, "description": { "type": "string", "description": "The type description" } } }, "PropertyTaxDto": { "type": "object", "properties": { "propertyTaxID": { "type": "string", "description": "The property tax group id of this fixed asset" }, "description": { "type": "string", "description": "The description of the property tax group of this fixed asset" } } }, "FixedAssetLocationDto": { "type": "object", "properties": { "departmentID": { "type": "string", "description": "The current department id of this fixed asset" }, "branchID": { "type": "string", "description": "The current branch id of this fixed asset" } } }, "bookInBookBalanceDto": { "properties": { "bookID": { "type": "string", "description": "The book id of this fixed asset" }, "description": { "type": "string", "description": "The description of the book" } }, "description": "The book details of this fixed asset" }, "BookBalanceDto": { "type": "object", "properties": { "acquisitionCost": { "type": "number", "description": "The acquisition cost of this fixed asset", "format": "double" }, "depreciationMethodID": { "type": "string", "description": "The depreciation method id of this fixed asset" }, "depreciationFromDate": { "type": "string", "description": "The date this asset is placed in service", "format": "date-time" }, "depreciationFromPeriod": { "type": "string", "description": "The first period this fixed asset will start/has started depreciating" }, "depreciationToPeriod": { "type": "string", "description": "The last period this fixed asset will depreciate/ was depreciated" }, "lastDepreciationPeriod": { "type": "string", "description": "The last period this asset has been depreciated" }, "salvageAmount": { "type": "number", "description": "The salvage amount of this fixed asset", "format": "double" }, "usefulLife": { "type": "number", "description": "The useful life of this fixed asset in years", "format": "double" }, "book": { "$ref": "#/components/schemas/bookInBookBalanceDto" } } }, "disposalMethodInDetailsDto": { "properties": { "description": { "type": "string", "description": "The description of the disposal method" } }, "description": "The disposal method details of this fixed asset" }, "leaseAndRentInfoInDetailsDto": { "properties": { "lessorID": { "type": "string" }, "lessorName": { "type": "string" }, "leaseRentTerm": { "type": "integer", "format": "int32" }, "leaseNumber": { "type": "string" }, "rentAmount": { "type": "number", "format": "double" }, "retailCost": { "type": "number", "format": "double" }, "manufacturingYear": { "type": "string" } }, "description": "The lease and rent infor for this fixed asset" }, "DetailsDto": { "type": "object", "properties": { "propertyType": { "enum": [ "Property", "GrantProperty", "Leased", "LeasedtoOthers", "Rented", "RentedtoOthers", "Credit" ], "type": "string", "description": "Type can be" }, "status": { "enum": [ "Active", "Disposed", "FullyDepreciated", "Hold", "Reversed", "Suspended" ], "type": "string", "description": "Status can be" }, "receiptDate": { "type": "string", "description": "The date of the receipt", "format": "date-time" }, "depreciateFromDate": { "type": "string", "description": "The date this asset is placed in service", "format": "date-time" }, "acquisitionCost": { "type": "number", "description": "The acquisition cost of this fixed asset", "format": "double" }, "salvageAmount": { "type": "number", "description": "The salvage amount of this fixed asset", "format": "double" }, "disposalDate": { "type": "string", "description": "The date of the disposal of this fixed asset", "format": "date-time" }, "disposalPeriodID": { "type": "string", "description": "The period of the disposal of this fixed asset" }, "disposalMethodID": { "type": "integer", "description": "The disposal method of this fixed asset", "format": "int32" }, "saleAmount": { "type": "number", "description": "The disposal amount of this fixed asset", "format": "double" }, "billNumber": { "type": "string", "description": "The bill number of the fixed asset invoice" }, "serialNumber": { "type": "string", "description": "The serial number of this fixed asset" }, "disposalMethod": { "$ref": "#/components/schemas/disposalMethodInDetailsDto" }, "leaseAndRentInfo": { "$ref": "#/components/schemas/leaseAndRentInfoInDetailsDto" } } }, "FixedAssetAccountsDto": { "type": "object", "properties": { "accountID": { "type": "string", "description": "The fixed asset account for this fixed asset" }, "subAccountID": { "type": "string", "description": "The sub account for this fixed asset" }, "accrualAccountID": { "type": "string", "description": "The accrual account for this fixed asset" }, "accrualSubAccountID": { "type": "string", "description": "The accrual sub account for this fixed asset" }, "accumulatedDepreciationAccountID": { "type": "string", "description": "The accumulated depreciation account for this fixed asset" }, "accumulatedDepreciationSubAccountID": { "type": "string", "description": "The accumulated depreciation sub for this fixed asset" }, "depreciatedExpenseAccountID": { "type": "string", "description": "The depreciation expense account for this fixed asset" }, "depreciatedExpenseSubAccountID": { "type": "string", "description": "The depreciation expense sub for this fixed asset" }, "disposalAccountID": { "type": "string", "description": "The proceeds account for this fixed asset" }, "disposalSubAccountID": { "type": "string", "description": "The proceeds sub for this fixed asset" }, "gainAccountID": { "type": "string", "description": "The gain account for this fixed asset" }, "gainSubAccountID": { "type": "string", "description": "The gain sub for this fixed asset" }, "lossAccountID": { "type": "string", "description": "The loss account for this fixed asset" }, "lossSubAccountID": { "type": "string", "description": "The loss sub for this fixed asset" }, "debitAccountID": { "type": "string", "description": "The debit account" }, "debitSubAccountID": { "type": "string", "description": "The debit sub account" }, "creditAccountID": { "type": "string", "description": "The credit account" }, "creditSubAccountID": { "type": "string", "description": "The credit sub account" } } }, "accountsInFixedAssetDto": { "properties": { "accountID": { "type": "string", "description": "The fixed asset account for this fixed asset" }, "subAccountID": { "type": "string", "description": "The sub account for this fixed asset" }, "accrualAccountID": { "type": "string", "description": "The accrual account for this fixed asset" }, "accrualSubAccountID": { "type": "string", "description": "The accrual sub account for this fixed asset" }, "accumulatedDepreciationAccountID": { "type": "string", "description": "The accumulated depreciation account for this fixed asset" }, "accumulatedDepreciationSubAccountID": { "type": "string", "description": "The accumulated depreciation sub for this fixed asset" }, "depreciatedExpenseAccountID": { "type": "string", "description": "The depreciation expense account for this fixed asset" }, "depreciatedExpenseSubAccountID": { "type": "string", "description": "The depreciation expense sub for this fixed asset" }, "disposalAccountID": { "type": "string", "description": "The proceeds account for this fixed asset" }, "disposalSubAccountID": { "type": "string", "description": "The proceeds sub for this fixed asset" }, "gainAccountID": { "type": "string", "description": "The gain account for this fixed asset" }, "gainSubAccountID": { "type": "string", "description": "The gain sub for this fixed asset" }, "lossAccountID": { "type": "string", "description": "The loss account for this fixed asset" }, "lossSubAccountID": { "type": "string", "description": "The loss sub for this fixed asset" }, "debitAccountID": { "type": "string", "description": "The debit account" }, "debitSubAccountID": { "type": "string", "description": "The debit sub account" }, "creditAccountID": { "type": "string", "description": "The credit account" }, "creditSubAccountID": { "type": "string", "description": "The credit sub account" } }, "description": "All accounts selected for this fixed asset" }, "detailsInFixedAssetDto": { "properties": { "propertyType": { "enum": [ "Property", "GrantProperty", "Leased", "LeasedtoOthers", "Rented", "RentedtoOthers", "Credit" ], "type": "string", "description": "Type can be" }, "status": { "enum": [ "Active", "Disposed", "FullyDepreciated", "Hold", "Reversed", "Suspended" ], "type": "string", "description": "Status can be" }, "receiptDate": { "type": "string", "description": "The date of the receipt", "format": "date-time" }, "depreciateFromDate": { "type": "string", "description": "The date this asset is placed in service", "format": "date-time" }, "acquisitionCost": { "type": "number", "description": "The acquisition cost of this fixed asset", "format": "double" }, "salvageAmount": { "type": "number", "description": "The salvage amount of this fixed asset", "format": "double" }, "disposalDate": { "type": "string", "description": "The date of the disposal of this fixed asset", "format": "date-time" }, "disposalPeriodID": { "type": "string", "description": "The period of the disposal of this fixed asset" }, "disposalMethodID": { "type": "integer", "description": "The disposal method of this fixed asset", "format": "int32" }, "saleAmount": { "type": "number", "description": "The disposal amount of this fixed asset", "format": "double" }, "billNumber": { "type": "string", "description": "The bill number of the fixed asset invoice" }, "serialNumber": { "type": "string", "description": "The serial number of this fixed asset" }, "disposalMethod": { "$ref": "#/components/schemas/disposalMethodInDetailsDto" }, "leaseAndRentInfo": { "$ref": "#/components/schemas/leaseAndRentInfoInDetailsDto" } }, "description": "The details of this fixed asset" }, "bookBalanceInFixedAssetDto": { "properties": { "acquisitionCost": { "type": "number", "description": "The acquisition cost of this fixed asset", "format": "double" }, "depreciationMethodID": { "type": "string", "description": "The depreciation method id of this fixed asset" }, "depreciationFromDate": { "type": "string", "description": "The date this asset is placed in service", "format": "date-time" }, "depreciationFromPeriod": { "type": "string", "description": "The first period this fixed asset will start/has started depreciating" }, "depreciationToPeriod": { "type": "string", "description": "The last period this fixed asset will depreciate/ was depreciated" }, "lastDepreciationPeriod": { "type": "string", "description": "The last period this asset has been depreciated" }, "salvageAmount": { "type": "number", "description": "The salvage amount of this fixed asset", "format": "double" }, "usefulLife": { "type": "number", "description": "The useful life of this fixed asset in years", "format": "double" }, "book": { "$ref": "#/components/schemas/bookInBookBalanceDto" } }, "description": "The book balance details for this fixed asset" }, "locationInFixedAssetDto": { "properties": { "departmentID": { "type": "string", "description": "The current department id of this fixed asset" }, "branchID": { "type": "string", "description": "The current branch id of this fixed asset" } }, "description": "The current location of this fixed asset" }, "propertyTaxInFixedAssetDto": { "properties": { "propertyTaxID": { "type": "string", "description": "The property tax group id of this fixed asset" }, "description": { "type": "string", "description": "The description of the property tax group of this fixed asset" } }, "description": "The property tax group this fixed asset is conntected to" }, "typeInFixedAssetDto": { "properties": { "assetTypeID": { "type": "string", "description": "The type id of this fixed asset" }, "description": { "type": "string", "description": "The type description" } }, "description": "The type of this fixed asset" }, "FixedAssetDto": { "type": "object", "properties": { "assetID": { "type": "string", "description": "The id that identifies this fixed asset" }, "recordType": { "type": "string", "description": "The type of the record. This value is 'A' for fixed assets" }, "parentAssetID": { "type": "string", "description": "The asset id of the parent of this fixed asset" }, "description": { "type": "string", "description": "The description of this fixed asset" }, "classID": { "type": "string", "description": "The class id of this fixed asset" }, "isTangible": { "type": "boolean", "description": "Indicates whether this fixed asset is tangible or not" }, "quantity": { "type": "number", "description": "The quantity of this fixed asset", "format": "double" }, "depreciable": { "type": "boolean", "description": "Indicates if this fixed asset can be depreciated or not" }, "usefulLife": { "type": "number", "description": "Useful life of this fixed asset in years", "format": "double" }, "accounts": { "$ref": "#/components/schemas/accountsInFixedAssetDto" }, "details": { "$ref": "#/components/schemas/detailsInFixedAssetDto" }, "bookBalance": { "$ref": "#/components/schemas/bookBalanceInFixedAssetDto" }, "location": { "$ref": "#/components/schemas/locationInFixedAssetDto" }, "propertyTax": { "$ref": "#/components/schemas/propertyTaxInFixedAssetDto" }, "type": { "$ref": "#/components/schemas/typeInFixedAssetDto" }, "lastModifiedDateTime": { "type": "string", "description": "A system generated date/time that indicates the last change for this fixed asset", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents an attribute in FixedAssetController. Used for getting data." }, "FixedAssetQueryParameters": { "type": "object", "properties": { "assetID": { "type": "string", "description": "Fixed Asset ID that identifies the asset." }, "classID": { "type": "string", "description": "View all fixed assets with this Fixed Asset Class ID." }, "status": { "enum": [ "Active", "Disposed", "FullyDepreciated", "Hold", "Reversed", "Suspended" ], "type": "string", "description": "View all fixed assets with this Status. Available statuses are: Active, Disposed, FullyDepriciated, Hold, Reversed, Suspended." }, "fromDate": { "type": "string", "description": "From 'Placed in service date' inclusive. Date format: YYYY-MM-DD.", "format": "date-time" }, "toDate": { "type": "string", "description": "To 'Placed in service date' inclusive. Date format: YYYY-MM-DD.", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "expandAccounts": { "type": "boolean", "description": "Set to True to include accounts and subaccounts. Default value is False" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "FixedAssetBookSettingsDto": { "type": "object", "properties": { "bookID": { "type": "string", "description": "The book id" }, "depreciationMethodID": { "type": "string", "description": "The depreciation method id" } } }, "bookSettingsInFixedAssetClassDto": { "properties": { "bookID": { "type": "string", "description": "The book id" }, "depreciationMethodID": { "type": "string", "description": "The depreciation method id" } }, "description": "Default book settings for the fixed asset using this fixed asset class" }, "accountsInFixedAssetClassDto": { "properties": { "accountID": { "type": "string", "description": "The fixed asset account for this fixed asset" }, "subAccountID": { "type": "string", "description": "The sub account for this fixed asset" }, "accrualAccountID": { "type": "string", "description": "The accrual account for this fixed asset" }, "accrualSubAccountID": { "type": "string", "description": "The accrual sub account for this fixed asset" }, "accumulatedDepreciationAccountID": { "type": "string", "description": "The accumulated depreciation account for this fixed asset" }, "accumulatedDepreciationSubAccountID": { "type": "string", "description": "The accumulated depreciation sub for this fixed asset" }, "depreciatedExpenseAccountID": { "type": "string", "description": "The depreciation expense account for this fixed asset" }, "depreciatedExpenseSubAccountID": { "type": "string", "description": "The depreciation expense sub for this fixed asset" }, "disposalAccountID": { "type": "string", "description": "The proceeds account for this fixed asset" }, "disposalSubAccountID": { "type": "string", "description": "The proceeds sub for this fixed asset" }, "gainAccountID": { "type": "string", "description": "The gain account for this fixed asset" }, "gainSubAccountID": { "type": "string", "description": "The gain sub for this fixed asset" }, "lossAccountID": { "type": "string", "description": "The loss account for this fixed asset" }, "lossSubAccountID": { "type": "string", "description": "The loss sub for this fixed asset" }, "debitAccountID": { "type": "string", "description": "The debit account" }, "debitSubAccountID": { "type": "string", "description": "The debit sub account" }, "creditAccountID": { "type": "string", "description": "The credit account" }, "creditSubAccountID": { "type": "string", "description": "The credit sub account" } }, "description": "Default accounts for the fixed asset using this fixed asset class" }, "FixedAssetClassDto": { "type": "object", "properties": { "classID": { "type": "string", "description": "The id that identifies this fixed asset class" }, "recordType": { "type": "string", "description": "The type of the record. This value is 'C' for fixed asset classes" }, "description": { "type": "string", "description": "The description of this fixed asset class" }, "active": { "type": "boolean", "description": "Indicates whether this fixed asset class is active or not" }, "assetTypeID": { "type": "string", "description": "The type id of this fixed asset class" }, "isTangible": { "type": "boolean", "description": "Indicates whether the fixed asset using this fixed asset class is tangible or not by default" }, "depreciable": { "type": "boolean", "description": "Indicates whether the fixed asset using this fixed asset class can be depreciated or not by default" }, "usefulLife": { "type": "number", "description": "Default useful life in years of the fixed asset using this fixed asset class", "format": "double" }, "acceleratedDepreciation": { "type": "boolean", "description": "Indicates whether the fixed asset using this fixed asset class will use accelerated depreciation depending on selected depreciation method" }, "bookSettings": { "$ref": "#/components/schemas/bookSettingsInFixedAssetClassDto" }, "accounts": { "$ref": "#/components/schemas/accountsInFixedAssetClassDto" }, "subAccountMask": { "type": "string", "description": "The sub account mask for this fixed asset class" }, "accumulatedDepreciationSubAccountMask": { "type": "string", "description": "The accumulated depreciation sub account mask for this fixed asset class" }, "depreciatedExpenseSubAccountMask": { "type": "string", "description": "The depreciated expense sub account mask for this fixed asset class" }, "proceedSubAccountMask": { "type": "string", "description": "The proceed sub account mask for this fixed asset class" }, "gainLossSubAccountMask": { "type": "string", "description": "The gain/loss sub account mask for this fixed asset class" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents an attribute in FixedAssetClass. Used for getting data." }, "FixedAssetClassQueryParameters": { "type": "object", "properties": { "classID": { "type": "string", "description": "Fixed Asset Class ID that identifies the fixed asset class." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "FixedAssetPropertyTaxDetailsDto": { "type": "object", "properties": { "date": { "type": "string", "description": "The date", "format": "date-time" }, "propertyValue": { "type": "number", "description": "The property value", "format": "double" }, "minPercent": { "type": "number", "description": "The minimum value percentage", "format": "double" } }, "description": "This class represents an attribute in FixedAssetPropertyTaxGroup. Used for getting data." }, "FixedAssetPropertyTaxDto": { "type": "object", "properties": { "propertyTaxID": { "type": "string", "description": "The property tax id of this property tax group" }, "description": { "type": "string", "description": "The description of this property tax group" }, "active": { "type": "boolean", "description": "A flag that indicates whether this fixed asset property tax group is active." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/FixedAssetPropertyTaxDetailsDto" }, "description": "Fixed Asset Property Tax Details" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents an attribute in FixedAssetPropertyTaxGroup. Used for getting data." }, "FixedAssetPropertyTaxQueryParameters": { "type": "object", "properties": { "propertyTaxID": { "type": "string", "description": "Property Tax ID that identifies the property tax group." }, "active": { "type": "boolean", "description": "Set to True to select active fixed asset property tax groups." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "FixedAssetRegisterDto": { "type": "object", "properties": { "documentDate": { "type": "string", "description": "The document date for this fixed asset transaction", "format": "date-time" }, "status": { "enum": [ "Balanced", "OnHold", "Posted", "Unposted" ], "type": "string", "description": "Status can be" }, "hold": { "type": "boolean", "description": "Indecates whether this fixed asset transaction is on hold or not" } } }, "FixedAssetTransactionAccountsDto": { "type": "object", "properties": { "debitAccountID": { "type": "string", "description": "The debit account" }, "debitSubAccountID": { "type": "string", "description": "The debit sub account" }, "creditAccountID": { "type": "string", "description": "The credit account" }, "creditSubAccountID": { "type": "string", "description": "The credit sub account" } } }, "accountsInFixedAssetTransactionDto": { "properties": { "debitAccountID": { "type": "string", "description": "The debit account" }, "debitSubAccountID": { "type": "string", "description": "The debit sub account" }, "creditAccountID": { "type": "string", "description": "The credit account" }, "creditSubAccountID": { "type": "string", "description": "The credit sub account" } }, "description": "The accounts used in this fixed asset transaction" }, "registerInFixedAssetTransactionDto": { "properties": { "documentDate": { "type": "string", "description": "The document date for this fixed asset transaction", "format": "date-time" }, "status": { "enum": [ "Balanced", "OnHold", "Posted", "Unposted" ], "type": "string", "description": "Status can be" }, "hold": { "type": "boolean", "description": "Indecates whether this fixed asset transaction is on hold or not" } }, "description": "The registration details" }, "FixedAssetTransactionDto": { "type": "object", "properties": { "refNo": { "type": "string", "description": "The referance number for this fixed asset transaction" }, "lineNo": { "type": "integer", "description": "The line number of this fixed asset transaction", "format": "int32" }, "branchID": { "type": "string", "description": "The branch id for this fixed asset transaction" }, "origin": { "enum": [ "Adjustment", "Purchasing", "Depreciation", "Disposal", "Transfer", "Reconciliation", "Split", "Reversal", "DisposalReversal" ], "type": "string", "description": "The origin of this fixed asset transaction. Origin can be" }, "assetID": { "type": "string", "description": "The asset id this fixed asset transaction belongs to" }, "transactionDescription": { "type": "string", "description": "The description of this fixed asset transaction" }, "bookID": { "type": "string", "description": "The book id for this fixed asset transaction" }, "transactionType": { "enum": [ "PurchasingPlus", "PurchasingMinus", "DepreciationPlus", "DepreciationMinus", "CalculatedPlus", "CalculatedMinus", "SalePlus", "SaleMinus", "TransferPurchasing", "TransferDepreciation", "ReconciliationPlus", "ReconciliationMinus", "PurchasingDisposal", "PurchasingReversal", "AdjustingDeprPlus", "AdjustingDeprMinus" ], "type": "string", "description": "Type can be" }, "accounts": { "$ref": "#/components/schemas/accountsInFixedAssetTransactionDto" }, "transactionAmount": { "type": "number", "description": "The amount of this fixed asset transaction", "format": "double" }, "batchNo": { "type": "string", "description": "The batch number of the general ledger transaction for this fixed asset transaction" }, "transactionPeriodID": { "type": "string", "description": "The transaction period id for this fixed asset transaction" }, "transactionDate": { "type": "string", "description": "The transaction date for this fixed asset transaction", "format": "date-time" }, "register": { "$ref": "#/components/schemas/registerInFixedAssetTransactionDto" }, "lastModifiedDateTime": { "type": "string", "description": "A system generated date/time that indicates the last change for this fixed asset transaction", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "FixedAssetTransactionQueryParameters": { "type": "object", "properties": { "refNo": { "type": "string", "description": "View all transactions connected to this Reference number." }, "assetID": { "type": "string", "description": "View all transactions connected to this Asset ID." }, "bookID": { "type": "string", "description": "View all transactions in this Book ID." }, "fromPeriod": { "type": "string", "description": "View all transactions from and including this Period. Format: YYYYMM." }, "toPeriod": { "type": "string", "description": "View all transactions to and including this Period. Format: YYYYMM." }, "accountID": { "type": "string", "description": "View all transactions for this Account ID." }, "subAccountID": { "type": "string", "description": "View all transactions for this Sub Account ID." }, "status": { "enum": [ "Balanced", "OnHold", "Posted", "Unposted" ], "type": "string", "description": "View all transactions with this Status. Available statuses: Balanced, OnHold, Posted and UnPosted." }, "transactionType": { "enum": [ "PurchasingPlus", "PurchasingMinus", "DepreciationPlus", "DepreciationMinus", "CalculatedPlus", "CalculatedMinus", "SalePlus", "SaleMinus", "TransferPurchasing", "TransferDepreciation", "ReconciliationPlus", "ReconciliationMinus", "PurchasingDisposal", "PurchasingReversal", "AdjustingDeprPlus", "AdjustingDeprMinus" ], "type": "string", "description": "View all transactions with this Transaction Type. Available types: PurchasingPlus, PurchasingMinus, DepreciationPlus, DepreciationMinus, CalculatedPlus, CalculatedMinu,SalePlus, SaleMinus,TransferPurchasing, TransferDepreciation, ReconciliationPlus, ReconciliationMinus, PurchasingDisposal, PurchasingReversal, AdjustingDeprPlus and AdjustingDeprMinus." }, "transactionFromDate": { "type": "string", "description": "View all transactions from and including this Transaction Date. Date format: YYYY-MM-DD." }, "transactionToDate": { "type": "string", "description": "View all transactions to and including this Transaction Date inclusive. Date format: YYYY-MM-DD ." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "GeneralLedgerPeriodBalanceQueryParameters": { "type": "object", "properties": { "periodId": { "type": "string", "description": "Period to retrieve balance for. Mandatory if 'LastModifiedDateTime' not provided. Format: 'yyyyMM'" }, "account": { "type": "string", "description": "Account to retrieve balance for" }, "subaccount": { "type": "string", "description": "Subaccount to retrieve balance for" }, "ledger": { "type": "string", "description": "Ledger to retrieve balance for" }, "branch": { "type": "string", "description": "Branch to retrieve balance for" }, "balanceType": { "enum": [ "Actual", "Report", "Statistical", "Budget" ], "type": "string", "description": "Balance Type of the ledger to be exported" }, "toggleBalanceSigns": { "type": "boolean", "description": "Parameter can be used in order to change the balance sign for liability and income accounts" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\nMandatory if 'PeriodId' is not provided.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```", "format": "date-time" }, "excludeYTDAccount": { "type": "boolean" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "SubAccountNumberDto": { "type": "object", "properties": { "subaccountNumber": { "type": "string", "description": "The subaccount number / code. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "The internal SubID identifier of the subaccount.", "format": "int32" } }, "description": "Minimal subaccount reference: the visible code and the internal identifier." }, "AccountNumberDescriptionDto": { "type": "object", "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string" }, "externalCode1": { "type": "string", "description": "ExternalCode1 is deprecated, please use ExternalCode1Info instead." }, "externalCode2": { "type": "string", "description": "ExternalCode2 is deprecated, please use ExternalCode2Info instead." }, "externalCode1Info": { "$ref": "#/components/schemas/ExternalCodeNumberDescriptionDto" }, "externalCode2Info": { "$ref": "#/components/schemas/ExternalCodeNumberDescriptionDto" }, "glConsolAccountCD": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "subaccountInGeneralLedgerBalanceDto": { "properties": { "subaccountNumber": { "type": "string", "description": "The subaccount number / code. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "The internal SubID identifier of the subaccount.", "format": "int32" } }, "description": "The subaccount of the balance row." }, "GeneralLedgerBalanceDto": { "type": "object", "properties": { "branch": { "$ref": "#/components/schemas/BranchNumberDto" }, "ledger": { "$ref": "#/components/schemas/LedgerDescriptionDto" }, "balanceType": { "enum": [ "Actual", "Report", "Statistical", "Budget" ], "type": "string" }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "account": { "$ref": "#/components/schemas/AccountNumberDescriptionDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInGeneralLedgerBalanceDto" }, "subaccountId": { "type": "string", "description": "[This field has been deprecated and will be removed in future versions. Use 'subaccount.subaccountId' instead.]\r\nThis field has been deprecated and will be removed in future versions. Use 'subaccount.subaccountId' instead." }, "subAccountCd": { "type": "string", "description": "[This field has been deprecated and will be removed in future versions. Use 'subaccount.subaccountNumber' instead.]\r\nThis field has been deprecated and will be removed in future versions. Use 'subaccount.subaccountNumber' instead." }, "currencyId": { "type": "string" }, "periodToDateDebit": { "type": "number", "description": "The total of all debit movements for the selected period.", "format": "double" }, "periodToDateCredit": { "type": "number", "description": "The total of all credit movements for the selected period.", "format": "double" }, "beginningBalance": { "type": "number", "description": "The total account balance at the start of the selected period.", "format": "double" }, "yearToDateBalance": { "type": "number", "description": "The total account balance at the end of the selected period.", "format": "double" }, "periodToDateDebitInCurrency": { "type": "number", "description": "The total of all debit movements in the currency of the selected account for the selected period.", "format": "double" }, "periodToDateCreditInCurrency": { "type": "number", "description": "The total of all credit movements in the currency of the selected account for the selected period.", "format": "double" }, "beginningBalanceInCurrency": { "type": "number", "description": "The total account balance in the currency of the selected account at the start of the selected period.", "format": "double" }, "yearToDateBalanceInCurrency": { "type": "number", "description": "The total account balance in the currency of the selected account at the end of the selected period.", "format": "double" }, "yearClosed": { "type": "boolean", "description": "True when the last period of a financial year is closed in all modules." }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a General Ledger Balance in GeneralLedgerBalanceController. Used by getting data." }, "GeneralLedgerTransactionsQueryParameters": { "required": [ "ledger" ], "type": "object", "properties": { "branch": { "type": "string", "description": "The branch CD" }, "ledger": { "type": "string", "description": "Mandatory. The ledger in which you want to view the account balances." }, "fromPeriod": { "type": "string", "description": "The financial period that begins the date range of the batches you want to view. Format YYYYPP" }, "toPeriod": { "type": "string", "description": "The financial period that ends the date range of the batches you want to view. Format YYYYPP" }, "account": { "type": "string", "description": "The account CD for which you want to view activities in the selected financial period." }, "subaccountId": { "type": "string", "description": "The Subaccount" }, "fromDate": { "type": "string", "description": "The first date of the interval within the period. Format YYYY-MM-DD" }, "toDate": { "type": "string", "description": "The last date of the interval within the selected period. Format YYYY-MM-DD" }, "includeUnposted": { "type": "boolean", "description": "Checkmark indicating if unposted batches are included." }, "includeUnreleased": { "type": "boolean", "description": "Checkmark indicating if unreleased (balanced) batches are included." }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "expandAccountInfo": { "type": "boolean", "description": "By default, if no value is provided, False and the account information will include only Number, Description, Type and GlConsolAccountCD.\r\nIf True, each transaction returned will include extended information about account." }, "expandBranchInfo": { "type": "boolean", "description": "By default, if no value is provided, False and branch information will include only branch number.\r\nIf True, each transaction returned will include extended information about Branch (number and name)." }, "includeTransactionBalance": { "type": "boolean", "description": "By default, if no value is provided, False and the transactions returned will not include their balances (fields BegBalance, EndingBalance, CurrBegBalance, CurrEndingBalance)\r\nIf True, each transaction returned will include its balance." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "branchInGeneralLedgerTransactionDetailsDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Branch > The branch of the company." }, "accountInGeneralLedgerTransactionDetailsDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string" }, "externalCode1": { "type": "string", "description": "ExternalCode1 is deprecated, please use ExternalCode1Info instead." }, "externalCode2": { "type": "string", "description": "ExternalCode2 is deprecated, please use ExternalCode2Info instead." }, "externalCode1Info": { "$ref": "#/components/schemas/ExternalCodeNumberDescriptionDto" }, "externalCode2Info": { "$ref": "#/components/schemas/ExternalCodeNumberDescriptionDto" }, "glConsolAccountCD": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Account > The account updated by the batch transactions." }, "ledgerInGeneralLedgerTransactionDetailsDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Ledger > The ledger used for the batch." }, "GeneralLedgerTransactionDetailsDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "format": "int32" }, "module": { "type": "string", "description": "Workspace > The workspace where the transaction originated." }, "batchNumber": { "type": "string", "description": "Batch number > The reference number of the batch (generated for the transaction) that updated the balance of the selected account." }, "tranDate": { "type": "string", "description": "Trans date > The date of the transaction.", "format": "date-time" }, "period": { "type": "string", "description": "Period > The financial period of the transaction." }, "description": { "type": "string", "description": "Description > The user-defined description of the transaction." }, "refNumber": { "type": "string", "description": "Ref. number > The reference number of the external document on which this transaction is based." }, "branch": { "$ref": "#/components/schemas/branchInGeneralLedgerTransactionDetailsDto" }, "account": { "$ref": "#/components/schemas/accountInGeneralLedgerTransactionDetailsDto" }, "ledger": { "$ref": "#/components/schemas/ledgerInGeneralLedgerTransactionDetailsDto" }, "subaccount": { "type": "string", "description": "Subaccount > The subaccount used in the batch." }, "begBalance": { "type": "number", "description": "Beg. balance > The running total of the account's beginning balance calculated in the order of transactions displayed in the table.", "format": "double" }, "debitAmount": { "type": "number", "description": "Debit amount > The transaction debit amount charged to the account during the selected financial period.", "format": "double" }, "creditAmount": { "type": "number", "description": "Credit amount > The transaction credit amount charged to the account during the selected financial period.", "format": "double" }, "endingBalance": { "type": "number", "description": "Ending balance > The running total of the account's ending balance calculated in the order of transactions displayed in the table.", "format": "double" }, "currency": { "type": "string", "description": "Click the Show currency details check box to view the below fields in the window.\r\nCurrency > The currency of transactions in the account. If it is not specified, the balance is in the base currency." }, "currBegBalance": { "type": "number", "description": "Beg. balance (currency) > The account balance in the selected currency at the start of the selected period.", "format": "double" }, "currDebitAmount": { "type": "number", "description": "Debit amount (currency) > The debit amount in the selected currency for the specified account over the selected period.", "format": "double" }, "currCreditAmount": { "type": "number", "description": "Credit amount (currency) > The credit amount in the selected currency for the specified account over the selected period.", "format": "double" }, "currEndingBalance": { "type": "number", "description": "Ending balance (currency) > The account balance in the selected currency at the start of the selected period.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information reflecting when the last change was done.", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "InventoryClassQueryParameters": { "type": "object", "properties": { "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ItemClassDto": { "type": "object", "properties": { "type": { "enum": [ "NonStockItem", "LaborItem", "ServiceItem", "ChargeItem", "ExpenseItem", "FinishedGoodItem", "ComponentPartItem", "SubassemblyItem" ], "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassAttributeDto" } }, "id": { "type": "string", "description": "The identifier." }, "description": { "type": "string", "description": "The description." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "PostingClassDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The identifier." }, "description": { "type": "string", "description": "The description." }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "BAccountDescriptionDto": { "type": "object", "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } } }, "PriceManagerDto": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "IntrastatDto": { "type": "object", "properties": { "cN8": { "type": "string", "description": "Represents the 8 digit level Combine Nomenclature commodity code specific for the year\r\nfor which the creating / actualizations Intrastat declarations is drafted." }, "countryOfOrigin": { "type": "string", "description": "The country of origin of the commodity will be selected,\r\nthat country where the good has been produced or had the last substantial transformation." }, "supplementaryMeasureUnit": { "type": "string", "description": "The requirement for Supplementary Measure Units applies only to certain classes of goods(NC8 Positions)\r\nthat may be expressed from quantitative point of view in other measurement units but kilo also." } }, "description": "This class represents a Intrastat part of InventoryItem in InventoryItemController. Used for getting data." }, "PackagingDto": { "type": "object", "properties": { "baseItemWeight": { "type": "number", "description": "The weight of the Base Unit of the item.", "format": "double" }, "weightUOM": { "type": "string", "description": "The Unit of Measure used for the Weight of the item." }, "baseItemVolume": { "type": "number", "description": "The volume of the Base Unit of the item.", "format": "double" }, "volumeUOM": { "type": "string", "description": "The Unit of Measure used for the Volume of the item." } }, "description": "This class represents a Packaging part of InventoryItem in InventoryItemController. Used for getting data." }, "SalesCategoryLineDto": { "type": "object", "properties": { "categoryId": { "type": "integer", "format": "int32" }, "description": { "type": "string" } } }, "SupplierDetailsLineDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "default": { "type": "boolean" }, "supplierId": { "type": "string" }, "supplierName": { "type": "string" }, "location": { "type": "string" }, "warehouse": { "type": "string" }, "purchaseUnit": { "type": "string" }, "supplierItemId": { "type": "string" }, "shipmentLeadTime": { "type": "integer", "format": "int32" }, "leadTime": { "type": "integer", "format": "int32" }, "minOrderFreq": { "type": "integer", "format": "int32" }, "minOrderQty": { "type": "number", "format": "double" }, "maxOrderQty": { "type": "number", "format": "double" }, "lotSize": { "type": "number", "format": "double" }, "eoq": { "type": "number", "format": "double" }, "currencyId": { "type": "string" }, "lastSupplierPrice": { "type": "number", "format": "double" }, "override": { "type": "boolean" } } }, "DefaultReceiptToDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "DefaultIssueFromDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "DefaultWarehouseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "InventoryUnitDto": { "type": "object", "properties": { "unitType": { "type": "integer", "format": "int32" }, "itemClass": { "$ref": "#/components/schemas/ItemClassDto" }, "inventoryID": { "type": "integer", "description": "The top part > Item ID > The unique alphanumeric identifier of the stock item.", "format": "int32" }, "toUnit": { "type": "string", "description": "To unit > The unit of measure selected as the base unit for the item." }, "sampleToUnit": { "type": "string" }, "fromUnit": { "type": "string", "description": "Mandatory field: From unit > The unit of measure for which the conversion parameters are specified." }, "unitMultDiv": { "type": "string", "description": "Multiply/divide > The operation to be performed for unit conversion." }, "unitRate": { "type": "number", "format": "double" }, "priceAdjustmentMultiplier": { "type": "number", "description": "Price adjustment multiplier > Changes the price automatically if you change the UoM.", "format": "double" }, "recordID": { "type": "integer", "format": "int64" } } }, "WarehouseDetailDto": { "type": "object", "properties": { "isDefault": { "type": "boolean" }, "warehouse": { "type": "string", "description": "Warehouse > The warehouse where the stock item is available." }, "quantityOnHand": { "type": "number", "description": "Qty. on hand > The quantity of this item available (on hand) at the warehouse.", "format": "double" }, "available": { "type": "number", "format": "double" }, "availableForShipment": { "type": "number", "format": "double" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" } }, "description": "This class represents a WarehouseDetail part of InventoryItem in InventoryItemController. Used for getting data." }, "bAccountInInventoryCrossReferenceDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: Supplier/Customer*, click magnifier > Account ID > Account no. identifying the business account." }, "InventoryCrossReferenceDto": { "type": "object", "properties": { "alternateType": { "enum": [ "CPN", "VPN", "Global", "Barcode" ], "type": "string", "description": "Alternate type > The type of alternate codification used for the item if applicable." }, "bAccount": { "$ref": "#/components/schemas/bAccountInInventoryCrossReferenceDto" }, "alternateID": { "type": "string", "description": "Mandatory field: Alternate ID > The alternate ID of the stock item (under the specified item ID) as used by the supplier or customer." }, "description": { "type": "string", "description": "Description > Any comments applicable to the specified cross-reference." }, "isDefault": { "type": "boolean", "description": "Default > Indicates whether this cross-reference is marked as the default one." }, "uom": { "type": "string", "description": "UoM > The unit of measure used for this component." }, "timestamp": { "type": "string", "description": "Timestamp of the inventory item the crossreference belongs to" } } }, "CostPriceStatisticsDto": { "type": "object", "properties": { "lastCost": { "type": "number", "description": "Cost price statistics section > Last cost > The last standard cost used for the stock item.", "format": "double" }, "averageCost": { "type": "number", "description": "Cost price statistics section > Average cost > The average cost for the stock item.", "format": "double" }, "minCost": { "type": "number", "description": "Cost price statistics section > Min. cost > The minimum cost for the stock item.", "format": "double" }, "maxCost": { "type": "number", "description": "Cost price statistics section > Max. cost > The maximum cost for the stock item.", "format": "double" } } }, "expenseAccrualAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Only used for Non-stock items.\r\nPurchase accrual account > Purchase order accrual account > The liability account to be used for this stock item to accrue amounts on purchase orders related to this item." }, "inventoryAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Only used for Stock items.\r\nInventory account > The asset account to be used to keep the inventory balance resulting from transactions with this stock item." }, "expenseAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Only used for Non-stock items.\r\nMandatory field: Expense account* > The default expense account to be used for this non-stock item." }, "cogsAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Only used for Stock items.\r\nCOGS account > The expense account to be used for this stock item to record the cost of goods sold (COGS) once the sales order is released." }, "expenseNonTaxableAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Expense account, non-taxable > The income account to be used for this stock item to record non-taxable expenses." }, "expenseEuAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Expense EU account > The income account to be used for this stock item to record EU expenses." }, "expenseImportAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Expense account, import > The income account to be used for this stock item to record import expenses." }, "expenseSubaccountInInventoryAccountInformationDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Only used for Non-stock items.\r\nMandatory field: Expense sub* > The subaccount to be used by default with the expense account for transactions related to this non-stock item." }, "cogsSubaccountInInventoryAccountInformationDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Only used for Stock items.\r\nCOGS sub. > The subaccount to be used for this item with the COGS account." }, "salesAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Sales account *> The income account to be used for this stock item to record sales." }, "salesNonTaxableAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Sales - non-taxable account > The income account to be used for this stock item to record non-taxable sales." }, "salesEuAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Sales - EU account > The income account to be used for this stock item to record EU sales." }, "salesExportAccountInInventoryAccountInformationDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Sales - export account > The income account to be used for this stock item to record export sales." }, "salesSubaccountInInventoryAccountInformationDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Sales sub. *> The subaccount to be used for this item to record sales." }, "InventoryAccountInformationDto": { "type": "object", "properties": { "expenseAccrualAccount": { "$ref": "#/components/schemas/expenseAccrualAccountInInventoryAccountInformationDto" }, "inventoryAccount": { "$ref": "#/components/schemas/inventoryAccountInInventoryAccountInformationDto" }, "expenseAccount": { "$ref": "#/components/schemas/expenseAccountInInventoryAccountInformationDto" }, "cogsAccount": { "$ref": "#/components/schemas/cogsAccountInInventoryAccountInformationDto" }, "expenseNonTaxableAccount": { "$ref": "#/components/schemas/expenseNonTaxableAccountInInventoryAccountInformationDto" }, "expenseEuAccount": { "$ref": "#/components/schemas/expenseEuAccountInInventoryAccountInformationDto" }, "expenseImportAccount": { "$ref": "#/components/schemas/expenseImportAccountInInventoryAccountInformationDto" }, "expenseSubaccount": { "$ref": "#/components/schemas/expenseSubaccountInInventoryAccountInformationDto" }, "cogsSubaccount": { "$ref": "#/components/schemas/cogsSubaccountInInventoryAccountInformationDto" }, "salesAccount": { "$ref": "#/components/schemas/salesAccountInInventoryAccountInformationDto" }, "salesNonTaxableAccount": { "$ref": "#/components/schemas/salesNonTaxableAccountInInventoryAccountInformationDto" }, "salesEuAccount": { "$ref": "#/components/schemas/salesEuAccountInInventoryAccountInformationDto" }, "salesExportAccount": { "$ref": "#/components/schemas/salesExportAccountInInventoryAccountInformationDto" }, "salesSubaccount": { "$ref": "#/components/schemas/salesSubaccountInInventoryAccountInformationDto" } } }, "LotSerClassDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "itemClassInInventoryDto": { "properties": { "type": { "enum": [ "NonStockItem", "LaborItem", "ServiceItem", "ChargeItem", "ExpenseItem", "FinishedGoodItem", "ComponentPartItem", "SubassemblyItem" ], "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassAttributeDto" } }, "id": { "type": "string", "description": "The identifier." }, "description": { "type": "string", "description": "The description." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: General information tab > Item defaults section > Item class* > The item class to which the stock item is assigned." }, "postingClassInInventoryDto": { "properties": { "id": { "type": "string", "description": "The identifier." }, "description": { "type": "string", "description": "The description." }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: General information tab > Item defaults section > Posting class* > The posting class of the stock item, which by default is the posting class assigned to the item class." }, "vatCodeInInventoryDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: General information tab > Item defaults section > VAT category* > The VAT code of the stock item, which by default is the VAT code associated with the item class." }, "lotSerialClassInInventoryDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: General information tab > Item defaults section > Lot/Serial Class* > The lot serial class ID of the stock item, which by default is the ID associated with the item class." }, "accountInformationInInventoryDto": { "properties": { "expenseAccrualAccount": { "$ref": "#/components/schemas/expenseAccrualAccountInInventoryAccountInformationDto" }, "inventoryAccount": { "$ref": "#/components/schemas/inventoryAccountInInventoryAccountInformationDto" }, "expenseAccount": { "$ref": "#/components/schemas/expenseAccountInInventoryAccountInformationDto" }, "cogsAccount": { "$ref": "#/components/schemas/cogsAccountInInventoryAccountInformationDto" }, "expenseNonTaxableAccount": { "$ref": "#/components/schemas/expenseNonTaxableAccountInInventoryAccountInformationDto" }, "expenseEuAccount": { "$ref": "#/components/schemas/expenseEuAccountInInventoryAccountInformationDto" }, "expenseImportAccount": { "$ref": "#/components/schemas/expenseImportAccountInInventoryAccountInformationDto" }, "expenseSubaccount": { "$ref": "#/components/schemas/expenseSubaccountInInventoryAccountInformationDto" }, "cogsSubaccount": { "$ref": "#/components/schemas/cogsSubaccountInInventoryAccountInformationDto" }, "salesAccount": { "$ref": "#/components/schemas/salesAccountInInventoryAccountInformationDto" }, "salesNonTaxableAccount": { "$ref": "#/components/schemas/salesNonTaxableAccountInInventoryAccountInformationDto" }, "salesEuAccount": { "$ref": "#/components/schemas/salesEuAccountInInventoryAccountInformationDto" }, "salesExportAccount": { "$ref": "#/components/schemas/salesExportAccountInInventoryAccountInformationDto" }, "salesSubaccount": { "$ref": "#/components/schemas/salesSubaccountInInventoryAccountInformationDto" } }, "description": "General ledger account tab >" }, "costPriceStatisticsInInventoryDto": { "properties": { "lastCost": { "type": "number", "description": "Cost price statistics section > Last cost > The last standard cost used for the stock item.", "format": "double" }, "averageCost": { "type": "number", "description": "Cost price statistics section > Average cost > The average cost for the stock item.", "format": "double" }, "minCost": { "type": "number", "description": "Cost price statistics section > Min. cost > The minimum cost for the stock item.", "format": "double" }, "maxCost": { "type": "number", "description": "Cost price statistics section > Max. cost > The maximum cost for the stock item.", "format": "double" } }, "description": "Price/cost information tab >" }, "defaultWarehouseInInventoryDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "General information tab > Warehouse defaults section > Default warehouse > The default warehouse used to store the stock item with the specified item ID." }, "defaultIssueFromInInventoryDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "General information tab > Warehouse defaults section > Default issue from > The location of the warehouse to be used by default to issue quantities of the selected stock item." }, "defaultReceiptToInInventoryDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "General information tab > Warehouse defaults section > Default receipt to > The location of warehouse to be used by default to receive certain quantities of the specified stock item." }, "packagingInInventoryDto": { "properties": { "baseItemWeight": { "type": "number", "description": "The weight of the Base Unit of the item.", "format": "double" }, "weightUOM": { "type": "string", "description": "The Unit of Measure used for the Weight of the item." }, "baseItemVolume": { "type": "number", "description": "The volume of the Base Unit of the item.", "format": "double" }, "volumeUOM": { "type": "string", "description": "The Unit of Measure used for the Volume of the item." } }, "description": "Packaging tab" }, "intrastatInInventoryDto": { "properties": { "cN8": { "type": "string", "description": "Represents the 8 digit level Combine Nomenclature commodity code specific for the year\r\nfor which the creating / actualizations Intrastat declarations is drafted." }, "countryOfOrigin": { "type": "string", "description": "The country of origin of the commodity will be selected,\r\nthat country where the good has been produced or had the last substantial transformation." }, "supplementaryMeasureUnit": { "type": "string", "description": "The requirement for Supplementary Measure Units applies only to certain classes of goods(NC8 Positions)\r\nthat may be expressed from quantitative point of view in other measurement units but kilo also." } }, "description": "General information tab > Intrastat section" }, "priceManagerInInventoryDto": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "description": "The Price/cost information tab > Price management section > Price manager > The manager responsible for the product pricing." }, "priceClassInInventoryDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Price/cost information tab > Price management section > Price class > The item price class associated with the non-stock item. Group stock or non-stock items with similar price calculation methods." }, "InventoryDto": { "type": "object", "properties": { "inventoryId": { "type": "integer", "description": "The unique internal identifier of the item as is stored in the database. This Id is not visible in the window.", "format": "int32" }, "inventoryNumber": { "type": "string", "description": "Mandatory field: The top part > Item Id* > The unique alphanumeric identifier of the stock item." }, "status": { "enum": [ "Active", "NoSales", "NoPurchases", "NoRequest", "Inactive", "MarkedForDeletion", "Unknown" ], "type": "string", "description": "The top part > Item status > The status of the stock item. The alternatives are: Active, No sales, No purchases, No request, Inactive, Marked for deletion." }, "type": { "enum": [ "NonStockItem", "LaborItem", "ServiceItem", "ChargeItem", "ExpenseItem", "FinishedGoodItem", "ComponentPartItem", "SubassemblyItem" ], "type": "string", "description": "General information tab > Item defaults section > Type > The type of stock item." }, "description": { "type": "string", "description": "The top part > Description *> A brief description of the stock item." }, "body": { "type": "string", "description": "The top part > Body *> A brief description of the stock item." }, "itemClass": { "$ref": "#/components/schemas/itemClassInInventoryDto" }, "postingClass": { "$ref": "#/components/schemas/postingClassInInventoryDto" }, "vatCode": { "$ref": "#/components/schemas/vatCodeInInventoryDto" }, "lotSerialClass": { "$ref": "#/components/schemas/lotSerialClassInInventoryDto" }, "defaultPrice": { "type": "number", "description": "Price/cost information tab > Price management section > Default price > The price of the stock item.", "format": "double" }, "pendingCost": { "type": "number", "description": "Price/cost information tab > Standard cost section > Pending cost > The pending standard cost for the stock item.", "format": "double" }, "pendingCostDate": { "type": "string", "description": "Price/cost information tab > Standard cost section > Pending cost date > The date when the pending standard cost becomes effective.", "format": "date-time" }, "currentCost": { "type": "number", "description": "Price/cost information tab > Standard cost section > Current cost > Read-only. This field displays the current standard cost for the stock item.", "format": "double" }, "effectiveDate": { "type": "string", "description": "Price/cost information tab > Standard cost section > Effective date > Read-only. This field shows the effective date for the current standard cost of the stock item.", "format": "date-time" }, "lastCost": { "type": "number", "description": "Price/cost information tab > Standard cost section > Last cost > Read-only. This field showing the last standard cost defined for the stock item.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "Information collected from system.", "format": "date-time" }, "baseUnit": { "type": "string", "description": "Mandatory field: General information tab > Unit of measurement section > Base unit* > The UoM used as the base unit for this stock item." }, "salesUnit": { "type": "string", "description": "Mandatory field: General information tab > Unit of measurement section > Sales unit *> The UoM to be used as the sales unit for the stock item." }, "purchaseUnit": { "type": "string", "description": "Mandatory field: General information tab > Unit of measurement section > Purchase unit *> The UoM to be used as the purchase unit for the stock item." }, "unspsc": { "type": "string", "description": "General information tab > UNSPSC Code > The UNSPSC code for the stock item." }, "stockItem": { "type": "boolean" }, "kitItem": { "type": "boolean" }, "accountInformation": { "$ref": "#/components/schemas/accountInformationInInventoryDto" }, "costPriceStatistics": { "$ref": "#/components/schemas/costPriceStatisticsInInventoryDto" }, "crossReferences": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryCrossReferenceDto" }, "description": "Cross-reference tab >" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "Attributes tab >" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeIdValueDto" } }, "warehouseDetails": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseDetailDto" }, "description": "Warehouse details tab >" }, "inventoryUnits": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryUnitDto" }, "description": "General information tab > The Unit conversion table just below the Unit of measurement section. Several fields collected from different parts of the window." }, "defaultWarehouse": { "$ref": "#/components/schemas/defaultWarehouseInInventoryDto" }, "defaultIssueFrom": { "$ref": "#/components/schemas/defaultIssueFromInInventoryDto" }, "defaultReceiptTo": { "$ref": "#/components/schemas/defaultReceiptToInInventoryDto" }, "supplierDetails": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierDetailsLineDto" }, "description": "Supplier details tab" }, "salesCategories": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCategoryLineDto" }, "description": "Attributes tab > Sales categories grid" }, "packaging": { "$ref": "#/components/schemas/packagingInInventoryDto" }, "intrastat": { "$ref": "#/components/schemas/intrastatInInventoryDto" }, "recommendedPrice": { "type": "number", "description": "The Price/cost information tab > Price management section > List price > The manufacturer's suggested retail price (MSRP) of the stock item.", "format": "double" }, "priceManagerID": { "type": "string", "description": "The Price/cost information tab > Price management section > Price manager > The ID of the manager responsible for the product pricing.", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "priceManager": { "$ref": "#/components/schemas/priceManagerInInventoryDto" }, "priceClass": { "$ref": "#/components/schemas/priceClassInInventoryDto" }, "priceWorkgroupID": { "type": "integer", "description": "The Price/cost information tab > Price management section > Price work group > The work group responsible for product pricing. Select the pricing work group for the stock item.", "format": "int32" }, "priceClassID": { "type": "string", "description": "The Price/cost information tab > Price management section > Price class > The price class of the item." }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the inventory item." }, "timestamp": { "type": "string", "description": "Timestamp of the inventory item record" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "DtoValueOfInventoryCrossReferenceAlternateTypes": { "type": "object", "properties": { "value": { "enum": [ "CPN", "VPN", "Global", "Barcode" ], "type": "string" } } }, "DtoValueOfInt16": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" } } }, "alternateTypeInCrossReferenceUpdateDto": { "properties": { "value": { "enum": [ "CPN", "VPN", "Global", "Barcode" ], "type": "string" } }, "description": "The alternate type field. Select one of the following predefined types: CPN, VPN, Global, Barcode" }, "CrossReferenceUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "alternateType": { "$ref": "#/components/schemas/alternateTypeInCrossReferenceUpdateDto" }, "bAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "alternateID": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "cN8InIntrastatUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Represents the 8 digit level Combine Nomenclature commodity code specific for the year\r\nfor which the creating / actualizations Intrastat declarations is drafted." }, "countryOfOriginInIntrastatUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The country of origin of the commodity will be selected,\r\nthat country where the good has been produced or had the last substantial transformation." }, "supplementaryMeasureUnitInIntrastatUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The requirement for Supplementary Measure Units applies only to certain classes of goods(NC8 Positions)\r\nthat may be expressed from quantitative point of view in other measurement units but kilo also." }, "IntrastatUpdateDto": { "type": "object", "properties": { "cN8": { "$ref": "#/components/schemas/cN8InIntrastatUpdateDto" }, "countryOfOrigin": { "$ref": "#/components/schemas/countryOfOriginInIntrastatUpdateDto" }, "supplementaryMeasureUnit": { "$ref": "#/components/schemas/supplementaryMeasureUnitInIntrastatUpdateDto" } }, "description": "This class represents a Intrastat part of InventoryItem in InventoryItemController. Used for insert/update data." }, "SupplierDetailsDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "active": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "default": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "supplierID": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "purchaseUnit": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplierItemID": { "$ref": "#/components/schemas/DtoValueOfString" }, "override": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "shipmentLeadTime": { "$ref": "#/components/schemas/DtoValueOfInt16" }, "minOrderFreq": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "minOrderQty": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "maxOrderQty": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "lotSize": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "eoq": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "currencyID": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "lastCostInCostPriceStatisticsUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "Cost price statistics section > Last cost > The last standard cost used for the stock item." }, "CostPriceStatisticsUpdateDto": { "type": "object", "properties": { "lastCost": { "$ref": "#/components/schemas/lastCostInCostPriceStatisticsUpdateDto" } } }, "baseItemWeightInPackagingUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The weight of the Base Unit of the item." }, "weightUOMInPackagingUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Unit of Measure used for the Weight of the item." }, "baseItemVolumeInPackagingUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The volume of the Base Unit of the item." }, "volumeUOMInPackagingUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Unit of Measure used for the Volume of the item." }, "PackagingUpdateDto": { "type": "object", "properties": { "baseItemWeight": { "$ref": "#/components/schemas/baseItemWeightInPackagingUpdateDto" }, "weightUOM": { "$ref": "#/components/schemas/weightUOMInPackagingUpdateDto" }, "baseItemVolume": { "$ref": "#/components/schemas/baseItemVolumeInPackagingUpdateDto" }, "volumeUOM": { "$ref": "#/components/schemas/volumeUOMInPackagingUpdateDto" } }, "description": "This class represents a Packaging part of InventoryItem in InventoryItemController. Used for insert/update data." }, "DtoValueOfInventoryType": { "type": "object", "properties": { "value": { "enum": [ "NonStockItem", "LaborItem", "ServiceItem", "ChargeItem", "ExpenseItem", "FinishedGoodItem", "ComponentPartItem", "SubassemblyItem" ], "type": "string" } } }, "DtoValueOfInventoryStatus": { "type": "object", "properties": { "value": { "enum": [ "Active", "NoSales", "NoPurchases", "NoRequest", "Inactive", "MarkedForDeletion", "Unknown" ], "type": "string" } } }, "inventoryNumberInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory for POST, not applicable for PUT. The unique alphanumeric identifier of the item that is used in UI." }, "itemClassInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory, the item class to which the item is assigned. Selecting a class provides default settings for the item." }, "postingClassInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The posting class of the item, which by default is the posting class assigned to the item class." }, "lotSerialClassInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The lot/serial class of the item, which by default is the lot/serial class assigned to the item class." }, "vatCodeInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The vat category of the item, which by default is the vat category associated with the item class." }, "defaultPriceInInventoryUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The price of the item. This price is used as the default price, if there are no other prices set." }, "unspscInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "General information tab > UNSPSC Code > The UNSPSC code for the item.\r\nMust contain exactly 8 digits." }, "expenseAccrualAccountInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Only used for Non-stock items" }, "inventoryAccountInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Only used for Stock items" }, "expenseAccountInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Only used for Non-stock items" }, "cogsAccountInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Only used for Stock items" }, "defaultWarehouseInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "General information tab > Warehouse defaults section > Default warehouse > The default warehouse used to store the stock item with the specified item ID." }, "defaultIssueFromInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "General information tab > Warehouse defaults section > Default issue from > The location of the warehouse to be used by default to issue quantities of the selected stock item." }, "defaultReceiptToInInventoryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "General information tab > Warehouse defaults section > Default receipt to > The location of warehouse to be used by default to receive certain quantities of the specified stock item." }, "InventoryUpdateDto": { "type": "object", "properties": { "inventoryNumber": { "$ref": "#/components/schemas/inventoryNumberInInventoryUpdateDto" }, "status": { "$ref": "#/components/schemas/DtoValueOfInventoryStatus" }, "type": { "$ref": "#/components/schemas/DtoValueOfInventoryType" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "body": { "$ref": "#/components/schemas/DtoValueOfString" }, "itemClass": { "$ref": "#/components/schemas/itemClassInInventoryUpdateDto" }, "postingClass": { "$ref": "#/components/schemas/postingClassInInventoryUpdateDto" }, "lotSerialClass": { "$ref": "#/components/schemas/lotSerialClassInInventoryUpdateDto" }, "vatCode": { "$ref": "#/components/schemas/vatCodeInInventoryUpdateDto" }, "defaultPrice": { "$ref": "#/components/schemas/defaultPriceInInventoryUpdateDto" }, "baseUnit": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesUnit": { "$ref": "#/components/schemas/DtoValueOfString" }, "purchaseUnit": { "$ref": "#/components/schemas/DtoValueOfString" }, "unspsc": { "$ref": "#/components/schemas/unspscInInventoryUpdateDto" }, "expenseAccrualAccount": { "$ref": "#/components/schemas/expenseAccrualAccountInInventoryUpdateDto" }, "inventoryAccount": { "$ref": "#/components/schemas/inventoryAccountInInventoryUpdateDto" }, "expenseAccount": { "$ref": "#/components/schemas/expenseAccountInInventoryUpdateDto" }, "cogsAccount": { "$ref": "#/components/schemas/cogsAccountInInventoryUpdateDto" }, "expenseNonTaxableAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseEuAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseImportAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "Only used for Non-stock items" }, "cogsSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "Only used for Stock items" }, "salesAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesNonTaxableAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesEuAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesExportAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "attributeLines": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeLineUpdateDto" } }, "packaging": { "$ref": "#/components/schemas/PackagingUpdateDto" }, "costPriceStatistics": { "$ref": "#/components/schemas/CostPriceStatisticsUpdateDto" }, "supplierDetails": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierDetailsDto" } }, "intrastat": { "$ref": "#/components/schemas/IntrastatUpdateDto" }, "crossReferences": { "type": "array", "items": { "$ref": "#/components/schemas/CrossReferenceUpdateDto" } }, "defaultWarehouse": { "$ref": "#/components/schemas/defaultWarehouseInInventoryUpdateDto" }, "defaultIssueFrom": { "$ref": "#/components/schemas/defaultIssueFromInInventoryUpdateDto" }, "defaultReceiptTo": { "$ref": "#/components/schemas/defaultReceiptToInInventoryUpdateDto" }, "kitItem": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "InventoryQueryParameters": { "type": "object", "properties": { "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.\r\nMaxPageSize will be set to 5000 from 1. April 2022", "format": "int32" }, "alternateID": { "type": "string", "description": "Applies for both Stock and Non-stock items. Some fields in this filter applies only for one of these." }, "inventoryNumber": { "type": "string", "description": "The Item ID." }, "salesCategory": { "type": "integer", "description": "The Category ID for the sales category, found on the Attributes tab.", "format": "int32" }, "addCostPriceStatistics": { "type": "boolean", "description": "This filter can be used only for stock items, from the Price/cost information tab." }, "attributes": { "type": "string", "description": " Attributes (additional information) connected to the entity.\r\n Examples:\r\n{{base}}/inventory?attributes={\"AttributeID\":\"ValueID\",\"AttributeID\":\"ValueID\"}\r\n{{base}}/inventory?attributes={\"AttributeID\":\"ValueID1,ValueID2\"}" }, "description": { "type": "string", "description": "A brief description of the stock item from the Top part of the window." }, "availabilityLastModifiedDateTime": { "type": "string", "description": "System retrieved information." }, "availabilityLastModifiedDateTimeCondition": { "type": "string", "description": "System retrieved information for state/condition." }, "inventoryTypes": { "type": "array", "items": { "type": "string" }, "description": "Filter on one or more inventory types: NonStockItem, LaborItem, ServiceItem, ChargeItem, ExpenseItem, FinishedGoodItem, ComponentPartItem or SubassemblyItem" }, "expandCrossReference": { "type": "boolean", "description": "These expand fields are by default set to true, but will be changed in the future. \r\nSet to true to retrieve information about the cross-references (item ID and suppliers/customers ID for the item connected to the item." }, "expandAttachment": { "type": "boolean", "description": "Set to true to retrieve information about the attachments connected to the item." }, "expandAttribute": { "type": "boolean", "description": "Set to true to retrieve the attribute descriptions used for the item." }, "expandWarehouseDetail": { "type": "boolean", "description": "Set to true to retrieve information about the warehouse connected to the item." }, "expandAccountInformation": { "type": "boolean", "description": "Set to true to retrieve information about the account information connected to the item." }, "expandInventoryUnits": { "type": "boolean", "description": "Set to true to retrieve information about the units of measure connected to the item." }, "expandSupplierDetails": { "type": "boolean", "description": "Set to true to retrieve details about the supplier connected to the item." }, "expandSalesCategories": { "type": "boolean", "description": "Set to true to retrieve details about the sales categories connected to the item." }, "expandNote": { "type": "boolean", "description": "Set to true to retrieve the note value connected to the item." }, "attachmentLastModifiedDateTime": { "type": "string", "description": "System retrieved information for last modified date and time for attachment." }, "attachmentLastModifiedDateTimeCondition": { "type": "string", "description": "System retrieved information for state/condition for attachment." }, "status": { "enum": [ "Active", "NoSales", "NoPurchases", "NoRequest", "Inactive", "MarkedForDeletion" ], "type": "string", "description": "The inventory item status" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" } } }, "BarCodeMetadataDto": { "type": "object", "properties": { "totalCount": { "type": "integer", "format": "int64" } } }, "BarCodeDto": { "type": "object", "properties": { "barCode": { "type": "string" }, "inventoryNumber": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/BarCodeMetadataDto" } } }, "alternateTypeInInventoryCrossReferenceUpdateDto": { "properties": { "value": { "enum": [ "CPN", "VPN", "Global", "Barcode" ], "type": "string" } }, "description": "The alternate type field. Select one of the following predefined types: CPN, VPN, Global, Barcode" }, "InventoryCrossReferenceUpdateDto": { "type": "object", "properties": { "alternateType": { "$ref": "#/components/schemas/alternateTypeInInventoryCrossReferenceUpdateDto" }, "bAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "alternateID": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "UpdateCostActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "ChangeInventoryNbrActionDto": { "type": "object", "properties": { "inventoryNbr": { "type": "string" } } }, "ChangeInventoryNbrActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "warehouseInInventoryAdjustmentLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Warehouse* > The warehouse where the item is stocked." }, "inventoryItemInInventoryAdjustmentLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Item ID* > The ID of the goods to be transferred." }, "locationInInventoryAdjustmentLineDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Location > The warehouse location from which the goods are transferred." }, "reasonCodeInInventoryAdjustmentLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Reason code > The reason code associated with the transferred goods." }, "InventoryAdjustmentLineDto": { "type": "object", "properties": { "warehouse": { "$ref": "#/components/schemas/warehouseInInventoryAdjustmentLineDto" }, "unitCost": { "type": "number", "description": "Unit cost > The cost of the unit used as base unit for the stock item.", "format": "double" }, "extCost": { "type": "number", "description": "Cost > The cost of the item.", "format": "double" }, "receiptNumber": { "type": "string", "description": "Receipt no. > Reference number for the receipt for the stock item." }, "poReceiptNumber": { "type": "string", "description": "Purchase order receipt number" }, "lineNumber": { "type": "integer", "format": "int32" }, "inventoryItem": { "$ref": "#/components/schemas/inventoryItemInInventoryAdjustmentLineDto" }, "location": { "$ref": "#/components/schemas/locationInInventoryAdjustmentLineDto" }, "quantity": { "type": "number", "description": "Quantity > The quantity of the transferred goods (in the units indicated below).", "format": "double" }, "uom": { "type": "string", "description": "Mandatory field: UoM* > The unit of measure (UoM) used for the goods to be transferred." }, "reasonCode": { "$ref": "#/components/schemas/reasonCodeInInventoryAdjustmentLineDto" }, "description": { "type": "string", "description": "Description > A brief description of the goods transfer transaction." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "branchNumber": { "$ref": "#/components/schemas/BranchNumberDto" } } }, "branchNumberInInventoryAdjustmentDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Branch associated" }, "InventoryAdjustmentDto": { "type": "object", "properties": { "totalCost": { "type": "number", "description": "The top part > Total cost > The total cost of the inventory items received. The system automatically calculates this value as a sum of all extended cost values of all received inventory items listed in the Transaction Details tab of this form.", "format": "double" }, "controlCost": { "type": "number", "description": "The top part > Control cost > The manually entered cost of stock items listed in the adjustment. Control cost is available only if the Validate document totals on Entry option is selected on the Inventory preferences window. The user enters this value manually to confirm the total cost as calculated automatically for the document. If the Control Cost and Total Cost values do not match, the system generates a warning message and the document cannot be saved.", "format": "double" }, "adjusmentLines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryAdjustmentLineDto" }, "description": "Transaction details tab > The inventory adjusment lines" }, "referenceNumber": { "type": "string", "description": "The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form." }, "status": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string", "description": " The current status of the receipt. The following options are available: \r\nOn Hold:The receipt/issue is a draft and can be edited. Receipts with this status cannot be released.\r\nBalanced: The receipt/issue data has been validated by the system and the receipt can be released. It also can be modified or deleted, but changes can be saved only if the receipt is balanced.\r\nReleased: The receipt/issue has been released and cannot be edited or deleted." }, "hold": { "type": "boolean", "description": "A check box that you select to give the receipt the On Hold status. Clear the check box to save the receipt with the Balanced status." }, "date": { "type": "string", "description": "The date when the inventory document was created. All transactions included in this document will have this transaction date.", "format": "date-time" }, "postPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format MMYYYY." }, "externalReference": { "type": "string", "description": "The external reference number of the inventory issue document (for example, the vendor’s reference code)." }, "description": { "type": "string", "description": "A brief description of the inventory issue or its transactions." }, "totalQuantity": { "type": "number", "description": "The total quantity of inventory items, which the system calculates automatically, for the document.", "format": "double" }, "controlQuantity": { "type": "number", "description": "The manually entered quantity of inventory items. Control Qty. is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Qty. and Total Qty.values do not match, the system generates a warning message and the issue cannot be saved.", "format": "double" }, "batchNumber": { "type": "string", "description": "The reference number of the batch generated for the receipt. Click the number to open the Journal Transactions (GL.30.10.00) form and view the details of the transactions." }, "lastModifiedDateTime": { "type": "string", "description": "The date when the document was last modified.", "format": "date-time" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInInventoryAdjustmentDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "The data containing information about the document attachments" }, "timestamp": { "type": "string", "description": "Timestamp of the inventory document" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a inventory issue in InventoryIssueController. Used by getting data." }, "InventoryAdjustmentLineUpdateDto": { "type": "object", "properties": { "warehouseId": { "$ref": "#/components/schemas/DtoValueOfString" }, "unitCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "extCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "receiptNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectId": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTaskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "controlCostInInventoryAdjustmentUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The manually entered summary cost for all specified inventory adjustment items." }, "referenceNumberInInventoryAdjustmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form." }, "holdInInventoryAdjustmentUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "A check box that you select to give the receipt the On Hold status. Clear the check box to save the receipt with the Balanced status." }, "dateInInventoryAdjustmentUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "The date when the receipt was created. All transactions included in this document will have this transaction date." }, "postPeriodInInventoryAdjustmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "externalReferenceInInventoryAdjustmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The external reference number of the inventory issue document (for example, the vendor’s reference code)." }, "descriptionInInventoryAdjustmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A brief description of the inventory issue or its transactions." }, "controlQuantityInInventoryAdjustmentUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The manually entered quantity of inventory items. Control Qty. is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Qty. and Total Qty.values do not match, the system generates a warning message and the issue cannot be saved." }, "branchNumberInInventoryAdjustmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Branch associated" }, "InventoryAdjustmentUpdateDto": { "type": "object", "properties": { "controlCost": { "$ref": "#/components/schemas/controlCostInInventoryAdjustmentUpdateDto" }, "adjustmentLines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryAdjustmentLineUpdateDto" }, "description": "The inventory adjustment lines" }, "referenceNumber": { "$ref": "#/components/schemas/referenceNumberInInventoryAdjustmentUpdateDto" }, "hold": { "$ref": "#/components/schemas/holdInInventoryAdjustmentUpdateDto" }, "date": { "$ref": "#/components/schemas/dateInInventoryAdjustmentUpdateDto" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInInventoryAdjustmentUpdateDto" }, "externalReference": { "$ref": "#/components/schemas/externalReferenceInInventoryAdjustmentUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInInventoryAdjustmentUpdateDto" }, "controlQuantity": { "$ref": "#/components/schemas/controlQuantityInInventoryAdjustmentUpdateDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInInventoryAdjustmentUpdateDto" } }, "description": "This class represents a inventory issue in InventoryIssueController. Used by getting data." }, "InventoryDocumentQueryParameters": { "type": "object", "properties": { "status": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string" }, "date": { "type": "string", "description": "The date when the inventory document was created\r\n \r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__." }, "dateCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records usind the __Date__ filter.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__." }, "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ReleaseInventoryDocumentActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "INAllocationsDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/LocationDescriptionDto" }, "lotSerialNumber": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "uom": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" } }, "description": "This class represents Allocation/Kit Allocation. Used for getting data." }, "warehouseInInventoryIssueLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Warehouse > (This column appears only if the Warehouses functionality is enabled in your system.) The warehouse from which the item is issued." }, "projectInInventoryIssueLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project" }, "projectTaskInInventoryIssueLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project Task" }, "inventoryItemInInventoryIssueLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Item ID* > The ID of the goods to be transferred." }, "locationInInventoryIssueLineDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Location > The warehouse location from which the goods are transferred." }, "reasonCodeInInventoryIssueLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Reason code > The reason code associated with the transferred goods." }, "InventoryIssueLineDto": { "type": "object", "properties": { "transactionType": { "enum": [ "Issue", "Return", "Invoice", "DebitNote", "CreditNote" ], "type": "string", "description": "Trans. type > The type of inventory issue transaction. Select one of the following types: Issue, Return, Invoice, Debit note, Credit note." }, "warehouse": { "$ref": "#/components/schemas/warehouseInInventoryIssueLineDto" }, "unitCost": { "type": "number", "description": "Unit cost > The cost of the specified unit of this stock item.", "format": "double" }, "extCost": { "type": "number", "description": "Ext. cost > The extended cost of the specified stock item. An extended cost is calculated automatically as the unit cost multiplied by the quantity of units involved in this transaction.", "format": "double" }, "unitPrice": { "type": "number", "description": "Unit price > The price of the specified unit of this stock item.", "format": "double" }, "extPrice": { "type": "number", "description": "Ext. price > The extended price of the specified stock item, calculated automatically as the unit price multiplied by the quantity of the stock item involved in the inventory issue operation.", "format": "double" }, "project": { "$ref": "#/components/schemas/projectInInventoryIssueLineDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInInventoryIssueLineDto" }, "lotSerialNumber": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/INAllocationsDto" } }, "poReceiptNumber": { "type": "string", "description": "Purchase order receipt number" }, "lineNumber": { "type": "integer", "format": "int32" }, "inventoryItem": { "$ref": "#/components/schemas/inventoryItemInInventoryIssueLineDto" }, "location": { "$ref": "#/components/schemas/locationInInventoryIssueLineDto" }, "quantity": { "type": "number", "description": "Quantity > The quantity of the transferred goods (in the units indicated below).", "format": "double" }, "uom": { "type": "string", "description": "Mandatory field: UoM* > The unit of measure (UoM) used for the goods to be transferred." }, "reasonCode": { "$ref": "#/components/schemas/reasonCodeInInventoryIssueLineDto" }, "description": { "type": "string", "description": "Description > A brief description of the goods transfer transaction." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "branchNumber": { "$ref": "#/components/schemas/BranchNumberDto" } } }, "branchNumberInInventoryIssueDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Branch associated" }, "InventoryIssueDto": { "type": "object", "properties": { "totalAmount": { "type": "number", "description": "The top part > Total amount > The total amount, calculated as a sum of amounts for all inventory issue operations included in this issue document.", "format": "double" }, "controlAmount": { "type": "number", "description": "The top part > Control amount > The manually entered summary amount for all specified inventory items. Control Amount is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Amount and Total Amount values do not match, the system generates a warning message and the issue cannot be saved.", "format": "double" }, "issueLines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryIssueLineDto" }, "description": "Transaction details tab >" }, "referenceNumber": { "type": "string", "description": "The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form." }, "status": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string", "description": " The current status of the receipt. The following options are available: \r\nOn Hold:The receipt/issue is a draft and can be edited. Receipts with this status cannot be released.\r\nBalanced: The receipt/issue data has been validated by the system and the receipt can be released. It also can be modified or deleted, but changes can be saved only if the receipt is balanced.\r\nReleased: The receipt/issue has been released and cannot be edited or deleted." }, "hold": { "type": "boolean", "description": "A check box that you select to give the receipt the On Hold status. Clear the check box to save the receipt with the Balanced status." }, "date": { "type": "string", "description": "The date when the inventory document was created. All transactions included in this document will have this transaction date.", "format": "date-time" }, "postPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format MMYYYY." }, "externalReference": { "type": "string", "description": "The external reference number of the inventory issue document (for example, the vendor’s reference code)." }, "description": { "type": "string", "description": "A brief description of the inventory issue or its transactions." }, "totalQuantity": { "type": "number", "description": "The total quantity of inventory items, which the system calculates automatically, for the document.", "format": "double" }, "controlQuantity": { "type": "number", "description": "The manually entered quantity of inventory items. Control Qty. is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Qty. and Total Qty.values do not match, the system generates a warning message and the issue cannot be saved.", "format": "double" }, "batchNumber": { "type": "string", "description": "The reference number of the batch generated for the receipt. Click the number to open the Journal Transactions (GL.30.10.00) form and view the details of the transactions." }, "lastModifiedDateTime": { "type": "string", "description": "The date when the document was last modified.", "format": "date-time" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInInventoryIssueDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "The data containing information about the document attachments" }, "timestamp": { "type": "string", "description": "Timestamp of the inventory document" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a inventory issue in InventoryIssueController. Used by getting data." }, "INAllocationsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string", "description": "The operation > Insert=1, Update=2, Delete=3" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "lotSerialNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" } }, "description": "This class represents a Kit Allocations from Kit Assembly. Used to add/update data." }, "DtoValueOfNullableOfInventoryTransactionType": { "type": "object", "properties": { "value": { "enum": [ "Issue", "Return", "Invoice", "DebitNote", "CreditNote" ], "type": "string" } } }, "InventoryIssueLineUpdateDto": { "type": "object", "properties": { "warehouseId": { "$ref": "#/components/schemas/DtoValueOfString" }, "unitCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "extCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "unitPrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "extPrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "tranType": { "$ref": "#/components/schemas/DtoValueOfNullableOfInventoryTransactionType" }, "lotSerialNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/INAllocationsUpdateDto" } }, "costCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectId": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTaskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "controlAmountInInventoryIssueUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The manually entered summary amount for all specified inventory items. Control Amount is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Amount and Total Amount values do not match, the system generates a warning message and the issue cannot be saved." }, "referenceNumberInInventoryIssueUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form." }, "holdInInventoryIssueUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "A check box that you select to give the receipt the On Hold status. Clear the check box to save the receipt with the Balanced status." }, "dateInInventoryIssueUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "The date when the receipt was created. All transactions included in this document will have this transaction date." }, "postPeriodInInventoryIssueUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "externalReferenceInInventoryIssueUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The external reference number of the inventory issue document (for example, the vendor’s reference code)." }, "descriptionInInventoryIssueUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A brief description of the inventory issue or its transactions." }, "controlQuantityInInventoryIssueUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The manually entered quantity of inventory items. Control Qty. is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Qty. and Total Qty.values do not match, the system generates a warning message and the issue cannot be saved." }, "branchNumberInInventoryIssueUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Branch associated" }, "InventoryIssueUpdateDto": { "type": "object", "properties": { "controlAmount": { "$ref": "#/components/schemas/controlAmountInInventoryIssueUpdateDto" }, "issueLines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryIssueLineUpdateDto" }, "description": "The inventory issue lines" }, "referenceNumber": { "$ref": "#/components/schemas/referenceNumberInInventoryIssueUpdateDto" }, "hold": { "$ref": "#/components/schemas/holdInInventoryIssueUpdateDto" }, "date": { "$ref": "#/components/schemas/dateInInventoryIssueUpdateDto" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInInventoryIssueUpdateDto" }, "externalReference": { "$ref": "#/components/schemas/externalReferenceInInventoryIssueUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInInventoryIssueUpdateDto" }, "controlQuantity": { "$ref": "#/components/schemas/controlQuantityInInventoryIssueUpdateDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInInventoryIssueUpdateDto" } }, "description": "This class represents a inventory issue in InventoryIssueController. Used by getting data." }, "warehouseInInventoryReceiptLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Warehouse* > The warehouse where the stock item is received." }, "projectInInventoryReceiptLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project" }, "projectTaskInInventoryReceiptLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project Task" }, "inventoryItemInInventoryReceiptLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Item ID* > The ID of the goods to be transferred." }, "locationInInventoryReceiptLineDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Location > The warehouse location from which the goods are transferred." }, "reasonCodeInInventoryReceiptLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Reason code > The reason code associated with the transferred goods." }, "InventoryReceiptLineDto": { "type": "object", "properties": { "warehouse": { "$ref": "#/components/schemas/warehouseInInventoryReceiptLineDto" }, "unitCost": { "type": "number", "description": "Unit cost > The cost of a unit of the received stock item.", "format": "double" }, "extCost": { "type": "number", "description": "Cost > The extended cost of the received stock item. An extended cost is calculated automatically as the unit cost multiplied by the quantity (or amount) of item that was received.", "format": "double" }, "project": { "$ref": "#/components/schemas/projectInInventoryReceiptLineDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInInventoryReceiptLineDto" }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/INAllocationsDto" } }, "poReceiptNumber": { "type": "string", "description": "Purchase order receipt number" }, "lineNumber": { "type": "integer", "format": "int32" }, "inventoryItem": { "$ref": "#/components/schemas/inventoryItemInInventoryReceiptLineDto" }, "location": { "$ref": "#/components/schemas/locationInInventoryReceiptLineDto" }, "quantity": { "type": "number", "description": "Quantity > The quantity of the transferred goods (in the units indicated below).", "format": "double" }, "uom": { "type": "string", "description": "Mandatory field: UoM* > The unit of measure (UoM) used for the goods to be transferred." }, "reasonCode": { "$ref": "#/components/schemas/reasonCodeInInventoryReceiptLineDto" }, "description": { "type": "string", "description": "Description > A brief description of the goods transfer transaction." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "branchNumber": { "$ref": "#/components/schemas/BranchNumberDto" } } }, "branchNumberInInventoryReceiptDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Branch associated" }, "InventoryReceiptDto": { "type": "object", "properties": { "totalCost": { "type": "number", "description": "The top part > Total cost > The total cost of the inventory items received. The system automatically calculates this value as a sum of all extended cost values of all received inventory items listed in the Transaction Details tab of this form.", "format": "double" }, "controlCost": { "type": "number", "description": "The total cost of the inventory items to be received. Control Cost is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. The user enters this value manually to confirm the total cost as calculated automatically for the document. If the Control Cost and Total Cost values do not match, the system generates a warning message and the document cannot be saved.", "format": "double" }, "transferNumber": { "type": "string", "description": "The top part > Transfer no. > The transfer number for the receipt operation. (Enter this number only if the two-step transfer operation is performed.)" }, "receiptLines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptLineDto" }, "description": "The inventory receipt lines" }, "referenceNumber": { "type": "string", "description": "The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form." }, "status": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string", "description": " The current status of the receipt. The following options are available: \r\nOn Hold:The receipt/issue is a draft and can be edited. Receipts with this status cannot be released.\r\nBalanced: The receipt/issue data has been validated by the system and the receipt can be released. It also can be modified or deleted, but changes can be saved only if the receipt is balanced.\r\nReleased: The receipt/issue has been released and cannot be edited or deleted." }, "hold": { "type": "boolean", "description": "A check box that you select to give the receipt the On Hold status. Clear the check box to save the receipt with the Balanced status." }, "date": { "type": "string", "description": "The date when the inventory document was created. All transactions included in this document will have this transaction date.", "format": "date-time" }, "postPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format MMYYYY." }, "externalReference": { "type": "string", "description": "The external reference number of the inventory issue document (for example, the vendor’s reference code)." }, "description": { "type": "string", "description": "A brief description of the inventory issue or its transactions." }, "totalQuantity": { "type": "number", "description": "The total quantity of inventory items, which the system calculates automatically, for the document.", "format": "double" }, "controlQuantity": { "type": "number", "description": "The manually entered quantity of inventory items. Control Qty. is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Qty. and Total Qty.values do not match, the system generates a warning message and the issue cannot be saved.", "format": "double" }, "batchNumber": { "type": "string", "description": "The reference number of the batch generated for the receipt. Click the number to open the Journal Transactions (GL.30.10.00) form and view the details of the transactions." }, "lastModifiedDateTime": { "type": "string", "description": "The date when the document was last modified.", "format": "date-time" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInInventoryReceiptDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "The data containing information about the document attachments" }, "timestamp": { "type": "string", "description": "Timestamp of the inventory document" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a inventory issue in InventoryIssueController. Used by getting data." }, "InventoryReceiptLineAllocationsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "lotSerialNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" } }, "description": "Lot/serial allocations for stock components in kit assemblies.\r\nUsed for adding and updating allocations." }, "InventoryReceiptLineUpdateDto": { "type": "object", "properties": { "warehouseId": { "$ref": "#/components/schemas/DtoValueOfString" }, "unitCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "extCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptLineAllocationsUpdateDto" } }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectId": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTaskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "transferNumberInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form." }, "controlCostInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The manually entered summary amount for all specified inventory receipt items." }, "referenceNumberInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form." }, "holdInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "A check box that you select to give the receipt the On Hold status. Clear the check box to save the receipt with the Balanced status." }, "dateInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "The date when the receipt was created. All transactions included in this document will have this transaction date." }, "postPeriodInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "externalReferenceInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The external reference number of the inventory issue document (for example, the vendor’s reference code)." }, "descriptionInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A brief description of the inventory issue or its transactions." }, "controlQuantityInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The manually entered quantity of inventory items. Control Qty. is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Qty. and Total Qty.values do not match, the system generates a warning message and the issue cannot be saved." }, "branchNumberInInventoryReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Branch associated" }, "InventoryReceiptUpdateDto": { "type": "object", "properties": { "transferNumber": { "$ref": "#/components/schemas/transferNumberInInventoryReceiptUpdateDto" }, "controlCost": { "$ref": "#/components/schemas/controlCostInInventoryReceiptUpdateDto" }, "receiptLines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryReceiptLineUpdateDto" }, "description": "The inventory issue lines" }, "referenceNumber": { "$ref": "#/components/schemas/referenceNumberInInventoryReceiptUpdateDto" }, "hold": { "$ref": "#/components/schemas/holdInInventoryReceiptUpdateDto" }, "date": { "$ref": "#/components/schemas/dateInInventoryReceiptUpdateDto" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInInventoryReceiptUpdateDto" }, "externalReference": { "$ref": "#/components/schemas/externalReferenceInInventoryReceiptUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInInventoryReceiptUpdateDto" }, "controlQuantity": { "$ref": "#/components/schemas/controlQuantityInInventoryReceiptUpdateDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInInventoryReceiptUpdateDto" } }, "description": "This class represents a inventory issue in InventoryIssueController. Used by getting data." }, "InventorySummaryQueryParameters": { "type": "object", "properties": { "warehouse": { "type": "string" }, "location": { "type": "string" } } }, "LocationIdNameDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } } }, "inventoryInInventorySummaryDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: The top part > Item ID* > \tThe stock item for which you want to view data. Click the magnifier." }, "warehouseInInventorySummaryDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Warehouse > The warehouse for which you want to view data." }, "locationInInventorySummaryDto": { "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Location > The location for which you want to view data; select a location, or make no selection to view data for all locations." }, "InventorySummaryDto": { "type": "object", "properties": { "inventory": { "$ref": "#/components/schemas/inventoryInInventorySummaryDto" }, "warehouse": { "$ref": "#/components/schemas/warehouseInInventorySummaryDto" }, "location": { "$ref": "#/components/schemas/locationInInventorySummaryDto" }, "available": { "type": "number", "description": "The table > Available > The quantity of the stock items available at the specific warehouse and location.", "format": "double" }, "availableForShipment": { "type": "number", "description": "The table > Available for shipment > The quantity of the stock items available at the specific warehouse and location calculated based on the quantity on hand with the quantities shipped and on shipping deducted.", "format": "double" }, "notAvailable": { "type": "number", "description": "The table > Not available > The quantity of the stock items on locations for which the Include in qty. available option is not selected.", "format": "double" }, "soBooked": { "type": "number", "description": "The table > Sales order booked > The quantity of the stock items booked according to sales orders.", "format": "double" }, "soAllocated": { "type": "number", "description": "The table > Sales order allocated > The quantity of stock items set aside according to sales orders.", "format": "double" }, "soShipped": { "type": "number", "description": "The table > Sales orders shipped > The quantity of the stock items shipped according to the confirmed shipments.", "format": "double" }, "soBackOrdered": { "type": "number", "description": "The table > Back orders > The quantity of the stock items on sales orders with the Back order status.", "format": "double" }, "inIssues": { "type": "number", "description": "The table > Inventory issues > The quantity of the stock items included in the inventory issue documents that have not yet been released.", "format": "double" }, "inReceipts": { "type": "number", "description": "The table > Invnetory receipts > The quantity of the stock items included in the inventory receipt documents that have not yet been released.", "format": "double" }, "inTransit": { "type": "number", "description": "The table > In transit > The quantity of the stock items included as in transit quantities in the inventory transfer documents that have not yet been released.", "format": "double" }, "inAssemblyDemand": { "type": "number", "description": "The table > In assembly demand > The quantity of the stock items included in unreleased kit assembly documents as components or kits, depending on whether the item is a kit or a kit component.", "format": "double" }, "inAssemblySupply": { "type": "number", "description": "The table > In assembly supply > The quantity of the stock items listed on unreleased kit assembly documents.", "format": "double" }, "purchasePrepared": { "type": "number", "description": "The table > Purchase prepared > The quantity of the stock items listed on purchase orders pending approval and on hold.", "format": "double" }, "purchaseOrders": { "type": "number", "description": "The table > Purchase orders > The quantity of the stock items included in open purchase orders. To view the purchase orders, open the Purchase orders (PO301000) window.", "format": "double" }, "poReceipts": { "type": "number", "description": "The table > Purchase order receipts > The quantity of the stock items included in the purchase receipts that have not yet been released. To view the purchase receipts, open the Purchase receipts (PO302000) window.", "format": "double" }, "expired": { "type": "number", "description": "The table > Expired > The quantity of the stock items that has reached its expiration date.", "format": "double" }, "onHand": { "type": "number", "description": "The table > On hand > The quantity of the stock items available on hand at the specified warehouse and location.", "format": "double" }, "soToPurchase": { "type": "number", "description": "The table > Sales order to purchase > The quantity of the stock items included in unreleased sales orders requiring creating purchase orders.", "format": "double" }, "purchaseForSO": { "type": "number", "description": "The table > Purchase for sales order. > The quantity of the stock items listed on open purchase orders created for sales orders.", "format": "double" }, "purchaseForSOPrepared": { "type": "number", "description": "The table > Purchase for sales order prepared > The quantity of the stock items listed on purchase orders yet on hold or pending approval and created for back orders.", "format": "double" }, "purchaseForSOReceipts": { "type": "number", "description": "The table > Purchase for sales order receipts > The quantity of the stock items listed on purchase receipts for orders that were created for sales orders.", "format": "double" }, "soToDropShip": { "type": "number", "description": "The table > Sales order to drop-ship > The quantity of the stock items included in open purchase orders created for drop-ship orders.", "format": "double" }, "dropShipForSO": { "type": "number", "description": "The table > Drop-ship for sales order > The quantity of the stock items listed on open drop-ship orders. This value is not included in the quantity available.", "format": "double" }, "dropShipForSOPrepared": { "type": "number", "description": "The table > Drop-ship for sales order, prepared > The quantity of the stock items listed on drop-ship sales orders with a status of On hold or Pending approval; this value is not included in the quantity available.", "format": "double" }, "dropShipForSOReceipts": { "type": "number", "description": "The table > Drop-ship for sales order, receipts > The quantity of the stock items listed on receipts for drop-ship sales orders; this value is not included in the quantity available.", "format": "double" }, "baseUnit": { "type": "string", "description": "The table > Base unit > The unit of measure (UoM) selected as the base unit for the stock items in the Stock items (IN202500) window." }, "estimatedUnitCost": { "type": "number", "description": "The table > Estimated unit cost > The estimated unit cost of the selected stock items.", "format": "double" }, "estimatedTotalCost": { "type": "number", "description": "The table > Estimated total cost > The estimated total cost of the stock items available at the specified warehouse and location.", "format": "double" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a InventorySummary in InventorySummaryController. Used by getting data." }, "AllocationsBasicDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/LocationDescriptionDto" }, "lotSerialNumber": { "type": "string" }, "quantity": { "type": "number", "format": "double" } }, "description": "This class represents a basic Allocation/Kit Allocation" }, "inventoryItemInInventoryTransferLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Item ID* > The ID of the goods to be transferred." }, "locationInInventoryTransferLineDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Location > The warehouse location from which the goods are transferred." }, "reasonCodeInInventoryTransferLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Reason code > The reason code associated with the transferred goods." }, "InventoryTransferLineDto": { "type": "object", "properties": { "toLocation": { "$ref": "#/components/schemas/LocationDescriptionDto" }, "lotSerialNumber": { "type": "string" }, "expirationDate": { "type": "string", "format": "date-time" }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationsBasicDto" } }, "lineNumber": { "type": "integer", "format": "int32" }, "inventoryItem": { "$ref": "#/components/schemas/inventoryItemInInventoryTransferLineDto" }, "location": { "$ref": "#/components/schemas/locationInInventoryTransferLineDto" }, "quantity": { "type": "number", "description": "Quantity > The quantity of the transferred goods (in the units indicated below).", "format": "double" }, "uom": { "type": "string", "description": "Mandatory field: UoM* > The unit of measure (UoM) used for the goods to be transferred." }, "reasonCode": { "$ref": "#/components/schemas/reasonCodeInInventoryTransferLineDto" }, "description": { "type": "string", "description": "Description > A brief description of the goods transfer transaction." }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "branchNumber": { "$ref": "#/components/schemas/BranchNumberDto" } } }, "warehouseInInventoryTransferDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part > From warehouse* > The warehouse from which the goods are transferred." }, "toWarehouseInInventoryTransferDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part > To warehouse > The warehouse to which the goods are transferred." }, "branchNumberInInventoryTransferDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Branch associated" }, "InventoryTransferDto": { "type": "object", "properties": { "warehouse": { "$ref": "#/components/schemas/warehouseInInventoryTransferDto" }, "toWarehouse": { "$ref": "#/components/schemas/toWarehouseInInventoryTransferDto" }, "transferLines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTransferLineDto" }, "description": "The Transaction details tab > The inventory transfer lines" }, "referenceNumber": { "type": "string", "description": "The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form." }, "status": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string", "description": " The current status of the receipt. The following options are available: \r\nOn Hold:The receipt/issue is a draft and can be edited. Receipts with this status cannot be released.\r\nBalanced: The receipt/issue data has been validated by the system and the receipt can be released. It also can be modified or deleted, but changes can be saved only if the receipt is balanced.\r\nReleased: The receipt/issue has been released and cannot be edited or deleted." }, "hold": { "type": "boolean", "description": "A check box that you select to give the receipt the On Hold status. Clear the check box to save the receipt with the Balanced status." }, "date": { "type": "string", "description": "The date when the inventory document was created. All transactions included in this document will have this transaction date.", "format": "date-time" }, "postPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format MMYYYY." }, "externalReference": { "type": "string", "description": "The external reference number of the inventory issue document (for example, the vendor’s reference code)." }, "description": { "type": "string", "description": "A brief description of the inventory issue or its transactions." }, "totalQuantity": { "type": "number", "description": "The total quantity of inventory items, which the system calculates automatically, for the document.", "format": "double" }, "controlQuantity": { "type": "number", "description": "The manually entered quantity of inventory items. Control Qty. is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Qty. and Total Qty.values do not match, the system generates a warning message and the issue cannot be saved.", "format": "double" }, "batchNumber": { "type": "string", "description": "The reference number of the batch generated for the receipt. Click the number to open the Journal Transactions (GL.30.10.00) form and view the details of the transactions." }, "lastModifiedDateTime": { "type": "string", "description": "The date when the document was last modified.", "format": "date-time" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInInventoryTransferDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "The data containing information about the document attachments" }, "timestamp": { "type": "string", "description": "Timestamp of the inventory document" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a inventory issue in InventoryIssueController. Used by getting data." }, "AllocationsUpdateBasicDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string", "description": "The operation > Insert=1, Update=2, Delete=3" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "lotSerialNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" } }, "description": "This class represents an Allocation. Used to add/update data." }, "InventoryTransferLineUpdateDto": { "type": "object", "properties": { "toLocationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "lotSerialNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationsUpdateBasicDto" } }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectId": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTaskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "referenceNumberInInventoryTransferUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The unique reference number of the receipt, which the system automatically assigns according to the numbering sequence selected for receipts on the Inventory Preferences IN.10.10.00) form." }, "holdInInventoryTransferUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "A check box that you select to give the receipt the On Hold status. Clear the check box to save the receipt with the Balanced status." }, "dateInInventoryTransferUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "The date when the receipt was created. All transactions included in this document will have this transaction date." }, "postPeriodInInventoryTransferUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "externalReferenceInInventoryTransferUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The external reference number of the inventory issue document (for example, the vendor’s reference code)." }, "descriptionInInventoryTransferUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A brief description of the inventory issue or its transactions." }, "controlQuantityInInventoryTransferUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The manually entered quantity of inventory items. Control Qty. is available only if the Validate Document Totals on Entry option is selected on the Inventory Preferences form. If the Control Qty. and Total Qty.values do not match, the system generates a warning message and the issue cannot be saved." }, "branchNumberInInventoryTransferUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Branch associated" }, "InventoryTransferUpdateDto": { "type": "object", "properties": { "warehouseId": { "$ref": "#/components/schemas/DtoValueOfString" }, "toWarehouseId": { "$ref": "#/components/schemas/DtoValueOfString" }, "transferLines": { "type": "array", "items": { "$ref": "#/components/schemas/InventoryTransferLineUpdateDto" }, "description": "The inventory issue lines" }, "referenceNumber": { "$ref": "#/components/schemas/referenceNumberInInventoryTransferUpdateDto" }, "hold": { "$ref": "#/components/schemas/holdInInventoryTransferUpdateDto" }, "date": { "$ref": "#/components/schemas/dateInInventoryTransferUpdateDto" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInInventoryTransferUpdateDto" }, "externalReference": { "$ref": "#/components/schemas/externalReferenceInInventoryTransferUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInInventoryTransferUpdateDto" }, "controlQuantity": { "$ref": "#/components/schemas/controlQuantityInInventoryTransferUpdateDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInInventoryTransferUpdateDto" } }, "description": "This class represents a inventory issue in InventoryIssueController. Used by getting data." }, "InventoryTransferDocumentQueryParameters": { "type": "object", "properties": { "warehouse": { "type": "string", "description": "Inventory transfer's source warehouse" }, "toWarehouse": { "type": "string", "description": "Inventory transfer's target warehouse" }, "status": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string" }, "date": { "type": "string", "description": "The date when the inventory document was created\r\n \r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__." }, "dateCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records usind the __Date__ filter.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Date__ and __DateCondition__ are __mutually inclusive__." }, "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "VatDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "subaccountInJournalTransactionLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: The table > Subaccount > The subaccount used with the account to detail a journal entry." }, "vatCodeInJournalTransactionLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The table > VAT code > The VAT code based on which the taxable amount is calculated." }, "vatInJournalTransactionLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The table > VAT ID > The VAT used to calculate the VAT amount." }, "projectInJournalTransactionLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The table > Project > The project with which this batch is associated, or the code indicating that this batch is not associated with any project." }, "projectTaskInJournalTransactionLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The table > Project task > The particular task of the project with which this batch is associated." }, "JournalTransactionLineDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "The table > Number at the left indicating the line number of the table.", "format": "int32" }, "accountNumber": { "type": "string", "description": "Mandatory field: The table > Account* > The account (associated with the specified branch) whose balance will be updated by the journal entry." }, "description": { "type": "string", "description": "The table > Description > A detailed description provided by a user or generated by the system." }, "subaccount": { "$ref": "#/components/schemas/subaccountInJournalTransactionLineDto" }, "referenceNumber": { "type": "string", "description": "The table > Ref. no. > The reference number of the external or internal document associated with the journal transaction." }, "debitAmount": { "type": "number", "description": "The table > Debit amount > The debit amount of the journal entry.", "format": "double" }, "debitAmountInCurrency": { "type": "number", "description": "Background calculation giving you the debit amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "creditAmount": { "type": "number", "description": "The table > Credit amount > The credit amount of the journal entry.", "format": "double" }, "creditAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Credit amount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "transactionDescription": { "type": "string", "description": "The table > Transaction Description > A description of the transaction or any comments relevant to the transaction." }, "vatCode": { "$ref": "#/components/schemas/vatCodeInJournalTransactionLineDto" }, "vat": { "$ref": "#/components/schemas/vatInJournalTransactionLineDto" }, "branch": { "type": "string", "description": "The table > Branch > The branch associated with this journal entry." }, "customerSupplier": { "type": "string", "description": "The table > Customer/Supplier > The customer or supplier associated with the entry." }, "transactionType": { "type": "string", "description": "The top part > Type > The type of this general ledger batch, which is specified by the system automatically." }, "module": { "enum": [ "ModuleGL", "ModuleAP", "ModuleAR", "ModuleCA", "ModuleCM", "ModuleIN", "ModuleSO", "ModulePO", "ModuleDR", "ModuleFA", "ModuleEP", "ModulePM", "ModuleTX", "ModuleCR" ], "type": "string", "description": "The workspace where the batch originates. See module in the Top part > Workspace" }, "uom": { "type": "string", "description": "The table > UoM > The quantity of items associated with the transaction, if relevant." }, "project": { "$ref": "#/components/schemas/projectInJournalTransactionLineDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInJournalTransactionLineDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "quantity": { "type": "number", "description": "The table > Quantity > The quantity of items associated with the transaction, if relevant.", "format": "double" }, "inventoryNumber": { "type": "string", "description": "Item ID > The item ID of the line item, if applicable." }, "note": { "type": "string" } } }, "JournalTransactionDto": { "type": "object", "properties": { "module": { "enum": [ "ModuleGL", "ModuleAP", "ModuleAR", "ModuleCA", "ModuleCM", "ModuleIN", "ModuleSO", "ModulePO", "ModuleDR", "ModuleFA", "ModuleEP", "ModulePM", "ModuleTX", "ModuleCR" ], "type": "string", "description": "The top part > Workspace > The workspace where the batch originates. New batches can be created only for General ledger." }, "batchNumber": { "type": "string", "description": "The top part > Batch number > The unique ID of the batch, which is generated by the numbering sequence assigned to batches in the GL102000 window." }, "status": { "enum": [ "Hold", "Balanced", "Unposted", "Posted", "Completed", "Voided", "Released", "PartiallyReleased", "Scheduled" ], "type": "string", "description": "The top part > Status > The current status of the batch. The status defines what processing can be applied to the batch. The following options are available: On hold, Balanced, Scheduled, Unposted, Posted, Void." }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the batch has the On hold status and cannot be released or posted. You can clear the check box only if the batch has total debits equal to total credits." }, "transactionDate": { "type": "string", "description": "Mandatory field: The top part > Transaction date* > The date when the batch was created, which relates to the transaction dates of the journal entries.", "format": "date-time" }, "postPeriod": { "type": "string", "description": "Mandatory field: The top part > Post period* > The financial period to which the transactions recorded in the document should be posted. Format MMYYYY." }, "financialPeriod": { "type": "string", "description": "Mandatory field: The top part Post period* > The financial period to which the transactions should be posted. Format YYYYMM." }, "ledger": { "type": "string", "description": "Mandatory field: The top part > Ledger* > The unique ID of the ledger to which batch transactions are posted. By default, it is the default posting ledger specified for the branch in the GL101010 window, but another posting ledger can be selected." }, "ledgerDescription": { "type": "string", "description": "Mandatory field: The top part > Ledger* > Click the magnifier > The description of the ledger to which batch transactions are posted. By default, it is the default posting ledger specified for the branch in the GL101010 window, but another posting ledger can be selected." }, "currencyId": { "type": "string", "description": "The top part > Currency > The currency used for all the journal transactions in the selected batch." }, "exchangeRate": { "type": "number", "description": "Ingformation collected from the system to calculate currency amount.", "format": "double" }, "autoReversing": { "type": "boolean", "description": "The top part > Automatic reversing > A check box that indicates (if selected) that the batch is auto-reversing." }, "reversingEntry": { "type": "boolean", "description": "The top part > Reversing entry > A check box that indicates (if selected) that the batch is a reversing batch. The Orig.batch number field displays the ID of the batch that was reversed by this batch." }, "description": { "type": "string", "description": "The top part > Description > A description of the batch." }, "originalBatchNumber": { "type": "string", "description": "The top part > Orig. batch number > For a scheduled or auto-reversing batch, the reference number of the batch used as a template." }, "debitTotal": { "type": "number", "description": "The top part > Debit total > The total of transaction debit amounts for the batch; the value is calculated automatically.", "format": "double" }, "debitTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Debit total in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "creditTotal": { "type": "number", "description": "The top part > Credit total > The total of transaction credit amounts for the batch; the value is calculated automatically.", "format": "double" }, "creditTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Credit total in your default currency. This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "controlTotal": { "type": "number", "description": "The top part > Control total > The control total of the batch, which is used for batch status validation.", "format": "double" }, "controlTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Control total in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "createVatTransaction": { "type": "boolean", "description": "The top part > Create VAT transactions > A check box that indicates (if selected) that a VAT-related transaction can be created manually; select this check box when you begin to create the transaction." }, "skipVatAmountValidation": { "type": "boolean", "description": "The top part > Skip VAT amount validation > A check box that (if selected) causes automatic validation of a VAT-related transaction that you create manually to be skipped." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "transactionCode": { "type": "string" }, "transactionCodeDescription": { "type": "string", "description": "The Table part > Transaction description > A description of the transaction or any comments relevant to the transaction." }, "branch": { "type": "string", "description": "The top part > Branch > The branch to which this batch is related. This field is available if your company is set up with branches." }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "journalTransactionLines": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransactionLineDto" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a journal transaction in JournalTransactionController. Used by getting data." }, "JournalTransactionLineUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "accountNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "project": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTask": { "$ref": "#/components/schemas/DtoValueOfString" }, "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "transactionDescription": { "$ref": "#/components/schemas/DtoValueOfString" }, "debitAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "creditAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "vatCodeId": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatId": { "$ref": "#/components/schemas/DtoValueOfString" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "postPeriodInJournalTransactionUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "financialPeriodInJournalTransactionUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM." }, "JournalTransactionUpdateDto": { "type": "object", "properties": { "batchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "transactionDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInJournalTransactionUpdateDto" }, "financialPeriod": { "$ref": "#/components/schemas/financialPeriodInJournalTransactionUpdateDto" }, "ledger": { "$ref": "#/components/schemas/DtoValueOfString" }, "currencyId": { "$ref": "#/components/schemas/DtoValueOfString" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "autoReversing": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "controlTotalInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "createVatTransaction": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "skipVatAmountValidation": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "transactionCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "journalTransactionLines": { "type": "array", "items": { "$ref": "#/components/schemas/JournalTransactionLineUpdateDto" } } }, "description": "This class represents a journal transaction in JournalTransactionController. Used for creating/updating data." }, "JournalTransactionQueryV2Parameters": { "type": "object", "properties": { "periodId": { "type": "string", "description": "Financial Period to query data for. Mandatory if 'LastModifiedDateTime' not provided. Format: YYYYPP" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\nMandatory if 'PeriodId' is not provided. \r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```" }, "module": { "type": "string", "description": "Module to query data for. Allowed values: GL, AP, AR, CM, CA, IN, DR, FA, PM" }, "status": { "enum": [ "Hold", "Balanced", "Unposted", "Posted", "Voided", "Scheduled", "Unreleased" ], "type": "string", "description": "Journal transaction status to query data for. Available statuses : Hold, Balanced, Unposted, Posted, Voided, Scheduled, Unreleased." }, "expandAttachments": { "type": "boolean", "description": "If true, includes all attachments for batch. Default is false." }, "branch": { "type": "string", "description": "Branch to query data for." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ReleaseJournalTransactionActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "KitAssemblyQueryParameters": { "type": "object", "properties": { "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string", "description": "System retrieved information for state/condition." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "type": { "type": "string" }, "refNo": { "type": "string" }, "status": { "enum": [ "H", "B", "R" ], "type": "string", "description": "Filter by Kit Assembly Status. Possible values: H (Hold), B (Balanced), R (Released)" }, "expandStockComponents": { "type": "boolean" }, "expandNonStockComponents": { "type": "boolean" }, "expandKitAllocations": { "type": "boolean" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "KitAssemblyNonStockComponentDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "format": "int32" }, "itemId": { "type": "string" }, "description": { "type": "string" }, "uoM": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "unitCost": { "type": "number", "format": "double" }, "reasonCode": { "type": "string" }, "componentQty": { "type": "number", "format": "double" }, "allowComponentQtyVariance": { "type": "boolean" }, "minComponentQty": { "type": "number", "format": "double" }, "maxComponentQty": { "type": "number", "format": "double" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "KitAssemblyStockComponentsDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "format": "int32" }, "itemId": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "string" }, "uoM": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "unitCost": { "type": "number", "format": "double" }, "reasonCode": { "type": "string" }, "componentQty": { "type": "number", "format": "double" }, "minComponentQty": { "type": "number", "format": "double" }, "allowComponentQtyVariance": { "type": "boolean" }, "maxComponentQty": { "type": "number", "format": "double" }, "allowComponentSubstitution": { "type": "boolean" }, "disassemblyCoeff": { "type": "number", "format": "double" }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/INAllocationsDto" } }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "KitAssemblyDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Type, possible values: P - Production, D - Disassembly" }, "refNo": { "type": "string" }, "status": { "type": "string", "description": "Status, possible values: H - On Hold, B - Balanced, R - Released" }, "hold": { "type": "boolean" }, "date": { "type": "string", "format": "date-time" }, "postPeriod": { "type": "string" }, "itemID": { "type": "string" }, "revision": { "type": "string" }, "reasonCode": { "type": "string" }, "description": { "type": "string" }, "warehouse": { "type": "string" }, "location": { "type": "string" }, "uoM": { "type": "string" }, "quantity": { "type": "number", "format": "double" }, "createdDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "salesOrderLink": { "type": "string" }, "stockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyStockComponentsDto" } }, "nonStockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyNonStockComponentDto" } }, "kitAllocations": { "type": "array", "items": { "$ref": "#/components/schemas/INAllocationsDto" } }, "timestamp": { "type": "string", "description": "Timestamp of the kit assembly record" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "BasePaginationDtoOfKitAssemblyDto": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyDto" } } } }, "KitAssemblyNonStockComponentsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "itemId": { "$ref": "#/components/schemas/DtoValueOfString" }, "uoM": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "unitCost": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "KitAssemblyStockComponentAllocationsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "itemId": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "lotSerialNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" } }, "description": "Lot/serial allocations for stock components in kit assemblies.\r\nUsed for adding and updating allocations." }, "KitAssemblyStockComponentsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "itemId": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "uoM": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "unitCost": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "stockComponentLineAllocations": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyStockComponentAllocationsUpdateDto" } } } }, "orderTypeInKitAssemblyLinkInsertDto": { "properties": { "value": { "type": "string" } }, "description": "Reference to the order type that the kit assembly is connected to" }, "orderNumberInKitAssemblyLinkInsertDto": { "properties": { "value": { "type": "string" } }, "description": "Reference to the order number that the kit assembly is connected to" }, "orderLineNumberInKitAssemblyLinkInsertDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "Reference to the order line number that the kit assembly is connected to" }, "KitAssemblyLinkInsertDto": { "type": "object", "properties": { "orderType": { "$ref": "#/components/schemas/orderTypeInKitAssemblyLinkInsertDto" }, "orderNumber": { "$ref": "#/components/schemas/orderNumberInKitAssemblyLinkInsertDto" }, "orderLineNumber": { "$ref": "#/components/schemas/orderLineNumberInKitAssemblyLinkInsertDto" } } }, "KitAssemblyInsertDto": { "type": "object", "properties": { "kitAssemblyLink": { "$ref": "#/components/schemas/KitAssemblyLinkInsertDto" }, "type": { "type": "string", "description": "Type, possible values: P - Production, D - Disassembly" }, "refNo": { "type": "string" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "postPeriod": { "$ref": "#/components/schemas/DtoValueOfString" }, "itemId": { "$ref": "#/components/schemas/DtoValueOfString" }, "revision": { "$ref": "#/components/schemas/DtoValueOfString" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "warehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "uoM": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "stockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyStockComponentsUpdateDto" } }, "stockComponentAllocations": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyStockComponentAllocationsUpdateDto" }, "description": "This property is deprecated and will be removed in a future version. \r\nUse StockComponentLineAllocations within each StockComponentLine instead." }, "nonStockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyNonStockComponentsUpdateDto" } }, "kitAllocations": { "type": "array", "items": { "$ref": "#/components/schemas/INAllocationsUpdateDto" } } } }, "KitAssemblyUpdateDto": { "type": "object", "properties": { "type": { "type": "string", "description": "Type, possible values: P - Production, D - Disassembly" }, "refNo": { "type": "string" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "postPeriod": { "$ref": "#/components/schemas/DtoValueOfString" }, "itemId": { "$ref": "#/components/schemas/DtoValueOfString" }, "revision": { "$ref": "#/components/schemas/DtoValueOfString" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "warehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "uoM": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "stockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyStockComponentsUpdateDto" } }, "stockComponentAllocations": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyStockComponentAllocationsUpdateDto" }, "description": "This property is deprecated and will be removed in a future version. \r\nUse StockComponentLineAllocations within each StockComponentLine instead." }, "nonStockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitAssemblyNonStockComponentsUpdateDto" } }, "kitAllocations": { "type": "array", "items": { "$ref": "#/components/schemas/INAllocationsUpdateDto" } } } }, "KitSpecificationsQueryParameters": { "type": "object", "properties": { "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string" }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "kitInventoryID": { "type": "string" }, "revisionID": { "type": "string" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "KitSpecificationNonStockComponentDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "format": "int32" }, "componentID": { "type": "string" }, "componentQty": { "type": "number", "format": "double" }, "uom": { "type": "string" }, "allowComponentQtyVariance": { "type": "boolean" }, "minComponentQty": { "type": "number", "format": "double" }, "maxComponentQty": { "type": "number", "format": "double" }, "description": { "type": "string" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "KitSpecificationStockComponentsDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "format": "int32" }, "componentID": { "type": "string" }, "componentQty": { "type": "number", "format": "double" }, "uom": { "type": "string" }, "allowComponentQtyVariance": { "type": "boolean" }, "minComponentQty": { "type": "number", "format": "double" }, "maxComponentQty": { "type": "number", "format": "double" }, "disassemblyCoeff": { "type": "number", "format": "double" }, "allowComponentSubstitution": { "type": "boolean" }, "description": { "type": "string" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "KitSpecificationDto": { "type": "object", "properties": { "kitInventoryID": { "type": "string" }, "revision": { "type": "string" }, "description": { "type": "string" }, "isActive": { "type": "boolean" }, "allowComponentAddition": { "type": "boolean" }, "isNonStock": { "type": "boolean" }, "createdDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "stockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitSpecificationStockComponentsDto" } }, "nonStockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitSpecificationNonStockComponentDto" } }, "timestamp": { "type": "string", "description": "Timestamp of the kit specification record" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "BasePaginationDtoOfKitSpecificationDto": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/KitSpecificationDto" } } } }, "KitSpecificationNonStockComponentsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "compInventoryID": { "$ref": "#/components/schemas/DtoValueOfString" }, "dfltCompQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "allowQtyVariation": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "minCompQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "maxCompQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" } } }, "KitSpecificationStockComponentsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "compInventoryID": { "$ref": "#/components/schemas/DtoValueOfString" }, "dfltCompQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "allowQtyVariation": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "minCompQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "maxCompQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "disassemblyCoeff": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "allowSubstitution": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" } } }, "KitSpecificationUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "kitInventoryID": { "$ref": "#/components/schemas/DtoValueOfString" }, "revisionID": { "$ref": "#/components/schemas/DtoValueOfString" }, "descr": { "$ref": "#/components/schemas/DtoValueOfString" }, "isActive": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "allowCompAddition": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "isNonStock": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "stockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitSpecificationStockComponentsUpdateDto" } }, "nonStockComponentLines": { "type": "array", "items": { "$ref": "#/components/schemas/KitSpecificationNonStockComponentsUpdateDto" } } } }, "LandedCostCodeDto": { "type": "object", "properties": { "landedCostCodeId": { "type": "string", "description": "Landed Cost Code" }, "description": { "type": "string", "description": "Description" }, "landedCostType": { "enum": [ "FreightAndMisOriginCharges", "CustomDuties", "VAT", "MiscDestinationCharges", "Other" ], "type": "string", "description": "Type" }, "applicationMethod": { "enum": [ "FromAP", "FromPO", "FromBoth" ], "type": "string", "description": "Application Method" }, "allocationMethod": { "enum": [ "ByQuantity", "ByCost", "ByWeight", "ByVolume", "None" ], "type": "string", "description": "Allocation Method" }, "supplierId": { "type": "string", "description": "Supplier ID" }, "supplierLocationId": { "type": "string", "description": "Supplier Location ID" }, "terms": { "type": "string", "description": "Terms" }, "reasonCode": { "type": "string", "description": "Reason Code" }, "landedCostAccrualAccount": { "type": "string", "description": "Landed Cost Accrual Account" }, "landedCostAccrualSubaccount": { "type": "string", "description": "Landed Cost Accrual Sub." }, "vatCategory": { "type": "string", "description": "Tax Category" }, "landedCostVarianceAccount": { "type": "string", "description": "Landed Cost Variance Account" }, "landedCostVarianceSubaccount": { "type": "string", "description": "Landed Cost Variance Sub." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "LandedCostQueryParameters": { "type": "object", "properties": { "code": { "type": "string", "description": "Landed Cost Code" }, "greaterThanValue": { "type": "string", "description": "Enter the from-value for Landed Cost Code" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "LedgerQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "Excludes ledgers with value lower than entry" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." } } }, "ConsolBranchDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } } }, "consolBranchInLedgerDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Consol. branch > The consolidation branch, which you create when a company has multiple branches that operate within a single legal entity and post transactions to the same ledger." }, "LedgerDto": { "type": "object", "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "Mandatory field: The top part > Ledger ID* > An alphanumeric string of up to 10 characters used to identify the ledger." }, "description": { "type": "string", "description": "The top part > Description > A detailed ledger description." }, "balanceType": { "enum": [ "Actual", "Report", "Statistical", "Budget" ], "type": "string", "description": "The top part > Balance type > The type of balance in the ledger. Select one of the following predefined types: Actual, Budget, Reporting, Statistical." }, "currencyId": { "type": "string", "description": "Mandatory field: The top part > Currency* > The default currency of the ledger." }, "consolidationSource": { "type": "boolean", "description": "The top part > Consolidation source > A check box that specifies, if selected, that the ledger should be used as a source ledger for consolidation." }, "consolBranch": { "$ref": "#/components/schemas/consolBranchInLedgerDto" }, "branchAccounting": { "type": "boolean", "description": "The top part > Branch accounting > A check box that you select to indicate that the system should automatically generate inter-branch transactions for this ledger to balance transactions for all branches involved." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "postInterCompany": { "type": "boolean", "description": "Branch accounting > True/False" } } }, "PeppolSchemeDto": { "type": "object", "properties": { "endpoint": { "type": "string", "description": "Seller electronic address identification scheme identifier.\r\nThe identification scheme identifier of the seller electronic address." }, "partyIdentification": { "type": "string", "description": "Buyer identifier identification scheme identifier.\r\nThe identification scheme identifier of the Buyer identifier." }, "partyLegal": { "type": "string", "description": "Seller legal registration identifier identification scheme identifier.\r\nThe identification scheme identifier of the Seller legal registration identifier." } } }, "baccountInLocationDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: The top part > Business connection* > The business account this location is associated with. Click the magnifier." }, "addressInLocationDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "General information tab > Location address section >" }, "contactInLocationDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "General information tab > Location contact section >" }, "vatZoneInLocationDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "General information tab > Location address section > VAT zone > The VAT zone associated with the account location." }, "peppolSchemeInLocationDto": { "properties": { "endpoint": { "type": "string", "description": "Seller electronic address identification scheme identifier.\r\nThe identification scheme identifier of the seller electronic address." }, "partyIdentification": { "type": "string", "description": "Buyer identifier identification scheme identifier.\r\nThe identification scheme identifier of the Buyer identifier." }, "partyLegal": { "type": "string", "description": "Seller legal registration identifier identification scheme identifier.\r\nThe identification scheme identifier of the Seller legal registration identifier." } }, "description": "Fields to be used when sending electronic invoices in PEPPOL BIS 3.0 format." }, "LocationDto": { "type": "object", "properties": { "baccount": { "$ref": "#/components/schemas/baccountInLocationDto" }, "locationId": { "type": "string", "description": "Mandatory field: The top part > Location ID* > The identifier of the location. Click the magnifier." }, "locationName": { "type": "string", "description": "The top part > Location name > A descriptive name to help users recognize the location." }, "active": { "type": "boolean", "description": "The top part > Active > A check box that you select if the location is active." }, "address": { "$ref": "#/components/schemas/addressInLocationDto" }, "contact": { "$ref": "#/components/schemas/contactInLocationDto" }, "vatRegistrationId": { "type": "string", "description": "General information tab > Location address section > VAT registration ID > The optional VAT registration ID associated with the location." }, "vatZone": { "$ref": "#/components/schemas/vatZoneInLocationDto" }, "ediCode": { "type": "string", "description": "General information tab > Location address section > EDI code > The EDI code to be used for the customer location." }, "gln": { "type": "string", "description": "General information tab > Location address section > GLN > The GLN to be used for the customer location." }, "corporateId": { "type": "string", "description": "General information tab > Location address section > Corporate ID > The corporate ID associated with the customer location." }, "lastModifiedDateTime": { "type": "string", "description": "System generation information", "format": "date-time" }, "peppolScheme": { "$ref": "#/components/schemas/peppolSchemeInLocationDto" }, "internalId": { "type": "integer", "format": "int32" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Location in LocationController. Used for getting data." }, "PeppolSchemeUpdateDto": { "type": "object", "properties": { "endpoint": { "$ref": "#/components/schemas/DtoValueOfString" }, "partyIdentification": { "$ref": "#/components/schemas/DtoValueOfString" }, "partyLegal": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "DtoValueOfPeppolSchemeUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/PeppolSchemeUpdateDto" } } }, "baccountIdInLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field for creating a new location. Can not be updated after it has been created." }, "locationIdInLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field for creating a new location. Can not be updated after it has been created." }, "LocationUpdateDto": { "type": "object", "properties": { "baccountId": { "$ref": "#/components/schemas/baccountIdInLocationUpdateDto" }, "locationId": { "$ref": "#/components/schemas/locationIdInLocationUpdateDto" }, "locationName": { "$ref": "#/components/schemas/DtoValueOfString" }, "active": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "addressIsSameAsMain": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "address": { "$ref": "#/components/schemas/DtoValueOfAddressUpdateDto" }, "contactIsSameAsMain": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "contact": { "$ref": "#/components/schemas/DtoValueOfContactInfoUpdateDto" }, "vatRegistrationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "ediCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "gln": { "$ref": "#/components/schemas/DtoValueOfString" }, "corporateId": { "$ref": "#/components/schemas/DtoValueOfString" }, "peppolScheme": { "$ref": "#/components/schemas/DtoValueOfPeppolSchemeUpdateDto" } }, "description": "This class represents a Location in LocationController. Used to create and update Location." }, "LocationQueryParameters": { "type": "object", "properties": { "locationId": { "type": "string" }, "gln": { "type": "string" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "LotSerialClassDetailDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the Lot Serial Class" }, "segmentNumber": { "type": "integer", "description": "Segment number for the Lot Serial segment", "format": "int32" }, "type": { "enum": [ "NumericVal", "FixedConst", "DateConst", "DayConst", "MonthConst", "MonthLongConst", "YearConst", "YearLongConst" ], "type": "string", "description": "Segment type for the Lot Serial segment" }, "value": { "type": "string", "description": "Segment value for the Lot Serial segment" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "LotSerialClassDto": { "type": "object", "properties": { "id": { "type": "string", "description": "The Id of the Lot Serial Class" }, "description": { "type": "string", "description": "The description of the Lot Serial Class" }, "trackingMethod": { "enum": [ "NotNumbered", "LotNumbered", "SerialNumbered" ], "type": "string", "description": "Method used to track the Lot Serial Class" }, "trackExpirationDate": { "type": "boolean", "description": "Option for enable/disable expiration date tracking of the Lot Serial Class" }, "requiredForDropShip": { "type": "boolean", "description": "Option for enable/disable require drop shipping of the Lot Serial Class" }, "assignmentMethod": { "enum": [ "WhenReceived", "WhenUsed" ], "type": "string", "description": "Assignment method used for the Lot Serial Class (When Used, When Received)" }, "issueMethod": { "enum": [ "FIFO", "LIFO", "Sequential", "Expiration", "UserEnterable" ], "type": "string", "description": "Issue method used for the Lot Serial Class (FIFO, LIFO, Sequential, Expiration, User-Enterable)" }, "autoIncrementalValueBetweenClasses": { "type": "boolean", "description": "Option for enable/disable auto incremental values between classes for the Lot Serial Class" }, "autoIncrementalValue": { "type": "string", "description": "Value used for the auto incremental value when AutoIncrementalValueBetweenClasses is enabled" }, "autoGenerateNextNumber": { "type": "boolean", "description": "Option for enable/disable auto generating the next number for the Lot Serial Class" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/LotSerialClassDetailDto" }, "description": "Lot Serial Class details (Segment Number, Type, Value)" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "LotSerialClassQueryParameters": { "type": "object", "properties": { "description": { "type": "string" }, "trackingMethod": { "enum": [ "NotNumbered", "LotNumbered", "SerialNumbered" ], "type": "string" }, "trackExpirationDate": { "type": "boolean" }, "requiredForDropShip": { "type": "boolean" }, "assignmentMethod": { "enum": [ "WhenReceived", "WhenUsed" ], "type": "string" }, "issueMethod": { "enum": [ "FIFO", "LIFO", "Sequential", "Expiration", "UserEnterable" ], "type": "string" }, "autoIncrementalValueBetweenClasses": { "type": "boolean" }, "autoIncrementalValue": { "type": "string" }, "autoGenerateNextNumber": { "type": "boolean" }, "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "MultilanguageDto": { "type": "object", "properties": { "languageISO": { "type": "string" }, "translation": { "type": "string" }, "isTranslated": { "type": "boolean" } } }, "MultilanguageTranslationDto": { "type": "object", "properties": { "translation": { "type": "string" } } }, "ActiveMultilanguageDto": { "type": "object", "properties": { "isDefault": { "type": "boolean" }, "languageISO": { "type": "string" }, "nativeName": { "type": "string" }, "isActive": { "type": "boolean" } } }, "LanguageUpdateDto": { "type": "object", "properties": { "languageISO": { "type": "string" } } }, "branchInNumberingSequenceDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The table > Branch > The branch using the numbering series." }, "NumberingSequenceDto": { "type": "object", "properties": { "numberingId": { "type": "string", "description": "Mandatory field: The top part > Numbering ID > The unique ID of the numbering series, which is an alphanumeric string of up to 10 characters." }, "branch": { "$ref": "#/components/schemas/branchInNumberingSequenceDto" }, "startNbr": { "type": "string", "description": "Mandatory field: The table > Start number* > The number to be used first in this numbering series or subsequence." }, "endNbr": { "type": "string", "description": "Mandatory field: The table > End number* > The number to be used at the end of this series. The end number cannot be less than the Start number." }, "startDate": { "type": "string", "description": "Mandatory field: The table > Start dat*e > The date when this series will first be used.", "format": "date-time" }, "lastNbr": { "type": "string", "description": "Mandatory field: The table > Last number* > The most recent allocated number used for an object in this series." }, "warnNbr": { "type": "string", "description": "Mandatory field: The table > Warning number* > The minimum number that triggers a warning that available numbers will be used up soon." }, "nbrStep": { "type": "integer", "description": "Mandatory field: The table > Numbering step* > The increment this series uses to generate the next number.", "format": "int32" }, "nextNumber": { "type": "string", "description": "Next number that will be assigned" } } }, "NumberingDto": { "type": "object", "properties": { "numberingId": { "type": "string", "description": "Mandatory field: The top part > Numbering ID > The unique ID of the numbering series, which is an alphanumeric string of up to 10 characters." }, "description": { "type": "string", "description": "Mandatory field: The top part > Description* > The description of the numbering series." }, "manualNumbering": { "type": "boolean", "description": "The top part > Manual numbering > A check box that indicates (if selected) that the system will not generate numbers for the series and users will need to specify document numbers manually." }, "newNumberSymbol": { "type": "string", "description": "Mandatory field: The top part > New number symbol* > An alphanumeric string used to indicate that a new number for an object will be assigned." }, "sequence": { "type": "array", "items": { "$ref": "#/components/schemas/NumberingSequenceDto" } } } }, "OrganizationQueryParameters": { "type": "object", "properties": { "expandBranches": { "type": "boolean", "description": "True to expand all Branches related to this Organization." }, "expandBankSettings": { "type": "boolean", "description": "True to expand payment settings for organization." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." } }, "description": "Organization Query Parameters" }, "mainAddressInExtendedOrganizationDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "Main Address" }, "mainContactInExtendedOrganizationDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Main Contact" }, "deliveryAddressInExtendedOrganizationDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "Delivery Address" }, "deliveryContactInExtendedOrganizationDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Delivery Contact" }, "defaultCountryInExtendedOrganizationDto": { "properties": { "id": { "type": "string", "description": "Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166." }, "name": { "type": "string", "description": "Mandatory field: Country name* > The complete name of the country." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Default Country" }, "industryCodeInExtendedOrganizationDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Industry Code" }, "currencyInExtendedOrganizationDto": { "properties": { "id": { "type": "string", "description": "Currency Id." }, "description": { "type": "string", "description": "Currency description." }, "symbol": { "type": "string", "description": "Currency symbol." }, "isBaseCurrency": { "type": "boolean", "description": "Identify if the currency is the base currency." }, "decimalPrecision": { "type": "integer", "description": "Decimal precision.", "format": "int32" }, "isUsedForAccounting": { "type": "boolean", "description": "Identify if is used for accounting." } }, "description": "Currency" }, "vatZoneInExtendedOrganizationDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Vat Zone" }, "ledgerInExtendedOrganizationDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Ledger" }, "bankSettingsInExtendedOrganizationDto": { "properties": { "bankName": { "type": "string", "description": "Bank name" }, "bankAddress1": { "type": "string", "description": "Bank address1" }, "bankAddress2": { "type": "string", "description": "BankAddress2" }, "bankAddress3": { "type": "string", "description": "BankAddress3" }, "bankCountry": { "type": "string", "description": "BankCountry" }, "iban": { "type": "string", "description": "IBAN" }, "bban": { "type": "string", "description": "BBAN" }, "bbaN2": { "type": "string", "description": "BBAN2" }, "bbaN3": { "type": "string", "description": "BBAN3" }, "bic": { "type": "string", "description": "BIC" }, "creditorId": { "type": "string", "description": "CreditorId" } }, "description": "Bank Settings" }, "ExtendedOrganizationDto": { "type": "object", "properties": { "organizationCd": { "type": "string", "description": "Organization Cd" }, "name": { "type": "string", "description": "Name" }, "organizationType": { "type": "string", "description": "Organization Type" }, "fileTaxByBranches": { "type": "boolean", "description": "File Tax By Branches" }, "baseCurrency": { "type": "string", "description": "Base Currency" }, "mainAddress": { "$ref": "#/components/schemas/mainAddressInExtendedOrganizationDto" }, "mainContact": { "$ref": "#/components/schemas/mainContactInExtendedOrganizationDto" }, "deliveryAddress": { "$ref": "#/components/schemas/deliveryAddressInExtendedOrganizationDto" }, "deliveryContact": { "$ref": "#/components/schemas/deliveryContactInExtendedOrganizationDto" }, "corporateId": { "type": "string", "description": "CorporateId" }, "vatRegistrationId": { "type": "string", "description": "VatRegistrationId" }, "defaultCountry": { "$ref": "#/components/schemas/defaultCountryInExtendedOrganizationDto" }, "industryCode": { "$ref": "#/components/schemas/industryCodeInExtendedOrganizationDto" }, "currency": { "$ref": "#/components/schemas/currencyInExtendedOrganizationDto" }, "vatZone": { "$ref": "#/components/schemas/vatZoneInExtendedOrganizationDto" }, "lastModifiedDateTime": { "type": "string", "description": "LastModifiedDateTime", "format": "date-time" }, "ledger": { "$ref": "#/components/schemas/ledgerInExtendedOrganizationDto" }, "bankSettings": { "$ref": "#/components/schemas/bankSettingsInExtendedOrganizationDto" }, "branches": { "type": "array", "items": { "$ref": "#/components/schemas/BranchNumberDto" }, "description": "Branches" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" } }, "description": "ExtendedOrganizationDto" }, "PackagingTypeDto": { "type": "object", "properties": { "boxId": { "type": "string", "description": "Mandatory field: The table > Box ID* > The ID of the type of box." }, "description": { "type": "string", "description": "The table > Description > A description of the box." }, "boxWeight": { "type": "number", "description": "The table > Tare weight > The weight of an empty box of this type, which may include the weight of any packaging material used to pack items inside the box.", "format": "double" }, "maxWeight": { "type": "number", "description": "The table > Max weight > The maximum weight a box of the type can hold.", "format": "double" }, "weightUoM": { "type": "string", "description": "The table > Weight UoM > The unit of measure used for the weight." }, "maxVolume": { "type": "number", "description": "The table > Max. volume > The maximum volume of items that can fit into a package of the type.", "format": "double" }, "volumeUoM": { "type": "string", "description": "The table > Volume UoM > The unit of measure used for the volume as specified in the Inventory preferences (IN101000) window." }, "length": { "type": "integer", "description": "The table > Length > The length of the package.", "format": "int32" }, "width": { "type": "integer", "description": "The table > Width > The width of the package.", "format": "int32" }, "height": { "type": "integer", "description": "The table > Height > The height of the package.", "format": "int32" }, "activeByDefault": { "type": "boolean", "description": "The table > Active by default > If you select this check box, the package will be added by default to the list of packages for each new ship via code." }, "lastModifiedDateTime": { "type": "string", "description": "The table > The date and time when the type was last modified.", "format": "date-time" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a PackagingType in PackagingTypeController. Used by getting data." }, "PackagingTypeQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "This field has been deprecated and will be removed in future versions." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "PaymentMethodDetailDto": { "type": "object", "properties": { "detailID": { "type": "string", "description": "Mandatory field: Table column > ID* > The identifier of the payment method element." }, "description": { "type": "string", "description": "Table column > Description > The name for the payment method element." }, "bankingDetailType": { "type": "string", "description": "Table column > BankingDetailType > The bank account type" } } }, "PaymentMethodDto": { "type": "object", "properties": { "paymentMethodID": { "type": "string", "description": "Mandatory field: The top part > Payment method ID* > The unique identifier of the payment method." }, "active": { "type": "boolean", "description": "The top part > Active > A check box that indicates whether the payment method is active in the system." }, "meansOfPayment": { "enum": [ "CreditCard", "CashOrCheck", "DirectDeposit" ], "type": "string", "description": "The top part > Means of payment > One of the system's built-in payment templates. The following options are available: Credit card, Cash, Direct deposit." }, "description": { "type": "string", "description": "Mandatory field: The top part > Description* > A description of the payment method." }, "useInAP": { "type": "boolean", "description": "The top part > Use for supplier > A check box that indicates whether the payment method will be used in Supplier ledger." }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentMethodDetailDto" }, "description": "The settings for Customer ledger and The settings of Supplier ledger tab > The table" } }, "description": "This class represents a Payment Method in PaymentMethodController. Used for getting data." }, "PaymentMethodQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "format": "int32" }, "skipRecords": { "type": "integer", "format": "int32" }, "lastModifiedDateTime": { "type": "string" }, "lastModifiedDateTimeCondition": { "type": "string" } } }, "branchInTaskDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Summary tab > Billing and Allocation settings > Branch information: branch number and name." }, "TaskDto": { "type": "object", "properties": { "taskId": { "type": "string", "description": "Mandatory field: > Task ID* > The ID of the task." }, "description": { "type": "string", "description": "Mandatory field: Description > The description of the task." }, "plannedStart": { "type": "string", "format": "date-time" }, "plannedEnd": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "description": "Start date > The date when the task was actually started.", "format": "date-time" }, "endDate": { "type": "string", "description": "End date > The date when the task was actually finished.", "format": "date-time" }, "branch": { "$ref": "#/components/schemas/branchInTaskDto" }, "rateTable": { "$ref": "#/components/schemas/RateTableIdDescriptionDto" }, "status": { "enum": [ "Planned", "Active", "Cancelled", "Canceled", "Completed" ], "type": "string", "description": "Mandatory field: Status* > The status of the task, which can be one of the following: In planning, Active, Cancelled, Completed." }, "restrictEmployees": { "type": "boolean", "description": "Summary tab > Task properties section > Restrict employees > A check box that indicates (if selected) that only the employees listed on the Employees tab of this window can create activities and documents associated with the current task." }, "visibility": { "$ref": "#/components/schemas/VisibilityDto" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeDto" }, "description": "The Employees tab > Information in this tab is retreived from EP203000 (Employees)" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeIdValueDto" }, "description": "Attributes" } } }, "RateTableIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "BillingRuleIdDescriptionDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "AllocationRuleIdDescriptionDto": { "type": "object", "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "VisibilityDto": { "type": "object", "properties": { "visibleInGl": { "type": "boolean", "description": "General ledger" }, "visibleInAp": { "type": "boolean", "description": "Supplier ledger" }, "visibleInAr": { "type": "boolean", "description": "Customer ledger" }, "visibleInSo": { "type": "boolean", "description": "Sales" }, "visibleInPo": { "type": "boolean", "description": "Purchases" }, "visibleInEa": { "type": "boolean", "description": "Expenses" }, "visibleInTa": { "type": "boolean", "description": "Time entries" }, "visibleInIn": { "type": "boolean", "description": "Inventory" }, "visibleInCa": { "type": "boolean", "description": "Cash management" }, "visibleInCr": { "type": "boolean" } } }, "TemplateNumberDescriptionDto": { "type": "object", "properties": { "status": { "enum": [ "Planned", "Active", "Completed", "Cancelled", "OnHold", "PendingApproval" ], "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "customerInProjectDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer for the project if this project is external." }, "templateInProjectDto": { "properties": { "status": { "enum": [ "Planned", "Active", "Completed", "Cancelled", "OnHold", "PendingApproval" ], "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The top part > Templated ID > The template used for creating this project, if applicable." }, "projectManagerInProjectDto": { "properties": { "employeeUserId": { "type": "string", "description": "Employee internal user ID. This is the ID of the user linked to the employee", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "employeeId": { "type": "integer", "description": "Mandatory field: The top part > Employee ID* > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEE segmented key.", "format": "int32" }, "employeeNumber": { "type": "string", "description": "General information tab > Employee settings section > Employee ref. no. > A reference number for the employee." }, "employeeName": { "type": "string", "description": "The top part > Employee name > The name of this employee." }, "status": { "enum": [ "Active", "OnHold", "HoldPayments", "Inactive", "OneTime" ], "type": "string", "description": "Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time." }, "department": { "type": "string", "description": "Mandatory field: General information tab > Employee section > Department* > The department the employee works for." }, "contact": { "$ref": "#/components/schemas/contactInEmployeeDto" }, "address": { "$ref": "#/components/schemas/addressInEmployeeDto" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "employeeClass": { "$ref": "#/components/schemas/employeeClassInEmployeeDto" }, "branch": { "$ref": "#/components/schemas/BranchNumberDto" }, "calendarID": { "type": "string" }, "employeeLogin": { "type": "string" }, "workGroupDescription": { "type": "array", "items": { "type": "string" } }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Summary tab > Project properties section > Project manager > The person who is responsible for managing the project and authorised to approve the project task and task activities." }, "visibilityInProjectDto": { "properties": { "visibleInGl": { "type": "boolean", "description": "General ledger" }, "visibleInAp": { "type": "boolean", "description": "Supplier ledger" }, "visibleInAr": { "type": "boolean", "description": "Customer ledger" }, "visibleInSo": { "type": "boolean", "description": "Sales" }, "visibleInPo": { "type": "boolean", "description": "Purchases" }, "visibleInEa": { "type": "boolean", "description": "Expenses" }, "visibleInTa": { "type": "boolean", "description": "Time entries" }, "visibleInIn": { "type": "boolean", "description": "Inventory" }, "visibleInCa": { "type": "boolean", "description": "Cash management" }, "visibleInCr": { "type": "boolean" } }, "description": "Summary tab > Visibility settings section >" }, "defAccountInProjectDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "General ledger accounts tab > Default values section > Default account > The account to be used as one of the sources of possible accounts for the invoices and transactions for the project." }, "defSubInProjectDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: General ledger accounts tab > Default values section > Default subaccount* > The subaccount to be used as one of the sources of possible segment values for subaccounts to be used in the invoices and transactions for the project." }, "defAccrualAccountInProjectDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "General ledger accounts tab > Default values section > Accrual account > The default accrual account to be used in project transactions for the project." }, "defAccrualSubInProjectDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "General ledger accounts tab > Default values section > Accrual subaccount > The default accrual subaccount to be used in project transactions for the project." }, "customerLocationInProjectDto": { "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Summary tab > Invoice to section > Customer location > The location of the project's customer." }, "allocationRuleInProjectDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Summary tab > Invoicing and allocation settings section > Allocation rule > The default allocation rule that is used for the tasks created for the project." }, "billingRuleInProjectDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Summary tab > Invoicing and allocation settings section > Invoicing rule > The default invoicing rule that is used for the tasks created for the project." }, "branchInProjectDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Summary tab > Billing and Allocation Settings > The branch information: branch number and name." }, "rateTableInProjectDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Summary tab > Invoicing and allocation settings section > Rate table > The rate table to be used with the allocation rules, if applicable." }, "ProjectDto": { "type": "object", "properties": { "internalID": { "type": "integer", "format": "int32" }, "projectID": { "type": "string", "description": "Mandatory field: The top part > Project ID* > The unique ID for the project." }, "customer": { "$ref": "#/components/schemas/customerInProjectDto" }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that you select to indicate that the project should have the In planning status." }, "status": { "enum": [ "Planned", "Active", "Completed", "Cancelled", "OnHold", "PendingApproval" ], "type": "string", "description": "The top part > Status > The status of the project, which can be one of the following options: In planning, Active, Completed, Suspended, Cancelled." }, "template": { "$ref": "#/components/schemas/templateInProjectDto" }, "description": { "type": "string", "description": "Mandatory field: The top part > Description* > The description of the project." }, "assets": { "type": "number", "description": "The top part > Assest > The actual assets for the project.", "format": "double" }, "liability": { "type": "number", "description": "The top part > Liabilities > The actual liabilities for the project.", "format": "double" }, "income": { "type": "number", "description": "The top part > Income > The income expected from the project.", "format": "double" }, "expenses": { "type": "number", "description": "The top part > Expenses > The total of the current expenses incurred by the project.", "format": "double" }, "startDate": { "type": "string", "description": "Mandatory field: Summary tab > Project properties section > Start date* > The date when the project starts.", "format": "date-time" }, "endDate": { "type": "string", "description": "Summary tab > Project properties section > End date > The date when the project is expected to end.", "format": "date-time" }, "projectManager": { "$ref": "#/components/schemas/projectManagerInProjectDto" }, "restrictEmployees": { "type": "boolean", "description": "Summary tab > Project properties section > Restrict employees > A check box that indicates (if selected) that only the employees listed on the Employees tab of this window can create activities and documents associated with the current project." }, "restrictEquipment": { "type": "boolean" }, "visibility": { "$ref": "#/components/schemas/visibilityInProjectDto" }, "defAccount": { "$ref": "#/components/schemas/defAccountInProjectDto" }, "defSub": { "$ref": "#/components/schemas/defSubInProjectDto" }, "defAccrualAccount": { "$ref": "#/components/schemas/defAccrualAccountInProjectDto" }, "defAccrualSub": { "$ref": "#/components/schemas/defAccrualSubInProjectDto" }, "billingPeriod": { "enum": [ "Weekly", "Monthly", "Quarterly", "Annual", "OnDemand" ], "type": "string", "description": "Summary tab > Invoicing and allocation settings section > Invoicing period > The frequency of invoicing, which can be one of the following options: Week, Month, Quarter, Year, On demand." }, "nextBillingDate": { "type": "string", "description": "Summary tab > Invoicing and allocation settings section > Next invoicing date > The date for which the next invoicing is scheduled for the project.", "format": "date-time" }, "lastBillingDate": { "type": "string", "description": "Summary tab > Invoicing and allocation settings section > Last invoicing date > The date when the latest invoicing was performed for the project.", "format": "date-time" }, "customerLocation": { "$ref": "#/components/schemas/customerLocationInProjectDto" }, "allocationRule": { "$ref": "#/components/schemas/allocationRuleInProjectDto" }, "billingRule": { "$ref": "#/components/schemas/billingRuleInProjectDto" }, "branch": { "$ref": "#/components/schemas/branchInProjectDto" }, "rateTable": { "$ref": "#/components/schemas/rateTableInProjectDto" }, "autoAllocate": { "type": "boolean", "description": "Summary tab > Invoicing and allocation settings section > Run allocation when you release project transactions > A check box that indicates (if selected) that allocation is run automatically during the release of the documents associated with this project." }, "automaticReleaseAr": { "type": "boolean", "description": "Summary tab > Invoicing and allocation settings section > Automatically release customer documents > A check box that indicates (if selected) that invoice documents are released automatically after the project invoicing is completed." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information", "format": "date-time" }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskDto" }, "description": "Tasks tab >" }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeDto" }, "description": "The Employees tab > Information in this tab is retreived from EP203000 (Employees)" }, "publicId": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "systemTemplate": { "type": "boolean" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeIdValueDto" }, "description": "Attributes tab >" }, "note": { "type": "string", "description": "The note on the project." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Project in ProjectController. Used for getting data." }, "ProjectQueryParameters": { "type": "object", "properties": { "status": { "enum": [ "Planned", "Active", "Completed", "Cancelled", "OnHold", "PendingApproval" ], "type": "string", "description": "Use drop down and select Status." }, "systemTemplate": { "type": "boolean", "description": "If the project is a template" }, "visibleInAP": { "type": "boolean", "description": "If the project is visible in AP" }, "startDate": { "type": "string", "description": "Project’s start date", "format": "date-time" }, "expandAttribute": { "type": "boolean", "description": "Expands project atributes" }, "attributes": { "type": "string", "description": "Identifies the attributes" }, "taskStatus": { "enum": [ "Planned", "Active", "Cancelled", "Canceled", "Completed" ], "type": "string", "description": "Use drop down and select Status." }, "taskVisibleInAp": { "type": "boolean", "description": "If the project task is visible in the Supplier ledger" }, "taskVisibleInAr": { "type": "boolean", "description": "If the project task is visible in the Customer ledger" }, "taskVisibleInCa": { "type": "boolean", "description": "If the project task is visible in the Cash management workspace" }, "taskVisibleInCr": { "type": "boolean", "description": "If the project task is visible in the CRM workspace" }, "taskVisibleInEa": { "type": "boolean", "description": "If the project task is visible in the Expense workspace" }, "taskVisibleInGl": { "type": "boolean", "description": "If the project task is visible in the General ledger workspace" }, "taskVisibleInIn": { "type": "boolean", "description": "If the project task is visible in the Inventory workspace" }, "taskVisibleInPo": { "type": "boolean", "description": "If the project task is visible in the Purchases workspace" }, "taskVisibleInSo": { "type": "boolean", "description": "If the project task is visible in the Sales workspace" }, "taskVisibleInTa": { "type": "boolean", "description": "If the project task is visible in the Time entities workspace" }, "nonProject": { "type": "boolean", "description": "Set to true to return the non-project." }, "publicId": { "type": "string", "description": "Identifies the Project by its publicId", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "restrictedEmployee": { "type": "string", "description": "ID of the employee where access restrictions apply" }, "restrictedUser": { "type": "integer", "description": "Id of the odp user where access restrictions apply", "format": "int64" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "branch": { "type": "string", "description": "The branch name." }, "onHold": { "type": "boolean", "description": "If the project is on hold" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "TaskEmployeeUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "employeeId": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "DtoValueOfNullableOfProjTaskStatus": { "type": "object", "properties": { "value": { "enum": [ "Planned", "Active", "Cancelled", "Canceled", "Completed" ], "type": "string" } } }, "ProjectEmployeeUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "employeeId": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "TaskUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "taskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "plannedStart": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "plannedEnd": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "startDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "rateTable": { "$ref": "#/components/schemas/DtoValueOfString" }, "status": { "$ref": "#/components/schemas/DtoValueOfNullableOfProjTaskStatus" }, "restrictEmployees": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/TaskEmployeeUpdateDto" } } } }, "VisibilityUpdateDto": { "type": "object", "properties": { "visibleInGl": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "visibleInAp": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "visibleInAr": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "visibleInSo": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "visibleInPo": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "visibleInEa": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "visibleInTa": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "visibleInIn": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "visibleInCa": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "visibleInCr": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" } } }, "DtoValueOfNullableOfBillingPeriod": { "type": "object", "properties": { "value": { "enum": [ "Weekly", "Monthly", "Quarterly", "Annual", "OnDemand" ], "type": "string" } } }, "DtoValueOfNullableOfProjectStatus": { "type": "object", "properties": { "value": { "enum": [ "Planned", "Active", "Completed", "Cancelled", "OnHold", "PendingApproval" ], "type": "string" } } }, "descriptionInProjectUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field" }, "startDateInProjectUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "Mandatory field" }, "branchInProjectUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Summary tab > Billing and Allocation Settings > The branch information: branch number and name." }, "ProjectUpdateDto": { "required": [ "description", "startDate" ], "type": "object", "properties": { "projectID": { "$ref": "#/components/schemas/DtoValueOfString" }, "internalID": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "customer": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/descriptionInProjectUpdateDto" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "template": { "$ref": "#/components/schemas/DtoValueOfString" }, "status": { "$ref": "#/components/schemas/DtoValueOfNullableOfProjectStatus" }, "defAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "defSub": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "Mandatory field when Project Template is not specified." }, "defAccrualAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "defAccrualSub": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "startDate": { "$ref": "#/components/schemas/startDateInProjectUpdateDto" }, "endDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "billingPeriod": { "$ref": "#/components/schemas/DtoValueOfNullableOfBillingPeriod" }, "allocationRule": { "$ref": "#/components/schemas/DtoValueOfString" }, "billingRule": { "$ref": "#/components/schemas/DtoValueOfString" }, "branch": { "$ref": "#/components/schemas/branchInProjectUpdateDto" }, "rateTable": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectManger": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectManagerInternalId": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "autoAllocate": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "automaticReleaseArDoc": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "restricEmployees": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "restricEquipment": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "customerLocation": { "$ref": "#/components/schemas/DtoValueOfString" }, "visibility": { "$ref": "#/components/schemas/VisibilityUpdateDto" }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TaskUpdateDto" } }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectEmployeeUpdateDto" } }, "note": { "$ref": "#/components/schemas/DtoValueOfString" } }, "description": "This class represent a Project in Project Controller. Used to pass data to server for creating or updating an project" }, "TaskQueryParameters": { "type": "object", "properties": { "projectId": { "type": "string", "description": "Identifies the Project" }, "publicId": { "type": "string", "description": "Identifies the project by publicId", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "projectInternalId": { "type": "integer", "description": "Identifies the project by internal id", "format": "int32" }, "description": { "type": "string", "description": "Identifies the Project task description" }, "taskCd": { "type": "string", "description": "Identifies the Project task ID" }, "taskCdDesc": { "type": "string", "description": "Identifies the Project task ID and description" }, "status": { "enum": [ "Planned", "Active", "Cancelled", "Canceled", "Completed" ], "type": "string", "description": "The status of the document." }, "expandAttribute": { "type": "boolean", "description": "Expands project atributes" }, "visibleInAp": { "type": "boolean", "description": "If the project task is visible in the Supplier ledger" }, "visibleInAr": { "type": "boolean", "description": "If the project task is visible in the Customer ledger" }, "visibleInCa": { "type": "boolean", "description": "If the project task is visible in the Cash management workspace" }, "visibleInCr": { "type": "boolean", "description": "If the project task is visible in the CRM workspace" }, "visibleInEa": { "type": "boolean", "description": "If the project task is visible in the Expense workspace" }, "visibleInGl": { "type": "boolean", "description": "If the project task is visible in the General ledger workspace" }, "visibleInIn": { "type": "boolean", "description": "If the project task is visible in the Inventory workspace" }, "visibleInPo": { "type": "boolean", "description": "If the project task is visible in the Purchases workspace" }, "visibleInSo": { "type": "boolean", "description": "If the project task is visible in the Sales workspace" }, "visibleInTa": { "type": "boolean", "description": "If the project task is visible in the Time entities workspace" }, "restrictedEmployee": { "type": "string", "description": "Id of the employee where access restrictions apply" }, "restrictedUser": { "type": "integer", "description": "Id of the Odp User where access restrictions apply", "format": "int64" }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "defAccountInTaskExtendedDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "General ledger accounts tab > Default values section > Default account > The account to be used as one of the sources of possible accounts for the invoices and transactions for the project task." }, "defSubInTaskExtendedDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "General ledger accounts tab > Default values section > Default subaccount* > The subaccount to be used as one of the sources of possible segment values for subaccounts to be used in the invoices and transactions for the project task." }, "defAccrualAccountInTaskExtendedDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "General ledger accounts tab > Default values section > Accrual account > The default accrual account to be used in project transactions for the project task." }, "defAccrualSubInTaskExtendedDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "General ledger accounts tab > Default values section > Accrual subaccount > The default accrual subaccount to be used in project transactions for the project task." }, "taxCategoryInTaskExtendedDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "VAT category > The tax category for the project task." }, "branchInTaskExtendedDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Summary tab > Billing and Allocation settings > Branch information: branch number and name." }, "rateTableInTaskExtendedDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Rate table > The rate table to be used in the allocation rules, if applicable." }, "visibilityInTaskExtendedDto": { "properties": { "visibleInGl": { "type": "boolean", "description": "General ledger" }, "visibleInAp": { "type": "boolean", "description": "Supplier ledger" }, "visibleInAr": { "type": "boolean", "description": "Customer ledger" }, "visibleInSo": { "type": "boolean", "description": "Sales" }, "visibleInPo": { "type": "boolean", "description": "Purchases" }, "visibleInEa": { "type": "boolean", "description": "Expenses" }, "visibleInTa": { "type": "boolean", "description": "Time entries" }, "visibleInIn": { "type": "boolean", "description": "Inventory" }, "visibleInCa": { "type": "boolean", "description": "Cash management" }, "visibleInCr": { "type": "boolean" } }, "description": "Information retrieved from the Summary tab" }, "TaskExtendedDto": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "Internal ID* > The internal ID of the task.", "format": "int32" }, "projectInternalId": { "type": "integer", "description": "Project Internal ID* > The internal ID of the project.", "format": "int32" }, "defAccount": { "$ref": "#/components/schemas/defAccountInTaskExtendedDto" }, "defSub": { "$ref": "#/components/schemas/defSubInTaskExtendedDto" }, "defAccrualAccount": { "$ref": "#/components/schemas/defAccrualAccountInTaskExtendedDto" }, "defAccrualSub": { "$ref": "#/components/schemas/defAccrualSubInTaskExtendedDto" }, "taxCategory": { "$ref": "#/components/schemas/taxCategoryInTaskExtendedDto" }, "lastModifiedDateTime": { "type": "string", "description": "Information collected from system.", "format": "date-time" }, "createdDateTime": { "type": "string", "description": "Information collected from the system. Not visible on the screen.", "format": "date-time" }, "taskId": { "type": "string", "description": "Mandatory field: > Task ID* > The ID of the task." }, "description": { "type": "string", "description": "Mandatory field: Description > The description of the task." }, "plannedStart": { "type": "string", "format": "date-time" }, "plannedEnd": { "type": "string", "format": "date-time" }, "startDate": { "type": "string", "description": "Start date > The date when the task was actually started.", "format": "date-time" }, "endDate": { "type": "string", "description": "End date > The date when the task was actually finished.", "format": "date-time" }, "branch": { "$ref": "#/components/schemas/branchInTaskExtendedDto" }, "rateTable": { "$ref": "#/components/schemas/rateTableInTaskExtendedDto" }, "status": { "enum": [ "Planned", "Active", "Cancelled", "Canceled", "Completed" ], "type": "string", "description": "Mandatory field: Status* > The status of the task, which can be one of the following: In planning, Active, Cancelled, Completed." }, "restrictEmployees": { "type": "boolean", "description": "Summary tab > Task properties section > Restrict employees > A check box that indicates (if selected) that only the employees listed on the Employees tab of this window can create activities and documents associated with the current task." }, "visibility": { "$ref": "#/components/schemas/visibilityInTaskExtendedDto" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/EmployeeDto" }, "description": "The Employees tab > Information in this tab is retreived from EP203000 (Employees)" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeIdValueDto" }, "description": "Attributes" } } }, "ChangeProjectIdActionDto": { "type": "object", "properties": { "projectId": { "type": "string" } } }, "ChangeProjectIdActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "ProjectAccountGroupQueryParameters": { "type": "object", "properties": { "expandAttribute": { "type": "boolean", "description": "Expands project atributes" }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ProjectAccountGroupDto": { "type": "object", "properties": { "accountGroupId": { "type": "string", "description": "The unique identifier of the account group." }, "active": { "type": "boolean", "description": "A check box that indicates that the account group is active." }, "description": { "type": "string", "description": "An alphanumeric string that describes the account group." }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeIdValueDto" }, "description": "Attributes" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "ProjectBasicQueryParameters": { "type": "object", "properties": { "status": { "enum": [ "Planned", "Active", "Completed", "Cancelled", "OnHold", "PendingApproval" ], "type": "string", "description": "Select project status." }, "description": { "type": "string", "description": "Project name/description" }, "projectId": { "type": "string", "description": "Identifies the Project" }, "startDate": { "type": "string", "description": "Project's start date", "format": "date-time" }, "nonProject": { "type": "boolean", "description": "Set to true to return the non-project." }, "projectIdDesc": { "type": "string", "description": "Identifies the Project by ID and description" }, "publicId": { "type": "string", "description": "Identifies the Project by its publicId", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "restrictedEmployee": { "type": "string", "description": "Id of the employee where access restrictions apply" }, "restrictedUser": { "type": "integer", "description": "Id of the odp user where access restrictions apply", "format": "int64" }, "visibleInAp": { "type": "boolean", "description": "If the project is visible in the Supplier ledger" }, "visibleInAr": { "type": "boolean", "description": "If the project is visible in the Customer ledger" }, "visibleInCa": { "type": "boolean", "description": "If the project is visible in the Cash management workspace" }, "visibleInCr": { "type": "boolean", "description": "If the project is visible in the CRM workspace" }, "visibleInEa": { "type": "boolean", "description": "If the project is visible in the Expense workspace" }, "visibleInGl": { "type": "boolean", "description": "If the project is visible in the General ledger workspace" }, "visibleInIn": { "type": "boolean", "description": "If the project is visible in the Inventory workspace" }, "visibleInPo": { "type": "boolean", "description": "If the project is visible in the Purchases workspace" }, "visibleInSo": { "type": "boolean", "description": "If the project is visible in the Sales workspace" }, "visibleInTa": { "type": "boolean", "description": "If the project is visible in the Time entities workspace" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "customerInProjectBasicDto": { "properties": { "number": { "type": "string" }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The top part > Customer > The customer for the project if this project is external." }, "visibilityInProjectBasicDto": { "properties": { "visibleInGl": { "type": "boolean", "description": "General ledger" }, "visibleInAp": { "type": "boolean", "description": "Supplier ledger" }, "visibleInAr": { "type": "boolean", "description": "Customer ledger" }, "visibleInSo": { "type": "boolean", "description": "Sales" }, "visibleInPo": { "type": "boolean", "description": "Purchases" }, "visibleInEa": { "type": "boolean", "description": "Expenses" }, "visibleInTa": { "type": "boolean", "description": "Time entries" }, "visibleInIn": { "type": "boolean", "description": "Inventory" }, "visibleInCa": { "type": "boolean", "description": "Cash management" }, "visibleInCr": { "type": "boolean" } }, "description": "Summary tab > Visibility settings section >" }, "ProjectBasicDto": { "type": "object", "properties": { "internalID": { "type": "integer", "format": "int32" }, "projectID": { "type": "string", "description": "Mandatory field: The top part > Project ID* > The unique ID for the project." }, "customer": { "$ref": "#/components/schemas/customerInProjectBasicDto" }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that you select to indicate that the project should have the In planning status." }, "status": { "enum": [ "Planned", "Active", "Completed", "Cancelled", "OnHold", "PendingApproval" ], "type": "string", "description": "The top part > Status > The status of the project, which can be one of the following options: In planning, Active, Completed, Suspended, Cancelled." }, "description": { "type": "string", "description": "Mandatory field: The top part > Description* > The description of the project." }, "startDate": { "type": "string", "description": "Mandatory field: Summary tab > Project properties section > Start date* > The date when the project starts.", "format": "date-time" }, "endDate": { "type": "string", "description": "Summary tab > Project properties section > End date > The date when the project is expected to end.", "format": "date-time" }, "autoAllocate": { "type": "boolean", "description": "Summary tab > Invoicing and allocation settings section > Run allocation when you release project transactions > A check box that indicates (if selected) that allocation is run automatically during the release of the documents associated with this project." }, "automaticReleaseAr": { "type": "boolean", "description": "Summary tab > Invoicing and allocation settings section > Automatically release customer documents > A check box that indicates (if selected) that invoice documents are released automatically after the project invoicing is completed." }, "lastModifiedDateTime": { "type": "string", "description": "Systemgenerated information.", "format": "date-time" }, "publicId": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "visibility": { "$ref": "#/components/schemas/visibilityInProjectBasicDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Project (light weight) in ProjectBasicController. Used for getting data." }, "ProjectBudgetQueryParameters": { "type": "object", "properties": { "project": { "type": "string", "description": "Identifies the Project" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ProjectBudgetDto": { "type": "object", "properties": { "projectID": { "type": "string" }, "projectTaskID": { "type": "string" }, "accountGroupID": { "type": "string" }, "inventoryNumber": { "type": "string" }, "description": { "type": "string" }, "uom": { "type": "string" }, "rate": { "type": "number", "format": "double" }, "originalBudgetQty": { "type": "number", "format": "double" }, "originalBudgetAmount": { "type": "number", "format": "double" }, "revisedBudgetQty": { "type": "number", "format": "double" }, "revisedBudgetAmount": { "type": "number", "format": "double" }, "actualQty": { "type": "number", "format": "double" }, "actualAmount": { "type": "number", "format": "double" }, "type": { "type": "string" }, "committedQty": { "type": "number", "format": "double" }, "committedAmount": { "type": "number", "format": "double" }, "committedOpenQty": { "type": "number", "format": "double" }, "committedOpenAmount": { "type": "number", "format": "double" }, "committedReceivedQty": { "type": "number", "format": "double" }, "committedInvoicedQty": { "type": "number", "format": "double" }, "committedInvoicedAmount": { "type": "number", "format": "double" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "ProjectBudgetUpdateDto": { "type": "object", "properties": { "projectID": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTaskID": { "$ref": "#/components/schemas/DtoValueOfString" }, "accountGroupID": { "$ref": "#/components/schemas/DtoValueOfString" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "rate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "originalBudgetQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "originalBudgetAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "revisedBudgetQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "revisedBudgetAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" } } }, "ProjectTaskUpdateDto": { "type": "object", "properties": { "taskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "plannedStart": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "plannedEnd": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "startDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "rateTable": { "$ref": "#/components/schemas/DtoValueOfString" }, "status": { "$ref": "#/components/schemas/DtoValueOfNullableOfProjTaskStatus" }, "visibility": { "$ref": "#/components/schemas/VisibilityUpdateDto" }, "restrictEmployees": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "employees": { "type": "array", "items": { "$ref": "#/components/schemas/TaskEmployeeUpdateDto" } } } }, "AccountGroupDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } } }, "inventoryIdInProjectTransactionLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Item ID > The identifier of the stock or non-stock item associated with the transaction." }, "earningTypeInProjectTransactionLineDto": { "properties": { "code": { "type": "string", "description": "Mandatory field: Code* > The unique ID of the type of hour." }, "description": { "type": "string", "description": "Mandatory field: Description > The brief description of the type of hour." }, "isOvertime": { "type": "boolean", "description": "Overtime > A check box that indicates (if selected) that the type of hour is treated as overtime." }, "isBillable": { "type": "boolean", "description": "Invoicable > A check box that indicates (if selected) that the type is treated as invoiceable by default." }, "isActive": { "type": "boolean", "description": "Active > A check box that indicates (if selected) that the type of hour is active and can be used." }, "overtimeMultiplier": { "type": "number", "description": "Multiplier > The value by which the employee cost for this type of hour is multiplied when the time activity is released.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" } }, "description": "Earning type > The earning type specified for the transaction to calculate the labour cost." }, "projectInProjectTransactionLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project > The project associated with the transaction." }, "projectTaskInProjectTransactionLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project task > The project task associated with the transaction." }, "debitAccountInProjectTransactionLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Debit account > For released transactions, the account the transaction debited when it was released; for unreleased transactions, the account the transaction debits if it is released (mainly for the transactions that originate in the Projects module)." }, "debitSubaccountInProjectTransactionLineDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Debit subaccount > For released transactions, the subaccount the transaction debited when it was released; for unreleased transactions, the subaccount the transaction debits if it is released." }, "creditAccountInProjectTransactionLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Credit account > For released transactions, the account the transaction credited when it was released; for unreleased transactions, the account the transaction credits if it is released." }, "creditSubaccountInProjectTransactionLineDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Credit subaccount > \tFor released transactions, the subaccount the transaction credited when it was released; for unreleased transactions, the subaccount the transaction credits if it is released." }, "branchInProjectTransactionLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Branch > The branch in which the transaction was created." }, "employeeInProjectTransactionLineDto": { "properties": { "employeeUserId": { "type": "string", "description": "Employee internal user ID. This is the ID of the user linked to the employee", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "employeeId": { "type": "integer", "description": "Mandatory field: The top part > Employee ID* > The unique identifier, which is assigned to the employee in accordance with the configuration of the EMPLOYEE segmented key.", "format": "int32" }, "employeeNumber": { "type": "string", "description": "General information tab > Employee settings section > Employee ref. no. > A reference number for the employee." }, "employeeName": { "type": "string", "description": "The top part > Employee name > The name of this employee." }, "status": { "enum": [ "Active", "OnHold", "HoldPayments", "Inactive", "OneTime" ], "type": "string", "description": "Mandatory field: The top part > Status > The status of the employee. The following options are available: Active, On hold, Hold payments, Inactive, One-time." }, "department": { "type": "string", "description": "Mandatory field: General information tab > Employee section > Department* > The department the employee works for." }, "contact": { "$ref": "#/components/schemas/contactInEmployeeDto" }, "address": { "$ref": "#/components/schemas/addressInEmployeeDto" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "employeeClass": { "$ref": "#/components/schemas/employeeClassInEmployeeDto" }, "branch": { "$ref": "#/components/schemas/BranchNumberDto" }, "calendarID": { "type": "string" }, "employeeLogin": { "type": "string" }, "workGroupDescription": { "type": "array", "items": { "type": "string" } }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Employee > The employee associated with the transaction, such as the employee who worked on the project for the customer." }, "customerVendorInProjectTransactionLineDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Customer/supplier > The name of the supplier (if the transaction originated in the Supplier ledger workspace) or customer (if the transaction originated in another workspace)." }, "accountGroupInProjectTransactionLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Account group > The account group of the debit side account of the transaction." }, "debitAccountGroupInProjectTransactionLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Debit Account group > The account group of the debit side account of the transaction. This field has been deprecated and will be removed in future versions. Use DebitAccountGroup." }, "creditAccountGroupInProjectTransactionLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Debit Account group > The account group of the credit side account of the transaction." }, "locationInProjectTransactionLineDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Location > The location of the customer or supplier." }, "ProjectTransactionLineDto": { "type": "object", "properties": { "tranId": { "type": "integer", "format": "int64" }, "date": { "type": "string", "description": "Date > The date the transaction was created.", "format": "date-time" }, "inventoryId": { "$ref": "#/components/schemas/inventoryIdInProjectTransactionLineDto" }, "description": { "type": "string", "description": "Description > The description of the transaction." }, "uom": { "type": "string", "description": "UoM > The unit of measure used to estimate the quantity for the transaction, such as HOUR or BOX." }, "quantity": { "type": "number", "description": "Quantity > \tThe quantity for the transaction, such as the number of service hours provided to the customer.", "format": "double" }, "unitRate": { "type": "number", "description": "Unit rate > The price of the item or the rate of the service.", "format": "double" }, "amount": { "type": "number", "description": "Amount > The amount of the transaction.", "format": "double" }, "billable": { "type": "boolean", "description": "Invoiceable > A check box indicating whether the transaction is used in calculating the amount charged to the customer for the project task." }, "released": { "type": "boolean", "description": "Released > A check box indicating whether the transaction has been released." }, "allocated": { "type": "boolean", "description": "Allocated > A check box that indicates whether the amounts of the transactions were allocated for the project." }, "billableQuantity": { "type": "number", "description": "Qty. that can be invoiced > The total invoiceable quantity for the transactions listed in the table.", "format": "double" }, "financialPeriod": { "type": "string", "description": "Period > The financial period associated with the transaction." }, "batchNbr": { "type": "string", "description": "Batch no. > The batch number of the transaction in the General ledger workspace." }, "useBillableQty": { "type": "boolean", "description": "Use the quantity that can be invoiced in the amount formula > A check box that you select if you want the system to use the invoiceable quantity (the Invoiceable quantity column) instead of the overall quantity (the Quantity column) of the transaction when calculating the amount of transaction." }, "startDate": { "type": "string", "description": "Start date > The start date for this transaction.", "format": "date-time" }, "endDate": { "type": "string", "description": "End date > The end date for this transaction", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information", "format": "date-time" }, "earningType": { "$ref": "#/components/schemas/earningTypeInProjectTransactionLineDto" }, "overtimeMultiplier": { "type": "number", "description": "Multiplier > The multiplier by which the unit rate is multiplied when the labour cost is calculated.", "format": "double" }, "project": { "$ref": "#/components/schemas/projectInProjectTransactionLineDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInProjectTransactionLineDto" }, "debitAccount": { "$ref": "#/components/schemas/debitAccountInProjectTransactionLineDto" }, "debitSubaccount": { "$ref": "#/components/schemas/debitSubaccountInProjectTransactionLineDto" }, "creditAccount": { "$ref": "#/components/schemas/creditAccountInProjectTransactionLineDto" }, "creditSubaccount": { "$ref": "#/components/schemas/creditSubaccountInProjectTransactionLineDto" }, "branch": { "$ref": "#/components/schemas/branchInProjectTransactionLineDto" }, "employee": { "$ref": "#/components/schemas/employeeInProjectTransactionLineDto" }, "customerVendor": { "$ref": "#/components/schemas/customerVendorInProjectTransactionLineDto" }, "accountGroup": { "$ref": "#/components/schemas/accountGroupInProjectTransactionLineDto" }, "debitAccountGroup": { "$ref": "#/components/schemas/debitAccountGroupInProjectTransactionLineDto" }, "creditAccountGroup": { "$ref": "#/components/schemas/creditAccountGroupInProjectTransactionLineDto" }, "location": { "$ref": "#/components/schemas/locationInProjectTransactionLineDto" }, "note": { "type": "string" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "ProjectTransactionDocumentDto": { "type": "object", "properties": { "refNbr": { "type": "string", "description": "The top part > Ref. no. > The reference number of the transaction." }, "description": { "type": "string", "description": "The top part > Description > The description provided for the transaction." }, "origDocNbr": { "type": "string", "description": "The top part > Orig. doc. no. > The reference number of the underlying document for the transaction." }, "status": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string", "description": "The top part > Status > The status of the transaction. The following statuses are possible: Balanced, Released." }, "module": { "enum": [ "ModuleGL", "ModuleAP", "ModuleAR", "ModuleCA", "ModuleCM", "ModuleIN", "ModuleSO", "ModulePO", "ModuleDR", "ModuleFA", "ModuleEP", "ModulePM", "ModuleTX", "ModuleCR" ], "type": "string", "description": "The top part > Module > The module you create the transactions in." }, "origDocType": { "enum": [ "Allocation", "Timecard", "Case", "ExpenseClaim", "EquipmentTimecard", "AllocationReversal", "Reversal", "CreditMemo", "UnbilledRemainder", "ProformaBilling" ], "type": "string", "description": "The top part > Orig. doc. no. > The type of the document the transaction is based on. It has one of the following values: Allocation, Time card, Case, Expense claim, Allocation reversal, Reversal, Credit note." }, "note": { "type": "string" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTransactionLineDto" }, "description": "The table >" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "DtoValueOfInt64": { "type": "object", "properties": { "value": { "type": "integer", "format": "int64" } } }, "ProjectTransactionLineUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "tranId": { "$ref": "#/components/schemas/DtoValueOfInt64" }, "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "inventoryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "billableQuantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "unitRate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "amount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "billable": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "financialPeriod": { "$ref": "#/components/schemas/DtoValueOfString" }, "batchNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "useBillableQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "project": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTask": { "$ref": "#/components/schemas/DtoValueOfString" }, "debitAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "debitSubaccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "creditAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "creditSubaccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "employee": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerVendor": { "$ref": "#/components/schemas/DtoValueOfString" }, "accountGroup": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "DtoValueOfNullableOfJournalTransactionModule": { "type": "object", "properties": { "value": { "enum": [ "ModuleGL", "ModuleAP", "ModuleAR", "ModuleCA", "ModuleCM", "ModuleIN", "ModuleSO", "ModulePO", "ModuleDR", "ModuleFA", "ModuleEP", "ModulePM", "ModuleTX", "ModuleCR" ], "type": "string" } } }, "DtoValueOfNullableOfProjectTransactionStatus": { "type": "object", "properties": { "value": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string" } } }, "ProjectTransactionDocumentUpdateDto": { "type": "object", "properties": { "refNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "status": { "$ref": "#/components/schemas/DtoValueOfNullableOfProjectTransactionStatus" }, "module": { "$ref": "#/components/schemas/DtoValueOfNullableOfJournalTransactionModule" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTransactionLineUpdateDto" } }, "note": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "ProjectTransactionQueryParameters": { "type": "object", "properties": { "module": { "enum": [ "ModuleGL", "ModuleAP", "ModuleAR", "ModuleCA", "ModuleCM", "ModuleIN", "ModuleSO", "ModulePO", "ModuleDR", "ModuleFA", "ModuleEP", "ModulePM", "ModuleTX", "ModuleCR" ], "type": "string", "description": "Select to filter on module; e.g. AR, AP, IN etc." }, "status": { "enum": [ "Hold", "Balanced", "Released" ], "type": "string", "description": "The status of the document." }, "project": { "type": "string", "description": "Filter on project ID." }, "projectTask": { "type": "string", "description": "Filter on Task ID." }, "billable": { "type": "boolean", "description": "Filter invoiceable project tasks." }, "branch": { "type": "string", "description": "Filter on branch for the project transation." }, "date": { "type": "string", "description": "Filter on the registration date for the project transaction.", "format": "date-time" }, "fromPeriod": { "type": "string", "description": "Mandatory. Start date for the task." }, "toPeriod": { "type": "string", "description": "Mandatory. End date for the task." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "expandNote": { "type": "boolean", "description": "Expands project transaction notes" }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "DiscountCodeNumberDescriptionDto": { "type": "object", "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } } }, "PurchaseReceiptsDto": { "type": "object", "properties": { "type": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string", "description": "The top part > Type > The type of the document, which can be Receipt, Return, or Transfer receipt." }, "receiptNumber": { "type": "string", "description": "The top part > Receipt no. > The unique reference number of the purchase receipt, transfer receipt, or return, which the system automatically assigns according to its number series." }, "status": { "enum": [ "Hold", "Balanced", "Released", "Cancelled" ], "type": "string", "description": "The top part > Status > The current status of the purchase or transfer receipt, or return, which the system assigns automatically." }, "supplierName": { "type": "string", "description": "The top part > Supplier > The supplier from which the items have been received or to which they will be returned." }, "currency": { "type": "string", "description": "The top part > Currency > The currency the supplier uses for invoicing." }, "totalQty": { "type": "number", "description": "The top part > Total qty. > The total quantity of items received from or returned to the supplier; the sum of all quantities of all stock items listed on the Document details tab.", "format": "double" }, "totalAmt": { "type": "number", "description": "The top part > Total amt. > The total amount calculated for items received from or returned to the supplier; the sum of all amounts of all stock items listed on the Document details tab.", "format": "double" } } }, "branchInPurchaseOrderLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Branch > The branch associated with the purchase order." }, "inventoryInPurchaseOrderLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Item ID > The ID of the item." }, "warehouseInPurchaseOrderLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Warehouse > The warehouse to receive the item listed on the order." }, "discountCodeInPurchaseOrderLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Discount code > The code of the line discount that has been applied to this line automatically." }, "taxCategoryInPurchaseOrderLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "VAT category > The VAT category assigned to the ordered stock item." }, "accountInPurchaseOrderLineDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Account > The expense account used to record the purchased non-stock item that does not require receipt (by default, the account specified for the item in the Combine COGS/expense sub. from field in the Posting classes (IN206000) window)." }, "subInPurchaseOrderLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Sub. ID > The subaccount used to record the purchased non-stock item that does not require receipt (by default, the subaccount generated in accordance with the rule defined in the Combine COGS/expense sub. from field in the Posting classes (IN206000) window)." }, "projectInPurchaseOrderLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project > The project with which this purchase order line is associated." }, "projectTaskInPurchaseOrderLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project task > The project task with which this purchase order is associated." }, "PurchaseOrderLineDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "description": "The line number", "format": "int32" }, "branch": { "$ref": "#/components/schemas/branchInPurchaseOrderLineDto" }, "inventory": { "$ref": "#/components/schemas/inventoryInPurchaseOrderLineDto" }, "lineType": { "enum": [ "GoodsForInventory", "GoodsForSalesOrder", "GoodsForReplenishment", "GoodsForDropShip", "NonStockForDropShip", "NonStockForSalesOrder", "NonStock", "Service", "Freight", "Description" ], "type": "string", "description": "Line type > \tThe type of the order line, which can be one of the following options: Goods for inventory, Non-stock, Service, Freight, Good for sales order, Non-stock for drop-ship, Drop-ship, Goods for RP, Description." }, "warehouse": { "$ref": "#/components/schemas/warehouseInPurchaseOrderLineDto" }, "lineDescription": { "type": "string", "description": "A description of the order line, which is copied from the item's description." }, "uom": { "type": "string", "description": "UoM > The unit of measure (UoM) in which the quantity of the item is specified." }, "orderQty": { "type": "number", "description": "Order qty. > The quantity of the item that has been ordered.", "format": "double" }, "baseOrderQty": { "type": "number", "description": "Base Order qty. > The base quantity of the item that has been ordered.", "format": "double" }, "qtyOnReceipts": { "type": "number", "description": "Qty. on receipts > The quantity of the item that has been received according to all receipts, including the unreleased ones.", "format": "double" }, "unitCost": { "type": "number", "description": "Unit cost > The cost per UoM of the stock item.", "format": "double" }, "unitCostInBaseCurrency": { "type": "number", "description": "Background calculation connected with the View base/View currency function in the top part. Changes the values in Unit cost, Amount, Disc. unit cost and Cost fields.", "format": "double" }, "extCost": { "type": "number", "description": "Ext. cost > The extended cost of the item, which is the unit cost multiplied by the quantity.", "format": "double" }, "discountPercent": { "type": "number", "description": "Discount percent > If the Supplier customer discounts functionality is enabled in the Enable/disable functionalities (CS100000) window, the percent of the discount that has been entered manually or calculated based on the discount amount entered manually for this line item.", "format": "double" }, "discountAmount": { "type": "number", "description": "Discount amount > If the Supplier customer discounts functionality is enabled in the Enable/disable functionalities (CS100000) window, the amount of the discount that has been specified manually or calculated based on the discount percent entered manually.", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Manual discount > A check box that indicates (if selected) that the discount has been applied manually." }, "discountCode": { "$ref": "#/components/schemas/discountCodeInPurchaseOrderLineDto" }, "amount": { "type": "number", "description": "Amount > The amount calculated (after the discount has been taken) for the item.", "format": "double" }, "receivedAmt": { "type": "number", "description": "Received amt. > The amount received on this purchase order for this item.", "format": "double" }, "alternateId": { "type": "string", "description": "Alternate ID > The alternate ID used for this stock item-subitem pair by the supplier." }, "minReceipt": { "type": "number", "description": "Min. receipt (%) > The minimum quantity of the item, expressed as a percentage of the ordered quantity, that is required for the item to be accepted at the warehouse if the Receipt action is Rejected.", "format": "double" }, "maxReceipt": { "type": "number", "description": "Max. receipt (%) > The maximum quantity of the item, expressed as a percentage of the ordered quantity, that is required for the item to be accepted at the warehouse if the Receipt action is Rejected.", "format": "double" }, "completeOn": { "type": "number", "description": "Complete on (%) > The minimum percentage of the ordered quantity for the stock item that must be received to complete the purchase order line (gets the default value from the Threshold receipt (%) setting of the supplier in the (AP303000) window).", "format": "double" }, "receiptAction": { "enum": [ "Reject", "AcceptButWarn", "Accept" ], "type": "string", "description": "Receipt action > The action that should be perform when the ordered item is received if its quantity is greater than the Max. receipt value or less than the Min. receipt value calculated based on the line's ordered quantity. Values: Reject, Accept but warn, Accept." }, "taxCategory": { "$ref": "#/components/schemas/taxCategoryInPurchaseOrderLineDto" }, "account": { "$ref": "#/components/schemas/accountInPurchaseOrderLineDto" }, "sub": { "$ref": "#/components/schemas/subInPurchaseOrderLineDto" }, "project": { "$ref": "#/components/schemas/projectInPurchaseOrderLineDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInPurchaseOrderLineDto" }, "requested": { "type": "string", "description": "Requested > The date when the item was requested.", "format": "date-time" }, "promised": { "type": "string", "description": "Promised > The date when the item's deliver was promised.", "format": "date-time" }, "completed": { "type": "boolean", "description": "Completed > A check box that indicates (if selected) that the purchasing of the item requested by this line of the purchase order has been completed." }, "canceled": { "type": "boolean", "description": "Cancelled > A check box that indicates (if selected) that this line of the purchase order has been cancelled." }, "orderType": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string", "description": "Order type > The order type this order is related to (for normal orders based on blanket or standard orders)." }, "orderNumber": { "type": "string", "description": "Order no. > \tThe reference number of the blanket or standard order (for normal orders based on blanket or standard orders)." }, "note": { "type": "string", "description": "Table > Icon Notes > Pop-up window for providing any user-defined text connected to the order." }, "customStr1": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr2": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr3": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr4": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr5": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customDec1": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customDec2": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customInt1": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customInt2": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customDateTimeUTC1": { "type": "string", "description": "A free custom colum of type DateTime - in UTC timezone", "format": "date-time" } }, "description": "This class represents a Purchase Order Line in PurchaseOrderController. Used for getting data." }, "UserDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } } }, "SupplierDescriptionDto": { "type": "object", "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } } }, "DiscountDetailDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "description": "The table > Line number.", "format": "int32" }, "skipDiscount": { "type": "boolean", "description": "The table > Skip discount > A check box that you select to cancel a Group or Document level discount for the document." }, "discountCode": { "type": "string", "description": "Mandatory field: The table > Discount code* > The discount code of the supplier discount applied to the document automatically or manually." }, "sequanceID": { "type": "string", "description": "Mandatory field: The table > Series ID* > The ID of the discount sequence applied to the document." }, "type": { "enum": [ "Line", "Group", "Document", "Flat" ], "type": "string", "description": "The table > Type > The type of discount applied to the document (Group or Document)." }, "manualDiscount": { "type": "boolean", "description": "The table > Manual discount > A check box that indicates (if selected) that the supplier discount shown in this row has been applied manually ." }, "discountableAmt": { "type": "number", "description": "The table > Discountable amt. > The amount used as a base for discount calculation if the discount is defined as based on the amount.", "format": "double" }, "discountableQty": { "type": "number", "description": "The table > Discountable qty. > The quantity used as a base for discount calculation if the discount is defined as based on the item quantity.", "format": "double" }, "discountAmt": { "type": "number", "description": "The table > Discount amt. > The amount of the discount.", "format": "double" }, "discount": { "type": "number", "description": "The table > Discount percent > The discount percent if by definition the discount is calculated as a percentage.", "format": "double" }, "freeItem": { "type": "integer", "description": "The table > Free item > The item ID of the free item, if one is specified by the discount applied to the document.", "format": "int32" }, "freeItemQty": { "type": "number", "description": "The table > Free item qty.> The quantity of the free item to be added as the discount.", "format": "double" } } }, "countryInPurchaseOrderAddressDto": { "properties": { "id": { "type": "string", "description": "Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166." }, "name": { "type": "string", "description": "Mandatory field: Country name* > The complete name of the country." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Country > The country." }, "countyInPurchaseOrderAddressDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "County > The county or province." }, "PurchaseOrderAddressDto": { "type": "object", "properties": { "overrideAddress": { "type": "boolean", "description": "The Supplier info tab > The Supplier address section > Override > A check box that you select to override (that is, to edit ) the default shipping address for the supplier." }, "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInPurchaseOrderAddressDto" }, "county": { "$ref": "#/components/schemas/countyInPurchaseOrderAddressDto" } } }, "PurchaseOrderContactDto": { "type": "object", "properties": { "overrideContact": { "type": "boolean", "description": "The Supplier information tab > The Supplier contact section > Override > A check box that you select to override (edit) the default contact settings for the supplier." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } } }, "shipToInPurchaseOrderDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Shipping instructions tab > The Delivery address section > Ship to > The particular destination of the selected type." }, "shippingLocationInPurchaseOrderDto": { "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The Shipping instructions tab > The Delivery address section > Shipping location* > The location from which the order is to be shipped." }, "warehouseInPurchaseOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Document details tab > Warehouse > The warehouse to receive the item listed on the order." }, "shippingContactInPurchaseOrderDto": { "properties": { "overrideContact": { "type": "boolean", "description": "The Supplier information tab > The Supplier contact section > Override > A check box that you select to override (edit) the default contact settings for the supplier." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Supplier information tab > The Supplier contact section > The supplier contact for matters related to this purchase order." }, "shippingAddressInPurchaseOrderDto": { "properties": { "overrideAddress": { "type": "boolean", "description": "The Supplier info tab > The Supplier address section > Override > A check box that you select to override (that is, to edit ) the default shipping address for the supplier." }, "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInPurchaseOrderAddressDto" }, "county": { "$ref": "#/components/schemas/countyInPurchaseOrderAddressDto" } }, "description": "Supplier info tab > The Supplier address section > The default shipping address for the supplier." }, "remitContactInPurchaseOrderDto": { "properties": { "overrideContact": { "type": "boolean", "description": "The Supplier information tab > The Supplier contact section > Override > A check box that you select to override (edit) the default contact settings for the supplier." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Supplier info tab > The Supplier contact section > The default contact settings for the supplier." }, "remitAddressInPurchaseOrderDto": { "properties": { "overrideAddress": { "type": "boolean", "description": "The Supplier info tab > The Supplier address section > Override > A check box that you select to override (that is, to edit ) the default shipping address for the supplier." }, "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInPurchaseOrderAddressDto" }, "county": { "$ref": "#/components/schemas/countyInPurchaseOrderAddressDto" } }, "description": "Supplier info tab > The Supplier address section > The default contact setting for the supplier." }, "termsInPurchaseOrderDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The Supplier info tab > The Info section > Terms* > The specific credit terms to be used for the purchase order." }, "supplierVatZoneInPurchaseOrderDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Supplier info tab > The Info section > Supplier VAT zone > The VAT zone of the supplier's location." }, "supplierInPurchaseOrderDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: The top part > Supplier* > The supplier from which the items will be purchased." }, "locationInPurchaseOrderDto": { "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part > Location* > Click the magnifier. The supplier location from which the items will be received." }, "ownerInPurchaseOrderDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Owner > The employee who is responsible for the purchase order." }, "branchInPurchaseOrderDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Document details tab > Branch > The branch to receive the item." }, "PurchaseOrderDto": { "type": "object", "properties": { "shippingDestinationType": { "enum": [ "CompanyLocation", "Customer", "Vendor", "Site" ], "type": "string", "description": "Shipping instructions tab > The Delivery address section > Shipping destination type > The type of the shipping destination, which is one of the following options: Branch location (meaning a branch of your company), Customer, Supplier, and Warehouse." }, "shipTo": { "$ref": "#/components/schemas/shipToInPurchaseOrderDto" }, "shippingLocation": { "$ref": "#/components/schemas/shippingLocationInPurchaseOrderDto" }, "warehouse": { "$ref": "#/components/schemas/warehouseInPurchaseOrderDto" }, "shippingContact": { "$ref": "#/components/schemas/shippingContactInPurchaseOrderDto" }, "shippingAddress": { "$ref": "#/components/schemas/shippingAddressInPurchaseOrderDto" }, "fobPoint": { "type": "string", "description": "Delivery instructions tab > The Delivery instructions section > FOB point > The FOB point where the title of goods (listed on this purchase order) is transferred from the supplier to the company." }, "shipVia": { "type": "string", "description": "Delivery instructions tab > The Delivery instructions section > Ship via > The carrier selected to ship the goods for the purchase order." }, "shipTerms": { "type": "string", "description": "Delivery instructions tab > The Delivery instructions section > Shipping terms > The shipping terms for the purchase order." }, "remitContact": { "$ref": "#/components/schemas/remitContactInPurchaseOrderDto" }, "remitAddress": { "$ref": "#/components/schemas/remitAddressInPurchaseOrderDto" }, "terms": { "$ref": "#/components/schemas/termsInPurchaseOrderDto" }, "supplierVatZone": { "$ref": "#/components/schemas/supplierVatZoneInPurchaseOrderDto" }, "discountDetails": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountDetailDto" }, "description": "Discount details tab >" }, "salesOrderType": { "type": "string", "description": "Other information tab > Sales order type > The type of the sales order associated with the purchase order." }, "salesOrderNbr": { "type": "string", "description": "Other information tab > Sales order no. > The ID of the sales order associated with the purchase order." }, "requisitionRefNbr": { "type": "string", "description": "Other information tab > Requisition ref. no. > The reference number of the requisition document associated with the purchase order, if any." }, "paymentRefNbr": { "type": "string", "description": "Other information tab > Prepayment ref. no. > The reference number of the prepayment request linked to this purchase order, if any." }, "workgroupID": { "type": "integer", "description": "Other information tab > Work group ID > The work group to which the purchase order was assigned for processing.", "format": "int32" }, "dontPrint": { "type": "boolean", "description": "Other information > Do not print > A check box that indicates (if selected) that the current purchase order should not be printed." }, "printed": { "type": "boolean", "description": "Other information > Printed > A check box that indicates (if selected) that the current purchase order was printed." }, "dontEmail": { "type": "boolean", "description": "Other information > Do not email > A check box that indicates (if selected) indicates that the purchase order should not be emailed." }, "emailed": { "type": "boolean", "description": "Other information > Emailed > A check box that indicates (if selected) indicates that the current purchase order was emailed." }, "openQuantity": { "type": "number", "description": "Other information > Open Quantity > The difference between the quantities of ordered and received items.", "format": "double" }, "openBalance": { "type": "number", "description": "Other information > Open amount > The amount of these items that are ordered but not received.", "format": "double" }, "orderType": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string", "description": "The top part > Type > The type of the purchase order, which can be one of these options: Normal, Drop-ship, Blanket, Default" }, "orderNbr": { "type": "string", "description": "The top part > Order no. > The unique reference number of the purchase order, which the system assigns based on the number series assigned to purchase orders of this type, as specified in the PO101000 window." }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that you select to give the purchase order the On hold status." }, "status": { "enum": [ "Balanced", "Cancelled", "Closed", "Hold", "Open", "PendingEmail", "PendingPrint", "Printed", "Voided" ], "type": "string", "description": "The top part > Status > The system-generated status of the purchase order, which can be one of the following options: On hold, Open, Pending approval, Rejected, Pending printing, Pending e-mail, Closed, Cancelled." }, "date": { "type": "string", "description": "Mandatory field: The top part > Date* > The date when the purchase order was created.", "format": "date-time" }, "promisedOn": { "type": "string", "description": "The top part > Delivery date > The date when the supplier promised that the items listed in the order will be received at their destination location.", "format": "date-time" }, "description": { "type": "string", "description": "The top part > Description > A brief description of the purchase order." }, "supplier": { "$ref": "#/components/schemas/supplierInPurchaseOrderDto" }, "location": { "$ref": "#/components/schemas/locationInPurchaseOrderDto" }, "owner": { "$ref": "#/components/schemas/ownerInPurchaseOrderDto" }, "currency": { "type": "string", "description": "The top part > Currency > The currency the purchase order will be paid in." }, "supplierRef": { "type": "string", "description": "The top part > Supplier ref. > The reference number of the supplier document related to this purchase order." }, "exchangeRate": { "type": "number", "format": "double" }, "lineTotal": { "type": "number", "description": "The top part > Line total > The total sum of the Extended amount entries for all lines in the current purchase order. This value is calculated by the system and users cannot manually change it.", "format": "double" }, "lineTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the Line total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The Top part > VAT exempt total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the VAT with the Include in VAT exempt total check box selected in the TX205000 window.", "format": "double" }, "vatExemptTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the VAT exempt total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "taxTotal": { "type": "number", "description": "The Top part > VAT total > The total VAT amount for all lines added to the current purchase order. This value, also calculated by the system, is the sum of the VAT amounts for each line.", "format": "double" }, "taxTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the VAT total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "orderTotal": { "type": "number", "description": "The Top part > Order total > The total sum for the purchase order, including VAT. This read-only value is the sum of the Line total and VAT total values.", "format": "double" }, "orderTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the Order total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "controlTotal": { "type": "number", "description": "The top part > Control total > The order's total amount (including VAT), which you must enter manually when you attempt to save the order with the Balanced status.", "format": "double" }, "controlTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the Control total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "branch": { "$ref": "#/components/schemas/branchInPurchaseOrderDto" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineDto" }, "description": "Document details tab > The table >" }, "taxDetails": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailDto" }, "description": "VAT details tab >" }, "purchaseReceipts": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptsDto" }, "description": "Purchase receipts tab >" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "customStr1": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr2": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr3": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr4": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr5": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customDec1": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customDec2": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customInt1": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customInt2": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customDateTimeUTC1": { "type": "string", "description": "A free custom colum of type DateTime - in UTC timezone", "format": "date-time" }, "timeStamp": { "type": "string", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Purchase Order in PurchaseOrderController. Used for getting data." }, "DtoValueOfNullableOfPurchaseOrderReceiptAction": { "type": "object", "properties": { "value": { "enum": [ "Reject", "AcceptButWarn", "Accept" ], "type": "string" } } }, "DtoValueOfNullableOfPoLineType": { "type": "object", "properties": { "value": { "enum": [ "GoodsForInventory", "GoodsForSalesOrder", "GoodsForReplenishment", "GoodsForDropShip", "NonStockForDropShip", "NonStockForSalesOrder", "NonStock", "Service", "Freight", "Description" ], "type": "string" } } }, "PurchaseOrderAddressUpdateDto": { "type": "object", "properties": { "overrideAddress": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "addressLine1": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine2": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine3": { "$ref": "#/components/schemas/DtoValueOfString" }, "postalCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "city": { "$ref": "#/components/schemas/DtoValueOfString" }, "countryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "county": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "PurchaseOrderContactUpdateDto": { "type": "object", "properties": { "overrideContact": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "name": { "$ref": "#/components/schemas/DtoValueOfString" }, "attention": { "$ref": "#/components/schemas/DtoValueOfString" }, "email": { "$ref": "#/components/schemas/DtoValueOfString" }, "web": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone1": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone2": { "$ref": "#/components/schemas/DtoValueOfString" }, "fax": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "customStr1InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InPurchaseOrderLineUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "PurchaseOrderLineUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "inventory": { "$ref": "#/components/schemas/DtoValueOfString" }, "lineType": { "$ref": "#/components/schemas/DtoValueOfNullableOfPoLineType" }, "warehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "lineDescription": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "orderQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "unitCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "extCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "amount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "alternateId": { "$ref": "#/components/schemas/DtoValueOfString" }, "minReceipt": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "maxReceipt": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "completeOn": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "receiptAction": { "$ref": "#/components/schemas/DtoValueOfNullableOfPurchaseOrderReceiptAction" }, "taxCategory": { "$ref": "#/components/schemas/DtoValueOfString" }, "account": { "$ref": "#/components/schemas/DtoValueOfString" }, "sub": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "project": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTask": { "$ref": "#/components/schemas/DtoValueOfString" }, "requested": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "promised": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "customStr1": { "$ref": "#/components/schemas/customStr1InPurchaseOrderLineUpdateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InPurchaseOrderLineUpdateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InPurchaseOrderLineUpdateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InPurchaseOrderLineUpdateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InPurchaseOrderLineUpdateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InPurchaseOrderLineUpdateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InPurchaseOrderLineUpdateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InPurchaseOrderLineUpdateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InPurchaseOrderLineUpdateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InPurchaseOrderLineUpdateDto" }, "completed": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" } }, "description": "This class represent a Purchase Order Line in Purchase Order Controller. Used to pass data to server for creating or updating an order line" }, "DtoValueOfNullableOfPurchaseOrderType": { "type": "object", "properties": { "value": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string" } } }, "DiscountDetailUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "skipDiscount": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "sequanceID": { "$ref": "#/components/schemas/DtoValueOfString" } }, "description": "This class represent a Discount Detail for Purchase Order in Purchase Order Controller. Used to pass data to server for creating or updating an order" }, "DtoValueOfPurchaseOrderAddressUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/PurchaseOrderAddressUpdateDto" } } }, "DtoValueOfPurchaseOrderContactUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/PurchaseOrderContactUpdateDto" } } }, "DtoValueOfNullableOfPOShippingDestinationType": { "type": "object", "properties": { "value": { "enum": [ "CompanyLocation", "Customer", "Vendor", "Site" ], "type": "string" } } }, "supplierInPurchaseOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if GLN or VatRegistrationId is not specified." }, "glnInPurchaseOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if Supplier or VatRegistrationId is not specified." }, "vatRegistrationIdInPurchaseOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if Supplier or GLN is not specified." }, "customStr1InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InPurchaseOrderUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "PurchaseOrderUpdateDto": { "type": "object", "properties": { "shippingDestinationType": { "$ref": "#/components/schemas/DtoValueOfNullableOfPOShippingDestinationType" }, "shipTo": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippingLocation": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippingContact": { "$ref": "#/components/schemas/DtoValueOfPurchaseOrderContactUpdateDto" }, "shippingAddress": { "$ref": "#/components/schemas/DtoValueOfPurchaseOrderAddressUpdateDto" }, "fobPoint": { "$ref": "#/components/schemas/DtoValueOfString" }, "shipVia": { "$ref": "#/components/schemas/DtoValueOfString" }, "shipTerms": { "$ref": "#/components/schemas/DtoValueOfString" }, "remitContact": { "$ref": "#/components/schemas/DtoValueOfPurchaseOrderContactUpdateDto" }, "remitAddress": { "$ref": "#/components/schemas/DtoValueOfPurchaseOrderAddressUpdateDto" }, "terms": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplierVatZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "discountDetails": { "type": "array", "items": { "$ref": "#/components/schemas/DiscountDetailUpdateDto" } }, "dontPrint": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "dontEmail": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "orderType": { "$ref": "#/components/schemas/DtoValueOfNullableOfPurchaseOrderType" }, "orderNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "promisedOn": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplier": { "$ref": "#/components/schemas/supplierInPurchaseOrderUpdateDto" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "gln": { "$ref": "#/components/schemas/glnInPurchaseOrderUpdateDto" }, "vatRegistrationId": { "$ref": "#/components/schemas/vatRegistrationIdInPurchaseOrderUpdateDto" }, "owner": { "$ref": "#/components/schemas/DtoValueOfNullableOfGuid" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "supplierRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "controlTotal": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineUpdateDto" } }, "changeDatesOnLines": { "type": "boolean" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "customStr1": { "$ref": "#/components/schemas/customStr1InPurchaseOrderUpdateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InPurchaseOrderUpdateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InPurchaseOrderUpdateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InPurchaseOrderUpdateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InPurchaseOrderUpdateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InPurchaseOrderUpdateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InPurchaseOrderUpdateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InPurchaseOrderUpdateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InPurchaseOrderUpdateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InPurchaseOrderUpdateDto" }, "timeStamp": { "type": "string", "format": "byte" } }, "description": "This class represent a Purchase Order in Purchase Order Controller. Used to pass data to server for creating or updating an order" }, "PurchaseOrderQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string", "description": "Filter on order no. and forward" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "orderType": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string", "description": "Select and filter on Type." }, "orderStatus": { "enum": [ "Balanced", "Cancelled", "Closed", "Hold", "Open", "PendingEmail", "PendingPrint", "Printed", "Voided" ], "type": "string", "description": "Select and filter on Status." }, "supplier": { "type": "string", "description": "Filter on Supplier." }, "branch": { "type": "string", "description": "Filter on Branch" }, "orderDate": { "type": "string", "description": "This value indicates the order date. Use it to retrieve all records that have the order date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __OrderDate__ and __OrderDateCondition__ are __mutually inclusive__." }, "orderDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the order date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __OrderDate__ and __OrderDateCondition__ are __mutually inclusive__." }, "deliveryDate": { "type": "string", "description": "This value indicates the date the document is due for delivery. Use it to retrieve all records that have the delivery date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __DeliveryDate__ and __DeliveryDateCondition__ are __mutually inclusive__." }, "deliveryDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DeliveryDate__ and __DeliveryDateCondition__ are __mutually inclusive__." }, "includeCustomFreeFields": { "type": "boolean", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "CreatePurchaseReceiptActionDto": { "required": [ "orderType" ], "type": "object", "properties": { "orderType": { "type": "string", "description": "Mandatory field" } } }, "supplierInPurchaseOrderBasicDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: The top part > Supplier* > The supplier from which the items will be purchased." }, "locationInPurchaseOrderBasicDto": { "properties": { "id": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part > Location* > Click the magnifier. The supplier location from which the items will be received." }, "ownerInPurchaseOrderBasicDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Owner > The employee who is responsible for the purchase order." }, "branchInPurchaseOrderBasicDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Document details tab > Branch > The branch to receive the item." }, "PurchaseOrderBasicDto": { "type": "object", "properties": { "orderType": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string", "description": "The top part > Type > The type of the purchase order, which can be one of these options: Normal, Drop-ship, Blanket, Default" }, "orderNbr": { "type": "string", "description": "The top part > Order no. > The unique reference number of the purchase order, which the system assigns based on the number series assigned to purchase orders of this type, as specified in the PO101000 window." }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that you select to give the purchase order the On hold status." }, "status": { "enum": [ "Balanced", "Cancelled", "Closed", "Hold", "Open", "PendingEmail", "PendingPrint", "Printed", "Voided" ], "type": "string", "description": "The top part > Status > The system-generated status of the purchase order, which can be one of the following options: On hold, Open, Pending approval, Rejected, Pending printing, Pending e-mail, Closed, Cancelled." }, "date": { "type": "string", "description": "Mandatory field: The top part > Date* > The date when the purchase order was created.", "format": "date-time" }, "promisedOn": { "type": "string", "description": "The top part > Delivery date > The date when the supplier promised that the items listed in the order will be received at their destination location.", "format": "date-time" }, "description": { "type": "string", "description": "The top part > Description > A brief description of the purchase order." }, "supplier": { "$ref": "#/components/schemas/supplierInPurchaseOrderBasicDto" }, "location": { "$ref": "#/components/schemas/locationInPurchaseOrderBasicDto" }, "owner": { "$ref": "#/components/schemas/ownerInPurchaseOrderBasicDto" }, "currency": { "type": "string", "description": "The top part > Currency > The currency the purchase order will be paid in." }, "supplierRef": { "type": "string", "description": "The top part > Supplier ref. > The reference number of the supplier document related to this purchase order." }, "exchangeRate": { "type": "number", "format": "double" }, "lineTotal": { "type": "number", "description": "The top part > Line total > The total sum of the Extended amount entries for all lines in the current purchase order. This value is calculated by the system and users cannot manually change it.", "format": "double" }, "lineTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the Line total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The Top part > VAT exempt total > The document total that is exempt from VAT. This total is calculated as the taxable amount for the VAT with the Include in VAT exempt total check box selected in the TX205000 window.", "format": "double" }, "vatExemptTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the VAT exempt total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "taxTotal": { "type": "number", "description": "The Top part > VAT total > The total VAT amount for all lines added to the current purchase order. This value, also calculated by the system, is the sum of the VAT amounts for each line.", "format": "double" }, "taxTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the VAT total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "orderTotal": { "type": "number", "description": "The Top part > Order total > The total sum for the purchase order, including VAT. This read-only value is the sum of the Line total and VAT total values.", "format": "double" }, "orderTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the Order total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "controlTotal": { "type": "number", "description": "The top part > Control total > The order's total amount (including VAT), which you must enter manually when you attempt to save the order with the Balanced status.", "format": "double" }, "controlTotalInBaseCurrency": { "type": "number", "description": "The top part > View base > A button that recalculates the Control total to your base currency if the amount on the purchase order is in another currency then base currency. When you click the button, the button toggles to View currency.", "format": "double" }, "branch": { "$ref": "#/components/schemas/branchInPurchaseOrderBasicDto" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineDto" }, "description": "Document details tab > The table >" }, "taxDetails": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailDto" }, "description": "VAT details tab >" }, "purchaseReceipts": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptsDto" }, "description": "Purchase receipts tab >" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "note": { "type": "string", "description": "Icon Notes on top of the window > Pop-up window for providing any user-defined text connected to the document." }, "customStr1": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr2": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr3": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr4": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr5": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customDec1": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customDec2": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customInt1": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customInt2": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customDateTimeUTC1": { "type": "string", "description": "A free custom colum of type DateTime - in UTC timezone", "format": "date-time" }, "timeStamp": { "type": "string", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Purchase Order in PurchaseOrderController. Used for getting data." }, "supplierInPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if GLN or VatRegistrationId is not specified." }, "glnInPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if Supplier or VatRegistrationId is not specified." }, "vatRegistrationIdInPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if Supplier or GLN is not specified." }, "customStr1InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InPurchaseOrderBasicUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "PurchaseOrderBasicUpdateDto": { "type": "object", "properties": { "orderType": { "$ref": "#/components/schemas/DtoValueOfNullableOfPurchaseOrderType" }, "orderNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "promisedOn": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplier": { "$ref": "#/components/schemas/supplierInPurchaseOrderBasicUpdateDto" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "gln": { "$ref": "#/components/schemas/glnInPurchaseOrderBasicUpdateDto" }, "vatRegistrationId": { "$ref": "#/components/schemas/vatRegistrationIdInPurchaseOrderBasicUpdateDto" }, "owner": { "$ref": "#/components/schemas/DtoValueOfNullableOfGuid" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "supplierRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "controlTotal": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseOrderLineUpdateDto" } }, "changeDatesOnLines": { "type": "boolean" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "customStr1": { "$ref": "#/components/schemas/customStr1InPurchaseOrderBasicUpdateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InPurchaseOrderBasicUpdateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InPurchaseOrderBasicUpdateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InPurchaseOrderBasicUpdateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InPurchaseOrderBasicUpdateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InPurchaseOrderBasicUpdateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InPurchaseOrderBasicUpdateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InPurchaseOrderBasicUpdateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InPurchaseOrderBasicUpdateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InPurchaseOrderBasicUpdateDto" }, "timeStamp": { "type": "string", "format": "byte" } }, "description": "This class represent a Purchase Order in Purchase Order Controller. Used to pass data to server for creating or updating an order\r\nSupplier is mandatory to create Purchase Order, customer can be identified by Supplier, GLN or VatRegistrationId" }, "locationInAllocationsDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Location > The location in the warehouse." }, "AllocationsDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "description": "Line no. > The line of the purchase order that contains the selected item.", "format": "int32" }, "itemId": { "type": "string", "description": "ItemId > The id of the item." }, "location": { "$ref": "#/components/schemas/locationInAllocationsDto" }, "lotSerialNumber": { "type": "string", "description": "Lot/Serial no. > The lot or serial number of the item." }, "quantity": { "type": "number", "description": "Quantity > The quantity of the stock item with the same lot number. It is 1 for items with serial numbers.", "format": "double" }, "uom": { "type": "string", "description": "UoM > The unit of measure for the specified quantity of the inventory item." }, "expirationDate": { "type": "string", "description": "Expiration date > The expiration date of the specified quantity of the stock item.", "format": "date-time" }, "description": { "type": "string", "description": "Description > The description of the stock item." } }, "description": "This class represents a Allocations for Purchase Receipt Line in PurchaseReceiptController. Used for getting data." }, "branchInPurchaseReceiptLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Branch is deprecated, please use BranchNumber instead." }, "branchNumberInPurchaseReceiptLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Document details tab > Branch* > The branch for which the item is purchased." }, "warehouseInPurchaseReceiptLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Document details tab > Warehouse* > The warehouse where the item has been received." }, "locationInPurchaseReceiptLineDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Document details tab > Location > The location where the item has been received." }, "discountCodeInPurchaseReceiptLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Document details tab > Discount code > The code of the line discount that has been applied to this line automatically." }, "taxCategoryInPurchaseReceiptLineDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Document details tab > VAT category > The VAT category assigned to the stock item." }, "accountInPurchaseReceiptLineDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Document details tab > Account > The account used to record the item amount on the purchase receipt;" }, "subInPurchaseReceiptLineDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Document details tab > Sub ID > The subaccount to be used to record the non-stock item amount on the purchase receipt (for non-stock items for which receipts are not required)." }, "actualAccountInPurchaseReceiptLineDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Document details tab > Accrual account > The accrual account to record the item amount on the purchase receipt; used for stock items and non-stock items for which a receipt is required." }, "actualSubInPurchaseReceiptLineDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Document details tab > Accrual sub. > The subaccount used to record the item amount on the purchase receipt, used for stock items and non-stock items for which a receipt is required." }, "projectInPurchaseReceiptLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Document details tab > Project > The project with which the document is associated. If the document is based on a purchase order, the project is automatically copied from the respective purchase order line." }, "projectTaskInPurchaseReceiptLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Document details tab > Project task > The project task with which the document is associated." }, "PurchaseReceiptLineDto": { "type": "object", "properties": { "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationsDto" } }, "note": { "type": "string" }, "baseReceiptQty": { "type": "number", "description": "Document details tab > Base receipt qty. > The quantity of the item received in the base unit of measure.", "format": "double" }, "lineNbr": { "type": "integer", "description": "The line number", "format": "int32" }, "branch": { "$ref": "#/components/schemas/branchInPurchaseReceiptLineDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInPurchaseReceiptLineDto" }, "inventory": { "$ref": "#/components/schemas/InventoryNumberDescriptionDto" }, "lineType": { "enum": [ "GoodsForInventory", "GoodsForSalesOrder", "GoodsForReplenishment", "GoodsForDropShip", "NonStockForDropShip", "NonStockForSalesOrder", "NonStock", "Service", "Freight", "Description" ], "type": "string", "description": "Document details tab > Line type > The type of the purchase order line." }, "warehouse": { "$ref": "#/components/schemas/warehouseInPurchaseReceiptLineDto" }, "location": { "$ref": "#/components/schemas/locationInPurchaseReceiptLineDto" }, "transactionDescription": { "type": "string", "description": "Document details tab > Transaction descr. > The description of the receipt or return transaction." }, "uom": { "type": "string", "description": "Document details tab > UoM > The unit of measure (UoM) used for the purchased or transferred item." }, "orderQty": { "type": "number", "description": "Document details tab > Ordered qty. > The quantity of the purchased item (in the specified UoM).", "format": "double" }, "openQty": { "type": "number", "description": "Document details tab > Open qty. > The quantity of the stock item yet to be received on the purchase order.", "format": "double" }, "receiptQty": { "type": "number", "description": "Document details tab > Receipts qty. > \tThe quantity of the item (with the specified subitem code) in the specified UoM that has been received (listed on released receipts).", "format": "double" }, "unitCost": { "type": "number", "description": "Document details tab > Unit cost > The cost of a unit of the purchased item.", "format": "double" }, "extCost": { "type": "number", "description": "Document details tab > Cost > The cost of the item, which is the unit price multiplied by the quantity.", "format": "double" }, "discountPercent": { "type": "number", "description": "Document details tab > Discount percent > If the Supplier and customer discounts functionality is enabled, the percent of the discount that has been entered manually or calculated based on the discount amount entered manually for this line item.", "format": "double" }, "discountAmount": { "type": "number", "description": "Document details tab > Discount amount > If the Supplier and customer discounts functionality is enabled, the amount of the discount that has been specified manually or calculated based on the discount percent entered manually.", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "Document details tab > Manual discount > A check box that indicates (if selected) that the discount has been applied manually." }, "discountCode": { "$ref": "#/components/schemas/discountCodeInPurchaseReceiptLineDto" }, "amount": { "type": "number", "description": "Document details tab > Amount > The amount calculated (after discount has been taken) for the item.", "format": "double" }, "taxCategory": { "$ref": "#/components/schemas/taxCategoryInPurchaseReceiptLineDto" }, "account": { "$ref": "#/components/schemas/accountInPurchaseReceiptLineDto" }, "accountDescription": { "type": "string", "description": "Document details tab > Description > The description of this account." }, "sub": { "$ref": "#/components/schemas/subInPurchaseReceiptLineDto" }, "actualAccount": { "$ref": "#/components/schemas/actualAccountInPurchaseReceiptLineDto" }, "actualSub": { "$ref": "#/components/schemas/actualSubInPurchaseReceiptLineDto" }, "project": { "$ref": "#/components/schemas/projectInPurchaseReceiptLineDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInPurchaseReceiptLineDto" }, "expirationDate": { "type": "string", "description": "Document details tab > Expiration date > The expiration date of the received item.", "format": "date-time" }, "lotSerialNumber": { "type": "string", "description": "Document details tab > Lot/serial no. > The lot or serial number assigned to the received quantity of the purchased item." }, "poOrderType": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string", "description": "Document details tab > Purchase order type > The type of the purchase order related to this purchase receipt." }, "poOrderNbr": { "type": "string", "description": "Document details tab > Purchase order no. > The reference number of the purchase order related to this purchase receipt." }, "poOrderLineNbr": { "type": "integer", "description": "Document details tab > Purchase order line no. > The line number of the purchase order related to this line of the purchase receipt.", "format": "int32" }, "transferOrderType": { "enum": [ "CreditNote", "DebitNote", "Invoice", "QuoteOrder", "RMAOrder", "SalesOrder", "StandardOrder", "TransferOrder" ], "type": "string", "description": "Document details tab > Transfer order type > The type of the transfer order to which this receipt is linked." }, "transferOrderNbr": { "type": "string", "description": "Document details tab > Transfer order no. > The reference number of the transfer order to which this receipt is linked." }, "transferOrderLineNbr": { "type": "integer", "description": "Document details tab > Transfer line no > The line number in the transfer order to which this receipt is linked.", "format": "int32" }, "completePoLine": { "type": "boolean", "description": "Document details tab > Complelete purchase line > A check box that indicates to the system (if selected) that the purchase order line added to this receipt line should be considered completed upon release of this purchase receipt." }, "customStr1": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr2": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr3": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr4": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr5": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customDec1": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customDec2": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customInt1": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customInt2": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customDateTimeUTC1": { "type": "string", "description": "A free custom colum of type DateTime - in UTC timezone", "format": "date-time" } }, "description": "This class represents a Purchase Order Line in PurchaseReceiptContraoller. Used for getting data." }, "supplierInLandedCostDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: Landed costs tab > Supplier* > The landed cost supplier to whom the landed cost amount will be paid." }, "locationInLandedCostDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: Landed costs tab > Location* > The location of the selected landed cost supplier." }, "taxCategoryInLandedCostDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Landed costs tab > VAT category > VAT category associated with supplier's VAT zone." }, "termsInLandedCostDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Landed costs tab > Terms > The credit terms used in relations with the landed cost supplier." }, "LandedCostDto": { "type": "object", "properties": { "lineNbr": { "type": "integer", "description": "Landed costs tab > Line number", "format": "int32" }, "landedCostCode": { "type": "string", "description": "Mandatory field: Landed costs tab > Landed costs* > Landed cost code > The landed cost code associated with the landed costs incurred for this purchase or transfer receipt." }, "description": { "type": "string", "description": "Mandatory field: Landed costs tab > Description* > The description of the landed cost code." }, "purchaseInvoiceNbr": { "type": "string" }, "supplier": { "$ref": "#/components/schemas/supplierInLandedCostDto" }, "location": { "$ref": "#/components/schemas/locationInLandedCostDto" }, "apBillDate": { "type": "string", "description": "Landed costs tab > Purchase invoice date > The date of the purchase invoice for the landed cost.", "format": "date-time" }, "currency": { "type": "string", "description": "Landed costs tab > Currency > The currency used for the landed cost." }, "amount": { "type": "number", "description": "Landed costs tab > Amount > A non-zero amount of the landed cost.", "format": "double" }, "taxCategory": { "$ref": "#/components/schemas/taxCategoryInLandedCostDto" }, "terms": { "$ref": "#/components/schemas/termsInLandedCostDto" }, "inventory": { "$ref": "#/components/schemas/InventoryNumberDescriptionDto" }, "apDocType": { "enum": [ "Check", "CreditAdj", "DebitAdj", "Invoice", "Prepayment", "QuickCheck", "Refund", "VoidCheck", "VoidQuickCheck" ], "type": "string", "description": "Landed costs tab > Supplier document type > The type of the supplier document generated for the landed cost." }, "apRefNbr": { "type": "string", "description": "Landed costs tab > Supplier ref. > The reference number of the supplier document generated for the landed cost." }, "inDocType": { "enum": [ "Invoice", "DebitNote", "CreditNote", "Payment", "VoidPayment", "Prepayment", "Refund", "FinCharge", "SmallBalanceWo", "SmallCreditWo", "CashSale", "CashReturn", "Undefined", "NoUpdate" ], "type": "string", "description": "Landed costs tab > Inventory doc. type > The type of the document generated in the Inventory workspace for this landed cost." }, "inRefNbr": { "type": "string", "description": "Landed costs tab > Inventory ref. no. > The reference number of the document generated in the Inventory workspace for this landed cost." }, "postponePurchaseInvoiceCreation": { "type": "boolean", "description": "Landed costs tab > Postpone creation of purchase invoice > A check box that indicates (if selected) that a related supplier ledger invoice for the incurred landed costs must be created later." } }, "description": "This class represents a Landed Cost Line for Purchase Receipt in PurchaseReceiptController. Used for getting data." }, "warehouseInPurchaseReceiptDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part or the Documents details tab > Warehouse* > The warehouse from which the items have been received for transfer orders." }, "supplierInPurchaseReceiptDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: The top part > Supplier* > The supplier from which the items have been received or to which they will be returned." }, "locationInPurchaseReceiptDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part Location* > The supplier location from which the items should be received or to which they should be returned." }, "branchNumberInPurchaseReceiptDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Document details tab > Branch* > The branch to which the document belongs." }, "PurchaseReceiptDto": { "type": "object", "properties": { "landedCost": { "type": "array", "items": { "$ref": "#/components/schemas/LandedCostDto" }, "description": "Landed costs tab > Landed cost code > The landed cost code specified in the line of the landed cost document." }, "note": { "type": "string" }, "timeStamp": { "type": "string", "description": "The top part > Tstamp > The timestamp of the purchase receipt.", "format": "byte" }, "receiptType": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string", "description": "The top part > Type > The type of the document, which can be one of the following options: Receipt, Return, Transfer receipt." }, "receiptNbr": { "type": "string", "description": "The top part > Receipt no. > The unique reference number of the purchase receipt." }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the document has the On hold status." }, "status": { "enum": [ "Hold", "Balanced", "Released", "Cancelled" ], "type": "string", "description": "The top part > Status > The current status of the purchase or transfer receipt, or return, which the system assigns automatically. On hold, Balanced, Released." }, "date": { "type": "string", "description": "Mandatory field: The top part > Date* > The date when the receipt document was created.", "format": "date-time" }, "postPeriod": { "type": "string", "description": "Mandatory field: The top part > Post period* > The financial period to which the transactions recorded in the document should be posted. Format MMYYYY." }, "warehouse": { "$ref": "#/components/schemas/warehouseInPurchaseReceiptDto" }, "supplier": { "$ref": "#/components/schemas/supplierInPurchaseReceiptDto" }, "location": { "$ref": "#/components/schemas/locationInPurchaseReceiptDto" }, "currency": { "type": "string", "description": "The top part > Currency > The currency the supplier uses for invoicing." }, "exchangeRate": { "type": "number", "format": "double" }, "createBill": { "type": "boolean", "description": "The top part > Create invoice > A check box that you select if the system must create an appropriate invoice (or adjustment) automatically when the purchase receipt is released." }, "supplierRef": { "type": "string", "description": "The top part > Supplier ref. > The reference number of the supplier document this receipt or return is based on." }, "totalQty": { "type": "number", "description": "The top part > Total qty. > The total quantity of items received from or returned to the supplier.", "format": "double" }, "controlQty": { "type": "number", "description": "The top part > Control qty. > The total quantity of goods on the receipt or return", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt total > The document total that is exempt from VAT.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "totalAmt": { "type": "number", "description": "The top part > Total amt. > The total amount calculated for items received from or returned to the supplier.", "format": "double" }, "controlTotal": { "type": "number", "description": "The top part > Control amt. > The total amount of the receipt or return, which you manually enter.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInPurchaseReceiptDto" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptLineDto" }, "description": "Document details tab > Line no > The number of the purchase receipt line on the document." }, "dueDate": { "type": "string", "description": "This value indicates the date the document is due", "format": "date-time" }, "customStr1": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr2": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr3": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr4": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr5": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customDec1": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customDec2": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customInt1": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customInt2": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customDateTimeUTC1": { "type": "string", "description": "A free custom colum of type DateTime - in UTC timezone", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Purchase Receipt in PurchaseReceiptController. Used for getting data." }, "DtoValueOfNullableOfSupplierDocumentType": { "type": "object", "properties": { "value": { "enum": [ "Check", "CreditAdj", "DebitAdj", "Invoice", "Prepayment", "QuickCheck", "Refund", "VoidCheck", "VoidQuickCheck" ], "type": "string" } } }, "DtoValueOfNullableOfSalesOrderTypes": { "type": "object", "properties": { "value": { "enum": [ "CreditNote", "DebitNote", "Invoice", "QuoteOrder", "RMAOrder", "SalesOrder", "StandardOrder", "TransferOrder" ], "type": "string" } } }, "lineNbrInAllocationsUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "Line no. > The line of the purchase order that contains the selected item." }, "locationInAllocationsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Location > The location in the warehouse." }, "lotSerialNumberInAllocationsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Lot/Serial no. > The lot or serial number of the item." }, "quantityInAllocationsUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "Quantity > The quantity of the stock item with the same lot number. It is 1 for items with serial numbers." }, "uomInAllocationsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "UoM > The unit of measure for the specified quantity of the inventory item." }, "expirationDateInAllocationsUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "Expiration date > The expiration date of the specified quantity of the stock item." }, "AllocationsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string", "description": "The operation > Insert=1, Update=2, Delete=3" }, "lineNbr": { "$ref": "#/components/schemas/lineNbrInAllocationsUpdateDto" }, "location": { "$ref": "#/components/schemas/locationInAllocationsUpdateDto" }, "lotSerialNumber": { "$ref": "#/components/schemas/lotSerialNumberInAllocationsUpdateDto" }, "quantity": { "$ref": "#/components/schemas/quantityInAllocationsUpdateDto" }, "uom": { "$ref": "#/components/schemas/uomInAllocationsUpdateDto" }, "expirationDate": { "$ref": "#/components/schemas/expirationDateInAllocationsUpdateDto" } }, "description": "This class represents a Allocations for Purchase Receipt Line in PurchaseReceiptEndpoint. Used to add/update data." }, "DtoValueOfPurchaseReceiptType": { "type": "object", "properties": { "value": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string" } } }, "LandedCostUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "landedCostCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "purchaseInvoiceNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplierId": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "apBillDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "amount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "taxCategory": { "$ref": "#/components/schemas/DtoValueOfString" }, "terms": { "$ref": "#/components/schemas/DtoValueOfString" }, "inventoryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "apDocType": { "$ref": "#/components/schemas/DtoValueOfNullableOfSupplierDocumentType" }, "apRefNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "inDocType": { "$ref": "#/components/schemas/DtoValueOfCustomerDocumentTypes" }, "inRefNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "postponePurchaseInvoiceCreation": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" } }, "description": "This class represents a Landed Cost Line for Purchase Receipt in PurchaseReceiptController. Used for getting data." }, "lineNbrInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The Document details tab > The number of the purchase receipt line." }, "lineTypeInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "enum": [ "GoodsForInventory", "GoodsForSalesOrder", "GoodsForReplenishment", "GoodsForDropShip", "NonStockForDropShip", "NonStockForSalesOrder", "NonStock", "Service", "Freight", "Description" ], "type": "string" } }, "description": "The Document details tab > The type of the purchase receipt line." }, "branchIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "BranchId is deprecated, please use BranchNumber instead." }, "branchNumberInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The number of the branch to which the purchase receipt line belongs." }, "inventoryIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The item ID of the received item." }, "warehouseIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The warehouse where the item has been received." }, "locationIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The location where the item has been received." }, "transactionDescriptionInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The description of the receipt or return transaction." }, "uomInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The unit of measure (UoM) used for the purchased or transferred item. By default, it is the purchase unit." }, "receiptQtyInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The quantity of the item in the specified UoM that has been received (listed on released receipts)." }, "unitCostInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The cost of a unit of the purchased item." }, "extCostInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The extended cost of the item, which is the unit price multiplied by the quantity." }, "discountPercentInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The automatically calculated or manually entered discount percent on the line." }, "discountAmountInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The automatically calculated or manually entered discount amount on the line." }, "manualDiscountInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "The Document details tab > A check box that indicates (if selected) that the discount has been applied manually." }, "discountCodeIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The code of the line discount that has been applied to this line automatically." }, "amountInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The amount calculated (after discount has been taken) for the item." }, "taxCategoryIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The VAT category assigned to the stock item." }, "accountIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The account used to record the item amount on the purchase receipt; used for non-stock items for which receipt is not required." }, "accountDescriptionInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The description of this account." }, "actualAccountIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The accrual account to record the item amount on the purchase receipt; used for stock items and non-stock items for which a receipt is required." }, "projectIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The project with which the document is associated." }, "projectTaskIdInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The project task with which the document is associated." }, "expirationDateInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "The Document details tab > The expiration date of the received item." }, "lotSerialNumberInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The lot or serial number assigned to the received quantity of the purchased item; <SPLIT> is displayed if multiple lot or serial numbers are assigned to the received quantity." }, "poOrderTypeInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string" } }, "description": "The Document details tab > The type of the purchase order related to this purchase receipt." }, "poOrderNbrInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "This property replaced by an action, please use the following sub-endpoint:/controller/api/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorder." }, "poOrderLineNbrInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "This property replaced by an action please use the following sub-endpoint:/controller/api/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorderlines" }, "transferOrderTypeInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "enum": [ "CreditNote", "DebitNote", "Invoice", "QuoteOrder", "RMAOrder", "SalesOrder", "StandardOrder", "TransferOrder" ], "type": "string" } }, "description": "The Document details tab > The type of the transfer order to which this receipt is linked." }, "transferOrderNbrInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The reference number of the transfer order to which this receipt is linked." }, "transferOrderLineNbrInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The Document details tab > The line number in the transfer order to which this receipt is linked." }, "completePoLineInPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "The Document details tab > A check box that indicates to the system (if selected) that the purchase order line added to this receipt line should be considered completed upon release of this purchase receipt." }, "customStr1InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InPurchaseReceiptLineUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "PurchaseReceiptLineUpdateDto": { "type": "object", "properties": { "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationsUpdateDto" } }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/lineNbrInPurchaseReceiptLineUpdateDto" }, "lineType": { "$ref": "#/components/schemas/lineTypeInPurchaseReceiptLineUpdateDto" }, "branchId": { "$ref": "#/components/schemas/branchIdInPurchaseReceiptLineUpdateDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInPurchaseReceiptLineUpdateDto" }, "inventoryId": { "$ref": "#/components/schemas/inventoryIdInPurchaseReceiptLineUpdateDto" }, "warehouseId": { "$ref": "#/components/schemas/warehouseIdInPurchaseReceiptLineUpdateDto" }, "locationId": { "$ref": "#/components/schemas/locationIdInPurchaseReceiptLineUpdateDto" }, "transactionDescription": { "$ref": "#/components/schemas/transactionDescriptionInPurchaseReceiptLineUpdateDto" }, "uom": { "$ref": "#/components/schemas/uomInPurchaseReceiptLineUpdateDto" }, "receiptQty": { "$ref": "#/components/schemas/receiptQtyInPurchaseReceiptLineUpdateDto" }, "unitCost": { "$ref": "#/components/schemas/unitCostInPurchaseReceiptLineUpdateDto" }, "extCost": { "$ref": "#/components/schemas/extCostInPurchaseReceiptLineUpdateDto" }, "discountPercent": { "$ref": "#/components/schemas/discountPercentInPurchaseReceiptLineUpdateDto" }, "discountAmount": { "$ref": "#/components/schemas/discountAmountInPurchaseReceiptLineUpdateDto" }, "manualDiscount": { "$ref": "#/components/schemas/manualDiscountInPurchaseReceiptLineUpdateDto" }, "discountCodeId": { "$ref": "#/components/schemas/discountCodeIdInPurchaseReceiptLineUpdateDto" }, "amount": { "$ref": "#/components/schemas/amountInPurchaseReceiptLineUpdateDto" }, "taxCategoryId": { "$ref": "#/components/schemas/taxCategoryIdInPurchaseReceiptLineUpdateDto" }, "accountId": { "$ref": "#/components/schemas/accountIdInPurchaseReceiptLineUpdateDto" }, "accountDescription": { "$ref": "#/components/schemas/accountDescriptionInPurchaseReceiptLineUpdateDto" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "The Document details tab > The subaccount to be used to record the non-stock item amount on the purchase receipt (for non-stock items for which receipts are not required)." }, "actualAccountId": { "$ref": "#/components/schemas/actualAccountIdInPurchaseReceiptLineUpdateDto" }, "actualSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "The Document details tab > The subaccount used to record the item amount on the purchase receipt, used for stock items and non-stock items for which a receipt is required." }, "projectId": { "$ref": "#/components/schemas/projectIdInPurchaseReceiptLineUpdateDto" }, "projectTaskId": { "$ref": "#/components/schemas/projectTaskIdInPurchaseReceiptLineUpdateDto" }, "expirationDate": { "$ref": "#/components/schemas/expirationDateInPurchaseReceiptLineUpdateDto" }, "lotSerialNumber": { "$ref": "#/components/schemas/lotSerialNumberInPurchaseReceiptLineUpdateDto" }, "poOrderType": { "$ref": "#/components/schemas/poOrderTypeInPurchaseReceiptLineUpdateDto" }, "poOrderNbr": { "$ref": "#/components/schemas/poOrderNbrInPurchaseReceiptLineUpdateDto" }, "poOrderLineNbr": { "$ref": "#/components/schemas/poOrderLineNbrInPurchaseReceiptLineUpdateDto" }, "transferOrderType": { "$ref": "#/components/schemas/transferOrderTypeInPurchaseReceiptLineUpdateDto" }, "transferOrderNbr": { "$ref": "#/components/schemas/transferOrderNbrInPurchaseReceiptLineUpdateDto" }, "transferOrderLineNbr": { "$ref": "#/components/schemas/transferOrderLineNbrInPurchaseReceiptLineUpdateDto" }, "completePoLine": { "$ref": "#/components/schemas/completePoLineInPurchaseReceiptLineUpdateDto" }, "customStr1": { "$ref": "#/components/schemas/customStr1InPurchaseReceiptLineUpdateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InPurchaseReceiptLineUpdateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InPurchaseReceiptLineUpdateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InPurchaseReceiptLineUpdateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InPurchaseReceiptLineUpdateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InPurchaseReceiptLineUpdateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InPurchaseReceiptLineUpdateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InPurchaseReceiptLineUpdateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InPurchaseReceiptLineUpdateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InPurchaseReceiptLineUpdateDto" } }, "description": "This class represents a Purchase Order Line in PurchaseReceiptContraoller. Used for getting data." }, "postPeriodInPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "customStr1InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InPurchaseReceiptUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "PurchaseReceiptUpdateDto": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptLineUpdateDto" } }, "landedCost": { "type": "array", "items": { "$ref": "#/components/schemas/LandedCostUpdateDto" } }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "receiptType": { "$ref": "#/components/schemas/DtoValueOfPurchaseReceiptType" }, "receiptNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInPurchaseReceiptUpdateDto" }, "warehouseId": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplierId": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "createBill": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "supplierRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "controlQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "controlAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "customStr1": { "$ref": "#/components/schemas/customStr1InPurchaseReceiptUpdateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InPurchaseReceiptUpdateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InPurchaseReceiptUpdateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InPurchaseReceiptUpdateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InPurchaseReceiptUpdateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InPurchaseReceiptUpdateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InPurchaseReceiptUpdateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InPurchaseReceiptUpdateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InPurchaseReceiptUpdateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InPurchaseReceiptUpdateDto" }, "timeStamp": { "type": "string", "format": "byte" } }, "description": "This class represents a Purchase Receipt in PurchaseReceiptController. Used for getting data." }, "PurchaseReceiptQueryParameters": { "type": "object", "properties": { "receiptType": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string" }, "status": { "enum": [ "Hold", "Balanced", "Released", "Cancelled" ], "type": "string" }, "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "supplier": { "type": "string" }, "poOrderNbr": { "type": "string" }, "branch": { "type": "string" }, "finPeriod": { "type": "string", "description": "Filter by financial period, format YYYYPP" }, "receiptDate": { "type": "string", "description": "This value indicates the receipt date. Use it to retrieve all records that have the receipt date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__." }, "receiptDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the order date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__." }, "dueDate": { "type": "string", "description": "This value indicates the date the document is due. Use it to retrieve all records that have the due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__." }, "dueDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__." }, "includeCustomFreeFields": { "type": "boolean", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set\r\nWorks only with PurchaseRecieptBasic and v2 of PurchaseReceipts." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ReleasePurchaseReceiptActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "PurchaseReceiptOrderUpdateDto": { "type": "object", "properties": { "orderNbr": { "type": "string", "description": "The reference number of the Purchase Order." }, "orderType": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string" }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationsUpdateDto" } } }, "description": "This class represents a Purchase Order reference number to add to a Purchase Receipt." }, "PurchaseReceiptOrderListUpdateDto": { "type": "object", "properties": { "purchaseOrders": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptOrderUpdateDto" }, "description": "The array of reference numbers of the Purchase Orders." } }, "description": "This class represents a list of Purchase Orders to add to a Purchase Receipt." }, "AddOrdersToPurchaseReceiptActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "PurchaseReceiptOrderLineNbrUpdateDto": { "type": "object", "properties": { "lineNbr": { "type": "string", "description": "The line number of the Purchase Order line." } }, "description": "Represents a Purchase Order line number to add to a Purchase Receipt." }, "PurchaseReceiptOrderLinesUpdateDto": { "type": "object", "properties": { "orderNbr": { "type": "string", "description": "The Purchase Order reference number." }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptOrderLineNbrUpdateDto" }, "description": "Array of line numbers belonging to a Purchase Order." }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationsUpdateDto" } } }, "description": "Represents a collection of Purchase Order lines belonging to a specific Purchase Order." }, "PurchaseReceiptOrderLinesListUpdateDto": { "type": "object", "properties": { "purchaseOrderLines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptOrderLinesUpdateDto" }, "description": "The collection of Purchase Order reference numbers and their lines." } }, "description": "This class represents a collection of Purchase Orders reference numbers and associated line numbers. Used to add Purchase Order lines to a Purchase Receipt." }, "AddOrderLinesToPurchaseReceiptActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "warehouseInPurchaseReceiptBasicDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part or the Documents details tab > Warehouse* > The warehouse from which the items have been received for transfer orders." }, "supplierInPurchaseReceiptBasicDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: The top part > Supplier* > The supplier from which the items have been received or to which they will be returned." }, "locationInPurchaseReceiptBasicDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part Location* > The supplier location from which the items should be received or to which they should be returned." }, "branchNumberInPurchaseReceiptBasicDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: Document details tab > Branch* > The branch to which the document belongs." }, "PurchaseReceiptBasicDto": { "type": "object", "properties": { "timeStamp": { "type": "string", "description": "The top part > Tstamp > The timestamp of the purchase receipt.", "format": "byte" }, "receiptType": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string", "description": "The top part > Type > The type of the document, which can be one of the following options: Receipt, Return, Transfer receipt." }, "receiptNbr": { "type": "string", "description": "The top part > Receipt no. > The unique reference number of the purchase receipt." }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that indicates (if selected) that the document has the On hold status." }, "status": { "enum": [ "Hold", "Balanced", "Released", "Cancelled" ], "type": "string", "description": "The top part > Status > The current status of the purchase or transfer receipt, or return, which the system assigns automatically. On hold, Balanced, Released." }, "date": { "type": "string", "description": "Mandatory field: The top part > Date* > The date when the receipt document was created.", "format": "date-time" }, "postPeriod": { "type": "string", "description": "Mandatory field: The top part > Post period* > The financial period to which the transactions recorded in the document should be posted. Format MMYYYY." }, "warehouse": { "$ref": "#/components/schemas/warehouseInPurchaseReceiptBasicDto" }, "supplier": { "$ref": "#/components/schemas/supplierInPurchaseReceiptBasicDto" }, "location": { "$ref": "#/components/schemas/locationInPurchaseReceiptBasicDto" }, "currency": { "type": "string", "description": "The top part > Currency > The currency the supplier uses for invoicing." }, "exchangeRate": { "type": "number", "format": "double" }, "createBill": { "type": "boolean", "description": "The top part > Create invoice > A check box that you select if the system must create an appropriate invoice (or adjustment) automatically when the purchase receipt is released." }, "supplierRef": { "type": "string", "description": "The top part > Supplier ref. > The reference number of the supplier document this receipt or return is based on." }, "totalQty": { "type": "number", "description": "The top part > Total qty. > The total quantity of items received from or returned to the supplier.", "format": "double" }, "controlQty": { "type": "number", "description": "The top part > Control qty. > The total quantity of goods on the receipt or return", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The top part > VAT exempt total > The document total that is exempt from VAT.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "totalAmt": { "type": "number", "description": "The top part > Total amt. > The total amount calculated for items received from or returned to the supplier.", "format": "double" }, "controlTotal": { "type": "number", "description": "The top part > Control amt. > The total amount of the receipt or return, which you manually enter.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInPurchaseReceiptBasicDto" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptLineDto" }, "description": "Document details tab > Line no > The number of the purchase receipt line on the document." }, "dueDate": { "type": "string", "description": "This value indicates the date the document is due", "format": "date-time" }, "customStr1": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr2": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr3": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr4": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr5": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customDec1": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customDec2": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customInt1": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customInt2": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customDateTimeUTC1": { "type": "string", "description": "A free custom colum of type DateTime - in UTC timezone", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Purchase Receipt in PurchaseReceiptController. Used for getting data." }, "lineNbrInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The Document details tab > The number of the purchase receipt line." }, "lineTypeInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "enum": [ "GoodsForInventory", "GoodsForSalesOrder", "GoodsForReplenishment", "GoodsForDropShip", "NonStockForDropShip", "NonStockForSalesOrder", "NonStock", "Service", "Freight", "Description" ], "type": "string" } }, "description": "The Document details tab > The type of the purchase receipt line." }, "branchIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "BranchId is deprecated, please use BranchNumber instead." }, "branchNumberInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The number of the branch to which the purchase receipt line belongs." }, "inventoryIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The item ID of the received item." }, "warehouseIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The warehouse where the item has been received." }, "locationIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The location where the item has been received." }, "transactionDescriptionInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The description of the receipt or return transaction." }, "uomInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The unit of measure (UoM) used for the purchased or transferred item. By default, it is the purchase unit." }, "receiptQtyInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The quantity of the item in the specified UoM that has been received (listed on released receipts)." }, "unitCostInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The cost of a unit of the purchased item." }, "extCostInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The extended cost of the item, which is the unit price multiplied by the quantity." }, "discountPercentInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The automatically calculated or manually entered discount percent on the line." }, "discountAmountInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The automatically calculated or manually entered discount amount on the line." }, "manualDiscountInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "The Document details tab > A check box that indicates (if selected) that the discount has been applied manually." }, "discountCodeIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The code of the line discount that has been applied to this line automatically." }, "amountInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The Document details tab > The amount calculated (after discount has been taken) for the item." }, "taxCategoryIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The VAT category assigned to the stock item." }, "accountIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The account used to record the item amount on the purchase receipt; used for non-stock items for which receipt is not required." }, "accountDescriptionInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The description of this account." }, "actualAccountIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The accrual account to record the item amount on the purchase receipt; used for stock items and non-stock items for which a receipt is required." }, "projectIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The project with which the document is associated." }, "projectTaskIdInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The project task with which the document is associated." }, "expirationDateInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "The Document details tab > The expiration date of the received item." }, "lotSerialNumberInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The lot or serial number assigned to the received quantity of the purchased item; <SPLIT> is displayed if multiple lot or serial numbers are assigned to the received quantity." }, "poOrderTypeInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "enum": [ "RegularOrder", "DropShip", "Blanket", "StandardBlanket" ], "type": "string" } }, "description": "The Document details tab > The type of the purchase order related to this purchase receipt." }, "poOrderNbrInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "This property replaced by an action, please use the following sub-endpoint:/controller/api/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorder." }, "poOrderLineNbrInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "This property replaced by an action please use the following sub-endpoint:/controller/api/v1/PurchaseReceipt/{receiptNumber}/action/addpurchaseorderlines" }, "transferOrderTypeInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "enum": [ "CreditNote", "DebitNote", "Invoice", "QuoteOrder", "RMAOrder", "SalesOrder", "StandardOrder", "TransferOrder" ], "type": "string" } }, "description": "The Document details tab > The type of the transfer order to which this receipt is linked." }, "transferOrderNbrInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The Document details tab > The reference number of the transfer order to which this receipt is linked." }, "transferOrderLineNbrInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The Document details tab > The line number in the transfer order to which this receipt is linked." }, "completePoLineInPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "The Document details tab > A check box that indicates to the system (if selected) that the purchase order line added to this receipt line should be considered completed upon release of this purchase receipt." }, "customStr1InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InPurchaseReceiptLineBasicUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "PurchaseReceiptLineBasicUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/lineNbrInPurchaseReceiptLineBasicUpdateDto" }, "lineType": { "$ref": "#/components/schemas/lineTypeInPurchaseReceiptLineBasicUpdateDto" }, "branchId": { "$ref": "#/components/schemas/branchIdInPurchaseReceiptLineBasicUpdateDto" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInPurchaseReceiptLineBasicUpdateDto" }, "inventoryId": { "$ref": "#/components/schemas/inventoryIdInPurchaseReceiptLineBasicUpdateDto" }, "warehouseId": { "$ref": "#/components/schemas/warehouseIdInPurchaseReceiptLineBasicUpdateDto" }, "locationId": { "$ref": "#/components/schemas/locationIdInPurchaseReceiptLineBasicUpdateDto" }, "transactionDescription": { "$ref": "#/components/schemas/transactionDescriptionInPurchaseReceiptLineBasicUpdateDto" }, "uom": { "$ref": "#/components/schemas/uomInPurchaseReceiptLineBasicUpdateDto" }, "receiptQty": { "$ref": "#/components/schemas/receiptQtyInPurchaseReceiptLineBasicUpdateDto" }, "unitCost": { "$ref": "#/components/schemas/unitCostInPurchaseReceiptLineBasicUpdateDto" }, "extCost": { "$ref": "#/components/schemas/extCostInPurchaseReceiptLineBasicUpdateDto" }, "discountPercent": { "$ref": "#/components/schemas/discountPercentInPurchaseReceiptLineBasicUpdateDto" }, "discountAmount": { "$ref": "#/components/schemas/discountAmountInPurchaseReceiptLineBasicUpdateDto" }, "manualDiscount": { "$ref": "#/components/schemas/manualDiscountInPurchaseReceiptLineBasicUpdateDto" }, "discountCodeId": { "$ref": "#/components/schemas/discountCodeIdInPurchaseReceiptLineBasicUpdateDto" }, "amount": { "$ref": "#/components/schemas/amountInPurchaseReceiptLineBasicUpdateDto" }, "taxCategoryId": { "$ref": "#/components/schemas/taxCategoryIdInPurchaseReceiptLineBasicUpdateDto" }, "accountId": { "$ref": "#/components/schemas/accountIdInPurchaseReceiptLineBasicUpdateDto" }, "accountDescription": { "$ref": "#/components/schemas/accountDescriptionInPurchaseReceiptLineBasicUpdateDto" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "The Document details tab > The subaccount to be used to record the non-stock item amount on the purchase receipt (for non-stock items for which receipts are not required)." }, "actualAccountId": { "$ref": "#/components/schemas/actualAccountIdInPurchaseReceiptLineBasicUpdateDto" }, "actualSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "The Document details tab > The subaccount used to record the item amount on the purchase receipt, used for stock items and non-stock items for which a receipt is required." }, "projectId": { "$ref": "#/components/schemas/projectIdInPurchaseReceiptLineBasicUpdateDto" }, "projectTaskId": { "$ref": "#/components/schemas/projectTaskIdInPurchaseReceiptLineBasicUpdateDto" }, "expirationDate": { "$ref": "#/components/schemas/expirationDateInPurchaseReceiptLineBasicUpdateDto" }, "lotSerialNumber": { "$ref": "#/components/schemas/lotSerialNumberInPurchaseReceiptLineBasicUpdateDto" }, "poOrderType": { "$ref": "#/components/schemas/poOrderTypeInPurchaseReceiptLineBasicUpdateDto" }, "poOrderNbr": { "$ref": "#/components/schemas/poOrderNbrInPurchaseReceiptLineBasicUpdateDto" }, "poOrderLineNbr": { "$ref": "#/components/schemas/poOrderLineNbrInPurchaseReceiptLineBasicUpdateDto" }, "transferOrderType": { "$ref": "#/components/schemas/transferOrderTypeInPurchaseReceiptLineBasicUpdateDto" }, "transferOrderNbr": { "$ref": "#/components/schemas/transferOrderNbrInPurchaseReceiptLineBasicUpdateDto" }, "transferOrderLineNbr": { "$ref": "#/components/schemas/transferOrderLineNbrInPurchaseReceiptLineBasicUpdateDto" }, "completePoLine": { "$ref": "#/components/schemas/completePoLineInPurchaseReceiptLineBasicUpdateDto" }, "customStr1": { "$ref": "#/components/schemas/customStr1InPurchaseReceiptLineBasicUpdateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InPurchaseReceiptLineBasicUpdateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InPurchaseReceiptLineBasicUpdateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InPurchaseReceiptLineBasicUpdateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InPurchaseReceiptLineBasicUpdateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InPurchaseReceiptLineBasicUpdateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InPurchaseReceiptLineBasicUpdateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InPurchaseReceiptLineBasicUpdateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InPurchaseReceiptLineBasicUpdateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InPurchaseReceiptLineBasicUpdateDto" } }, "description": "This class represents a Purchase Receipt Line in PurchaseReceiptBasicContraoller. Used for adding data." }, "postPeriodInPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "customStr1InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InPurchaseReceiptBasicUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "PurchaseReceiptBasicUpdateDto": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/PurchaseReceiptLineBasicUpdateDto" } }, "receiptType": { "$ref": "#/components/schemas/DtoValueOfPurchaseReceiptType" }, "receiptNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInPurchaseReceiptBasicUpdateDto" }, "warehouseId": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplierId": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "createBill": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "supplierRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "controlQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "controlAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "customStr1": { "$ref": "#/components/schemas/customStr1InPurchaseReceiptBasicUpdateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InPurchaseReceiptBasicUpdateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InPurchaseReceiptBasicUpdateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InPurchaseReceiptBasicUpdateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InPurchaseReceiptBasicUpdateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InPurchaseReceiptBasicUpdateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InPurchaseReceiptBasicUpdateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InPurchaseReceiptBasicUpdateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InPurchaseReceiptBasicUpdateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InPurchaseReceiptBasicUpdateDto" }, "timeStamp": { "type": "string", "format": "byte" } }, "description": "This class represents a Purchase Receipt in PurchaseReceiptBasicController. Used for adding data." }, "PurchaseReceiptV2QueryParameters": { "type": "object", "properties": { "receiptType": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string" }, "status": { "enum": [ "Hold", "Balanced", "Released", "Cancelled" ], "type": "string" }, "greaterThanValue": { "type": "string" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "supplier": { "type": "string" }, "poOrderNbr": { "type": "string" }, "expandNote": { "type": "boolean" }, "branch": { "type": "string" }, "finPeriod": { "type": "string", "description": "Filter by financial period, format YYYYPP" }, "receiptDate": { "type": "string", "description": "This value indicates the receipt date. Use it to retrieve all records that have the receipt date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__." }, "receiptDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the order date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __ReceiptDate__ and __ReceiptDateCondition__ are __mutually inclusive__." }, "dueDate": { "type": "string", "description": "This value indicates the date the document is due. Use it to retrieve all records that have the due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__." }, "dueDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__." }, "includeCustomFreeFields": { "type": "boolean", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "SalesCategoryDto": { "type": "object", "properties": { "categoryID": { "type": "integer", "description": "The left pane > Categories. See the list of category members on the right side.\r\nThe right pane > Item ID > The unique identifier of the sales category.", "format": "int32" }, "description": { "type": "string", "description": "The right pane > Description > The description of the sales category, which can serve as an identifier." }, "parentID": { "type": "integer", "description": "The right pane > Parent category > The primary/main category for Item sales.", "format": "int32" }, "sortOrder": { "type": "integer", "format": "int32" }, "subCategories": { "type": "array", "items": { "$ref": "#/components/schemas/SalesCategoryDto" }, "description": "A list can be expanded on the left side." } }, "description": "This class represents a Sales Category in SalesCategoryController. Used by getting data." }, "DtoValueOfNullableOfInventoryReplenishmentSources": { "type": "object", "properties": { "value": { "enum": [ "DropShipToOrder", "Manufactured", "None", "Purchased", "PurchaseToOrder", "Transfer" ], "type": "string" } } }, "DtoValueOfNullableOfSalesOrderOperations": { "type": "object", "properties": { "value": { "enum": [ "Issue", "Receipt" ], "type": "string" } } }, "SalesOrderAddressUpdateDto": { "type": "object", "properties": { "overrideAddress": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "addressLine1": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine2": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine3": { "$ref": "#/components/schemas/DtoValueOfString" }, "postalCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "city": { "$ref": "#/components/schemas/DtoValueOfString" }, "countryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "county": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "SalesOrderContactUpdateDto": { "type": "object", "properties": { "overrideContact": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "name": { "$ref": "#/components/schemas/DtoValueOfString" }, "attention": { "$ref": "#/components/schemas/DtoValueOfString" }, "email": { "$ref": "#/components/schemas/DtoValueOfString" }, "web": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone1": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone2": { "$ref": "#/components/schemas/DtoValueOfString" }, "fax": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "inventoryIdInSalesOrderLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "InventoryId is deprecated, please use InventoryNumber instead." }, "inventoryNumberInSalesOrderLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field" }, "SalesOrderLineUpdateDto": { "required": [ "inventoryNumber" ], "type": "object", "properties": { "invoiceNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesOrderOperation": { "$ref": "#/components/schemas/DtoValueOfNullableOfSalesOrderOperations" }, "freeItem": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "requestedOn": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "shipOn": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "shipComplete": { "$ref": "#/components/schemas/DtoValueOfNullableOfSalesOrderShipCompleteStatuses" }, "undershipThreshold": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "overshipThreshold": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "completed": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "markForPO": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "poSource": { "$ref": "#/components/schemas/DtoValueOfNullableOfInventoryReplenishmentSources" }, "lotSerialNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPerson": { "$ref": "#/components/schemas/DtoValueOfString" }, "taxCategory": { "$ref": "#/components/schemas/DtoValueOfString" }, "commissionable": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "alternateID": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTask": { "$ref": "#/components/schemas/DtoValueOfString" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "externalLink": { "$ref": "#/components/schemas/DtoValueOfString" }, "isRotRutDeductible": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "inventoryId": { "$ref": "#/components/schemas/inventoryIdInSalesOrderLineUpdateDto" }, "inventoryNumber": { "$ref": "#/components/schemas/inventoryNumberInSalesOrderLineUpdateDto" }, "warehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "unitCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "unitPrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "discUnitPrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "lineDescription": { "$ref": "#/components/schemas/DtoValueOfString" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" } }, "description": "This class represent a Sales Order Line in Sales Order Controller. Used to pass data to server for creating or updating an order line" }, "DtoValueOfNullableOfSalesOrderShipCompleteStatuses": { "type": "object", "properties": { "value": { "enum": [ "BackOrderAllowed", "CancelRemainder", "ShipComplete" ], "type": "string" } } }, "DtoValueOfSalesOrderAddressUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/SalesOrderAddressUpdateDto" } } }, "DtoValueOfSalesOrderContactUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/SalesOrderContactUpdateDto" } } }, "orderTypeInSalesOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field" }, "customerInSalesOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if GLN or VatRegistrationId is not specified." }, "glnInSalesOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if Customer or VatRegistrationId is not specified." }, "vatRegistrationIdInSalesOrderUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if Customer or GLN is not specified." }, "SalesOrderUpdateDto": { "required": [ "orderType" ], "type": "object", "properties": { "project": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "printDescriptionOnInvoice": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "printNoteOnExternalDocuments": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "printNoteOnInternalDocuments": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "soBillingContact": { "$ref": "#/components/schemas/DtoValueOfSalesOrderContactUpdateDto" }, "soBillingAddress": { "$ref": "#/components/schemas/DtoValueOfSalesOrderAddressUpdateDto" }, "customerVATZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "invoiceSeparately": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "terms": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPerson": { "$ref": "#/components/schemas/DtoValueOfString" }, "owner": { "$ref": "#/components/schemas/DtoValueOfNullableOfGuid" }, "origOrderType": { "$ref": "#/components/schemas/DtoValueOfString" }, "origOrderNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "soShippingContact": { "$ref": "#/components/schemas/DtoValueOfSalesOrderContactUpdateDto" }, "soShippingAddress": { "$ref": "#/components/schemas/DtoValueOfSalesOrderAddressUpdateDto" }, "schedShipment": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "shipSeparately": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "shipComplete": { "$ref": "#/components/schemas/DtoValueOfNullableOfSalesOrderShipCompleteStatuses" }, "cancelBy": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "canceled": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "preferredWarehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "shipVia": { "$ref": "#/components/schemas/DtoValueOfString" }, "fobPoint": { "$ref": "#/components/schemas/DtoValueOfString" }, "priority": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt16" }, "shippingTerms": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippingZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "residentialDelivery": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "saturdayDelivery": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "insurance": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "transactionType": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "paymentMethod": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "isRotRutDeductible": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "emailed": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "rotRutDetails": { "$ref": "#/components/schemas/RotRutUpdateDto" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderLineUpdateDto" } }, "orderType": { "$ref": "#/components/schemas/orderTypeInSalesOrderUpdateDto" }, "orderNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "requestOn": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "customerOrder": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerRefNo": { "$ref": "#/components/schemas/DtoValueOfString" }, "customer": { "$ref": "#/components/schemas/customerInSalesOrderUpdateDto" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "contactId": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "gln": { "$ref": "#/components/schemas/glnInSalesOrderUpdateDto" }, "vatRegistrationId": { "$ref": "#/components/schemas/vatRegistrationIdInSalesOrderUpdateDto" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "recalculateShipment": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" } }, "description": "This class represent a Sales Order in Sales Order Controller. Used to pass data to server for creating or updating an order" }, "RotRutBasicDto": { "type": "object", "properties": { "distributedAutomaticaly": { "type": "boolean" }, "type": { "enum": [ "Rut", "Rot" ], "type": "string" }, "appartment": { "type": "string" }, "estate": { "type": "string" }, "organizationNbr": { "type": "string" }, "distribution": { "type": "array", "items": { "$ref": "#/components/schemas/RotRutDistributionDto" } } } }, "SOCommissionDto": { "type": "object", "properties": { "salesPersonId": { "type": "string" }, "commissionPercent": { "type": "number", "format": "double" }, "commissionAmount": { "type": "number", "format": "double" }, "commissionableAmount": { "type": "number", "format": "double" } } }, "CreateShipmentActionDto": { "required": [ "orderType", "shipmentDate", "shipmentWarehouse" ], "type": "object", "properties": { "orderType": { "type": "string", "description": "Mandatory field" }, "returnShipmentDto": { "type": "boolean" }, "shipmentDate": { "type": "string", "description": "Mandatory field", "format": "date-time" }, "shipmentWarehouse": { "type": "string", "description": "Mandatory field" }, "operation": { "type": "string", "description": "Operation Type. Possible values: I or R, I = Issue, R = Receipt. If not set it will take the default one defined on Order Type." } } }, "PackageDetailLineDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "Packages tab > Line number. The sequence of the lines.", "format": "int32" }, "confirmed": { "type": "boolean", "description": "Packages tab > Confirmed > This check box indicates (if selected) that shipping of the package specified on the line has been confirmed." }, "boxId": { "type": "string", "description": "Mandatory field: Packages tab > Box ID* > The box used for the package." }, "type": { "type": "string", "description": "Packages tab > Type > The type of package: Auto or Manual." }, "description": { "type": "string", "description": "Packages tab > Description > The description of the item or description of the box contents." }, "weight": { "type": "number", "description": "Packages tab > Weight > The gross weight of the package.", "format": "double" }, "uom": { "type": "string", "description": "Packages tab > UoM > The unit of measure in which the weight of the package is specified." }, "volume": { "type": "number", "description": "Packages tab > Volume > The gross volume of the package.", "format": "double" }, "volumeUOM": { "type": "string", "description": "Packages tab > VolumeUoM > The unit of measure in which the volume of the package is specified." }, "declaredValue": { "type": "number", "description": "Packages tab > Declared value > The amount of the package specified for insurance, you can edit the value if needed.", "format": "double" }, "coDAmount": { "type": "number", "description": "Packages tab > Cost of delivery amount > The amount to be charged on delivery of the package, you can edit the value if needed.", "format": "double" }, "trackingNumber": { "type": "string", "description": "Packages tab > Tracking number > The tracking number provided for the package by the carrier if integration with carrier is configured." }, "customRefNbr1": { "type": "string", "description": "Packages tab > Customer ref. no. 1 > An auxiliary reference number to appear on the carrier label for the box." }, "customRefNbr2": { "type": "string", "description": "Packages tab > Customer ref. no. 2 > An additional auxiliary reference number to appear on the carrier label for the box." } } }, "ShipmentOrderLineDto": { "type": "object", "properties": { "orderType": { "type": "string", "description": "Orders tab > Order typer > The type of the order." }, "orderNbr": { "type": "string", "description": "Orders tab > Order no. > The reference number of the sales or transfer order." }, "shippedQty": { "type": "number", "description": "Orders tab > Shipped qty. > The quantity of goods shipped in accordance with the order.", "format": "double" }, "shippedWeight": { "type": "number", "description": "Orders tab > Shipped weight > The weight of the goods shipped in accordance with the order.", "format": "double" }, "shippedVolume": { "type": "number", "description": "Orders tab > Shipped volume > The volume of the goods shipped in accordance with the sales or transfer order.", "format": "double" }, "invoiceType": { "type": "string", "description": "Orders tab > Invoice type > The type of invoice for the goods shipped for the sales order." }, "invoiceNbr": { "type": "string", "description": "Orders tab > Invoice no. > The reference number of the invoice for the goods shipped." }, "inventoryDocType": { "type": "string", "description": "Orders tab > Inventory doc. type > The type of the inventory document that lists the items for this shipment." }, "inventoryRefNbr": { "type": "string", "description": "Orders tab > Inventory ref. no. > The reference number of the inventory document that lists the items for this shipment." }, "note": { "type": "string" } } }, "warehouseInShipmentDetailLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: Document details tab > Warehouse* > The warehouse from which the items is shipped." }, "locationInShipmentDetailLineDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Document details tab > Location > The location in the warehouse from which the item is shipped." }, "ShipmentDetailLineDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "Document details tab > The line number indicating sequence.", "format": "int32" }, "orderType": { "type": "string", "description": "Document details tab > The type of the document, which is one of the predefined order types or a custom order type." }, "orderNbr": { "type": "string", "description": "Document details tab > Order no. > The reference number of the document." }, "inventoryNumber": { "type": "string", "description": "Document details tab > Item ID > The ID of the item being shipped." }, "freeItem": { "type": "boolean", "description": "Document details tab > Free item > The free item earned by the customer, if applicable. (This column does not appear for transfer.)" }, "warehouse": { "$ref": "#/components/schemas/warehouseInShipmentDetailLineDto" }, "location": { "$ref": "#/components/schemas/locationInShipmentDetailLineDto" }, "uom": { "type": "string", "description": "Document details tab > UoM > The unit of measure used for the item in shipment." }, "shippedQty": { "type": "number", "description": "Document details tab > Shipped qty. > The quantity of the item shipped with the specified properties.", "format": "double" }, "orderedQty": { "type": "number", "description": "Document details tab > Ordered qty. > The quantity of the item ordered with the specified properties.", "format": "double" }, "openQty": { "type": "number", "description": "Document details tab > Open qty. > The number of items with the specified quantities still to be shipped.", "format": "double" }, "lotSerialNbr": { "type": "string", "description": "Document details tab > Lot/serial no. > The lot or serial number of particular items of the item." }, "expirationDate": { "type": "string", "description": "Document details tab > Expiration date > The expiration date of the item, if it is traced for this item ID.", "format": "date-time" }, "reasonCode": { "type": "string", "description": "Document details tab > Reason code > The reason code used for shipments." }, "description": { "type": "string", "description": "Document details tab > Description > A short description for the shipment." }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationsDto" }, "description": "Document details tab > Allocations button > Opens the Allocations dialog box, so that you can specify the locations, or lot or serial numbers for the units of the of the item." }, "orderLineNbr": { "type": "integer", "description": "Document details tab > Order line no. > Read only. The order's line number that matches this shipment line.", "format": "int32" }, "note": { "type": "string" }, "externalLink": { "type": "string" }, "alternateID": { "type": "string" }, "customStr1": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr2": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr3": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr4": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr5": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customDec1": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customDec2": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customInt1": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customInt2": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customDateTimeUTC1": { "type": "string", "description": "A free custom colum of type DateTime - in UTC timezone", "format": "date-time" } } }, "ModeOfTransportDto": { "type": "object", "properties": { "id": { "type": "integer", "description": "Click on the magnifier. > The identifier.", "format": "int32" }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "ShipmentContactDto": { "type": "object", "properties": { "overrideContact": { "type": "boolean", "description": "Override contact > A check box that you select to not use+ the default contact information and to type new contact information." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } } }, "countryInShipmentAddressDto": { "properties": { "id": { "type": "string", "description": "Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166." }, "name": { "type": "string", "description": "Mandatory field: Country name* > The complete name of the country." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Country > The country." }, "countyInShipmentAddressDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "County > The county or province." }, "ShipmentAddressDto": { "type": "object", "properties": { "overrideAddress": { "type": "boolean", "description": "Override address > A check box that you select to not include the default address information and to type new address information." }, "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInShipmentAddressDto" }, "county": { "$ref": "#/components/schemas/countyInShipmentAddressDto" } } }, "customerInShipmentDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "The top part > Customer > The customer to whom the goods specified in the document should be shipped. (This field does not appear for transfers.)" }, "locationInShipmentDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part > Location* > The customer location to receive the shipment." }, "fromWarehouseInShipmentDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: The top part > Warehouse ID* > The warehouse from which the goods should be shipped." }, "toWarehouseInShipmentDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > To warehouse > The warehouse to which the goods should be shipped in case of a transfer." }, "ownerInShipmentDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The top part > Owner > The user assigned to approve the document." }, "deliveryAddressInShipmentDto": { "properties": { "overrideAddress": { "type": "boolean", "description": "Override address > A check box that you select to not include the default address information and to type new address information." }, "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInShipmentAddressDto" }, "county": { "$ref": "#/components/schemas/countyInShipmentAddressDto" } }, "description": "Delivery settings tab > Delivery address section >" }, "deliveryContactInShipmentDto": { "properties": { "overrideContact": { "type": "boolean", "description": "Override contact > A check box that you select to not use+ the default contact information and to type new contact information." }, "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Delivery settings tab > Delivery address contact section >" }, "shipViaInShipmentDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Shipping information section > Ship via > The carrier used for shipping the goods." }, "fobPointInShipmentDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Shipping information section > FOB point > The point where obligation of goods passes to the customer." }, "shippingTermsInShipmentDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Shipping information section > Shipping terms > The shipping terms used in relations with the customer." }, "shippingZoneInShipmentDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Shipping information section > Shipping zone ID > The shipping zone of the customer." }, "transactionTypeInShipmentDto": { "properties": { "id": { "type": "integer", "description": "Click on the magnifier. > The identifier.", "format": "int32" }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Intrastat section > Transaction type > The 1-digit code that describes the nature of the transaction (according to EU regulations for Intrastat reporting)." }, "modeOfTrasportInShipmentDto": { "properties": { "id": { "type": "integer", "description": "Click on the magnifier. > The identifier.", "format": "int32" }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Delivery settings tab > Intrastat section > Mode of transportation > The method of transportation." }, "ShipmentDto": { "type": "object", "properties": { "timeStamp": { "type": "string", "format": "byte" }, "shipmentNumber": { "type": "string", "description": "The top part > Shipment no > The unique reference number of the document, which is automatically generated by the system." }, "shipmentType": { "enum": [ "Issue", "DropShip", "Transfer" ], "type": "string", "description": "The top part > Type > The type of the shipment document, which can be one of the following options: Shipment, Transfer." }, "status": { "enum": [ "Open", "Hold", "Completed", "Cancelled", "Confirmed", "Invoiced", "Receipted", "AutoGenerated", "PartiallyInvoiced" ], "type": "string", "description": "The top part > Status > The status of the document." }, "hold": { "type": "boolean", "description": "The top part > Hold > This check box indicates (if selected) that the documents cannot be processed further until the check box is cleared." }, "operation": { "enum": [ "Issue", "Receipt" ], "type": "string", "description": "The top part > Operation > The operation to be performed in the Inventory workspace for this shipment: Issue or Receipt." }, "shipmentDate": { "type": "string", "description": "Mandatory field: The top part > Shipment date* > The date when the document has been created.", "format": "date-time" }, "customer": { "$ref": "#/components/schemas/customerInShipmentDto" }, "location": { "$ref": "#/components/schemas/locationInShipmentDto" }, "fromWarehouse": { "$ref": "#/components/schemas/fromWarehouseInShipmentDto" }, "toWarehouse": { "$ref": "#/components/schemas/toWarehouseInShipmentDto" }, "currencyId": { "type": "string", "description": "Delivery settings tab > Freight currency > By default, it is the currency of the sales order, but you can change it if needed." }, "owner": { "$ref": "#/components/schemas/ownerInShipmentDto" }, "shippedQuantity": { "type": "number", "description": "The top part > Shipped quantity > The quantity of goods shipped.", "format": "double" }, "shippedWeight": { "type": "number", "description": "The top part > Shipped weight > The weight of the goods shipped.", "format": "double" }, "shippedVolume": { "type": "number", "description": "The top part > Shipped volume > The total volume of the items in the shipment.", "format": "double" }, "packages": { "type": "integer", "description": "The top part > Packages > The number of boxes included in this shipment.", "format": "int32" }, "packagesWeight": { "type": "number", "description": "The top part > Package weight > The total weight of the shipment that includes the weight of boxes (for boxes determined automatically).", "format": "double" }, "packagesVolume": { "type": "number", "description": "The top part > Package volume > The total volume of the shipment that includes the volume of boxes (for boxes determined automatically).", "format": "double" }, "controlQuantity": { "type": "number", "description": "The top part > Control quantity > The control value, which you manually enter as a value equal to the shipped quantity if the Validate shipment total on confirmation check box has been selected in the Sales orders preferences (SO101000) window.", "format": "double" }, "deliveryAddress": { "$ref": "#/components/schemas/deliveryAddressInShipmentDto" }, "deliveryContact": { "$ref": "#/components/schemas/deliveryContactInShipmentDto" }, "shipVia": { "$ref": "#/components/schemas/shipViaInShipmentDto" }, "fobPoint": { "$ref": "#/components/schemas/fobPointInShipmentDto" }, "shippingTerms": { "$ref": "#/components/schemas/shippingTermsInShipmentDto" }, "shippingZone": { "$ref": "#/components/schemas/shippingZoneInShipmentDto" }, "residentialDelivery": { "type": "boolean", "description": "Delivery settings tab > Shipping information section > Residential delivery > This check box indicates (if selected) that the shipping address is a residential one." }, "saturdayDelivery": { "type": "boolean", "description": "Delivery settings tab > Shipping information section > Saturday delivery > This check box indicates delivery on saturday." }, "useCustomerAccount": { "type": "boolean" }, "insurance": { "type": "boolean", "description": "Delivery settings tab > Shipping information section > Insurance > This check box indicates (if selected) that insurance is required for the shipment." }, "freightCost": { "type": "number", "description": "Delivery settings tab > Shipping information section > Freight cost > The freight cost of the shipment.", "format": "double" }, "freightAmt": { "type": "number", "description": "Delivery settings tab > Shipping information section > Freight amt. > The amount of freight the customer will be charged for the shipment.", "format": "double" }, "transactionType": { "$ref": "#/components/schemas/transactionTypeInShipmentDto" }, "modeOfTrasport": { "$ref": "#/components/schemas/modeOfTrasportInShipmentDto" }, "container": { "type": "boolean", "description": "Delivery settings tab > Intrastat section > Container > This check box indicates (if selected) that the shipment gets marked as shipped in container for Intrastat reporting purposes." }, "shipmentDetailLines": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDetailLineDto" }, "description": "Document details tab >" }, "shipmentOrderLines": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentOrderLineDto" }, "description": "Orders tab >" }, "shipmentPackageLines": { "type": "array", "items": { "$ref": "#/components/schemas/PackageDetailLineDto" }, "description": "Packages tab >" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "note": { "type": "string" }, "customStr1": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr2": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr3": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr4": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customStr5": { "type": "string", "description": "A free custom colum of type string with max length 100." }, "customDec1": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customDec2": { "type": "number", "description": "A free custom colum of type decimal with max 4 decimals.", "format": "double" }, "customInt1": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customInt2": { "type": "integer", "description": "A free custom colum of type int", "format": "int32" }, "customDateTimeUTC1": { "type": "string", "description": "A free custom colum of type DateTime - in UTC timezone", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Shipment in ShipmentController. Used by getting data." }, "CreateShipmentActionResultDto": { "type": "object", "properties": { "referenceNumber": { "type": "string" }, "shipmentDto": { "$ref": "#/components/schemas/ShipmentDto" }, "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "CancelSalesOrderActionDto": { "required": [ "orderType" ], "type": "object", "properties": { "orderType": { "type": "string", "description": "Mandatory field" } } }, "CancelSalesOrderActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "saleOrderUpdateDtoInReopenSalesOrderActionDto": { "properties": { "project": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "printDescriptionOnInvoice": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "printNoteOnExternalDocuments": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "printNoteOnInternalDocuments": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "soBillingContact": { "$ref": "#/components/schemas/DtoValueOfSalesOrderContactUpdateDto" }, "soBillingAddress": { "$ref": "#/components/schemas/DtoValueOfSalesOrderAddressUpdateDto" }, "customerVATZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "invoiceSeparately": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "terms": { "$ref": "#/components/schemas/DtoValueOfString" }, "salesPerson": { "$ref": "#/components/schemas/DtoValueOfString" }, "owner": { "$ref": "#/components/schemas/DtoValueOfNullableOfGuid" }, "origOrderType": { "$ref": "#/components/schemas/DtoValueOfString" }, "origOrderNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "soShippingContact": { "$ref": "#/components/schemas/DtoValueOfSalesOrderContactUpdateDto" }, "soShippingAddress": { "$ref": "#/components/schemas/DtoValueOfSalesOrderAddressUpdateDto" }, "schedShipment": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "shipSeparately": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "shipComplete": { "$ref": "#/components/schemas/DtoValueOfNullableOfSalesOrderShipCompleteStatuses" }, "cancelBy": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "canceled": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "preferredWarehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "shipVia": { "$ref": "#/components/schemas/DtoValueOfString" }, "fobPoint": { "$ref": "#/components/schemas/DtoValueOfString" }, "priority": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt16" }, "shippingTerms": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippingZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "residentialDelivery": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "saturdayDelivery": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "insurance": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "transactionType": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "paymentMethod": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "isRotRutDeductible": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "emailed": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "rotRutDetails": { "$ref": "#/components/schemas/RotRutUpdateDto" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderLineUpdateDto" } }, "orderType": { "$ref": "#/components/schemas/orderTypeInSalesOrderUpdateDto" }, "orderNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "requestOn": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "customerOrder": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerRefNo": { "$ref": "#/components/schemas/DtoValueOfString" }, "customer": { "$ref": "#/components/schemas/customerInSalesOrderUpdateDto" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "contactId": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "gln": { "$ref": "#/components/schemas/glnInSalesOrderUpdateDto" }, "vatRegistrationId": { "$ref": "#/components/schemas/vatRegistrationIdInSalesOrderUpdateDto" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "recalculateShipment": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" } }, "description": "Mandatory" }, "ReopenSalesOrderActionDto": { "required": [ "saleOrderUpdateDto" ], "type": "object", "properties": { "saleOrderUpdateDto": { "$ref": "#/components/schemas/saleOrderUpdateDtoInReopenSalesOrderActionDto" } } }, "ReopenSalesOrderActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "inventoryIdInSalesOrderBasicLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "InventoryId is deprecated, please use InventoryNumber instead." }, "inventoryNumberInSalesOrderBasicLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field" }, "SalesOrderBasicLineUpdateDto": { "required": [ "inventoryNumber" ], "type": "object", "properties": { "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "inventoryId": { "$ref": "#/components/schemas/inventoryIdInSalesOrderBasicLineUpdateDto" }, "inventoryNumber": { "$ref": "#/components/schemas/inventoryNumberInSalesOrderBasicLineUpdateDto" }, "warehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "unitCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "unitPrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "discUnitPrice": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "lineDescription": { "$ref": "#/components/schemas/DtoValueOfString" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" } }, "description": "This class represent a Sales Order Line in Sales Order Controller. Used to pass data to server for creating or updating an order line" }, "orderTypeInSalesOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field" }, "customerInSalesOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if GLN or VatRegistrationId is not specified." }, "glnInSalesOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if Customer or VatRegistrationId is not specified." }, "vatRegistrationIdInSalesOrderBasicUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field if Customer or GLN is not specified." }, "SalesOrderBasicUpdateDto": { "required": [ "orderType" ], "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/SalesOrderBasicLineUpdateDto" } }, "orderType": { "$ref": "#/components/schemas/orderTypeInSalesOrderBasicUpdateDto" }, "orderNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "requestOn": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "customerOrder": { "$ref": "#/components/schemas/DtoValueOfString" }, "customerRefNo": { "$ref": "#/components/schemas/DtoValueOfString" }, "customer": { "$ref": "#/components/schemas/customerInSalesOrderBasicUpdateDto" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "contactId": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "gln": { "$ref": "#/components/schemas/glnInSalesOrderBasicUpdateDto" }, "vatRegistrationId": { "$ref": "#/components/schemas/vatRegistrationIdInSalesOrderBasicUpdateDto" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "recalculateShipment": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" } }, "description": "This class represent a Sales Order in Sales Order Controller. Used to pass data to server for creating or updating an order" }, "PrepareInvoiceActionResultDto": { "type": "object", "properties": { "referenceNumber": { "type": "string" }, "customerInvoiceDto": { "$ref": "#/components/schemas/CustomerInvoiceDto" }, "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "SendEmailActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "SalesOrderTypeDto": { "type": "object", "properties": { "orderType": { "type": "string", "description": "Mandatory field: The top part > Order type* > The ID of the order type, which is a two-character alphanumeric string." }, "active": { "type": "boolean", "description": "The top part > Active > A check box that indicates (if selected) that the order type is active," }, "description": { "type": "string", "description": "The top part > Description > The brief description of the order type." }, "behavior": { "enum": [ "SalesOrder", "Invoice", "Quote", "RMAOrder", "CreditMemo" ], "type": "string", "description": "Template settings tab > Automation behaviour > An automation behaviour is a set of automation steps. The type of automation behaviour used for the template, which can be Sales order, Invoice, Quote, Credit note, or RMA order." }, "defaultOperation": { "enum": [ "Issue", "Receipt" ], "type": "string", "description": "Template settings tab > Default operation > The default inventory operation for the order type, which can be Receipt or Issue." }, "customerDocumentType": { "enum": [ "Invoice", "DebitMemo", "CreditMemo", "CashSale", "CashReturn", "NoUpdate" ], "type": "string", "description": "Template settings tab > Customer document type > The type of customer ledger document to be generated on release of a document of this type." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a SOOrderType in SalesOrderTypeController. Used to get data." }, "SalesOrderTypeQueryParameters": { "type": "object", "properties": { "orderBy": { "type": "string" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "SalesOrderV2QueryParameters": { "type": "object", "properties": { "orderType": { "type": "string", "description": "Filter by Order type." }, "status": { "enum": [ "Open", "Hold", "CreditHold", "Completed", "Cancelled", "BackOrder", "Shipping", "Invoiced", "PendingApproval", "Voided" ], "type": "string", "description": "Select to filter on status on order." }, "greaterThanValue": { "type": "string", "description": "Filter on Order no. greater than value." }, "showNotes": { "type": "boolean", "description": "Set to true to include notes." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "CreatePurchaseOrderActionDto": { "required": [ "orderType" ], "type": "object", "properties": { "orderType": { "type": "string", "description": "Mandatory field" }, "preferSupplierFromSOLine": { "type": "boolean", "description": "Supplier" } } }, "ARSPCommnHistoryDto": { "type": "object", "properties": { "commnPeriod": { "type": "string" }, "commnAmt": { "type": "number", "format": "double" }, "commnblAmt": { "type": "number", "format": "double" }, "prProcessedDate": { "type": "string", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "CustSalesPeopleDto": { "type": "object", "properties": { "bAccountID": { "type": "integer", "format": "int32" }, "customerName": { "type": "string" }, "locationID": { "type": "integer", "format": "int32" }, "locationName": { "type": "string" }, "isDefault": { "type": "boolean" }, "commisionPct": { "type": "number", "format": "double" }, "createdDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "SalesPersonDto": { "type": "object", "properties": { "salespersonID": { "type": "string" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "commissionPct": { "type": "number", "format": "double" }, "salesSub": { "$ref": "#/components/schemas/SubAccountDescriptionDto" }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/CustSalesPeopleDto" } }, "commissionHistory": { "type": "array", "items": { "$ref": "#/components/schemas/ARSPCommnHistoryDto" } }, "createdDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a salesperson in SalesPersonController. Used for getting data." }, "CustSalesPeopleUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "customerID": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationID": { "$ref": "#/components/schemas/DtoValueOfString" }, "commissionPct": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" } } }, "SalesPersonUpdateDto": { "type": "object", "properties": { "salespersonID": { "$ref": "#/components/schemas/DtoValueOfString" }, "name": { "$ref": "#/components/schemas/DtoValueOfString" }, "isActive": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "commissionPct": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "salesSub": { "$ref": "#/components/schemas/DtoValueOfString" }, "customers": { "type": "array", "items": { "$ref": "#/components/schemas/CustSalesPeopleUpdateDto" } } } }, "SalesPersonQueryParameters": { "type": "object", "properties": { "salespersonCD": { "type": "string" }, "name": { "type": "string" }, "isActive": { "type": "boolean" }, "commissionPct": { "type": "number", "format": "double" }, "salesSub": { "type": "string" }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "BasePaginationDtoOfSalesPersonDto": { "type": "object", "properties": { "pageNumber": { "type": "integer", "format": "int32" }, "pageSize": { "type": "integer", "format": "int32" }, "totalCount": { "type": "integer", "format": "int64" }, "records": { "type": "array", "items": { "$ref": "#/components/schemas/SalesPersonDto" } } } }, "ShipmentPackageLineUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "confirmed": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "boxId": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "weight": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "volume": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "declaredValue": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "codAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "trackingNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "customRefNbr1": { "$ref": "#/components/schemas/DtoValueOfString" }, "customRefNbr2": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "expirationDateInShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "Property will become obsolete after version 5.31" }, "customStr1InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InShipmentDetailLineUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "ShipmentDetailLineUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "warehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippedQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "lotSerialNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "expirationDate": { "$ref": "#/components/schemas/expirationDateInShipmentDetailLineUpdateDto" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "allocations": { "type": "array", "items": { "$ref": "#/components/schemas/AllocationsUpdateDto" } }, "customStr1": { "$ref": "#/components/schemas/customStr1InShipmentDetailLineUpdateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InShipmentDetailLineUpdateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InShipmentDetailLineUpdateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InShipmentDetailLineUpdateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InShipmentDetailLineUpdateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InShipmentDetailLineUpdateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InShipmentDetailLineUpdateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InShipmentDetailLineUpdateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InShipmentDetailLineUpdateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InShipmentDetailLineUpdateDto" } } }, "DtoValueOfNullableOfTransportationModes": { "type": "object", "properties": { "value": { "enum": [ "Unknown", "BySea", "ByRail", "ByRoad", "ByAeroPlane", "ConsignmentsByPosts", "FixedInstallations", "InlandWaterway" ], "type": "string" } } }, "DtoValueOfNullableOfShipmentOperations": { "type": "object", "properties": { "value": { "enum": [ "Issue", "Receipt" ], "type": "string" } } }, "DtoValueOfNullableOfShipmentTypes": { "type": "object", "properties": { "value": { "enum": [ "Issue", "DropShip", "Transfer" ], "type": "string" } } }, "customStr1InShipmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InShipmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InShipmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InShipmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InShipmentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InShipmentUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InShipmentUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InShipmentUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InShipmentUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InShipmentUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "ShipmentUpdateDto": { "type": "object", "properties": { "shipmentType": { "$ref": "#/components/schemas/DtoValueOfNullableOfShipmentTypes" }, "operation": { "$ref": "#/components/schemas/DtoValueOfNullableOfShipmentOperations" }, "shipmentDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "customer": { "$ref": "#/components/schemas/DtoValueOfString" }, "owner": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "fromWarehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "toWarehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "controlQuantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "overrideContact": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "businessName": { "$ref": "#/components/schemas/DtoValueOfString" }, "attention": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone1": { "$ref": "#/components/schemas/DtoValueOfString" }, "email": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideAddress": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "addressLine1": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine2": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine3": { "$ref": "#/components/schemas/DtoValueOfString" }, "city": { "$ref": "#/components/schemas/DtoValueOfString" }, "country": { "$ref": "#/components/schemas/DtoValueOfString" }, "county": { "$ref": "#/components/schemas/DtoValueOfString" }, "postalCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "shipVia": { "$ref": "#/components/schemas/DtoValueOfString" }, "fobPoint": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippingTerms": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippingZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "residentialDelivery": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "saturdayDelivery": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "useCustomerAccount": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "insurance": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "freightAmt": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "freightCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "transactionType": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "modeOfTrasport": { "$ref": "#/components/schemas/DtoValueOfNullableOfTransportationModes" }, "container": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "shipmentDetailLines": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDetailLineUpdateDto" } }, "shipmentPackageLines": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPackageLineUpdateDto" } }, "customStr1": { "$ref": "#/components/schemas/customStr1InShipmentUpdateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InShipmentUpdateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InShipmentUpdateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InShipmentUpdateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InShipmentUpdateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InShipmentUpdateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InShipmentUpdateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InShipmentUpdateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InShipmentUpdateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InShipmentUpdateDto" } } }, "ShipmentsQueryParameters": { "type": "object", "properties": { "customerId": { "type": "integer", "format": "int32" }, "customerNumber": { "type": "string" }, "greaterThanValue": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The GreaterThanValue parameter has no effect on the result." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string", "description": "This field has been deprecated and will be removed in future versions. The OrderBy parameter has no effect on the result." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "status": { "enum": [ "Open", "Hold", "Completed", "Cancelled", "Confirmed", "Invoiced", "Receipted", "AutoGenerated", "PartiallyInvoiced" ], "type": "string" }, "pageSize": { "type": "integer", "format": "int32" }, "pageNumber": { "type": "integer", "format": "int32" }, "shipmentType": { "enum": [ "Issue", "DropShip", "Transfer" ], "type": "string", "description": "Filter by Shipment Type" }, "shipmentDate": { "type": "string", "description": "Shipment Date\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __ShipmentDate__ and __ShipmentDate__ are __mutually inclusive__." }, "shipmentDateCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __ShipmentDate__ and __ShipmentDateCondition__ are __mutually inclusive__." }, "includeCustomFreeFields": { "type": "boolean", "description": "Parameter to include custom free fields information in the result set, if true then custom free fields will be included in the result set" } } }, "customStr1InShipmentCreateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InShipmentCreateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InShipmentCreateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InShipmentCreateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InShipmentCreateDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InShipmentCreateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InShipmentCreateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InShipmentCreateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InShipmentCreateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InShipmentCreateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "ShipmentCreateDto": { "type": "object", "properties": { "shipmentType": { "$ref": "#/components/schemas/DtoValueOfNullableOfShipmentTypes" }, "operation": { "$ref": "#/components/schemas/DtoValueOfNullableOfShipmentOperations" }, "shipmentDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "customer": { "$ref": "#/components/schemas/DtoValueOfString" }, "owner": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "fromWarehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "toWarehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "controlQuantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "overrideContact": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "businessName": { "$ref": "#/components/schemas/DtoValueOfString" }, "attention": { "$ref": "#/components/schemas/DtoValueOfString" }, "phone1": { "$ref": "#/components/schemas/DtoValueOfString" }, "email": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideAddress": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "addressLine1": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine2": { "$ref": "#/components/schemas/DtoValueOfString" }, "addressLine3": { "$ref": "#/components/schemas/DtoValueOfString" }, "city": { "$ref": "#/components/schemas/DtoValueOfString" }, "country": { "$ref": "#/components/schemas/DtoValueOfString" }, "county": { "$ref": "#/components/schemas/DtoValueOfString" }, "postalCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "shipVia": { "$ref": "#/components/schemas/DtoValueOfString" }, "fobPoint": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippingTerms": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippingZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "residentialDelivery": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "saturdayDelivery": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "useCustomerAccount": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "insurance": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "freightAmt": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "freightCost": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "transactionType": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "modeOfTrasport": { "$ref": "#/components/schemas/DtoValueOfNullableOfTransportationModes" }, "container": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "shipmentDetailLines": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDetailLineUpdateDto" } }, "shipmentPackageLines": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentPackageLineUpdateDto" } }, "customStr1": { "$ref": "#/components/schemas/customStr1InShipmentCreateDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InShipmentCreateDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InShipmentCreateDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InShipmentCreateDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InShipmentCreateDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InShipmentCreateDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InShipmentCreateDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InShipmentCreateDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InShipmentCreateDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InShipmentCreateDto" } } }, "ShipmentSOLine": { "type": "object", "properties": { "orderType": { "type": "string", "description": "Sales Order Type" }, "orderNumber": { "type": "string", "description": "Sales Order Number" }, "orderLineNumber": { "type": "integer", "description": "Sales Order Line Number, optional if Inventory Id is entered", "format": "int32" }, "inventoryId": { "type": "string", "description": "Inventory Id, ignored if Order Line Number is specified. If more that one line on the Sales order has this Inventory Id, it will not work." } } }, "ShipmentSOOrder": { "type": "object", "properties": { "orderType": { "type": "string", "description": "Sales Order Type" }, "orderNumber": { "type": "string", "description": "Sales Order Number" } } }, "ConfirmShipmentActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "customStr1InShipmentDetailLineAddDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr2InShipmentDetailLineAddDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr3InShipmentDetailLineAddDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr4InShipmentDetailLineAddDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customStr5InShipmentDetailLineAddDto": { "properties": { "value": { "type": "string" } }, "description": "A free custom colum of type string with max length 100." }, "customDec1InShipmentDetailLineAddDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customDec2InShipmentDetailLineAddDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "A free custom colum of type decimal with max 4 decimals." }, "customInt1InShipmentDetailLineAddDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customInt2InShipmentDetailLineAddDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "A free custom colum of type int" }, "customDateTimeUTC1InShipmentDetailLineAddDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "A free custom colum of type DateTime - in UTC timezone" }, "ShipmentDetailLineAddDto": { "required": [ "inventoryNumber" ], "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "warehouse": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "shippedQty": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "customStr1": { "$ref": "#/components/schemas/customStr1InShipmentDetailLineAddDto" }, "customStr2": { "$ref": "#/components/schemas/customStr2InShipmentDetailLineAddDto" }, "customStr3": { "$ref": "#/components/schemas/customStr3InShipmentDetailLineAddDto" }, "customStr4": { "$ref": "#/components/schemas/customStr4InShipmentDetailLineAddDto" }, "customStr5": { "$ref": "#/components/schemas/customStr5InShipmentDetailLineAddDto" }, "customDec1": { "$ref": "#/components/schemas/customDec1InShipmentDetailLineAddDto" }, "customDec2": { "$ref": "#/components/schemas/customDec2InShipmentDetailLineAddDto" }, "customInt1": { "$ref": "#/components/schemas/customInt1InShipmentDetailLineAddDto" }, "customInt2": { "$ref": "#/components/schemas/customInt2InShipmentDetailLineAddDto" }, "customDateTimeUTC1": { "$ref": "#/components/schemas/customDateTimeUTC1InShipmentDetailLineAddDto" } } }, "ShipmentUpdateDeleteLineDto": { "required": [ "deleteSOLine" ], "type": "object", "properties": { "deleteSOLine": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "LocationIdNameDescriptionDto": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "id": { "type": "string", "description": "Click the magnifier > The displayed name" }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "InventoryIdNameDescriptionDto": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "id": { "type": "string", "description": "Click the magnifier > The displayed name" }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "inventoryInStocktakeLineV2Dto": { "properties": { "internalId": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "id": { "type": "string", "description": "Click the magnifier > The displayed name" }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Stocktaking details tab > Item ID > The item ID of the item." }, "locationInStocktakeLineV2Dto": { "properties": { "internalId": { "type": "integer", "description": "Click the magnifier > The identifier", "format": "int32" }, "id": { "type": "string", "description": "Click the magnifier > The displayed name" }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Stocktaking details tab > Location > The warehouse location of the item." }, "warehouseInStocktakeLineV2Dto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Warehouse > An info field that shows the warehouse where the stocktaking count is performed." }, "StocktakeLineV2Dto": { "type": "object", "properties": { "status": { "enum": [ "NotEntered", "Entered", "Skipped" ], "type": "string", "description": "Stocktaking details tab > Status > The status of the line of the stocktaking document, which indicates whether the actual physical quantity has been specified for the line." }, "lineNbr": { "type": "integer", "description": "Stocktaking details tab > Line no. > The number of the line in the stocktaking document.", "format": "int32" }, "tagNbr": { "type": "integer", "description": "Stocktaking details tab > Tag no. > The tag number for the line item, which is the stock item with the properties specified in the line, such as location, subitem, and lot or serial number.", "format": "int32" }, "inventory": { "$ref": "#/components/schemas/inventoryInStocktakeLineV2Dto" }, "location": { "$ref": "#/components/schemas/locationInStocktakeLineV2Dto" }, "warehouse": { "$ref": "#/components/schemas/warehouseInStocktakeLineV2Dto" }, "lotSerialNbr": { "type": "string", "description": "Stocktaking details tab > Lot/serial number > The lot or serial number of the item." }, "expirationDate": { "type": "string", "description": "Stocktaking details tab > Expiration date > The expiration date of the item with this specific lot or serial number.", "format": "date-time" }, "bookQuantity": { "type": "number", "description": "Stocktaking details tab > Book quantity > The book quantity of the item, which is calculated based on the system records.", "format": "double" }, "physicalQuantity": { "type": "number", "description": "Stocktaking details tab > Physical quantity > The physical quantity of the item as entered manually.", "format": "double" }, "varianceQuantity": { "type": "number", "description": "Stocktaking details tab > Variance quantity > The difference between the book quantity and the physical quantity for the line item.", "format": "double" }, "unitCost": { "type": "number", "description": "Stocktaking details tab > Unit cost > The last cost of the item’s base unit as approximation of its unit cost during the count.", "format": "double" }, "extVarianceCost": { "type": "number", "description": "Stocktaking details tab > Variance cost > The difference between the extended cost calculated based on the book quantity and the extended cost calculated based on the physical quantity for the item.", "format": "double" }, "reasonCode": { "type": "string", "description": "Stocktaking details tab > Reason code > The reason code for the item." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "baseUnit": { "type": "string", "description": "Stocktaking details tab > Base Unit > The base unit for the item." } } }, "StocktakeV2Dto": { "type": "object", "properties": { "referenceNbr": { "type": "string", "description": "The top part > Ref. no. > The reference number of the stocktaking document to be reviewed." }, "description": { "type": "string", "description": "The top part > Description > The description of the stocktaking." }, "summaryStatus": { "enum": [ "Cancelled", "Completed", "Counting", "Entering" ], "type": "string", "description": "The top part > Status > An info field that shows the current status of this stocktaking document." }, "freezeDate": { "type": "string", "description": "The top part > Freeze date > An info field that shows the date when the stocktaking document was created.", "format": "date-time" }, "numberOfLines": { "type": "integer", "format": "int32" }, "physicalQty": { "type": "number", "description": "The top part > Total physical qty. > An info field showing the total actual quantity of all stock items listed in the document.", "format": "double" }, "varianceQty": { "type": "number", "description": "The top part > Total variance qty. > An info field showing the total variance quantity for the document.", "format": "double" }, "varianceCost": { "type": "number", "description": "The top part > Total variance cost > An info field showing the total variance cost for all stock items listed in the document.", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "lines": { "type": "array", "items": { "$ref": "#/components/schemas/StocktakeLineV2Dto" }, "description": "Stocktaking details tab >" }, "timestamp": { "type": "string", "description": "Timestamp of the stocktake record" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "StocktakeLineUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNbr": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "physicalQuantity": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "inventoryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "reasonCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "lotSerialNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "expirationDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" } }, "description": "This class represent a Stocktake line in StocktakeContoller. Used to update a Stocktake line" }, "StocktakeUpdateDto": { "type": "object", "properties": { "lines": { "type": "array", "items": { "$ref": "#/components/schemas/StocktakeLineUpdateDto" } } }, "description": "This class represents a Stocktake in StocktakeController. Used to update Stocktake." }, "StocktakeV2ExceptionDto": { "type": "object", "properties": { "inventoryId": { "type": "string", "description": "Stocktaking details tab > Item ID > The item ID of the item." }, "locationId": { "type": "string", "description": "Stocktaking details tab > Location > The warehouse location of the item." }, "physicalQuantity": { "type": "number", "description": "Stocktaking details tab > Variance quantity > The difference between the book quantity and the physical quantity for the line item.", "format": "double" }, "reasonCode": { "type": "string", "description": "Stocktaking details tab > Reason code > The reason code for the item." }, "lotSerialNumber": { "type": "string", "description": "Stocktaking details tab > Expiration date > The expiration date of the item with this specific lot or serial number." }, "expirationDate": { "type": "string", "description": "Stocktaking details tab > Book quantity > The book quantity of the item, which is calculated based on the system records.", "format": "date-time" }, "message": { "type": "string", "description": "Exception message" }, "errorCode": { "enum": [ "NotDefined", "InventoryIDNotFound", "LocationIDNotFound", "ReasonCodeNotFound", "ItemIsNotStockItem", "CombinationAlreadyInUse", "CombinationNotAllowed", "LotSerialNumberAlreadyInUse" ], "type": "string", "description": "Exception error code" } } }, "StocktakePagingQueryParameters": { "type": "object", "properties": { "warehouse": { "type": "string", "description": "Filter by Warehouse." }, "location": { "type": "string", "description": "Filter by Location." }, "inventory": { "type": "string", "description": "Filter by Inventory." }, "lotSerialNumber": { "type": "string", "description": "Filter by LotSerialNumber." }, "summaryStatus": { "enum": [ "Cancelled", "Completed", "Counting", "Entering" ], "type": "string", "description": "Filter by SummaryStatus." }, "startWithLine": { "type": "integer", "description": "Filter by LineNumber GreaterEqual StartWithLine.", "format": "int32" }, "endWithLine": { "type": "integer", "description": "Filter by by LineNumber LessEqual EndWithLine.", "format": "int32" }, "freezeDateTime": { "type": "string", "description": "Filter by FreezeDateTime." }, "freezeDateTimeCondition": { "type": "string", "description": "Filter by FreezeDateTimeCondition." }, "lastModifiedDateTime": { "type": "string", "description": "System generated value for last modification of transaction/record. Use format: YYYY-MM-DD HH:MM (date and time) to filter from date to present.." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "System retrieved information for state/condition." }, "expirationDateTime": { "type": "string", "description": "Filter by ExpirationDateTime." }, "expirationDateTimeCondition": { "type": "string", "description": "Filter by ExpirationDateTimeCondition." }, "status": { "enum": [ "NotEntered", "Entered", "Skipped" ], "type": "string", "description": "Filter by StocktakeLineStatus." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "subaccountNumberInSubAccountUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field, identifies the subaccount to update." }, "subaccountIdInSubAccountUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The property is now considered obsolete, use SubaccountNumber instead. If SubaccountNumber is specified in a request, this property is ignored." }, "SubAccountUpdateDto": { "required": [ "subaccountNumber" ], "type": "object", "properties": { "subaccountNumber": { "$ref": "#/components/schemas/subaccountNumberInSubAccountUpdateDto" }, "subaccountId": { "$ref": "#/components/schemas/subaccountIdInSubAccountUpdateDto" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "active": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "SubaccountQueryParameters": { "type": "object", "properties": { "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "active": { "type": "boolean", "description": "If the SubAccount is active" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected", "format": "int32" } } }, "SupplierClassDto": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassAttributeDto" } }, "paymentMethodId": { "type": "string" }, "paymentMethodDescription": { "type": "string" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "SupplierBalanceQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." } } }, "WithoutWithVatDto": { "type": "object", "properties": { "withoutVat": { "type": "number", "format": "double" }, "withVat": { "type": "number", "format": "double" } } }, "SupplierBalanceDto": { "type": "object", "properties": { "branchNumber": { "type": "string" }, "supplier": { "$ref": "#/components/schemas/SupplierDescriptionDto" }, "balance": { "type": "number", "format": "double" }, "unreleasedPurchasesNotInApproval": { "$ref": "#/components/schemas/WithoutWithVatDto" }, "totalSentForApproval": { "$ref": "#/components/schemas/WithoutWithVatDto" }, "totalPurchaseInvoicePeriod": { "$ref": "#/components/schemas/WithoutWithVatDto" }, "totalPurchaseInvoiceYear": { "$ref": "#/components/schemas/WithoutWithVatDto" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" } } }, "supplierInSupplierPOBalanceDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "The name of the supplier" }, "SupplierPOBalanceDto": { "type": "object", "properties": { "supplier": { "$ref": "#/components/schemas/supplierInSupplierPOBalanceDto" }, "totalPOOnHoldOrderTotal": { "type": "number", "description": "The total amount of order on hold", "format": "double" }, "totalPOOnHoldLineTotal": { "type": "number", "description": "The total amount of the order line on hold", "format": "double" }, "totalOpenPOOrderTotal": { "type": "number", "description": "The total open amount of the order", "format": "double" }, "totalOpenPOLineTotal": { "type": "number", "description": "The total open amount of the order line", "format": "double" }, "totalClosedPOOrderTotal": { "type": "number", "description": "The total closed amount of the order", "format": "double" }, "totalClosedPOLineTotal": { "type": "number", "description": "The total closed amount of the order line", "format": "double" }, "lastModifiedDateTime": { "type": "string", "description": "The date and time when the purchase order was last modified.", "format": "date-time" } } }, "SupplierPaymentMethodDetailDto": { "type": "object", "properties": { "paymentMethodDetailDescription": { "type": "string", "description": "The description of the payment method detail." }, "paymentMethodDetailValue": { "type": "string", "description": "The ID of the payment method detail." }, "paymentMethodDetailBankingDetailType": { "type": "string", "description": "Payment method banking detail type" }, "paymentMethodDetailID": { "type": "string", "description": "payment method detail ID" } }, "description": "This class represents a Payment Method Detail in SupplierController. Used to get data for SupplierPaymentMethodDetails of a Supplier." }, "supplierAccountInSupplierGlAccountsDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Supplier account > The liability account used to record the balance of supplier ledger transactions related to the supplier." }, "supplierSubaccountInSupplierGlAccountsDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Supplier sub > The corresponding subaccount used to record the balance of supplier ledger transactions related to the supplier." }, "expenseAccountInSupplierGlAccountsDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Expense account > The expense account used to record expenses incurred for the supplier." }, "expenseAccountNonTaxInSupplierGlAccountsDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Expence acct, non-taxable > The non-taxable expense account used to record expenses made to the suppliers of this class." }, "expenseEUAccountInSupplierGlAccountsDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Expence EU account > The EU expense account used to record expenses made to the suppliers of this class." }, "expenseAccountImportInSupplierGlAccountsDto": { "properties": { "type": { "type": "string" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Expense account, import > The import expense account used to record expenses made to the suppliers of this class." }, "expenseSubaccountInSupplierGlAccountsDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Expense sub > The corresponding subaccount used to record expenses incurred for the supplier." }, "SupplierGlAccountsDto": { "type": "object", "properties": { "supplierAccount": { "$ref": "#/components/schemas/supplierAccountInSupplierGlAccountsDto" }, "supplierSubaccount": { "$ref": "#/components/schemas/supplierSubaccountInSupplierGlAccountsDto" }, "expenseAccount": { "$ref": "#/components/schemas/expenseAccountInSupplierGlAccountsDto" }, "expenseAccountNonTax": { "$ref": "#/components/schemas/expenseAccountNonTaxInSupplierGlAccountsDto" }, "expenseEUAccount": { "$ref": "#/components/schemas/expenseEUAccountInSupplierGlAccountsDto" }, "expenseAccountImport": { "$ref": "#/components/schemas/expenseAccountImportInSupplierGlAccountsDto" }, "expenseSubaccount": { "$ref": "#/components/schemas/expenseSubaccountInSupplierGlAccountsDto" } } }, "mainAddressInSupplierDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "General information tab > Main address section >" }, "mainContactInSupplierDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "General information tab > Main contact section >" }, "parentRecordInSupplierDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "General information tab > Main contact section > Parent account > The parent supplier's account, which you can select from the list of existing supplier accounts." }, "supplierClassInSupplierDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: General information tab > Financial settings section > Supplier class* > The class of the supplier." }, "creditTermsInSupplierDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "General information tab > Financial settings section > Terms > The type of credit terms used in operations with the supplier." }, "remitAddressInSupplierDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "Payment settings tab > Remittance address section >" }, "remitContactInSupplierDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Payment settings tab > Remittance contact section >" }, "paymentMethodInSupplierDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Payment settings tab > Payment settings section > Payment method > The default payment method to be used for the supplier." }, "supplierAddressInSupplierDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "Purchase settings tab > Shipping address section >" }, "supplierContactInSupplierDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "Purchase settings tab > Shipping contact information section >" }, "locationInSupplierDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Purchase settings tab > Default location settings section >" }, "vatZoneInSupplierDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Purchase settings tab > Default location settings section > VAT zone > The VAT zone of the supplier's default location." }, "glAccountsInSupplierDto": { "properties": { "supplierAccount": { "$ref": "#/components/schemas/supplierAccountInSupplierGlAccountsDto" }, "supplierSubaccount": { "$ref": "#/components/schemas/supplierSubaccountInSupplierGlAccountsDto" }, "expenseAccount": { "$ref": "#/components/schemas/expenseAccountInSupplierGlAccountsDto" }, "expenseAccountNonTax": { "$ref": "#/components/schemas/expenseAccountNonTaxInSupplierGlAccountsDto" }, "expenseEUAccount": { "$ref": "#/components/schemas/expenseEUAccountInSupplierGlAccountsDto" }, "expenseAccountImport": { "$ref": "#/components/schemas/expenseAccountImportInSupplierGlAccountsDto" }, "expenseSubaccount": { "$ref": "#/components/schemas/expenseSubaccountInSupplierGlAccountsDto" } }, "description": "General ledger accounts tab >" }, "SupplierDto": { "type": "object", "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "Mandatory field: The top part > Supplier ID* > The ID of the supplier account." }, "name": { "type": "string", "description": "Mandatory field: The top part > Supplier name* > The name of the supplier to appear in the system, which may be a trade name or a doing-business-as (DBA) name." }, "status": { "enum": [ "Active", "OnHold", "HoldPayments", "Inactive", "OneTime" ], "type": "string", "description": "Mandatory field: The top part > Status* > The status of the supplier account." }, "mainAddress": { "$ref": "#/components/schemas/mainAddressInSupplierDto" }, "mainContact": { "$ref": "#/components/schemas/mainContactInSupplierDto" }, "accountReference": { "type": "string", "description": "General information tab > Main contact section > Account ref. > An optional text field that can contain a reference to your company's account number in the supplier's system." }, "parentRecord": { "$ref": "#/components/schemas/parentRecordInSupplierDto" }, "supplierClass": { "$ref": "#/components/schemas/supplierClassInSupplierDto" }, "creditTerms": { "$ref": "#/components/schemas/creditTermsInSupplierDto" }, "documentLanguage": { "type": "string", "description": "General information tab > Financial settings section > Document language > The language of the documents to be printed to the suppliers of the class." }, "currencyId": { "type": "string", "description": "General information tab > Financial settings section > Currency ID > The currency that is used in operations with the supplier." }, "remitAddress": { "$ref": "#/components/schemas/remitAddressInSupplierDto" }, "remitContact": { "$ref": "#/components/schemas/remitContactInSupplierDto" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInSupplierDto" }, "cashAccount": { "type": "string", "description": "Payment settings tab > Payment settings section > Cash account > The cash account to be used for operations with the supplier. You must select a cash account." }, "chargeBearer": { "enum": [ "Payer", "Beneficiary", "Shared", "ServiceLevel" ], "type": "string", "description": "Payment settings tab > Payment settings section > Charge bearer > The party that will pay possible expenses connected with the payment." }, "accountUsedForPayment": { "enum": [ "IBAN", "BBAN", "BANKGIRO", "PLUSGIRO" ], "type": "string", "description": "Payment settings tab > Payment settings section > Account used for payment > The bank account to be used for payments to the supplier." }, "paymentBy": { "enum": [ "DueDate", "DiscountDate" ], "type": "string", "description": "Payment settings tab > Payment settings section > Payment by > An option that defines how to calculate the date when this supplier should be paid." }, "paymentLeadTime": { "type": "integer", "description": "Payment settings tab > Payment settings section > Payment lead time (days) > The number of days required for the payment to be delivered to the supplier's location.", "format": "int32" }, "paymentRefDisplayMask": { "type": "string", "description": "Payment settings tab > Payment settings section > Payment ref. display mask > This is a rule (mask) for how the payment reference number will be displayed." }, "paySeparately": { "type": "boolean", "description": "Payment settings tab > Payment settings section > Pay separately > A check box that indicates (if selected) that each supplier document should be paid by a separate payment." }, "supplierAddress": { "$ref": "#/components/schemas/supplierAddressInSupplierDto" }, "supplierContact": { "$ref": "#/components/schemas/supplierContactInSupplierDto" }, "location": { "$ref": "#/components/schemas/locationInSupplierDto" }, "vatRegistrationId": { "type": "string", "description": "Purchase settings tab > Default location settings section > VAT registration ID > The supplier's VAT registration ID associated with the location." }, "corporateId": { "type": "string", "description": "Purchase settings tab > Default location settings section > National insurance no. > The supplier’s national insurance number associated with the location." }, "vatZone": { "$ref": "#/components/schemas/vatZoneInSupplierDto" }, "glAccounts": { "$ref": "#/components/schemas/glAccountsInSupplierDto" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeIdValueDto" }, "description": "Attributes tab >" }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "supplierPaymentMethodDetails": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPaymentMethodDetailDto" }, "description": "This class represents a Payment Method Detail in SupplierController. Used to get data for SupplierPaymentMethodDetails of a Supplier." }, "retainageApply": { "type": "boolean", "description": "Payment settings tab > Retainage settings section > Apply retainage > A check box that indicates (if selected) that by default, invoices with retainage are created for the supplier in the Purchase invoices window." }, "retainageCashAccountID": { "type": "string", "description": "Payment settings tab > Retainage settings section > Retainage cash account > The cash account to be used to record retainages for this supplier." }, "retainagePct": { "type": "number", "description": "Payment settings tab > Retainage settings section > Retainage (%) > The default percent to be retained in invoices for the supplier.", "format": "double" }, "note": { "type": "string" }, "numberOfEmployees": { "type": "integer", "description": "Legal requirements that all companies with more than 250 employees keep track of their business accounts", "format": "int32" }, "naceCode": { "type": "string", "description": "General information tab > Main contact section > Industry Code ID > The supplier's NACE code" }, "landedCostSupplier": { "type": "boolean", "description": "General information tab > SupplierProperties > Landed Cost Supplier > Indicates if the supplier is a landed cost supplier or not" }, "currencyOverride": { "type": "boolean", "description": "General information tab > Financial settings section > Enable currency override" }, "currencyRateOverride": { "type": "boolean", "description": "General information tab > Financial settings section > Enable rate override" }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a supplier in SupplierController. Used by getting data." }, "SupplierGlAccountsUpdateDto": { "type": "object", "properties": { "supplierAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplierSubaccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseAccountNonTax": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseEUAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseAccountImport": { "$ref": "#/components/schemas/DtoValueOfString" }, "expenseSubaccount": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "SupplierPaymentMethodDetailUpdateDto": { "type": "object", "properties": { "paymentMethodDetailDescription": { "type": "string" }, "paymentMethodDetailValue": { "$ref": "#/components/schemas/DtoValueOfString" } }, "description": "This class represents a Payment Method Detail in SupplierController. Used to update SupplierPaymentMethodDetails when creating or updating a Supplier." }, "DtoValueOfSupplierGlAccountsUpdateDto": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/SupplierGlAccountsUpdateDto" } } }, "DtoValueOfPaymentBy": { "type": "object", "properties": { "value": { "enum": [ "DueDate", "DiscountDate" ], "type": "string" } } }, "DtoValueOfAccountUsedForPayment": { "type": "object", "properties": { "value": { "enum": [ "IBAN", "BBAN", "BANKGIRO", "PLUSGIRO" ], "type": "string" } } }, "DtoValueOfSupplierChargeBearer": { "type": "object", "properties": { "value": { "enum": [ "Payer", "Beneficiary", "Shared", "ServiceLevel" ], "type": "string" } } }, "DtoValueOfSupplierStatus": { "type": "object", "properties": { "value": { "enum": [ "Active", "OnHold", "HoldPayments", "Inactive", "OneTime" ], "type": "string" } } }, "SupplierUpdateDto": { "type": "object", "properties": { "number": { "$ref": "#/components/schemas/DtoValueOfString" }, "name": { "$ref": "#/components/schemas/DtoValueOfString" }, "status": { "$ref": "#/components/schemas/DtoValueOfSupplierStatus" }, "accountReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "numberOfEmployees": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "parentRecordNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplierClassId": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideWithClassValues": { "type": "boolean" }, "creditTermsId": { "$ref": "#/components/schemas/DtoValueOfString" }, "documentLanguage": { "$ref": "#/components/schemas/DtoValueOfString" }, "currencyId": { "$ref": "#/components/schemas/DtoValueOfString" }, "currencyOverride": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "currencyRateOverride": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "paymentMethodId": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentLeadTime": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt16" }, "paymentRefDisplayMask": { "$ref": "#/components/schemas/DtoValueOfString" }, "paySeparately": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "vatRegistrationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "corporateId": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatZoneId": { "$ref": "#/components/schemas/DtoValueOfString" }, "chargeBearer": { "$ref": "#/components/schemas/DtoValueOfSupplierChargeBearer" }, "accountUsedForPayment": { "$ref": "#/components/schemas/DtoValueOfAccountUsedForPayment" }, "paymentBy": { "$ref": "#/components/schemas/DtoValueOfPaymentBy" }, "mainAddress": { "$ref": "#/components/schemas/DtoValueOfAddressUpdateDto" }, "mainContact": { "$ref": "#/components/schemas/DtoValueOfContactInfoUpdateDto" }, "remitAddress": { "$ref": "#/components/schemas/DtoValueOfAddressUpdateDto" }, "remitContact": { "$ref": "#/components/schemas/DtoValueOfContactInfoUpdateDto" }, "supplierAddress": { "$ref": "#/components/schemas/DtoValueOfAddressUpdateDto" }, "supplierContact": { "$ref": "#/components/schemas/DtoValueOfContactInfoUpdateDto" }, "glAccounts": { "$ref": "#/components/schemas/DtoValueOfSupplierGlAccountsUpdateDto" }, "supplierPaymentMethodDetails": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPaymentMethodDetailUpdateDto" } }, "attributeLines": { "type": "array", "items": { "$ref": "#/components/schemas/AttributeLineUpdateDto" } }, "retainageCashAccountID": { "$ref": "#/components/schemas/DtoValueOfString" }, "retainageApply": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "retainagePct": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "naceCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "landedCostSupplier": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" } }, "description": "This class represents a supplier in SupplierController. Used to create and update supplier." }, "SupplierQueryParameters": { "type": "object", "properties": { "greaterThanValue": { "type": "string" }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "orderBy": { "type": "string" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "name": { "type": "string", "description": "Contains supplier name." }, "status": { "enum": [ "Active", "OnHold", "HoldPayments", "Inactive", "OneTime" ], "type": "string" }, "vatRegistrationId": { "type": "string" }, "corporateId": { "type": "string" }, "attributes": { "type": "string" }, "expandAccountInformation": { "type": "boolean" }, "expandNote": { "type": "boolean" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "SupplierInboxRuleQueryParameters": { "type": "object", "properties": { "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "SafeWaitHandle": { "type": "object", "properties": { "isInvalid": { "type": "boolean", "readOnly": true }, "isClosed": { "type": "boolean", "readOnly": true } } }, "WaitHandle": { "type": "object", "properties": { "handle": { "type": "object" }, "safeWaitHandle": { "$ref": "#/components/schemas/SafeWaitHandle" } } }, "CancellationToken": { "type": "object", "properties": { "isCancellationRequested": { "type": "boolean", "readOnly": true }, "canBeCanceled": { "type": "boolean", "readOnly": true }, "waitHandle": { "$ref": "#/components/schemas/WaitHandle" } } }, "SupplierInvoiceForSupplierQueryParameters": { "type": "object", "properties": { "expandAttachment": { "type": "boolean", "description": "Set to true if you want to see all attachments regarding this document." }, "expandLandedCosts": { "type": "boolean", "description": "Expland landed cost lines" }, "documentType": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string", "description": "By type of document." }, "released": { "type": "integer", "description": "Parameter for showing if invoice has been released or not.", "format": "int32" }, "project": { "type": "string", "description": "Filter by the project with which the document is associated." }, "expandApproval": { "type": "boolean", "description": "Set to true to include approval information." }, "expandNote": { "type": "boolean", "description": "Set to true to include description." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string", "description": "The status of the document" }, "expandLinePrebookAccounts": { "type": "boolean", "description": "Expland line-level pre-booking account and sub-account information." }, "branch": { "type": "string", "description": "Filter by Branch" }, "financialPeriod": { "type": "string", "description": "Filter by Financial Period, format YYYYPP" }, "dueDate": { "type": "string", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "format": "date-time" }, "dueDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__." }, "docDate": { "type": "string", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.", "format": "date-time" }, "docDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__." }, "item": { "type": "string", "description": "Filter by Item used into the document lines" }, "balance": { "type": "number", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "format": "double" }, "balanceCondition": { "type": "string", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__." }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "SupplierNumberDto": { "type": "object", "properties": { "internalId": { "type": "integer", "description": "The internal id of the supplier", "format": "int64" }, "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } } }, "SupplierInvoiceLandedCostDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "Landed Costs Tab > Number at the left indicating the line number of the table.", "format": "int32" }, "landedCostCodeId": { "type": "string", "description": "Landed Costs Tab > Landed cost code > The Landed Cost Code ID lf the Landed Cost Code" }, "description": { "type": "string", "description": "Landed Costs Tab > Description > The description of the landed cost" }, "amount": { "type": "number", "description": "Landed Costs Tab > Amount > The amount of the landed cost", "format": "double" }, "vatCategoryId": { "type": "string", "description": "Landed Costs Tab > VAT Category > The ID of VAT cateogry" }, "purchaseReceiptType": { "enum": [ "PoReceipt", "PoReturn", "TransferReceipt" ], "type": "string", "description": "Landed Costs Tab > Purchase Receipt Type > The purchase receipt type" }, "purcahseOrderReceiptNumber": { "type": "string", "description": "Landed Costs Tab > Purchase order receipt no. > The purchase order receipt number" }, "inventoryId": { "type": "string", "description": "Landed Costs Tab > Item ID > The ID of the inventory item" }, "siteId": { "type": "string", "description": "Landed Costs Tab > Warehouse > The ID of the warehouse" }, "locationId": { "type": "string", "description": "Landed Costs Tab > Location > The ID of the warehouse location" } } }, "accountInSupplierInvoiceLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "The table > Mandatory field: Account* > The purchase account used for the invoice line." }, "subaccountInSupplierInvoiceLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The table > Mandatory field: Subaccount* > The corresponding subaccount used for this invoice line." }, "prebookAccountInSupplierInvoiceLineDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Prebook account used on the line. Note that this feature is not available in all countries." }, "prebookSubaccountInSupplierInvoiceLineDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Prebook subaccount used on the line. Note that this feature is not available in all countries." }, "vatCodeInSupplierInvoiceLineDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The table > VAT category > The VAT category (if applied) for the transaction. Unless you specify otherwise, it is the default VAT category of the supplier location's VAT zone." }, "branchNumberInSupplierInvoiceLineDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The table > Mandatory field: Branch* > The branch that purchases the line item or service.\r\nNote: The field type has been changed from string to BranchNumberDto, please consider doing changes accordingly." }, "projectInSupplierInvoiceLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The table > Project > The project associated with the invoice line." }, "projectTaskInSupplierInvoiceLineDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The table > Project task > The project task associated with the invoice line." }, "SupplierInvoiceLineDto": { "type": "object", "properties": { "lineNumber": { "type": "integer", "description": "The table > Number at the left indicating the line number of the table.", "format": "int32" }, "inventoryNumber": { "type": "string", "description": "The table > Item ID > The unique ID of the particular item or service delivered by the supplier." }, "externalInventoryId": { "type": "string", "description": "The table > External inventory id > External inventory number" }, "stockItem": { "type": "boolean", "description": "Background information indicating whether the item is a stock item or not." }, "transactionDescription": { "type": "string", "description": "The table > Transaction descr. > Any description relevant to the transaction. An alphanumeric string of up to 30 characters may be used." }, "quantity": { "type": "number", "description": "The table > Quantity > The quantity of the item or service to be delivered by the supplier.", "format": "double" }, "uom": { "type": "string", "description": "The table > UoM > The unit of measure for the item." }, "unitCost": { "type": "number", "description": "The table > Unit cost > The unit cost of the item.", "format": "double" }, "unitCostInCurrency": { "type": "number", "description": "Background calculation giving you the Unit cost in the selected currency.This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "cost": { "type": "number", "description": "The table > Cost > The unit cost of the item or service received from the supplier.", "format": "double" }, "costInCurrency": { "type": "number", "description": "Background calculation giving you the Cost in the selected currency.This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "discountPercent": { "type": "number", "description": "The table > Discount percent > The percent of the line-level discount that has been applied manually or automatically.", "format": "double" }, "discountAmount": { "type": "number", "description": "The table > Discount amount > The amount of the line-level discount that has been applied manually or automatically to this line.", "format": "double" }, "discountAmountInCurrency": { "type": "number", "description": "Background calculation giving you the Discount amount in the selected currency.This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "discountUnitCost": { "type": "number", "description": "Background calculation giving you the Discount unit cost in the default currency.", "format": "double" }, "discountUnitCostInCurrency": { "type": "number", "description": "Background calculation giving you the Discount unit cost in the selected currency.This field is applicable if the amount is given in a another currency than your default.", "format": "double" }, "manualDiscount": { "type": "boolean", "description": "The table > Manual discount > A check box that indicates (if selected) that the discount has been applied manually." }, "account": { "$ref": "#/components/schemas/accountInSupplierInvoiceLineDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInSupplierInvoiceLineDto" }, "prebookAccount": { "$ref": "#/components/schemas/prebookAccountInSupplierInvoiceLineDto" }, "prebookSubaccount": { "$ref": "#/components/schemas/prebookSubaccountInSupplierInvoiceLineDto" }, "deferralSchedule": { "type": "integer", "description": "The table > Original deferral schedule > A read-only column filled in by the system in the Debit adjustment documents created by the reversing process.It shows the ID of the deferral schedule associated with the original document (such as a purchase invoice).", "format": "int32" }, "deferralScheduleNbr": { "type": "string", "description": "The public CD/Code of the deferral schedule visible to user" }, "deferralCode": { "type": "string", "description": "The table > Deferral code > The deferral code assigned to the stock item or non-stock item specified in this document line." }, "vatCode": { "$ref": "#/components/schemas/vatCodeInSupplierInvoiceLineDto" }, "poNumber": { "type": "string", "description": "The table > Purchase order number > The number of the purchase order linked to this line of the invoice." }, "poLineNr": { "type": "integer", "description": "The table > Purchase order line > The line number of the purchase order line linked to this line of the invoice.", "format": "int32" }, "poReceiptNbr": { "type": "string", "description": "The table > Purchase order receipt no. > The number of the purchase receipt linked to this line of the invoice." }, "poReceiptLineNbr": { "type": "integer", "description": "The table > Purchase order receipt line > The line number of the purchase receipt's line that is linked to this line of the invoice.", "format": "int32" }, "branchNumber": { "$ref": "#/components/schemas/branchNumberInSupplierInvoiceLineDto" }, "note": { "type": "string", "description": "The table > Icon Notes > Pop-up window for providing any user-defined text connected with to invoice." }, "splitHierarchy": { "type": "string", "description": "The table > Split hierarchy > The number of the original row that has been split." }, "project": { "$ref": "#/components/schemas/projectInSupplierInvoiceLineDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInSupplierInvoiceLineDto" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" }, "description": "The data containing information about the document attachments" }, "retainagePct": { "type": "number", "format": "double" }, "curyRetainageAmt": { "type": "number", "format": "double" }, "termStartDate": { "type": "string", "format": "date-time" }, "termEndDate": { "type": "string", "format": "date-time" } } }, "ApprovalDetailsDto": { "type": "object", "properties": { "attachmentID": { "type": "string", "description": "The Approval details tab > Default document > The default document that includes the payments requiring approval." }, "comment": { "type": "string", "description": "The Approval details tab > Comment > The comment connected with the approval of the payments." } } }, "approvalDetailsInSupplierInvoiceDto": { "properties": { "attachmentID": { "type": "string", "description": "The Approval details tab > Default document > The default document that includes the payments requiring approval." }, "comment": { "type": "string", "description": "The Approval details tab > Comment > The comment connected with the approval of the payments." } }, "description": "The Approval details tab >" }, "creditTermsInSupplierInvoiceDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Top part > Terms > The credit terms associated with the supplier (unavailable for prepayments and debit adjustments)" }, "supplierTaxZoneInSupplierInvoiceDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The Financial details tab > The VAT section > Supplier VAT Zone > The VAT zone of the supplier, which is specified in the AP303000 window." }, "supplierInSupplierInvoiceDto": { "properties": { "internalId": { "type": "integer", "description": "The internal id of the supplier", "format": "int64" }, "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Top part > Supplier* > The identifier of the supplier referred to in the document." }, "paymentMethodInSupplierInvoiceDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > Payment method > The payment method used for the payment." }, "locationInSupplierInvoiceDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The Top part > Location* > The supplier location associated with the purchase." }, "SupplierInvoiceDto": { "type": "object", "properties": { "taxDetailLines": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailDto" }, "description": "The VAT details tab >" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachmentDto" } }, "approvalDetails": { "$ref": "#/components/schemas/approvalDetailsInSupplierInvoiceDto" }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierInvoiceLineDto" }, "description": "Transaction lines" }, "landedCosts": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierInvoiceLandedCostDto" }, "description": "The Landed cost lines tab >" }, "hold": { "type": "boolean", "description": "The Top part > Hold > A check box that indicates that the status of the supplier ledger document is On hold." }, "exchangeRate": { "type": "number", "description": "The Top part > Currency > The currency of the document.", "format": "double" }, "paymentRefNo": { "type": "string", "description": "The Top part > Payment ref.no > The payment reference number of the document." }, "originalReferenceNumber": { "type": "string", "description": "The original reference number of the document." }, "creditTerms": { "$ref": "#/components/schemas/creditTermsInSupplierInvoiceDto" }, "retainageApply": { "type": "boolean", "description": "The Top part > Apply retainage > A check box that indicates (if selected) that this invoice is an invoice with retainage." }, "cashDiscountDate": { "type": "string", "description": "The Top part > Cash discount date > The end date of the cash discount period, which the system calculates by using the supplier's credit terms.", "format": "date-time" }, "detailTotal": { "type": "number", "description": "The Top part > Detail total > The document total as specified in the Document details tab.", "format": "double" }, "detailTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Detail total in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "discountTotal": { "type": "number", "description": "The Top part > Discount total > The discount total calculated for the document. This total includes discounts of the Group and Document levels.", "format": "double" }, "discountTotalInCurrency": { "type": "number", "description": "Background calculation giving you the Discount total in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "vatTaxableTotal": { "type": "number", "description": "The Top part > VAT taxable total > The document total that is subjected to VAT.", "format": "double" }, "vatTaxableTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT taxable total in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "vatExemptTotal": { "type": "number", "description": "The Top part > VAT exempt total > The document total that is exempt from VAT.", "format": "double" }, "vatExemptTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT exempt total in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "withholdingTax": { "type": "number", "description": "The Top part > With. tax > The amount of withholding tax calculated for the document, if applicable.", "format": "double" }, "withholdingTaxInCurrency": { "type": "number", "description": "Background calculation giving you the With. tax in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "buyerReference": { "type": "string", "description": "The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes)." }, "roundingDiff": { "type": "number", "description": "The Top part > Rounding diff. > The difference between the original invoice amount (including the VAT amount calculated by the system) and rounded invoice amount (including the VAT amount modified by a user for VAT-inclusive items).", "format": "double" }, "roundingDiffInCurrency": { "type": "number", "description": "Background calculation giving you the Rounding diff. in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "amount": { "type": "number", "description": "The Top part > Amount > The amount to be paid for the document. Equal to the amount (or to the sum of amounts) shown in the Amount column of the Document details tab.", "format": "double" }, "vatAmount": { "type": "number", "description": "The Top part > VAT amount > The VAT amount to be paid for the document. Enter this amount manually according to the VAT amount specified in the original document.", "format": "double" }, "taxCalculationMode": { "enum": [ "TaxSetting", "Gross", "Net" ], "type": "string", "description": "The Financial details tab > The VAT section > VAT calculation mode > The VAT calculation mode, which defines which amounts (VAT-inclusive or VAT-exclusive) should be entered in the detail lines of a document (TaxSetting, Gross, Net)" }, "supplierTaxZone": { "$ref": "#/components/schemas/supplierTaxZoneInSupplierInvoiceDto" }, "paySelected": { "type": "boolean", "description": "The Financial details tab > The Payment information section > Approved for payment > When set to true indicates that the document is approved for payment." }, "curyRetainageTotal": { "type": "number", "format": "double" }, "curyRetainageUnreleasedAmt": { "type": "number", "format": "double" }, "documentVersionNumber": { "type": "integer", "format": "int64" }, "supplier": { "$ref": "#/components/schemas/supplierInSupplierInvoiceDto" }, "documentType": { "enum": [ "Check", "CreditAdj", "DebitAdj", "Invoice", "Prepayment", "QuickCheck", "Refund", "VoidCheck", "VoidQuickCheck" ], "type": "string", "description": "The top part > Top part > Type > The type of the document. The following types are available: Purchase invoice, credit adjustment, purchase credit note, prepayment." }, "referenceNumber": { "type": "string" }, "postPeriod": { "type": "string", "description": "The Top part > Post period* > The post period of the payment document. Format MMYYYY." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "date": { "type": "string", "description": "The Top part > Date* > The date of the original supplier ledger document; by default, it is the current date, which can be changed.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The Top part > OrigInvoiceDate* > The original invoice date of the original supplier ledger document; by default, it is the current date, which can be changed.", "format": "date-time" }, "dueDate": { "type": "string", "description": "The Top part > Due date* > The date when payment for the document is due in accordance with the supplier's credit terms.", "format": "date-time" }, "approvalStatus": { "enum": [ "New", "Canceled", "SentToApproval", "ReceivedByApproval", "InProgressApproval", "RejectedInApproval", "ApprovedInApproval", "ActiveWorkflowApproval" ], "type": "string", "description": "The Top part > Approval status > The status of the document in Visma.net Approval. [New, Canceled, SentToApproval, ReceivedByApproval, InProgressApproval, RejectedInApproval, ApprovedInApproval, ActiveWorkflowApproval." }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string", "description": "The Top part > Document status > A read-only field that shows the status of the supplier ledger document:[Hold, Balanced, Voided, Scheduled, Open, Closed, Printed, Prebooked, Reserved]" }, "currencyId": { "type": "string", "description": "The Top part > Currency > The currency of the document." }, "balance": { "type": "number", "description": "The Top part > Balance > The balance of the supplier ledger document after VAT (if inclusive) and the discount as specified in the tabs below.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The Top part > Cash discount > The cash discount amount that has been or will be taken in the document, which the system calculates based in the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInSupplierInvoiceDto" }, "supplierReference": { "type": "string", "description": "The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes)." }, "description": { "type": "string", "description": "The Top part > Description > A user-provided description for this supplier ledger document." }, "createdDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "note": { "type": "string", "description": "The table > Document details tab and Applications tab > Icon Notes > Pop-up window for providing any user-defined text connected with to invoice." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "location": { "$ref": "#/components/schemas/locationInSupplierInvoiceDto" }, "vatTotal": { "type": "number", "description": "The Top part > VAT total > The total amount of tax paid in the document.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "branchNumber": { "$ref": "#/components/schemas/BranchNumberDto" }, "payDate": { "type": "string", "description": "The Financial details tab > The Payment information section > Pay date* > The date when the invoice should be paid. The date is the difference between the document due date or discount date and the number of days specified in the Payment lead time field in AP303000.", "format": "date-time" }, "paymentMessage": { "type": "string", "description": "The Financial details tab > The Payment information section > Payment message > The message connected with the payment." }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a ApInvoice in SupplierInvoiceController. Used by getting data." }, "SupplierDocumentForSupplierQueryParameters": { "type": "object", "properties": { "documentType": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string", "description": "By type of document." }, "released": { "type": "integer", "description": "Parameter for showing if invoice has been released or not.", "format": "int32" }, "project": { "type": "string", "description": "Filter by the project with which the document is associated." }, "expandApproval": { "type": "boolean", "description": "Set to true to include approval information." }, "expandNote": { "type": "boolean", "description": "Set to true to include description." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string", "description": "The status of the document" }, "expandLinePrebookAccounts": { "type": "boolean", "description": "Expland line-level pre-booking account and sub-account information." }, "branch": { "type": "string", "description": "Filter by Branch" }, "financialPeriod": { "type": "string", "description": "Filter by Financial Period, format YYYYPP" }, "dueDate": { "type": "string", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "format": "date-time" }, "dueDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__." }, "docDate": { "type": "string", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.", "format": "date-time" }, "docDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__." }, "item": { "type": "string", "description": "Filter by Item used into the document lines" }, "balance": { "type": "number", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "format": "double" }, "balanceCondition": { "type": "string", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__." }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "accountInSupplierDocumentDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: Document details tab > Account* > The expense account to be updated by this transaction." }, "subaccountInSupplierDocumentDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Mandatory field: Document details tab > Subaccount* > The corresponding subaccount to be used for invoices and adjustments." }, "branchInSupplierDocumentDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Branch is deprecated, please use BranchNumber instead." }, "supplierInSupplierDocumentDto": { "properties": { "internalId": { "type": "integer", "description": "The internal id of the supplier", "format": "int64" }, "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "The Top part > Supplier* > The identifier of the supplier referred to in the document." }, "paymentMethodInSupplierDocumentDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The Financial details tab > Payment method > The payment method used for the payment." }, "locationInSupplierDocumentDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "The Top part > Location* > The supplier location associated with the purchase." }, "SupplierDocumentDto": { "type": "object", "properties": { "account": { "$ref": "#/components/schemas/accountInSupplierDocumentDto" }, "subaccount": { "$ref": "#/components/schemas/subaccountInSupplierDocumentDto" }, "amount": { "type": "number", "description": "Document details tab > Amount > Read-only. The total amount for the specified quantity of items or services of this type (after the discount has been taken).", "format": "double" }, "amountInCurrency": { "type": "number", "description": "An automatic calculation of the amount with the currency set as default for supplier.", "format": "double" }, "branch": { "$ref": "#/components/schemas/branchInSupplierDocumentDto" }, "supplier": { "$ref": "#/components/schemas/supplierInSupplierDocumentDto" }, "documentType": { "enum": [ "Check", "CreditAdj", "DebitAdj", "Invoice", "Prepayment", "QuickCheck", "Refund", "VoidCheck", "VoidQuickCheck" ], "type": "string", "description": "The top part > Top part > Type > The type of the document. The following types are available: Purchase invoice, credit adjustment, purchase credit note, prepayment." }, "referenceNumber": { "type": "string" }, "postPeriod": { "type": "string", "description": "The Top part > Post period* > The post period of the payment document. Format MMYYYY." }, "financialPeriod": { "type": "string", "description": "The financial period to which the transactions recorded in the document should be posted. Format YYYYMM." }, "date": { "type": "string", "description": "The Top part > Date* > The date of the original supplier ledger document; by default, it is the current date, which can be changed.", "format": "date-time" }, "origInvoiceDate": { "type": "string", "description": "The Top part > OrigInvoiceDate* > The original invoice date of the original supplier ledger document; by default, it is the current date, which can be changed.", "format": "date-time" }, "dueDate": { "type": "string", "description": "The Top part > Due date* > The date when payment for the document is due in accordance with the supplier's credit terms.", "format": "date-time" }, "approvalStatus": { "enum": [ "New", "Canceled", "SentToApproval", "ReceivedByApproval", "InProgressApproval", "RejectedInApproval", "ApprovedInApproval", "ActiveWorkflowApproval" ], "type": "string", "description": "The Top part > Approval status > The status of the document in Visma.net Approval. [New, Canceled, SentToApproval, ReceivedByApproval, InProgressApproval, RejectedInApproval, ApprovedInApproval, ActiveWorkflowApproval." }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string", "description": "The Top part > Document status > A read-only field that shows the status of the supplier ledger document:[Hold, Balanced, Voided, Scheduled, Open, Closed, Printed, Prebooked, Reserved]" }, "currencyId": { "type": "string", "description": "The Top part > Currency > The currency of the document." }, "balance": { "type": "number", "description": "The Top part > Balance > The balance of the supplier ledger document after VAT (if inclusive) and the discount as specified in the tabs below.", "format": "double" }, "balanceInCurrency": { "type": "number", "description": "Background calculation giving you the Balance in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "cashDiscount": { "type": "number", "description": "The Top part > Cash discount > The cash discount amount that has been or will be taken in the document, which the system calculates based in the specified credit terms.", "format": "double" }, "cashDiscountInCurrency": { "type": "number", "description": "Background calculation giving you the Cash discount in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "paymentMethod": { "$ref": "#/components/schemas/paymentMethodInSupplierDocumentDto" }, "supplierReference": { "type": "string", "description": "The Top part > Supplier ref. > The document's original reference number as assigned by the supplier (for informational purposes)." }, "description": { "type": "string", "description": "The Top part > Description > A user-provided description for this supplier ledger document." }, "createdDateTime": { "type": "string", "format": "date-time" }, "lastModifiedDateTime": { "type": "string", "format": "date-time" }, "note": { "type": "string", "description": "The table > Document details tab and Applications tab > Icon Notes > Pop-up window for providing any user-defined text connected with to invoice." }, "closedFinancialPeriod": { "type": "string", "description": "Format YYYYMM." }, "location": { "$ref": "#/components/schemas/locationInSupplierDocumentDto" }, "vatTotal": { "type": "number", "description": "The Top part > VAT total > The total amount of tax paid in the document.", "format": "double" }, "vatTotalInCurrency": { "type": "number", "description": "Background calculation giving you the VAT total in your default currency. This field is applicable if the amount is given in another currency than your default.", "format": "double" }, "branchNumber": { "$ref": "#/components/schemas/BranchNumberDto" }, "payDate": { "type": "string", "description": "The Financial details tab > The Payment information section > Pay date* > The date when the invoice should be paid. The date is the difference between the document due date or discount date and the number of days specified in the Payment lead time field in AP303000.", "format": "date-time" }, "paymentMessage": { "type": "string", "description": "The Financial details tab > The Payment information section > Payment message > The message connected with the payment." }, "cashAccount": { "type": "string", "description": "Financial details tab > The payment information section > Cash account > The cash account associated with the payment method." }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "SupplierAccountQueryParameters": { "type": "object", "properties": { "supplierItemId": { "type": "array", "items": { "type": "string" }, "description": "The list of supplier itemIds to search the expense account for. If the list empty, then the general expense account for the specific supplier is returned" }, "vatRegistrationId": { "type": "string", "description": "The vat registration id of the supplier" }, "linesNonTaxable": { "type": "boolean", "description": "Indicates if all lines are taxable or not. Default is false" } } }, "subaccountInSupplierItemAccountDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The SubAccount for the SupplierItemID. If null, this means that no account was found for the {Visma.net.ERP.Web.Api.Model.V1.SupplierItemAccountDto.SupplierItemId}" }, "SupplierItemAccountDto": { "type": "object", "properties": { "supplierItemId": { "type": "string", "description": "The supplier item id for which the account is displayed." }, "itemId": { "type": "string", "description": "The item id matched to the SupplierItemId. If null, this means that no itemId was found for the corresponding {Visma.net.ERP.Web.Api.Model.V1.SupplierItemAccountDto.SupplierItemId}" }, "accountID": { "type": "string", "description": "The Account ID is the actual ID of the expense account for the SupplierItemID or of the supplier if no SUpplierItemId was specified in the request. If null, this means that no account was found for the {Visma.net.ERP.Web.Api.Model.V1.SupplierItemAccountDto.SupplierItemId}" }, "subaccount": { "$ref": "#/components/schemas/subaccountInSupplierItemAccountDto" } } }, "subaccountInSupplierAccountDto": { "properties": { "subaccountNumber": { "type": "string", "description": "Mandatory field: Subaccount* > The subaccount number. Format 9-XX." }, "subaccountId": { "type": "integer", "description": "SubID > The identifier of the subaccount.", "format": "int32" }, "description": { "type": "string", "description": "Description > The description of the identifier." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "active": { "type": "boolean", "description": "Active > The status of the identifier." }, "segments": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentDto" }, "description": "Segments are entities that you use to define the structure of IDs for the subaccount. This information is collected from window CS202000." }, "timeStamp": { "type": "string", "description": "The timestamp of the subaccount, used for concurrency control.", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "The default Expense SubAccount for the supplier" }, "SupplierAccountDto": { "type": "object", "properties": { "number": { "type": "string", "description": "The supplier number" }, "name": { "type": "string", "description": "The supplier name" }, "accountID": { "type": "string", "description": "The default Expense Account ID for the supplier" }, "subaccount": { "$ref": "#/components/schemas/subaccountInSupplierAccountDto" } } }, "supplierAccountInSupplierAccountsDto": { "properties": { "number": { "type": "string", "description": "The supplier number" }, "name": { "type": "string", "description": "The supplier name" }, "accountID": { "type": "string", "description": "The default Expense Account ID for the supplier" }, "subaccount": { "$ref": "#/components/schemas/subaccountInSupplierAccountDto" } }, "description": "The supplier account information" }, "SupplierAccountsDto": { "type": "object", "properties": { "supplierAccount": { "$ref": "#/components/schemas/supplierAccountInSupplierAccountsDto" }, "supplierItemAccounts": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierItemAccountDto" }, "description": "The list of SUpplierItems Ids with their expense accounts" } } }, "SupplierDocumentQueryParameters": { "type": "object", "properties": { "supplier": { "type": "string", "description": "Filter by Supplier" }, "documentType": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string", "description": "By type of document." }, "released": { "type": "integer", "description": "Parameter for showing if invoice has been released or not.", "format": "int32" }, "project": { "type": "string", "description": "Filter by the project with which the document is associated." }, "expandApproval": { "type": "boolean", "description": "Set to true to include approval information." }, "expandNote": { "type": "boolean", "description": "Set to true to include description." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string", "description": "The status of the document" }, "expandLinePrebookAccounts": { "type": "boolean", "description": "Expland line-level pre-booking account and sub-account information." }, "branch": { "type": "string", "description": "Filter by Branch" }, "financialPeriod": { "type": "string", "description": "Filter by Financial Period, format YYYYPP" }, "dueDate": { "type": "string", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "format": "date-time" }, "dueDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__." }, "docDate": { "type": "string", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.", "format": "date-time" }, "docDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__." }, "item": { "type": "string", "description": "Filter by Item used into the document lines" }, "balance": { "type": "number", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "format": "double" }, "balanceCondition": { "type": "string", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__." }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "purchaseNumberInLinkLineDto": { "properties": { "value": { "type": "string" } }, "description": "PurchaseNumber refers to either PurchaseOrder or PurchaseReceipt number depends on the value of {Visma.net.ERP.Web.Api.Model.V1.AP.LinkLineDto.PurchaseType}\r\nIf {Visma.net.ERP.Web.Api.Model.V1.AP.LinkLineDto.PurchaseType} is set to {Visma.net.ERP.Web.Api.Model.V1.Enum.PurchaseType.PurchaseReceipt}, then it should refer to the PruchaseReceipt number\r\notherwise it refers to the PurchaseOrder" }, "purchaseLineNbrInLinkLineDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "PurchaseLineNbr refers to either PurchaseOrder or PurchaseReceipt line number depends on the value of {Visma.net.ERP.Web.Api.Model.V1.AP.LinkLineDto.PurchaseType}\r\nIf {Visma.net.ERP.Web.Api.Model.V1.AP.LinkLineDto.PurchaseType} is set to {Visma.net.ERP.Web.Api.Model.V1.Enum.PurchaseType.PurchaseReceipt}, then it should refer to the PruchaseReceipt line number\r\notherwise it refers to the PurchaseOrder" }, "LinkLineDto": { "type": "object", "properties": { "purchaseType": { "enum": [ "PurchaseOrder", "PurchaseReceipt" ], "type": "string", "description": "PurchaseTye can be either {Visma.net.ERP.Web.Api.Model.V1.Enum.PurchaseType.PurchaseOrder} or {Visma.net.ERP.Web.Api.Model.V1.Enum.PurchaseType.PurchaseReceipt}\r\nIt should be noted that for stock-items, its only limited to {Visma.net.ERP.Web.Api.Model.V1.Enum.PurchaseType.PurchaseReceipt}, however,\r\nfor non-stock items we can choose either {Visma.net.ERP.Web.Api.Model.V1.Enum.PurchaseType.PurchaseReceipt} or {Visma.net.ERP.Web.Api.Model.V1.Enum.PurchaseType.PurchaseOrder}" }, "purchaseNumber": { "$ref": "#/components/schemas/purchaseNumberInLinkLineDto" }, "purchaseLineNbr": { "$ref": "#/components/schemas/purchaseLineNbrInLinkLineDto" } } }, "userEmailInSupplierInvoiceCommentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The email of the user who created the comment.\r\nUser email is mandatory" }, "commentTextInSupplierInvoiceCommentUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The comment text.\r\nCommand text is mandatory." }, "commentDateTimeInSupplierInvoiceCommentUpdateDto": { "properties": { "value": { "type": "string", "format": "date-time" } }, "description": "When the comment was created (value provided should be in UTC format).\r\nCreated date and time is mandatory" }, "SupplierInvoiceCommentUpdateDto": { "type": "object", "properties": { "userEmail": { "$ref": "#/components/schemas/userEmailInSupplierInvoiceCommentUpdateDto" }, "commentText": { "$ref": "#/components/schemas/commentTextInSupplierInvoiceCommentUpdateDto" }, "commentDateTime": { "$ref": "#/components/schemas/commentDateTimeInSupplierInvoiceCommentUpdateDto" } }, "description": "SupplierInvoiceCommentUpdateDto" }, "lineNumberInSupplierInvoiceLandedCostUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "Landed Costs Tab > Number at the left indicating the line number of the table." }, "landedCostCodeIdInSupplierInvoiceLandedCostUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Landed Costs Tab > Landed cost code > The Landed Cost Code ID lf the Landed Cost Code" }, "descriptionInSupplierInvoiceLandedCostUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Landed Costs Tab > Description > The description of the landed cost" }, "amountInSupplierInvoiceLandedCostUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "Landed Costs Tab > Amount > The amount in currency of the landed cost" }, "taxCategoryIdInSupplierInvoiceLandedCostUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Landed Costs Tab > VAT Category > The ID of VAT cateogry" }, "poReceiptNumberInSupplierInvoiceLandedCostUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Landed Costs Tab > Purchase order receipt no. > The purchase order receipt number" }, "inventoryIdInSupplierInvoiceLandedCostUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Landed Costs Tab > Item ID > The ID of the inventory item" }, "siteIdInSupplierInvoiceLandedCostUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Landed Costs Tab > Warehouse > The ID of the warehouse" }, "locationIdInSupplierInvoiceLandedCostUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Landed Costs Tab > Location > The ID of the warehouse location" }, "SupplierInvoiceLandedCostUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/lineNumberInSupplierInvoiceLandedCostUpdateDto" }, "landedCostCodeId": { "$ref": "#/components/schemas/landedCostCodeIdInSupplierInvoiceLandedCostUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInSupplierInvoiceLandedCostUpdateDto" }, "amount": { "$ref": "#/components/schemas/amountInSupplierInvoiceLandedCostUpdateDto" }, "taxCategoryId": { "$ref": "#/components/schemas/taxCategoryIdInSupplierInvoiceLandedCostUpdateDto" }, "poReceiptNumber": { "$ref": "#/components/schemas/poReceiptNumberInSupplierInvoiceLandedCostUpdateDto" }, "inventoryId": { "$ref": "#/components/schemas/inventoryIdInSupplierInvoiceLandedCostUpdateDto" }, "siteId": { "$ref": "#/components/schemas/siteIdInSupplierInvoiceLandedCostUpdateDto" }, "locationId": { "$ref": "#/components/schemas/locationIdInSupplierInvoiceLandedCostUpdateDto" } } }, "AddPurchaseOrderDto": { "type": "object", "properties": { "poOrderNumber": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "AddPOReceiptLineDto": { "type": "object", "properties": { "poReceiptNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "poReceiptLineNumber": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "unitCostInCurrency": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "costInCurrency": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" } } }, "ApprovalDetailsUpdateDto": { "type": "object", "properties": { "attachmentID": { "$ref": "#/components/schemas/DtoValueOfString" }, "comment": { "$ref": "#/components/schemas/DtoValueOfString" } } }, "branchInSupplierInvoiceLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Branch is deprecated, please use BranchNumber instead." }, "undoSplitLineInSupplierInvoiceLineUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "When set to true on an invoice line with Operation = Delete, the line is treated as an undo split-line request instead of an ordinary delete.\r\nThe field only has an effect for split child lines; the selected line must belong to a split hierarchy.\r\nThe undo removes the split child line and restores the amount/quantity to the parent split line through the same undo split action as the UI.\r\nOn prebooked documents, ordinary line delete remains blocked; this field may be used to request undo split for an eligible split child line.\r\nWhen omitted or false, Delete keeps its normal delete behavior." }, "prebookAccountNumberInSupplierInvoiceLineUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Account used for prebooking. Note that this feature is not available for all countries." }, "SupplierInvoiceLineUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "inventoryNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "transactionDescription": { "$ref": "#/components/schemas/DtoValueOfString" }, "quantity": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "uom": { "$ref": "#/components/schemas/DtoValueOfString" }, "unitCostInCurrency": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "costInCurrency": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountPercent": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountAmountInCurrency": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "discountUnitCostInCurrency": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "manualDiscount": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "accountNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" } }, "deferralSchedule": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "deferralCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatCodeId": { "$ref": "#/components/schemas/DtoValueOfString" }, "branch": { "$ref": "#/components/schemas/branchInSupplierInvoiceLineUpdateDto" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectId": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectInternalId": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "projectTaskId": { "$ref": "#/components/schemas/DtoValueOfString" }, "projectTaskInternalId": { "$ref": "#/components/schemas/DtoValueOfNullableOfInt32" }, "splitLine": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "undoSplitLine": { "$ref": "#/components/schemas/undoSplitLineInSupplierInvoiceLineUpdateDto" }, "splitHierarchy": { "$ref": "#/components/schemas/DtoValueOfString" }, "retainagePct": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "curyRetainageAmt": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "linkLine": { "$ref": "#/components/schemas/LinkLineDto" }, "termStartDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "termEndDate": { "$ref": "#/components/schemas/DtoValueOfNullableOfDateTime" }, "externalInventoryId": { "$ref": "#/components/schemas/DtoValueOfString" }, "prebookAccountNumber": { "$ref": "#/components/schemas/prebookAccountNumberInSupplierInvoiceLineUpdateDto" }, "prebookSubaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "Subaccount used for prebooking. Note that this feature is not available for all countries." } } }, "DtoValueOfNullableOfSupplierInvoiceTypes": { "type": "object", "properties": { "value": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string" } } }, "postPeriodInSupplierInvoiceUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format MMYYYY." }, "financialPeriodInSupplierInvoiceUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The financial period to which the transactions recorded in the document should be posted. Use the format YYYYMM." }, "paySelectedInSupplierInvoiceUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "The Financial details tab > The Default Payment Info section > When set to true indicates that the document is approved for payment." }, "validateLineDetailsInSupplierInvoiceUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "If this flag is set/true, the system will surface any line validation errors to the clients rather than silently ignoring these." }, "SupplierInvoiceUpdateDto": { "type": "object", "properties": { "documentType": { "$ref": "#/components/schemas/DtoValueOfNullableOfSupplierInvoiceTypes" }, "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "date": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "origInvoiceDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "postPeriod": { "$ref": "#/components/schemas/postPeriodInSupplierInvoiceUpdateDto" }, "financialPeriod": { "$ref": "#/components/schemas/financialPeriodInSupplierInvoiceUpdateDto" }, "supplierReference": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplierNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "locationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "currencyId": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentRefNo": { "$ref": "#/components/schemas/DtoValueOfString" }, "creditTermsId": { "$ref": "#/components/schemas/DtoValueOfString" }, "dueDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "cashDiscountDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "note": { "$ref": "#/components/schemas/DtoValueOfString" }, "exchangeRate": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "branchNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "roundingDiffInCurrency": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "taxCalculationMode": { "$ref": "#/components/schemas/DtoValueOfNullableOfTaxCalcMode" }, "supplierTaxZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentMethod": { "$ref": "#/components/schemas/DtoValueOfString" }, "payDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "amount": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "vatAmount": { "$ref": "#/components/schemas/DtoValueOfDecimal" }, "paymentMessage": { "$ref": "#/components/schemas/DtoValueOfString" }, "applyRetainage": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "taxDetailLines": { "type": "array", "items": { "$ref": "#/components/schemas/TaxDetailUpdateDto" } }, "invoiceLines": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierInvoiceLineUpdateDto" } }, "approvalDetails": { "$ref": "#/components/schemas/ApprovalDetailsUpdateDto" }, "addPOReceiptLines": { "type": "array", "items": { "$ref": "#/components/schemas/AddPOReceiptLineDto" } }, "addPurchaseOrders": { "type": "array", "items": { "$ref": "#/components/schemas/AddPurchaseOrderDto" } }, "landedCosts": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierInvoiceLandedCostUpdateDto" } }, "paySelected": { "$ref": "#/components/schemas/paySelectedInSupplierInvoiceUpdateDto" }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "validateLineDetails": { "$ref": "#/components/schemas/validateLineDetailsInSupplierInvoiceUpdateDto" } } }, "SupplierInvoiceQueryParameters": { "type": "object", "properties": { "supplier": { "type": "string", "description": "Filter by Supplier" }, "expandAttachment": { "type": "boolean", "description": "Set to true if you want to see all attachments regarding this document." }, "expandLandedCosts": { "type": "boolean", "description": "Expland landed cost lines" }, "documentType": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string", "description": "By type of document." }, "released": { "type": "integer", "description": "Parameter for showing if invoice has been released or not.", "format": "int32" }, "project": { "type": "string", "description": "Filter by the project with which the document is associated." }, "expandApproval": { "type": "boolean", "description": "Set to true to include approval information." }, "expandNote": { "type": "boolean", "description": "Set to true to include description." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "Reserved" ], "type": "string", "description": "The status of the document" }, "expandLinePrebookAccounts": { "type": "boolean", "description": "Expland line-level pre-booking account and sub-account information." }, "branch": { "type": "string", "description": "Filter by Branch" }, "financialPeriod": { "type": "string", "description": "Filter by Financial Period, format YYYYPP" }, "dueDate": { "type": "string", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "format": "date-time" }, "dueDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__." }, "docDate": { "type": "string", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __Docate__ and __DocDateCondition__ are __mutually inclusive__.", "format": "date-time" }, "docDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocumentDate__ and __DocumentDateCondition__ are __mutually inclusive__." }, "item": { "type": "string", "description": "Filter by Item used into the document lines" }, "balance": { "type": "number", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "format": "double" }, "balanceCondition": { "type": "string", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__." }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ReleaseSupplierInvoiceActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "CorrectSupplierInvoiceActionResultDto": { "type": "object", "properties": { "refNbr": { "type": "string" }, "errorMessage": { "type": "string" }, "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "ReverseInvoiceResultDto": { "type": "object", "properties": { "refNbr": { "type": "string" }, "docType": { "type": "string" }, "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "SendToApprovalResult": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "accountNumberInPrebookingUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Account used for prebooking." }, "PrebookingUpdateDto": { "type": "object", "properties": { "accountNumber": { "$ref": "#/components/schemas/accountNumberInPrebookingUpdateDto" }, "subaccount": { "type": "array", "items": { "$ref": "#/components/schemas/SegmentUpdateDto" }, "description": "Subaccount used for prebooking." } } }, "PrebookSupplierInvoiceActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "baccountInSupplierLocationDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: The top part > Business connection* > The business account this location is associated with. Click the magnifier." }, "addressInSupplierLocationDto": { "properties": { "addressId": { "type": "integer", "format": "int32" }, "addressLine1": { "type": "string", "description": "Address 1 > The first line of the customer's/supplier's/company's/employee's contact address." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line of the address." }, "addressLine3": { "type": "string", "description": "Address 3 > The third line of the address." }, "postalCode": { "type": "string", "description": "Postcode > The postcode." }, "city": { "type": "string", "description": "City > The city." }, "country": { "$ref": "#/components/schemas/countryInAddressDto" }, "county": { "$ref": "#/components/schemas/countyInAddressDto" } }, "description": "General information tab > Location address section >" }, "contactInSupplierLocationDto": { "properties": { "contactId": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": "Name > The legal name of to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The attention line as it is used in your customer's/supplier's/company's business letters. The intention of this line is to direct the letter to the right person if the letter is not addressed to any specific person." }, "email": { "type": "string", "description": "Email > The email address of the customer/supplier/company as a business entity." }, "web": { "type": "string", "description": "Web > The website of the company, if one exists." }, "phone1": { "type": "string", "description": "Phone 1 > The default phone number." }, "phone2": { "type": "string", "description": "Phone 2 > An additional phone number." }, "fax": { "type": "string", "description": "Fax > The fax number." } }, "description": "General information tab > Location contact section >" }, "vatZoneInSupplierLocationDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier. The identifier for the VAT zone of the supplier, which is specified in the AP303000 window." }, "description": { "type": "string", "description": "Click the magnifier. The description for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultVatCategory": { "type": "string", "description": "Click the magnifier. The Default VAT category for the VAT zone of the supplier, which is specified in the AP303000 window." }, "defaultTaxCategory": { "$ref": "#/components/schemas/TaxCategoryNumberDescriptionDto" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "General information tab > Location address section > VAT zone > The VAT zone associated with the account location." }, "SupplierLocationDto": { "type": "object", "properties": { "baccount": { "$ref": "#/components/schemas/baccountInSupplierLocationDto" }, "locationId": { "type": "string", "description": "Mandatory field: The top part > Location ID* > The identifier of the location. Click the magnifier." }, "locationName": { "type": "string", "description": "The top part > Location name > A descriptive name to help users recognize the location." }, "active": { "type": "boolean", "description": "The top part > Active > A check box that you select if the location is active." }, "address": { "$ref": "#/components/schemas/addressInSupplierLocationDto" }, "contact": { "$ref": "#/components/schemas/contactInSupplierLocationDto" }, "vatRegistrationId": { "type": "string", "description": "General information tab > Location address section > VAT registration ID > The optional VAT registration ID associated with the location." }, "vatZone": { "$ref": "#/components/schemas/vatZoneInSupplierLocationDto" }, "ediCode": { "type": "string", "description": "General information tab > Location address section > EDI code > The EDI code to be used for the customer location." }, "gln": { "type": "string", "description": "General information tab > Location address section > GLN > The GLN to be used for the customer location." }, "corporateId": { "type": "string", "description": "General information tab > Location address section > Corporate ID > The corporate ID associated with the customer location." }, "lastModifiedDateTime": { "type": "string", "description": "System generation information", "format": "date-time" }, "supplierPaymentMethodDetails": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPaymentMethodDetailDto" }, "description": "Supplier payment method details from the supplier location page." }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Location in LocationController. Used for getting data." }, "baccountIdInSupplierLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field for creating a new location. Can not be updated after it has been created." }, "locationIdInSupplierLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Mandatory field for creating a new location. Can not be updated after it has been created." }, "SupplierLocationUpdateDto": { "type": "object", "properties": { "baccountId": { "$ref": "#/components/schemas/baccountIdInSupplierLocationUpdateDto" }, "locationId": { "$ref": "#/components/schemas/locationIdInSupplierLocationUpdateDto" }, "locationName": { "$ref": "#/components/schemas/DtoValueOfString" }, "active": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "addressIsSameAsMain": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "address": { "$ref": "#/components/schemas/DtoValueOfAddressUpdateDto" }, "contactIsSameAsMain": { "$ref": "#/components/schemas/DtoValueOfNullableOfBoolean" }, "contact": { "$ref": "#/components/schemas/DtoValueOfContactInfoUpdateDto" }, "vatRegistrationId": { "$ref": "#/components/schemas/DtoValueOfString" }, "vatZone": { "$ref": "#/components/schemas/DtoValueOfString" }, "ediCode": { "$ref": "#/components/schemas/DtoValueOfString" }, "gln": { "$ref": "#/components/schemas/DtoValueOfString" }, "corporateId": { "$ref": "#/components/schemas/DtoValueOfString" } }, "description": "This class represents a Location in LocationController. Used to create and update Location." }, "SupplierLocationQueryParameters": { "type": "object", "properties": { "locationId": { "type": "string" }, "gln": { "type": "string" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "SupplierPaymentAdjustmentDto": { "type": "object", "properties": { "branch": { "type": "string" }, "batchNumber": { "type": "string" }, "docType": { "enum": [ "Invoice", "CreditAdj", "DebitAdj", "Prepayment", "Refund", "Payment" ], "type": "string" }, "invoiceRefNbr": { "type": "string" }, "amountPaid": { "type": "number", "format": "double" }, "cashDiscountTaken": { "type": "number", "format": "double" }, "withholdingTax": { "type": "number", "format": "double" }, "applicationPeriod": { "type": "string" }, "date": { "type": "string", "format": "date-time" }, "dueDate": { "type": "string", "format": "date-time" }, "cashDiscountDate": { "type": "string", "format": "date-time" }, "balance": { "type": "number", "format": "double" }, "cashDiscountBalance": { "type": "number", "format": "double" }, "description": { "type": "string" }, "currency": { "type": "string" }, "postPeriod": { "type": "string" }, "supplierRef": { "type": "string" } } }, "supplierInSupplierPaymentDto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Mandatory field: The top part > Supplier* > The supplier." }, "locationInSupplierPaymentDto": { "properties": { "countryId": { "type": "string", "description": "Location*." }, "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "Mandatory field: The top part > Location* > The supplier's location. Main location by default." }, "currencyInSupplierPaymentDto": { "properties": { "id": { "type": "string", "description": "Currency Id." }, "description": { "type": "string", "description": "Currency description." }, "symbol": { "type": "string", "description": "Currency symbol." }, "isBaseCurrency": { "type": "boolean", "description": "Identify if the currency is the base currency." }, "decimalPrecision": { "type": "integer", "description": "Decimal precision.", "format": "int32" }, "isUsedForAccounting": { "type": "boolean", "description": "Identify if is used for accounting." } }, "description": "The top part > Currency > The currency of the payment; by default, it is the currency associated with the cash account." }, "SupplierPaymentDto": { "type": "object", "properties": { "type": { "enum": [ "Payment", "DebitAdj", "Prepayment", "Refund", "VoidPayment", "VoidRefund" ], "type": "string", "description": "The top part > Type >The type of supplier ledger payment document. The following types are available: Payment, PUrchase credit note, Prepayment, Supplier refund, Voided payment." }, "documentType": { "type": "string", "description": "The top part > Voucher no. > The unique identifier of the supplier ledger document." }, "refNbr": { "type": "string", "description": "The top part > Voucher no. > The unique identifier of the supplier ledger document." }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "PendingApproval", "Rejected", "Reserved", "PendingPrint" ], "type": "string", "description": "The top part > Status > The status of the supplier ledger document, which can be one of the following: On Hold, Printed, Open, Reserved, Closed, Voided, Released." }, "hold": { "type": "boolean", "description": "The top part > Hold > A check box that means (if selected) that the status of the document is On hold." }, "applicationDate": { "type": "string", "description": "Mandatory field: The top part > Date* > The date when the payment is applied. The default value is the current business date.", "format": "date-time" }, "applicationPeriod": { "type": "string", "description": "MAndatory field: The top part > Financial period* > The financial period of payment application." }, "paymentRef": { "type": "string", "description": "The top part > Payment ref. > A payment reference number." }, "supplier": { "$ref": "#/components/schemas/supplierInSupplierPaymentDto" }, "location": { "$ref": "#/components/schemas/locationInSupplierPaymentDto" }, "paymentMethod": { "type": "string", "description": "Mandatory field: The top part > Payment method* > The payment method associated with the supplier." }, "cashAccount": { "type": "string", "description": "Mandatory field: The top part > Cash account* > The cash account associated with the payment method." }, "currency": { "$ref": "#/components/schemas/currencyInSupplierPaymentDto" }, "description": { "type": "string", "description": "The top part > Description > A description for the payment. You may use up to 50 alphanumeric characters." }, "paymentAmount": { "type": "number", "description": "The top part > Payment amount > The total payment amount that should be applied to the documents.", "format": "double" }, "financeCharges": { "type": "number", "description": "The top part > Finance charges > The total on all finance charges applied to this document.", "format": "double" }, "balance": { "type": "number", "description": "Balance of the payment remaining to be applied and released. Only released applications will count towards the balance.", "format": "double" }, "unappliedBalance": { "type": "number", "description": "The top part > Unapplied balance > The balance that has not been applied. This will be a non-zero value if the payment amount is not equal to a document's total amount. Checks shall always have a zero unapplied balance.", "format": "double" }, "appliedAmount": { "type": "number", "description": "The top part > Amount > The amount to be applied on the application date.", "format": "double" }, "released": { "type": "boolean", "description": "Background information: if this check box is selected, the document has been released." }, "lastModifiedDateTime": { "type": "string", "description": "Background information: The date and time when the document has been last modified.", "format": "date-time" }, "branch": { "type": "string" }, "paymentLines": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPaymentAdjustmentDto" } }, "timeStamp": { "type": "string", "description": "Identifier that represents a specific version of the resource.\r\nIt helps to prevent simultaneous updates of the resource from overwriting each other (by using ETags and If-Match headers)", "format": "byte" }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } } }, "SupplierPaymentAdjustmentUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "documentType": { "$ref": "#/components/schemas/DtoValueOfNullableOfSupplierInvoiceTypes" }, "refNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "amountPaid": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "cashDiscountTaken": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "crossRate": { "$ref": "#/components/schemas/DtoValueOfDecimal" } } }, "DtoValueOfNullableOfSupplierPaymentTypes": { "type": "object", "properties": { "value": { "enum": [ "Payment", "DebitAdj", "Prepayment", "Refund", "VoidPayment", "VoidRefund" ], "type": "string" } } }, "typeInSupplierPaymentUpdateDto": { "properties": { "value": { "enum": [ "Payment", "DebitAdj", "Prepayment", "Refund", "VoidPayment", "VoidRefund" ], "type": "string" } }, "description": "Reference number for the document. Can be used when manual numbering is enabled." }, "SupplierPaymentUpdateDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/typeInSupplierPaymentUpdateDto" }, "referenceNumber": { "$ref": "#/components/schemas/DtoValueOfString" }, "hold": { "$ref": "#/components/schemas/DtoValueOfBoolean" }, "applicationDate": { "$ref": "#/components/schemas/DtoValueOfDateTime" }, "applicationPeriod": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentRef": { "$ref": "#/components/schemas/DtoValueOfString" }, "supplier": { "$ref": "#/components/schemas/DtoValueOfString" }, "location": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentMethod": { "$ref": "#/components/schemas/DtoValueOfString" }, "cashAccount": { "$ref": "#/components/schemas/DtoValueOfString" }, "currency": { "$ref": "#/components/schemas/DtoValueOfString" }, "description": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentAmount": { "$ref": "#/components/schemas/DtoValueOfNullableOfDecimal" }, "branch": { "$ref": "#/components/schemas/DtoValueOfString" }, "paymentLines": { "type": "array", "items": { "$ref": "#/components/schemas/SupplierPaymentAdjustmentUpdateDto" } }, "overrideNumberSeries": { "$ref": "#/components/schemas/DtoValueOfBoolean" } } }, "SupplierPaymentQueryParameters": { "type": "object", "properties": { "invoiceRefNbr": { "type": "string" }, "paymentType": { "enum": [ "Payment", "DebitAdj", "Prepayment", "Refund", "VoidPayment", "VoidRefund" ], "type": "string", "description": "The top part > Type >The type of supplier ledger payment document. The following types are available: Payment, PUrchase credit note, Prepayment, Supplier refund, Voided payment." }, "greaterThanValue": { "type": "string", "description": "Enter the from-value for Ref. no." }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "supplier": { "type": "string", "description": "Filter by Supplier" }, "branch": { "type": "string", "description": "Filter by Branch" }, "docDate": { "type": "string", "description": "This value indicates the document date. Use it to retrieve all records that have the Document Date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__.", "format": "date-time" }, "docDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Document Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DocDate__ and __DocDateCondition__ are __mutually inclusive__." }, "dueDate": { "type": "string", "description": "This value indicates the date the document is due for payment. Use it to retrieve all records that have the Due date since that time, up to the future.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd```\r\n\r\n_Note:_ __DueDate__ and __DueDateConditionCondition__ are __mutually inclusive__.", "format": "date-time" }, "dueDateCondition": { "type": "string", "description": "This value represents the condition to be applied to the Due Date when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __DueDate__ and __DueDateCondition__ are __mutually inclusive__." }, "financialPeriod": { "type": "string", "description": "Filter by financial period, format YYYYPP" }, "balance": { "type": "number", "description": "This value represents balance of the payment remaining to be applied and released. Only released applications will count towards the balance.\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__.", "format": "double" }, "balanceCondition": { "type": "string", "description": "This value represents the condition to be applied to the Balance when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __Balance__ and __BalanceCondition__ are __mutually inclusive__." }, "status": { "enum": [ "Hold", "Balanced", "Voided", "Scheduled", "Open", "Closed", "Printed", "Prebooked", "PendingApproval", "Rejected", "Reserved", "PendingPrint" ], "type": "string", "description": "Filter by document status" }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "ReleaseSupplierPaymentActionDto": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/DtoValueOfNullableOfSupplierPaymentTypes" } } }, "WriteoffPaymentActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "SupplierBalanceV2QueryParameters": { "required": [ "fromFinPeriod", "toFinPeriod" ], "type": "object", "properties": { "branch": { "type": "string", "description": "Filter by Branch" }, "supplier": { "type": "string", "description": "Filter by Supplier" }, "fromFinPeriod": { "type": "string", "description": "Filter from financial period, format YYYYPP\r\nThe filte is inclusive, the records for the specified period will be included in the results.\r\nThis filter is required." }, "toFinPeriod": { "type": "string", "description": "Filter to financial period, format YYYYPP\r\nThe filte is inclusive, the records for the specified period will be included in the results.\r\nThis filter is required." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } }, "description": "Query parameters for Suppliers Balance - version 2" }, "supplierInSupplierBalanceV2Dto": { "properties": { "internalId": { "type": "integer", "format": "int32" }, "number": { "type": "string", "description": "The identifier of the particular destination of the selected type." }, "name": { "type": "string", "description": "The name of the particular destination of the selected type." } }, "description": "Supplier" }, "SupplierBalanceV2Dto": { "type": "object", "properties": { "branch": { "type": "string", "description": "Branch" }, "supplier": { "$ref": "#/components/schemas/supplierInSupplierBalanceV2Dto" }, "beginBalance": { "type": "number", "description": "Begin balance", "format": "double" }, "purchases": { "type": "number", "description": "Purchases", "format": "double" }, "paymentsAndPrepayments": { "type": "number", "description": "Payments and prepayments", "format": "double" }, "adjustmentsAndDiscounts": { "type": "number", "description": "Adjustments and discounts", "format": "double" }, "yearToDateBalance": { "type": "number", "description": "Year to date balance", "format": "double" } }, "description": "SupplierBalanceV2Dto" }, "itemIdInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Item Id" }, "descriptionInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The description of the reported quantity." }, "uoMInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The unit of measure of item" }, "projectInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The project that the employee worked on." }, "projectTaskInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The project task that the employee worked on." }, "monInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The quantity reported for Monday." }, "tueInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The quantity reported for Tuesday." }, "wedInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The quantity reported for Wednesday." }, "thuInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The quantity reported for Thursday." }, "friInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The quantity reported for Friday." }, "satInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The quantity reported for Saturday." }, "sunInTimeCardMaterialsUpdateDto": { "properties": { "value": { "type": "number", "format": "double" } }, "description": "The quantity reported for Sunday." }, "TimeCardMaterialsUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "itemId": { "$ref": "#/components/schemas/itemIdInTimeCardMaterialsUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInTimeCardMaterialsUpdateDto" }, "uoM": { "$ref": "#/components/schemas/uoMInTimeCardMaterialsUpdateDto" }, "project": { "$ref": "#/components/schemas/projectInTimeCardMaterialsUpdateDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInTimeCardMaterialsUpdateDto" }, "mon": { "$ref": "#/components/schemas/monInTimeCardMaterialsUpdateDto" }, "tue": { "$ref": "#/components/schemas/tueInTimeCardMaterialsUpdateDto" }, "wed": { "$ref": "#/components/schemas/wedInTimeCardMaterialsUpdateDto" }, "thu": { "$ref": "#/components/schemas/thuInTimeCardMaterialsUpdateDto" }, "fri": { "$ref": "#/components/schemas/friInTimeCardMaterialsUpdateDto" }, "sat": { "$ref": "#/components/schemas/satInTimeCardMaterialsUpdateDto" }, "sun": { "$ref": "#/components/schemas/sunInTimeCardMaterialsUpdateDto" } } }, "earningTypeInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The type of the work time spent by the employee" }, "projectInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The project that the employee worked on." }, "projectTaskInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The project task that the employee worked on." }, "monInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The work time reported for Monday, including overtime." }, "tueInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The work time reported for Tuesday, including overtime." }, "wedInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The work time reported for Wednesday, including overtime." }, "thuInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The work time reported for Thursday, including overtime." }, "friInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The work time reported for Friday, including overtime." }, "satInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The work time reported for Saturday, including overtime." }, "sunInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "The work time reported for Sunday, including overtime." }, "invoiceableInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "A check box that you select to indicate that these work hours are invoiceable." }, "descriptionInTimeCardSummaryUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "The description of the reported work hours." }, "TimeCardSummaryUpdateDto": { "type": "object", "properties": { "operation": { "enum": [ "Insert", "Update", "Delete" ], "type": "string" }, "lineNumber": { "$ref": "#/components/schemas/DtoValueOfInt32" }, "earningType": { "$ref": "#/components/schemas/earningTypeInTimeCardSummaryUpdateDto" }, "project": { "$ref": "#/components/schemas/projectInTimeCardSummaryUpdateDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInTimeCardSummaryUpdateDto" }, "mon": { "$ref": "#/components/schemas/monInTimeCardSummaryUpdateDto" }, "tue": { "$ref": "#/components/schemas/tueInTimeCardSummaryUpdateDto" }, "wed": { "$ref": "#/components/schemas/wedInTimeCardSummaryUpdateDto" }, "thu": { "$ref": "#/components/schemas/thuInTimeCardSummaryUpdateDto" }, "fri": { "$ref": "#/components/schemas/friInTimeCardSummaryUpdateDto" }, "sat": { "$ref": "#/components/schemas/satInTimeCardSummaryUpdateDto" }, "sun": { "$ref": "#/components/schemas/sunInTimeCardSummaryUpdateDto" }, "invoiceable": { "$ref": "#/components/schemas/invoiceableInTimeCardSummaryUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInTimeCardSummaryUpdateDto" } } }, "TimeCardUpdateDto": { "type": "object", "properties": { "refNbr": { "$ref": "#/components/schemas/DtoValueOfString" }, "employee": { "$ref": "#/components/schemas/DtoValueOfString" }, "summary": { "type": "array", "items": { "$ref": "#/components/schemas/TimeCardSummaryUpdateDto" }, "description": "Time Card summary information" }, "materials": { "type": "array", "items": { "$ref": "#/components/schemas/TimeCardMaterialsUpdateDto" }, "description": "Time Card Materials information" } } }, "SubmitTimeCardActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "SendTimeCardToApprovalActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "PutTimeCardOnHoldActionResultDto": { "type": "object", "properties": { "actionId": { "type": "string", "format": "uuid" }, "actionResult": { "enum": [ "Queued", "InProcess", "Failed", "Done" ], "type": "string" }, "errorInfo": { "type": "string" } } }, "UiExtensionScreenDto": { "type": "object", "properties": { "screenId": { "type": "string" }, "stepIds": { "type": "array", "items": { "type": "string" } } } }, "UiExtensionQueryParameters": { "type": "object", "properties": { "screenId": { "type": "string" }, "type": { "enum": [ "Action", "Menu" ], "type": "string" } } }, "UiExtensionDto": { "type": "object", "properties": { "internalId": { "type": "string", "format": "uuid" }, "title": { "type": "string" }, "url": { "type": "string" }, "type": { "enum": [ "Action", "Menu" ], "type": "string" }, "screenId": { "type": "string" }, "stepId": { "type": "string" }, "ownerName": { "type": "string" }, "enabled": { "type": "boolean" } } }, "UiExtensionUpdateDto": { "required": [ "title", "url", "type", "ownerId", "ownerName" ], "type": "object", "properties": { "title": { "type": "string", "description": "" }, "url": { "type": "string", "description": "" }, "type": { "enum": [ "Action", "Menu" ], "type": "string", "description": "" }, "screenId": { "type": "string", "description": "" }, "stepId": { "type": "string", "description": "" }, "ownerId": { "type": "string", "description": "", "format": "uuid" }, "ownerName": { "type": "string", "description": "" } } }, "UnitOfMeasureDto": { "type": "object", "properties": { "fromUnit": { "type": "string", "description": "Mandatory field: The table > From unit* > The unit to be converted." }, "toUnit": { "type": "string", "description": "Mandatory field: The table > To unit* > The unit to which the unit specified in the From unit will be converted with the use of the specified operation and specified conversion factor." }, "unitMultDiv": { "enum": [ "Multiply", "Divide" ], "type": "string", "description": "The table > Multiply/divide > The operation to be performed for conversion of the From unit to the To unit." }, "unitRate": { "type": "number", "description": "The table > Conversion factor > The factor to be used for the unit conversion with the specified operation.", "format": "double" }, "supplementaryMeasureUnit": { "enum": [ "None", "Carats", "NumberOfCells", "CarryingCapacityTons", "Gram", "GramFissileIsotypes", "Kilogram", "KilogramCholineChloride", "KilogramHydrogenPeroxide", "KilogramPotassiumOxide", "KilogramPotassiumHydroxide", "KilogramMethylamines", "KilogramDrainedNetWeight", "KilogramSubstance90Dry", "KilogramNitrogen", "KilogramSodiumHydroxide", "KilogramDiphosphorusPentaoxide", "KilogramUranium", "NumberOfItems", "NumberOfPairs", "Items100", "Items1000", "KilowattHours1000", "Litre", "LitrePureAlco", "Litres1000", "Meter", "SquareMeter", "CubicMeter", "CubicMeters1000", "Terajoule" ], "type": "string", "description": "The table > Supplementary measure unit > The supplementary measure unit to which the conversion will be made for Intrastat." } } }, "VatRateLineDto": { "type": "object", "properties": { "revisionID": { "type": "string", "description": "The revision ID of the VAT rate." }, "vatRate": { "type": "number", "description": "The VAT rate of the line.", "format": "double" }, "groupType": { "enum": [ "Output", "Input" ], "type": "string", "description": "The type of the reporting group." }, "startDate": { "type": "string", "description": "The date and time from which the VAT rate is effective.", "format": "date-time" } } }, "VatCategoryLineDto": { "type": "object", "properties": { "vatId": { "type": "string", "description": "Mandatory field: VAT ID* > The ID of the VAT included in the category." }, "vendorCd": { "type": "string", "description": "Vendor code > The vendor number associated with the VAT category line." }, "description": { "type": "string", "description": "Description > The detailed description of the VAT item." }, "type": { "enum": [ "Sales", "Use", "Vat", "Withholding", "ExemptVat", "StatisticalVat", "DirectVat", "PendingVat", "ReverseVat" ], "type": "string", "description": "VAT type > The type of VAT, which defines how it is processed." }, "calculateOn": { "enum": [ "ExtractFromItemAmount", "ItemAmount", "ItemTaxAmount", "DocumentAmount", "DocumenTaxAmount" ], "type": "string", "description": "Calculate on > The way the VAT amount is calculated, which can be one of the following options: Extract from item amount, Document amount, Document and VAT amount." }, "cashDiscount": { "enum": [ "ToTaxableAmount", "ToPromtPayment", "ToTaxAmount", "AdjustTax", "NoAdjust" ], "type": "string", "description": "Cash discount > The method of calculating the taxable amount if a discount is applied (based on the credit terms). It can be one of the following options: Reduce VAT amount, Does not affect VAT amount." }, "vatRates": { "type": "array", "items": { "$ref": "#/components/schemas/VatRateLineDto" } } } }, "VatCategoryDto": { "type": "object", "properties": { "vatCategoryId": { "type": "string", "description": "Mandatory field: The top part > VAT category ID* > The unique ID of the VAT category. An alphanumeric string of up to six characters can be used." }, "description": { "type": "string", "description": "The top part > Description > A detailed description of the category." }, "active": { "type": "boolean", "description": "The top part > Active > A check box that means (if selected) that this VAT category is active." }, "excludeListedTaxes": { "type": "boolean", "description": "The top part > Exclude listed taxes > A check box that indicates (if selected) this VAT category should exclude the listed taxes from VAT zones." }, "lastModifiedDateTime": { "type": "string", "description": "Systemgenerated information.", "format": "date-time" }, "vatCategoryLines": { "type": "array", "items": { "$ref": "#/components/schemas/VatCategoryLineDto" }, "description": "The table >" } } }, "VatInformationScheduleDto": { "type": "object", "properties": { "startDate": { "type": "string", "description": "Mandatory field: Start date > The date when the VAT at the rate in the current row becomes effective.", "format": "date-time" }, "vatRate": { "type": "number", "description": "VAT rate > The VAT rate (%) that is used to calculate the VAT amount.", "format": "double" }, "minTaxableAmt": { "type": "number", "description": "Min. taxable amount > The minimum taxable amount for which this rate is applicable.", "format": "double" }, "maxTaxableAmt": { "type": "number", "description": "Max. taxable amount > The maximum taxable amount for which this rate applies.", "format": "double" }, "reportingGroup": { "type": "string", "description": "Reporting group > The reporting group for the VAT." }, "deductibleVatRate": { "type": "number", "description": "Deductible VAT rate > The VAT rate (%) that is used to calculate the amount deductible from the output VAT.", "format": "double" }, "groupType": { "enum": [ "Output", "Input" ], "type": "string", "description": "Group type > The type of the reporting group." } } }, "vatPayableAccountInVatGlAccountsDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Mandatory field: VAT payable account* > The liability account that accumulates the VAT amounts to be paid to a tax agency for the VAT reporting period." }, "vatPayableSubaccountInVatGlAccountsDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Mandatory field: VAT payable subaccount* > The corresponding VAT payable subaccount." }, "vatClaimableAccountInVatGlAccountsDto": { "properties": { "type": { "enum": [ "Asset", "Liability", "Income", "Expense" ], "type": "string", "description": "Account > The account number." }, "externalCode1": { "type": "string", "description": "Account class > The identifier of the account class." }, "externalCode2": { "type": "string", "description": "Account class > The name of the account class." }, "active": { "type": "boolean" }, "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "VAT Claimable account > The account that accumulates the VAT amounts to be claimed from the tax agency for the VAT reporting period." }, "vatClaimableSubccountInVatGlAccountsDto": { "properties": { "active": { "type": "boolean" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "VAT claimable subaccount > The corresponding tax claimable subaccount." }, "VatGlAccountsDto": { "type": "object", "properties": { "vatPayableAccount": { "$ref": "#/components/schemas/vatPayableAccountInVatGlAccountsDto" }, "vatPayableSubaccount": { "$ref": "#/components/schemas/vatPayableSubaccountInVatGlAccountsDto" }, "vatClaimableAccount": { "$ref": "#/components/schemas/vatClaimableAccountInVatGlAccountsDto" }, "vatClaimableSubccount": { "$ref": "#/components/schemas/vatClaimableSubccountInVatGlAccountsDto" } } }, "vatAgencyIdInVatInformationDto": { "properties": { "internalId": { "type": "integer", "description": "The internal id of the supplier", "format": "int64" }, "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "VAT settings tab > Tax agency > The name of the tax agency to receive the VAT." }, "defaultNonStockItemInVatInformationDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "VAT settings tab > Default non-stock item > The default non-stock item for the VAT ID." }, "glAccountsInVatInformationDto": { "properties": { "vatPayableAccount": { "$ref": "#/components/schemas/vatPayableAccountInVatGlAccountsDto" }, "vatPayableSubaccount": { "$ref": "#/components/schemas/vatPayableSubaccountInVatGlAccountsDto" }, "vatClaimableAccount": { "$ref": "#/components/schemas/vatClaimableAccountInVatGlAccountsDto" }, "vatClaimableSubccount": { "$ref": "#/components/schemas/vatClaimableSubccountInVatGlAccountsDto" } }, "description": "General ledger accounts >" }, "VatInformationDto": { "type": "object", "properties": { "vatCategoryId": { "type": "string", "description": "VatCategoryId is deprecated, please use Vat Id instead" }, "vatId": { "type": "string", "description": "Mandatory field: VAT settings tab > VAT ID* > The unique ID of the VAT." }, "description": { "type": "string", "description": "VAT settings tab > Description > A detailed description of the VAT." }, "type": { "enum": [ "Sales", "Use", "Vat", "Withholding", "ExemptVat", "StatisticalVat", "DirectVat", "PendingVat", "ReverseVat" ], "type": "string", "description": "VAT settings tab > VAT type > The type of VAT." }, "deductibleVat": { "type": "boolean", "description": "VAT settings tab > Partially deductible VAT > A check box that indicates (if selected) that this is a deductible value-added VAT." }, "reverseVat": { "type": "boolean", "description": "VAT settings tab > Reverse VAT > A check box that indicates (if selected) that this is a reverse VAT." }, "statisticalVat": { "type": "boolean", "description": "VAT settings tab > Statistical VAT > A check box that indicates (if selected) that the VAT on documents will be calculated only for statistical purposes or will be reported only but not actually paid." }, "pendingVat": { "type": "boolean", "description": "VAT settings tab > Pendig VAT > A check box that indicates (if selected) that the VAT that should be calculated in documents, but should not be recorded to the VAT report until the VAT invoice is received." }, "includeinVatExemptTotal": { "type": "boolean", "description": "VAT settings tab > Include in VAT exempt total > A check box that indicates (if selected) that this value-added VAT has a zero rate and is used to calculate a document subtotal that is actually exempt from VAT." }, "includeinVatTotal": { "type": "boolean", "description": "VAT settings tab > Include in VAT taxable total > A check box that indicates (if selected) that the VAT taxable amount should appear in the VAT taxable total field in the documents (such as invoices)." }, "enterFromVatInvoice": { "type": "boolean", "description": "VAT settings tab > Enter from VAT invoice > A check box that indicates (if selected) that this VAT should be calculated for documents only if the documents are added to a VAT invoice or VAT adjustment." }, "calculateOn": { "enum": [ "ExtractFromItemAmount", "ItemAmount", "ItemTaxAmount", "DocumentAmount", "DocumenTaxAmount" ], "type": "string", "description": "VAT settings tab > Calculate on > The method of calculating the tax amount, which is one of the following options: Extract from item amount, Item amount, Item and VAT amount, Document amount, Document and VAT amount." }, "cashDiscount": { "enum": [ "ToTaxableAmount", "ToPromtPayment", "ToTaxAmount", "AdjustTax", "NoAdjust" ], "type": "string", "description": "VAT settings tab > Cash discount > The method of calculating the tax base amount if a cash discount is applied." }, "vatAgencyId": { "$ref": "#/components/schemas/vatAgencyIdInVatInformationDto" }, "notValidAfter": { "type": "string", "description": "VAT settings tab > Not valid after > The date after which the VAT is not effective.", "format": "date-time" }, "euReportCode": { "enum": [ "SalesOfGoods", "Triangulation", "SalesOfService" ], "type": "string", "description": "VAT settings tab > EU report code > The EU reporting code for the VAT." }, "documentText": { "type": "string", "description": "VAT Settings tab > Document text tab > Document text > The text to be printed to the VAT document." }, "defaultNonStockItem": { "$ref": "#/components/schemas/defaultNonStockItemInVatInformationDto" }, "vismaXmlVatType": { "enum": [ "VatTypeHigh", "VatTypeMedium", "VatTypeLow", "VatTypeZero", "VatTypeExempt" ], "type": "string", "description": "VAT settings tab > Visma XML VAT type > The VAT type to be used in Visma XML files." }, "lastModifiedDateTime": { "type": "string", "description": "System generated information.", "format": "date-time" }, "glAccounts": { "$ref": "#/components/schemas/glAccountsInVatInformationDto" }, "schedules": { "type": "array", "items": { "$ref": "#/components/schemas/VatInformationScheduleDto" }, "description": "Both tabs > VAT schedule >" }, "categories": { "type": "array", "items": { "$ref": "#/components/schemas/VatCategoryDto" }, "description": "Both tabs > Categories tab >" }, "zones": { "type": "array", "items": { "$ref": "#/components/schemas/VatZoneDto" }, "description": "Both tabs > Zones tab >" } } }, "VatQueryParameters": { "type": "object", "properties": { "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." } } }, "noteInUpdateNoteDto": { "properties": { "value": { "type": "string" } }, "description": "Note for Vat report header." }, "UpdateNoteDto": { "type": "object", "properties": { "note": { "$ref": "#/components/schemas/noteInUpdateNoteDto" } } }, "VatCategoryQueryParameters": { "type": "object", "properties": { "vendorCd": { "type": "string", "description": "The vendor number associated with the VAT category line." }, "greaterThanValue": { "type": "string", "description": "Greater than value. The item which is the object for this, varies from API to API." }, "numberToRead": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "skipRecords": { "type": "integer", "description": "This field has been deprecated and will be removed in future versions. Use pagenumber and pagesize for pagination purposes. Pagenumber and pagesize does not work with NumberToRead and SkipRecords.", "format": "int32" }, "lastModifiedDateTime": { "type": "string", "description": "This value, generated by the system, indicates the last time the record was modified. Use it to retrieve all records that have been modified since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "lastModifiedDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __LastModifiedDateTime__ and __LastModifiedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTime": { "type": "string", "description": "This value, generated by the system, indicates the creation date and time. Use it to retrieve all records that have been created since that time, up to the present.\r\n\r\nAccepted format:\r\n* ```yyyy-MM-dd```\r\n* ```yyyy-MM-dd HH:mm:ss```\r\n* ```yyyy-MM-dd HH:mm:ss.FFF```\r\n* ```yyyy-MM-ddTHH:mm:ss```\r\n* ```yyyy-MM-ddTHH:mm:ss.FFF```\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." }, "createdDateTimeCondition": { "type": "string", "description": "This value represents the condition to be applied when retrieving records.\r\n\r\nAccepted values (without the single quotes):\r\n* '>' for greater than\r\n* '<' for less than\r\n* '>=' for greater than or equal\r\n* '<=' for less than or equal\r\n\r\n_Note:_ __CreatedDateTime__ and __CreatedDateTimeCondition__ are __mutually inclusive__." } } }, "VatZoneQueryParameters": { "type": "object", "properties": { "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "primaryItemInWarehouseLocationDto": { "properties": { "number": { "type": "string", "description": "Number of item" }, "description": { "type": "string", "description": "Name of item/description" } }, "description": "Primary item > The primary item for this location, which is the item that is received the most often or stored here in the highest volumes." }, "primaryItemClassInWarehouseLocationDto": { "properties": { "type": { "enum": [ "NonStockItem", "LaborItem", "ServiceItem", "ChargeItem", "ExpenseItem", "FinishedGoodItem", "ComponentPartItem", "SubassemblyItem" ], "type": "string" }, "attributes": { "type": "array", "items": { "$ref": "#/components/schemas/ClassAttributeDto" } }, "id": { "type": "string", "description": "The identifier." }, "description": { "type": "string", "description": "The description." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Primary item class > The primary item class for this location; items of this class are received the most often or stored here in the highest volumes." }, "projectInWarehouseLocationDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project > The project to associate with this location by default." }, "projectTaskInWarehouseLocationDto": { "properties": { "internalId": { "type": "integer", "description": "The internal identifier.", "format": "int32" }, "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Project task > The project task to associate with this location by default." }, "WarehouseLocationDto": { "type": "object", "properties": { "locationId": { "type": "string", "description": "Location ID > The unique ID of the warehouse location." }, "description": { "type": "string", "description": "Description > A brief description of the warehouse location." }, "active": { "type": "boolean", "description": "Active > This check box indicates whether this location is active." }, "inclQtyAvail": { "type": "boolean", "description": "Include in qty. available > You select this check box if the quantities of goods available at this location will be included in the quantities of available goods and used in inventory transactions, such as issues and transfers." }, "isCosted": { "type": "boolean", "description": "Cost separately > You select this check box if the costs for goods available at this location will be calculated separately from costs calculated at the system-level; that is, for FIFO and specific valuation methods, separate cost layers will be created for this location." }, "salesValid": { "type": "boolean", "description": "Sales allowed > You select this check box if sales are allowed from this location." }, "receiptsValid": { "type": "boolean", "description": "Receipts allowed > You select this check box if receipts are allowed at this location." }, "transfersValid": { "type": "boolean", "description": "Transfers allowed > You select this check box if transfers are allowed for this location." }, "assemblyValid": { "type": "boolean", "description": "Assembly allowed > You select this check box if assembly operations are allowed at this location." }, "primaryItemValid": { "enum": [ "PrimaryNothing", "PrimaryItemWarning", "PrimaryItemError", "PrimaryItemClassWarning", "PrimaryItemClassError" ], "type": "string", "description": "Primary item validation > An option indicating whether the operations with the primary item should be validated for this location and how." }, "primaryItem": { "$ref": "#/components/schemas/primaryItemInWarehouseLocationDto" }, "primaryItemClass": { "$ref": "#/components/schemas/primaryItemClassInWarehouseLocationDto" }, "project": { "$ref": "#/components/schemas/projectInWarehouseLocationDto" }, "projectTask": { "$ref": "#/components/schemas/projectTaskInWarehouseLocationDto" } } }, "countryInWarehouseAddressDto": { "properties": { "id": { "type": "string", "description": "Mandatory field: Country ID* > The unique two-letter country ID according to international standard ISO 3166." }, "name": { "type": "string", "description": "Mandatory field: Country name* > The complete name of the country." }, "errorInfo": { "type": "string" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "Country > The country where the warehouse is located." }, "countyInWarehouseAddressDto": { "properties": { "id": { "type": "string", "description": "Click the magnifier > The identifier" }, "name": { "type": "string", "description": "Click the magnifier > The displayed name" } }, "description": "County > The county where the warehouse is located." }, "WarehouseAddressDto": { "type": "object", "properties": { "addressId": { "type": "integer", "description": "Information retrieved from the system.", "format": "int32" }, "addressType": { "type": "string", "description": "Information retrieved from the system." }, "validated": { "type": "boolean", "description": "Information retrieved from the system." }, "addressLine1": { "type": "string", "description": "Address ! > The first line in the address of the warehouse." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line in the warehouse address." }, "city": { "type": "string", "description": "City > The city of the warehouse address." }, "country": { "$ref": "#/components/schemas/countryInWarehouseAddressDto" }, "county": { "$ref": "#/components/schemas/countyInWarehouseAddressDto" }, "postalCode": { "type": "string", "description": "Postcode > The postcode relevant for the warehouse address." } } }, "WarehouseContactDto": { "type": "object", "properties": { "contactId": { "type": "integer", "description": "Information retrieved from the system.", "format": "int32" }, "companyName": { "type": "string", "description": "Company name > The legal business name of the warehouse to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The department or person to be noted on the attention line, if this line is used by your company." }, "email": { "type": "string", "description": "Email > The email address of the contact person assigned to this warehouse." }, "web": { "type": "string", "description": "Web > The URL of the web page where information about the warehouse is published." }, "phone1": { "type": "string", "description": "Phone 1 > The primary phone number of the contact person assigned to this warehouse." }, "phone2": { "type": "string", "description": "Phone 2 > \tA secondary phone number of the contact person assigned to this warehouse." }, "fax": { "type": "string", "description": "Fax > The fax number of the contact person assigned to this warehouse." } } }, "ReplenishmentClassIdDescriptionDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } } }, "branchInWarehouseDto": { "properties": { "number": { "type": "string", "description": "Click the magnifier. > The identifier." }, "name": { "type": "string", "description": "Click the magnifier. > The name." } }, "description": "Mandatory field: The top part > Branch* > The branch associated with the company." }, "replenishmentClassInWarehouseDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "The top part > Replenishment class > The replenishment class associated with this warehouse." }, "receiptLocationInWarehouseDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Location table tab > Receiving location > The warehouse location to be used to receive goods." }, "shipLocationInWarehouseDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Location table tab > Shipping location > The warehouse location to be used to ship goods." }, "returnLocationInWarehouseDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Location table tab > RMA location > The RMA warehouse location." }, "dropShipLocationInWarehouseDto": { "properties": { "id": { "type": "string", "description": "Click on the magnifier. > The identifier." }, "description": { "type": "string", "description": "Click on the magnifier. > The description." } }, "description": "Location table tab > Drop-ship location > The warehouse location used to account for drop shipments." }, "contactInWarehouseDto": { "properties": { "contactId": { "type": "integer", "description": "Information retrieved from the system.", "format": "int32" }, "companyName": { "type": "string", "description": "Company name > The legal business name of the warehouse to appear on the documents." }, "attention": { "type": "string", "description": "Attention > The department or person to be noted on the attention line, if this line is used by your company." }, "email": { "type": "string", "description": "Email > The email address of the contact person assigned to this warehouse." }, "web": { "type": "string", "description": "Web > The URL of the web page where information about the warehouse is published." }, "phone1": { "type": "string", "description": "Phone 1 > The primary phone number of the contact person assigned to this warehouse." }, "phone2": { "type": "string", "description": "Phone 2 > \tA secondary phone number of the contact person assigned to this warehouse." }, "fax": { "type": "string", "description": "Fax > The fax number of the contact person assigned to this warehouse." } }, "description": "Address information tab > Contact section >" }, "addressInWarehouseDto": { "properties": { "addressId": { "type": "integer", "description": "Information retrieved from the system.", "format": "int32" }, "addressType": { "type": "string", "description": "Information retrieved from the system." }, "validated": { "type": "boolean", "description": "Information retrieved from the system." }, "addressLine1": { "type": "string", "description": "Address ! > The first line in the address of the warehouse." }, "addressLine2": { "type": "string", "description": "Address 2 > The second line in the warehouse address." }, "city": { "type": "string", "description": "City > The city of the warehouse address." }, "country": { "$ref": "#/components/schemas/countryInWarehouseAddressDto" }, "county": { "$ref": "#/components/schemas/countyInWarehouseAddressDto" }, "postalCode": { "type": "string", "description": "Postcode > The postcode relevant for the warehouse address." } }, "description": "Address information tab > Address section >" }, "WarehouseDto": { "type": "object", "properties": { "warehouseID": { "type": "string", "description": "Mandatory field: The top part > Warehouse ID* > The unique ID of the warehouse." }, "branch": { "$ref": "#/components/schemas/branchInWarehouseDto" }, "replenishmentClass": { "$ref": "#/components/schemas/replenishmentClassInWarehouseDto" }, "active": { "type": "boolean", "description": "The top part > Active > This check box indicates (if selected) that the warehouse is active." }, "lockSitePICountEntry": { "type": "boolean", "description": "The top part > Freeze the inventory when the stocktaking is in data entry state > This check box indicates (if selected) that the inventory in the warehouse will be frozen during the stocktaking and data entry stages of stocktaking." }, "description": { "type": "string", "description": "The top part > Description > A brief description of the warehouse." }, "locationEntry": { "enum": [ "Validate", "Warn", "NoValidate" ], "type": "string", "description": "The top part > Location entry > An option indicating whether warehouse locations can be added directly on any inventory document or only by using this window." }, "avgDefaultCost": { "enum": [ "AverageCost", "LastCost" ], "type": "string", "description": "The top part > Avg. default return cost > For items with the Average valuation method, the option that defines which of costs should be used for returns and receipts." }, "fifoDefaultCost": { "enum": [ "AverageCost", "LastCost" ], "type": "string", "description": "The top part > FIFO default returns cost > For items with the FIFO valuation method, the option that defines which of costs should be used for returns and receipts." }, "receiptLocation": { "$ref": "#/components/schemas/receiptLocationInWarehouseDto" }, "shipLocation": { "$ref": "#/components/schemas/shipLocationInWarehouseDto" }, "returnLocation": { "$ref": "#/components/schemas/returnLocationInWarehouseDto" }, "dropShipLocation": { "$ref": "#/components/schemas/dropShipLocationInWarehouseDto" }, "contact": { "$ref": "#/components/schemas/contactInWarehouseDto" }, "address": { "$ref": "#/components/schemas/addressInWarehouseDto" }, "locations": { "type": "array", "items": { "$ref": "#/components/schemas/WarehouseLocationDto" }, "description": "Location table tab > The location table >" }, "timestamp": { "type": "string", "description": "Timestamp of the warehouse record" }, "metadata": { "$ref": "#/components/schemas/MetadataDto" } }, "description": "This class represents a Warehouse in WarehouseController. Used for getting data." }, "WarehouseQueryParameters": { "type": "object", "properties": { "active": { "type": "boolean", "description": "Selects only the warehouses that are active/inactive." }, "branch": { "type": "string", "description": "Selects only the warehouses for the specified branch." }, "pageNumber": { "type": "integer", "description": "Pagination parameter. Page number.", "format": "int32" }, "pageSize": { "type": "integer", "description": "Pagination parameter. Number of items to be collected.\r\nPlease use a page size lower or equal to the allowed max page size which is returned as part of the metadata information.\r\nIf requested page size is greater than allowed max page size, request will be limited to max page size.", "format": "int32" } } }, "DtoValueOfNullableOfPrimaryItemValid": { "type": "object", "properties": { "value": { "enum": [ "PrimaryNothing", "PrimaryItemWarning", "PrimaryItemError", "PrimaryItemClassWarning", "PrimaryItemClassError" ], "type": "string" } } }, "locationIdInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Location ID > The unique ID of the warehouse location." }, "descriptionInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Description > A brief description of the warehouse location." }, "activeInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "Active > This check box indicates whether this location is active." }, "inclQtyAvailInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "Include in qty. available > You select this check box if the quantities of goods available at this location will be included in the quantities of available goods and used in inventory transactions, such as issues and transfers." }, "isCostedInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "Cost separately > You select this check box if the costs for goods available at this location will be calculated separately from costs calculated at the system-level; that is, for FIFO and specific valuation methods, separate cost layers will be created for this location." }, "salesValidInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "Sales allowed > You select this check box if sales are allowed from this location." }, "receiptsValidInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "Receipts allowed > You select this check box if receipts are allowed at this location." }, "transfersValidInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "Transfers allowed > You select this check box if transfers are allowed for this location." }, "assemblyValidInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "boolean" } }, "description": "Assembly allowed > You select this check box if assembly operations are allowed at this location." }, "pickPriorityInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "integer", "format": "int32" } }, "description": "Pick priority > The order of which location should have priority." }, "primaryItemValidInWarehouseLocationUpdateDto": { "properties": { "value": { "enum": [ "PrimaryNothing", "PrimaryItemWarning", "PrimaryItemError", "PrimaryItemClassWarning", "PrimaryItemClassError" ], "type": "string" } }, "description": "Primary item validation > An option indicating whether the operations with the primary item should be validated for this location and how." }, "primaryItemIdInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Primary item > The primary item for this location, which is the item that is received the most often or stored here in the highest volumes." }, "primaryItemClassIdInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Primary item class > The primary item class for this location; items of this class are received the most often or stored here in the highest volumes." }, "projectIdInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Project > The project to associate with this location by default." }, "projectTaskIdInWarehouseLocationUpdateDto": { "properties": { "value": { "type": "string" } }, "description": "Project task > The project task to associate with this location by default." }, "WarehouseLocationUpdateDto": { "type": "object", "properties": { "locationId": { "$ref": "#/components/schemas/locationIdInWarehouseLocationUpdateDto" }, "description": { "$ref": "#/components/schemas/descriptionInWarehouseLocationUpdateDto" }, "active": { "$ref": "#/components/schemas/activeInWarehouseLocationUpdateDto" }, "inclQtyAvail": { "$ref": "#/components/schemas/inclQtyAvailInWarehouseLocationUpdateDto" }, "isCosted": { "$ref": "#/components/schemas/isCostedInWarehouseLocationUpdateDto" }, "salesValid": { "$ref": "#/components/schemas/salesValidInWarehouseLocationUpdateDto" }, "receiptsValid": { "$ref": "#/components/schemas/receiptsValidInWarehouseLocationUpdateDto" }, "transfersValid": { "$ref": "#/components/schemas/transfersValidInWarehouseLocationUpdateDto" }, "assemblyValid": { "$ref": "#/components/schemas/assemblyValidInWarehouseLocationUpdateDto" }, "pickPriority": { "$ref": "#/components/schemas/pickPriorityInWarehouseLocationUpdateDto" }, "primaryItemValid": { "$ref": "#/components/schemas/primaryItemValidInWarehouseLocationUpdateDto" }, "primaryItemId": { "$ref": "#/components/schemas/primaryItemIdInWarehouseLocationUpdateDto" }, "primaryItemClassId": { "$ref": "#/components/schemas/primaryItemClassIdInWarehouseLocationUpdateDto" }, "projectId": { "$ref": "#/components/schemas/projectIdInWarehouseLocationUpdateDto" }, "projectTaskId": { "$ref": "#/components/schemas/projectTaskIdInWarehouseLocationUpdateDto" } } }, "WebhookNotificationFeedbackDto": { "type": "object", "properties": { "notificationId": { "type": "string", "description": "The ID of the notification.", "format": "uuid" }, "source": { "type": "string", "description": "The source of the notification" }, "description": { "type": "string", "description": "The description text of the notification. Such as \"Operation failed\"." }, "isSuccess": { "type": "boolean", "description": "Was the notification successfully consumed: True or false." } } } }, "securitySchemes": { "serviceapi": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://connect.visma.com/connect/token", "scopes": { } } } } } } }