Skip to main content
To export data, queue an asynchronous export request, poll its status, and read a temporary downloadUrl when the request is completed. Export types can expose xlsx, csv, or zip formats. The authenticated company and Public API client are always derived from the Bearer token. Public API clients can only see export requests that they created themselves. Software-created export requests, requests created by other Public API clients, raw params, metadata, internal actor fields, provider payloads, and internal error details are not exposed. Legacy direct XLSX routes and coach export templates are not part of the Public API.

Scopes

Integrations that create an export and later poll for status or download metadata need both scopes.

Accounting package

When company-accounting-zip is available in the export catalog, request it with options.format set to zip and both params.dateFrom and params.dateTo as inclusive YYYY-MM-DD dates. The maximum range is 366 days between the two dates. The package covers the authenticated company.
cURL
Poll the returned request ID with the standard workflow below. A completed package has a temporary signed download URL and a seven-day file lifetime. Keep the export request ID so an interrupted workflow can resume polling the same request. All original invoice PDFs must be available: an unavailable PDF causes the request to fail instead of delivering an incomplete package. CSV files use stable English column keys, comma separators, a UTF-8 BOM and dot-decimal numbers. Text that could execute a spreadsheet formula is prefixed with an apostrophe. Date-only values remain YYYY-MM-DD; timestamps are UTC ISO 8601. Invoice lines are not limited to the page size of invoice API reads. Invoice selection uses invoice issue date, including credit notes. Transactions and Chargebacks use creation timestamps from dateFrom at 00:00:00Z through the day after dateTo, exclusively. Their rows can refer to invoices issued in another period. Creating a payment attempt is not proof of settlement. Credit-note amounts have the opposite sign to regular invoices; discount lines have the opposite sign to charge lines. Stored invoice totals are preserved. The VAT summary rounds the VAT-rate buckets within each invoice before summing the period, so rounding is not repeated across all invoices combined. Amounts use two decimals. Read warnings.csv before importing, especially when stored totals differ from calculated lines or rounded VAT-rate buckets. Issuer and external-recipient snapshots reflect the issued document. Where historical client identity is unavailable, recipientDataSource explicitly identifies a current client record or unavailable data. Ledger numbers and names come from the current company ledger. Empty fields represent unavailable data. Statuses reflect the time the export runs, rather than a historical period-end balance. The package does not infer open balances or include a normalized refund, provider fee or payout ledger. Use payment-provider records for those movements.

Workflow

  1. Use GET /public/v1/exports/types to discover active export types for the authenticated company.
  2. Queue an export with POST /public/v1/exports/requests.
  3. Poll GET /public/v1/exports/requests/{exportRequestId} until status is completed, failed, canceled, expired, or deleted.
  4. Download the file through the signed data.exportRequest.file.downloadUrl while it is present and before file.expiresAt.
  5. Optionally retry failed or completed jobs, cancel queued or running jobs, or delete terminal jobs to clear their public file URL.

List export types

Required scope: exports:read The response contains only export types that are active for the authenticated company and support asynchronous export in at least one configured format. Response fields:

Create an export request

Required scope: exports:write Request body: When a single-sheet export is requested as csv, the download is a .csv file. When a multi-sheet export is requested as csv, the download is a .zip file containing one CSV file per worksheet so no worksheet data is dropped.
Response:

List export requests

Required scope: exports:read Query parameters: Only requests created by the authenticated Public API client are returned.

Export request fields

GET /public/v1/exports/requests returns data.exportRequests[]. GET /public/v1/exports/requests/{exportRequestId} returns data.exportRequest. Example completed request:

Cancel, retry, and delete

All write actions require exports:write and an Idempotency-Key header. Empty request bodies are accepted. Software-created requests and requests from another Public API client are returned as not found for these actions.