Reports

Pre-built and country-specific financial reports — income, expenses, AR aging, tax compliance.

3 endpoints·Scopes: reports:read, reports:write

GET/api/reports#

List reports

scope · reports:read

Lists reports the caller can see. Results are filtered by the caller's accessible organizations; many routes paginate via page and limit.

Scope: reports:read
Endpoint: GET /api/reports

curl "https://guliel.com/api/reports?organizationId=value" \
  -H "Authorization: Bearer $GULIEL_API_KEY"

successreq
boolean
reportsreq
array<object>Report definitions (name, description, parameters, columns). The full shape lives in src/lib/reports/types.ts:ReportDefinition.
organizationCountryreq
string

GET/api/reports/{reportType}#

Get a report

scope · reports:read

Fetches a single report by id. Returns 404 if the report isn't in the caller's accessible organizations.

Scope: reports:read
Endpoint: GET /api/reports/{reportType}

curl "https://guliel.com/api/reports/<reportType>?reportType=value" \
  -H "Authorization: Bearer $GULIEL_API_KEY"

successreq
boolean
datareq
objectGenerated report data — shape varies by report type (rows, totals, charts, etc.). See src/lib/reports/types.ts:ReportData and the per-report adapter in src/lib/reports/generators/.

GET/api/reports/{reportType}/schema#

List schema for a report

scope · reports:read

Returns every schema row associated with the given report.

Scope: reports:read
Endpoint: GET /api/reports/{reportType}/schema

curl "https://guliel.com/api/reports/<reportType>/schema?reportType=value" \
  -H "Authorization: Bearer $GULIEL_API_KEY"

successreq
boolean
definitionreq
objectReport definition (name, description, columns, parameters). See src/lib/reports/types.ts:ReportDefinition for the full shape.