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
Whencompany-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
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
- Use
GET /public/v1/exports/typesto discover active export types for the authenticated company. - Queue an export with
POST /public/v1/exports/requests. - Poll
GET /public/v1/exports/requests/{exportRequestId}untilstatusiscompleted,failed,canceled,expired, ordeleted. - Download the file through the signed
data.exportRequest.file.downloadUrlwhile it is present and beforefile.expiresAt. - Optionally retry failed or completed jobs, cancel queued or running jobs, or delete terminal jobs to clear their public file URL.
List export types
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
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.
List export requests
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 requireexports: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.