Payment schedules and reports
Export a report
GET/v1/reports/{name}
Coming the week of 25 January 2027
This endpoint ships in the week of 25 January 2027. The shape shown here can still change before release.
Downloads a report as a CSV or PDF file with the same numbers as the JSON report.
This is GET /v1/reports/{name} with format=csv or format=pdf. It takes the same filters as Get a report and returns a file instead of JSON. Exporting needs its own permission, reports.export, which the Accountant role has by default. See Reports.
- Permission
reports.export- Type
- Read-only. Changes nothing.
- Auth
- API key, MCP token or signed-in session
- Capability
export_report- CLI
freeinvoiceautomation report export- Available
- From the week of 25 January 2027
export_report
curl --request GET \
--url https://api.freeinvoiceautomation.com/v1/reports/<name> \
--header 'Authorization: Bearer <api-key>'period,currency,invoiced,paid
2027-01,USD,5400.00,3100.00
2027-02,USD,6200.00,5850.00Authorizations
Authorizationstringrequired
Bearer <api-key>. An API key from Settings > API keys, or an MCP token. See Authentication.Path Parameters
nameenum<string>required
Which report.
Available options: aged-receivables, outstanding-by-client, client-statement, revenue, tax-collected, payments-received
Query Parameters
formatenum<string>required
File format.
Available options: csv, pdf
business_idstring<uuid>
Business to report on. May be left out when you can reach exactly one business.
fromstring<date>
Start of the date range (
YYYY-MM-DD).tostring<date>
End of the date range (
YYYY-MM-DD).client_idstring<uuid>
Only this client. Required for
client-statement.currencystring
Only documents in this ISO 4217 currency.
Errors
Plus the common errors every call can return. See Errors.