Download a ZIP file containing all necessary documents for an e-invoice or message sent to or received from a tax authority

get

https://api.test.ecosio-hub.com:{port}/api/v1/documents/{messageId}

This ZIP file contains the original invoice, detailing the transactions, and an acknowledgment confirming receipt of the invoice. Contents may vary by country.

In the Outbound Flow for sending invoices to tax authorities, the final file represents the invoice mapped to meet the receiver's requirements. The original file is your source file sent to ecosio.

Country	Invoice PDF	Original	Final	Extra Files
Belgium	{id}_generated.pdf (if available)	{id}_original.*	{id}_final.xml	{id}_ack.xml
Denmark	{id}_generated.pdf (if available)	{id}_original.*	{id}_final.xml	{id}_ack.xml
Germany	{id}_generated.pdf (if available)	{id}_original.*	{id}_final.* xml or pdf (ZUGFeRD)	{id}_ack.json or {id}_ack.xml
Italy	{id}_generated.pdf (if available)	{id}_original.*	{id}_final.xml	{id}_ack.xml
Malaysia	{id}_generated.pdf (if available)	{id}_original.*	{id}_final.xml	{id}_ack.json
Romania	{id}_generated.pdf (if available)	{id}_original.*	{id}_final.xml	{id}_ack.xml {id}_final.pdf {id}_final_signature.xml
Spain	{id}_generated.pdf (if available)	{id}_original.*	{id}_final.xml	{id}_ack.xml
Other	{id}_generated.pdf (if available)	{id}_original.*	{id}_final.*	{id}_ack.txt (if available)

In the Inbound Flow for receiving invoices from tax authorities, the original file is the invoice sent to ecosio's system, and the final file is the invoice from your counterpart.

Country	Invoice PDF	Original	Final	Extra Files
Belgium	{id}_generated.pdf (if available)	{id}_original.xml	{id}_final.*	N/A
Denmark	{id}_generated.pdf (if available)	{id}_original.xml	{id}_final.*	N/A
Germany	{id}_generated.pdf (if available)	{id}_original.* xml or pdf (ZUGFeRD)	{id}_final.*	N/A
Italy	{id}_generated.pdf (if available)	{id}_original.xml	{id}_final.*	N/A
Malaysia	{id}_generated.pdf (if available)	{id}_original.xml	{id}_final.*	N/A
Romania	{id}_generated.pdf (if available)	{id}_original.xml	{id} _final.*	{id}_original.pdf {id}_original_signature.xml
Other	{id}_generated.pdf (if available)	{id}_original.*	{id}_final.*	{id}_ack.txt (if available)
The ZIP file can only be successfully downloaded when the message is in a final state or was already in DELIVERED_API, DELIVERED_SFTP or DELIVERED_WEB.

Responses

202

ACCEPTED.

The message is not yet in a final state. Please try again later.

Code	Name	Description
101	USER_KEY_INVALID	The user provided a wrong user key (deprecated)
104	USER_NOT_PERMITTED	The user authenticated successfully but has no rights to fulfill the requested task

200OK. The Zip file for this e-invoice with all relevant documents.

400BAD REQUEST In case an error occurred during the processing of the request.

401UNAUTHORIZED In case the authentication credentials are not valid CodeNameDescription102CREDENTIALS_INVALIDThe provided credentials are invalid

403FORBIDDEN. In case the user could not be authenticated CodeNameDescription101USER_KEY_INVALIDThe user provided a wrong user key (deprecated)104USER_NOT_PERMITTEDThe user authenticated successfully but has no rights to fulfill the requested task

404NOT FOUND. In case the message could not be found

409CONFLICT. CodeNameDescription409MESSAGE_NOT_IN_APPROPRIATE_STATEThe message is not in a state where the documents can be processed. Please retry the request later after the documents have been collected.

500INTERNAL SERVER ERROR. CodeNameDescription300INTERNAL_SERVER_ERRORAn unexpected error occurred while processing the request. Please contact [email protected] to gain updates on the cause of the error (deprecated)