Get Document Status
Use this request to retrieve the document's status, using the GUID.
To retrieve the Document's status, use a GET method and the following URL:
https://e-invoicing-service.vertexcloud.com/customers/v1/documents/{documentId}
where:
{documentId}
is the Document's GUID.
For example:
curl --request GET \
--url https://e-invoicing-service.vertexcloud.com/customers/v1/documents/ABCfe1231 \
--header 'accept: application/json' \
--header 'x-correlation-id: BVJ7890'
Details
Detail | Description |
---|---|
Method | GET |
Endpoint | /v1/documents/{documentId} |
API Reference Topic | Get Document Status |
Input
The following parameters can be specified in inbound requests that are sent to the service:
Path Parameters
Path Parameter | Description |
---|---|
documentId | The GUID of the document who's status you want to view. |
Headers
Header | Description |
---|---|
x-correlation-id | The sender's unique reference for the request. This value is returned in the headers of responses and is useful for debugging, logging and so on. See Correlation IDs. |
Output
The status of the document is returned in the response. See Document Status Fields.
Example Request
Here is an example request:
curl --request GET \
--url https://e-invoicing-service.vertexcloud.com/customers/v1/documents/ABCfe1231 \
--header 'accept: application/json' \
--header 'x-correlation-id: BVJ7890'
Updated 18 days ago