Download credit note XML

GET 
/api/v3/credit-notes/:credit_note_id/xml

Required scopes: billing:read

Download the XML file of a Credit note

Not available to sub-accounts: the response is 403 (error 1601).

Request

Responses

200

OK (file download)

Response Headers

Content-Length

File size in bytes.

Content-Disposition

Filename and content disposition (attachment).

Last-Modified

File last modified datetime.

Cache-Control

Cache directive.

X-Content-Type-Options

Mime sniffing protection.

400

The request is not valid: error 1000 with the errors for each field in meta.errors, error 1001 (or 1) for other invalid input

401

The access token is missing, invalid, expired or revoked (error 1100): request a new token and retry once

403

The access token is valid but not enough: missing scope (error 1101), token for the other API (error 1102), missing permission, feature not included in the plan, operation not available to sub-accounts, internal API without administrator privileges or IP address not allowed (error 1601). A new token does not change the result

404

The resource does not exist or does not belong to the account (error 1200)

429

Too many requests (error 1300): retry after the seconds in the Retry-After header

Response Headers

Retry-After

Seconds to wait before retrying

500

Unexpected server error (error 1500)