Skip to main content
GET
Execute Custom Report

Authorizations

Authorization
string
header
required

Token-based authentication with required prefix "Token"

Path Parameters

id
integer
required

Query Parameters

account
string

Account ID(s), comma-separated

account_subtype
string

Account subtype(s)

account_type
string

Account type(s), comma-separated (e.g. REVENUE,EXPENSE)

aggregation_fields
string

Override saved aggregates: comma-separated fn:field pairs (e.g. sum:net_debit,sum:net_credit)

bank
string

Bank account ID(s), comma-separated

currency
string

Currency code(s), comma-separated

department
string

Department ID(s), comma-separated

end_date
string

End date (YYYY-MM-DD)

entity
string

Entity ID(s), comma-separated

group_fields
string

Override saved row dimensions, comma-separated (e.g. vendor_id,account_id)

group_keys
string

Drilldown parent keys

include_totals
boolean

Include grand totals row

journal_type
string

Journal type(s), comma-separated

limit
integer

Page size (max 10000)

mode
string

paginated | full | csv. full returns unpaginated JSON for grouped reports; reports without groupings/aggregations stay paginated in JSON — use csv, which streams the complete report as a CSV attachment, for a full flat export.

no_department
boolean

Only rows without a department

no_tag
boolean

Only rows without tags

no_vendor
boolean

Only rows without a vendor

offset
integer

Pagination offset

pivot_fields
string

Override saved column dimensions, comma-separated (e.g. date_month)

shouldPivot
boolean

Enable pivot columns

show_empty_lines
boolean

Include zero-balance rows (defaults to the saved report's setting)

sort
string

Sort by column id; prefix with '-' for descending

start_date
string

Start date (YYYY-MM-DD)

tag
string

Tag ID(s), comma-separated

tag_groups
string

Tag group ID(s), comma-separated

vendor
string

Vendor ID(s), comma-separated

Response

Output schema for custom report data responses.

count
integer
required

Total rows before pagination

next
string | null
required

Next page URL (null for datatable pagination)

previous
string | null
required

Previous page URL

results
object[]
required

Result rows: group field values plus one key per aggregate/pivot column (sparse — zero pivot values omitted)

engine_used
enum<string>

Execution engine used (absent on flat responses from reports without groupings/aggregations)

  • postgres - postgres
  • pandas_pivot - pandas_pivot
Available options:
postgres,
pandas_pivot
totals_row
object

Grand totals across all rows (include_totals=true)

pivot_result_fields
string[]

Sorted list of pivot column names

pivot_value_mappings
object

Mapping of pivot field -> {display_name: id} for drilldown