{
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the POST operation is successful, the server responds with 200 OK and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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.\r\nThe If-Match header should be included in the request headers using the following syntax: If-Match: \"etag_value\"\r\n* If the update is successful, the server responds with 204 No Content and includes the new ETag value in the response headers.\r\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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
},
"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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=,..,=]\" (without quotes): when the background operation is finsihed, a notification is posted to the Webhook subscription set up in Developer Portal for your integration client.\r\nOptionally a set of name-value pairs can be added. These will be sent as headers in the POST request to the Webhook subscription's url.\r\n\r\nTo find status and details of a background-api operation, GET .. v1/background/{id}. To get the response 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": [
{
"interactiveapi": [ ]
}
]
}
},
"/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.\r\nSupported values:\r\n* a URL: when the background operation is finished, a notification will be posted to the URL with a document containing a reference id, status code and a details state location.\r\n* \"none\" (without quotes): Fire and forget; no notification will be sent when background operation is finished.\r\n* \"subscription[:=