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

DetailDescription
MethodGET
Endpoint/v2/documents/integration-queue
API Reference TopicGet Documents from the Integration Queue

Request Parameters

The following parameters can be specified in requests:

Path ParameterTypeDescription
statusStatusCodeOne of the states documented in Invoice Status Workflow
directionDirectionCode• Send: Outbound Invoices
• Receive: Inbound invoices
limitIntegerSpecifies the number of new documents to be returned with a single request. The default is 100.
afterDocumentIdGUIDSpecifies 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.

OutputTypeDescription
documents/document IdGUIDThe unique identifier of the document within Vertex e-Invoicing.
documents/statusStatusCodeOne of the states documented in Document Status Workflow.
documents/transmission timestampDateTimeThe timestamp at which the invoice document was transmitted.
countIntegerThe total number of documents returned.
last documentIdGUIDThe documentId of the last document returned.