Get Documents from the Integration Queue
Use this request to retrieve documents from Vertex e-Invoicing.
To retrieve documents from the integration system, use the GET method and the following URL:
https://e-invoicing-service.vertexcloud.com/customers/v2/documents/integration-queue
Details
| Detail | Description |
|---|---|
| Method | GET |
| Endpoint | /v2/documents/integration-queue |
| API Reference Topic | Get Documents from the Integration Queue |
Request parameters
The following parameters can be specified in requests:
| Path Parameter | Type | Description |
|---|---|---|
status | StatusCode | One of the states documented in Invoice Status Workflow |
direction | DirectionCode | • Send: Outbound Invoices • Receive: Inbound invoices |
limit | Integer | Specifies the number of new documents to be returned with a single request. The default is 100. |
afterDocumentId | GUID | Specifies the documentId after which new documents with successive documentIds should be returned. |
Response output
The status of the document is returned in the response. See Document Status Fields.
| Output | Type | Description |
|---|---|---|
documents/document Id | GUID | The unique identifier of the document within Vertex e-Invoicing. |
documents/status | StatusCode | One of the states documented in Document Status Workflow. |
documents/transmission timestamp | DateTime | The timestamp at which the invoice document was transmitted. |
count | Integer | The total number of documents returned. |
last documentId | GUID | The documentId of the last document returned. |
Updated 9 months ago