Documents
The Documents endpoints can be used to send new documents, retrieve documents, or perform actions on previously sent documents.
Download OpenAPI specification
A Document contains all information relevant to one business document. The most common type of document is an invoice, but a document can be any type business document, ranging from credit notes, shipping documents, purchase orders, and more.
Most document details, as well as the semantic information required for routing and processing, are defined in an encoded xml document. The XML can specify all processes requested for the document, including mapping, signing, transmission, distribution and even archiving.
Therefore, Sovos' Document API requests act as air traffic controllers, taking an existing XML and following the instructions within the XML. To process a new document, like issuing an invoice, Sovos recommends configuring the XML's business process to "default", which tells Sovos to follow the actions and workflow of actions required for the country and document type.
Some actions can be triggered by API requests, such as canceling, distributing and updating archived documents. These API requests are usually reserved for specific scenarios.
These are the available endpoints in the Documents resource:
| HTTP Method | Path | Description |
|---|---|---|
| POST | /v1/documents | Sends an encoded document to Sovos for processing according to the Business Scopes specified. |
| POST | /v1/documents/{countryCode}/action | Sends requests to a tax authority for one or more documents. Available actions include canceling, correcting, or distributing. Specify the desired action using the actionCode. |
| GET | /v1/documents/{countryCode}/{documentId}/notifications | Returns notifications by documentId. |