Exports

Base URL: $BUSINESS_API

Download a completed report execution as CSV

Logs

GET /exports/{id}.csv

When the execution has a locale, the header row and known enum values (status, method, category, ageing band…) are labelled in that language; unknown values pass through. raw=true returns the stored file with snake_case column keys and raw values, for machine use.

Parameters

idstring · path · required

Execution id

rawboolean · query · optional · default false

true returns column keys and raw values regardless of the execution's locale.

Returns

200 text/csv

Errors 403 · 404

Permissions reports:read · Roles: admin, analyst, finance, owner

curl -X GET "$BUSINESS_API/exports/{id}.csv" \
  -H "Authorization: Bearer sk_test_..."
Response 200

text/csv

Download a completed report execution as PDF

Logs

GET /exports/{id}.pdf

Renders the stored CSV of a completed report run as a PDF with the tenant's issuer details, the report definition's name and description, and column labels and values in the caller's language; it is served inline. Runs that are not completed, or whose export file is missing or empty, return 404. Requires the reports:read permission.

Parameters

idstring · path · required

Execution id

layoutstring · query · optional · default a4

Page format. mobile is one narrow column sized to its content, for reading on a phone. An unknown value renders A4.

one of a4, mobile

Returns

200 PDF document

Errors 403 · 404

Permissions reports:read · Roles: admin, analyst, finance, owner

curl -X GET "$BUSINESS_API/exports/{id}.pdf" \
  -H "Authorization: Bearer sk_test_..."
Response 200

PDF document