Get Document Status
Use this request to retrieve a document's status.
To retrieve the Document's status, use the GET method and the following URL:
https://e-invoicing-service.vertexcloud.com/customers/v2/documents/{documentId}
where:
{documentId}
is the identifier for the document as returned in the response to the original document request.
Details
Detail | Description |
---|---|
Method | GET |
Endpoint | /v2/documents/{documentId} |
API Reference Topic | Get Document Status |
Request Parameter
The following parameter can be specified in requests:
Parameter | Type | Description |
---|---|---|
documentId | GUID | The GUID of the document for which you want to view the status. Required. |
Response Output
Output | Type | Description |
---|---|---|
documentId | GUID | The GUID of the document you requested to view the status of. |
Document Number | String | The logical invoice number from within the invoice body. |
Issue Date | DateTime | The issue date time from the invoice body. |
Sender | String | The Sender from the VRBL header. |
Receiver | String | The Receiver from the VRBL header. |
Is Integrated | Boolean | The current state of the integration flag. |
Status | StatusCode | The document workflow status as listed in Document Workflow Status. |
Transmission Direction | String | Indicates the direction of invoice transmission. Possible values include: • Send • Receive |
Transmission DateTime | DateTime | The timestamp at which the invoice was transmitted to Vertex e-Invoicing. |
ErrorDetails | Object | An object providing structured details about any errors encountered in document processing. |
Endpoints | Object | An object providing structured information about the routing information for the document. |
Updated about 1 month ago