Export Purchase Invoices
GET/api/purchase-invoices/list/export
Export purchase invoices as XLSX or CSV.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Response: Binary file download (xlsx or csv). Not a JSON response.
Column keys: id, supplier_invoice_number, purchase_order_number, supplier_name, status, purchase_invoice_date, due_date, other_date, currency_code, calculated_total, tax_total, total_paid, created_at, updated_at, archived_at.
In line_items mode, additional columns are added for each line: item_sku, item_name, item_quantity_invoiced, item_amount, item_line_total.
Request
Responses
- 200
- 401
- 403
- 429
OK
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.
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.