Invoices

Export invoices to a spreadsheet

Export a selection of invoices to xlsx or csv and stream it back as an attachment.

  • Filter by invoice_ids, client_id, series_id, status, dates or search; format is SUMMARY or ITEMS.
  • Capped at 5,000 invoices: 422 export_limit_exceeded.
post/companies/{company}/invoices/export/excel

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/invoices/export/excel
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Headers

Idempotency-Keystring required
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

invoice_idsstring[] nullable

List of invoice IDs (UUID v7 values) to export. If omitted, exports the set matching the filters.

status'draft' | 'scheduled' | 'issued' | 'paid' | 'cancelled' | 'overdue' | 'annulled' | 'null' nullable

Invoice status to filter by (draft, scheduled, issued, paid, cancelled, overdue, annulled). sent is accepted as an alias of issued in every API version.

date_fromstring date-time nullable

Start of the issue-date range (inclusive).

date_tostring date-time nullable

End of the issue-date range (inclusive).

client_idstring uuid nullable

Client ID (UUID v7 value) to filter invoices by.

series_idstring nullable

Series ID (UUID v7 value) to filter invoices by.

searchstring nullable

Free-text search term (number, recipient, series).

format'SUMMARY' | 'ITEMS' | 'null' nullable

Content layout: SUMMARY (one row per invoice) or ITEMS (one row per line).

file_format'xlsx' | 'csv' | 'null' nullable

File format: xlsx or csv.

Changes

No recorded changes to this operation across all 1 revision of this API.