Download the invoice file

Changed on

Streams the generated file against a signed link: the XRechnung XML (the legal artifact) for an XRechnung invoice, the hybrid PDF/A-3 with embedded XML for ZUGFeRD, or the plain PDF. With variant=preview it streams the PDF visualisation of an XRechnung XML. Use the download_url (or preview_url) an Invoice response or email carries; it expires at its download_url_expires_at and can be revoked.

get/api/v1/invoices/{id}/download

Request

Path parameters

idstring uuid required

Query parameters

tstring required

Signed link token, as carried by download_url

variant'preview'

The PDF visualisation of an XRechnung XML

Response

Invoice bytes: the XRechnung XML, a ZUGFeRD or plain PDF, or (variant=preview) the PDF visualisation

Changes

    • breaking

      added the new required query request parameter t

    • info

      added the new optional query request parameter variant

    • info

      added the media type application/xml for the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status