Get the status of the sent document

Endpoint: GET /einvoicing/documents/:id/status

Retrieve the status of a submitted document. For details, see GetDocumentStatus.

To understand how to design document status retrieval, storage, and event handling, see Response key and document retrieval in ELR.

Use the unique id returned by the SubmitDocument endpoint to check the status of the document.

Headers


Name	Description
Accept	application/json
avalara-version	Specifies the version of the API to use.
X-Avalara-Client	Provided by Avalara.

Path parameter


Name	Description
`id`	(Required) The document ID returned from the SubmitDocument response.

Response

A successful response includes a document status.


Status	Description
Complete	The document has been processed and accepted.
Pending	The ELR service, network, or tax authority is still processing the document.
Error	The document failed processing. Details are available in the `events[]` array, including validation errors.

An error response (404) is returned if no document is found for the specified ID.

Important

Wait at least 10 seconds between the SubmitDocument and GetDocumentStatus requests to avoid receiving a Pending status due to processing delays.

Example request

curl --location -g '/einvoicing/documents/{{documentId}}/status' \
--header 'Accept: application/json' \
--header 'avalara-version: 1.5' \
--header 'X-Avalara-Client: ProvidedToYouByAvalara'