Docs

Download a generated document or the route's receipt

  • In the sandbox

In plain words

Returns a stored document: the JSON as received, the built file, the validation report or the route's receipt.
GET
/invoices/{id}/documents/{kind}

Kinds: canonical (the JSON as received), erp-export (an ERP export as the ERP sent it), the file as sent (ubl, cii, fa3, pdf), the built document (xrechnung-ubl for Germany, ubl or fa3 otherwise), validation-report and manifest (the SHA-256 of the bytes that go to the route, and the layers that checked them). The four JSON kinds are served as application/json. The ETag is the SHA-256.

Authorization

apiKey
headerAuthorizationBearer <token>

Send your key as a bearer token: Authorization: Bearer <your-api-key>. Health is the only call that needs no key.

Path parameters

id*string

The invoice id returned by the submit call.

Match^inv_[A-Za-z0-9]{16,40}$
kind*string

Which document to fetch.

Value in"ubl""cii""fa3""facturx""pdf""route-receipt""validation-report""manifest""canonical""erp-export"

Response body

The file. ETag is its SHA-256.

response?string
curl -X GET "https://example.com/invoices/inv_bd8bc8b276f38643f1c0f24f/documents/ubl" \  -H "Authorization: Bearer <your-api-key>"
{}