Download an invoice or a credit memo file

GET https://{{host}}/invoicing-api/v3/contracts/:contractId/invoices/:invoiceId/download?fileFormat={{fileFormat}}

Returns the content of the selected contract's invoice or credit memo file. The downloadable file is available in the response body. The Content-Type depends on the format of the file you're downloading.

Request Params

KeyDatatypeRequiredDescription
fileFormatstring(Required) Enum File format of the invoice. These are the available values: PDF, CSV, and JSON.
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK