curl --location -g --request PATCH 'https://api-test-tls.sovos.com/v1/config/{countryCode}/companies/{companyId}' \
--header 'Authorization: Bearer TOKEN' \
--header 'x-correlationId: SET-TO-UNIQUE-VALUE' \
--header 'Content-Type: application/json' \
--data-raw '{
	"status": "LockedForArchiving"
}'

{
    "timestamp": 1622206829408,
    "status": 200,
    "success": true,
    "message": "Company Locked",
    "data": {}
}

Retrieve the Invoices via the APi

To download the invoices by using the API:

1. Follow the steps on the Searching for Invoices page until all the references are collected.

2. Use the references to download all the invoices via the endpoint for Retrieving Invoices.

Download all the Invoices using a URL

As an alternative to using the API, it's possible to download all invoices from a locked company from a URL that Sovos provides upon request. This web page is accessed via HTTPS with your client certificate, which is also used to access Sovos eArchiving via the API. All invoices, attachments, and metadata are streamed from Sovos eArchiving to you. The downloaded data is a stream of XML invoice objects, where each XML invoice object has the same syntax as the output when the invoices are retrieved via the API.

If you use an ordinary web browser, the XML file is saved to the disk. As an alternative, you can also develop a web client that downloads the XML file and potentially parses the invoices, attachments, and metadata from the XML file. The downloaded XML file can be several megabytes or even gigabytes in size. Sovos recommends using a SAX parser -- based on an event-driven algorithm with low memory requirements -- instead of a DOM parser -- which allocates RAM memory for the entire XML document.

If there's a need to perform a reconciliation check on the downloaded invoices, the API endpoints that list and retrieve invoices can be used. The downloaded invoices and the corresponding references downloaded from the web page can then be compared to the identified references.

curl --location -g --request PATCH 'https://api-test-tls.sovos.com/v1/config/{countryCode}/companies/{companyId}' \
--header 'Authorization: Bearer TOKEN' \
--header 'x-correlationId: SET-TO-UNIQUE-VALUE' \
--header 'Content-Type: application/json' \
--data-raw '{
	"status": "ClosedForArchiving"
}'

{
    "timestamp": 1622210925597,
    "status": 200,
    "success": true,
    "message": "Company Closed",
    "data": {}
}