Upload Sales Invoice Document
POST/api/sales-invoices/:salesInvoice/documents
Attach a file to the invoice. Send as multipart/form-data.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
file(required): accepted types pdf, jpg, jpeg, png, gif, webp, heic, doc, docx, xls, xlsx, csv, txt, html, htm, eml, msg, zip; maximum 20 MB. The extension decides the type; files whose contents are an executable or script are rejected whatever they are named.description(optional, up to 2,000 characters): what the file is and where it came from.
Returns the stored document. Returns 422 on an order invoice (kind order_mirror) — attach the file to the sales order instead.
Requires orders:write and sales_invoices.update.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.