v1

latestOpenAPI 3.0.22026-07-1351821.6 KB
Notification history

Returns task status by search criteria. Does not contain task payload.

get/v1/tasks

Query parameters

taskTypestring

Task type (InvoiceGenericTask, InvoiceCalcTax, etc)

Task type (InvoiceGenericTask, InvoiceCalcTax, etc)

taskStatusstring

Status of the task. Available values: 'New', 'Completed', 'Failed'.

Status of the task. Available values: 'New', 'Completed', 'Failed'.

documentIdstring

Returns all tasks for a specific document (for example all tasks related to one AccountingDocument).

Returns all tasks for a specific document (for example all tasks related to one AccountingDocument).

lastUpdatedstring

Date Filter. Returns tasks which have been updated after specified datetime.

Date Filter. Returns tasks which have been updated after specified datetime.

Headers

x-amz-meta-continuationtokenstring

Used to get next page of results when item count indicated by 'pageSize' is exceeded. A token is returned in header (not body) parameter 'X-amz-meta-continuationToken' of the response whenever there are more records to fetch. Post the received value here in a new GET request to receive the next page of results.

Used to get next page of results when item count indicated by 'pageSize' is exceeded. A token is returned in header (not body) parameter 'X-amz-meta-continuationToken' of the response whenever there are more records to fetch. Post the received value here in a new GET request to receive the next page of results.

Response

Successful Response

Example response

{
  "taskStatus": [
    {
      "taskId": "sajkhe1i87yhdgdi6sad7iyahljh1ut1",
      "taskStatus": "New",
      "taskType": "AccountingDocuments",
      "taskSubType": "WaitingForTransfer",
      "documentId": "198phejkbaku7dilj12kdg867hbdsmag",
      "expirationTime": "2020-12-04T08:39:13Z",
      "externalProcessingTime": "2020-12-04T08:39:13Z",
      "lastUpdated": "2020-12-04T08:39:13Z",
      "taskHistory": [
        {
          "action": "New",
          "timeStamp": "2021-08-12T08:39:13Z"
        }
      ]
    }
  ]
}