Execute Custom Report
Execute custom report and return DataTable-compatible response.
:param request: HTTP request with query params :param pk: Custom report ID :return: Paginated, sparse-formatted response
Authorizations
Token-based authentication with required prefix "Token"
Path Parameters
Query Parameters
Account ID(s), comma-separated
Account subtype(s)
Account type(s), comma-separated (e.g. REVENUE,EXPENSE)
Override saved aggregates: comma-separated fn:field pairs (e.g. sum:net_debit,sum:net_credit)
Bank account ID(s), comma-separated
Currency code(s), comma-separated
Department ID(s), comma-separated
End date (YYYY-MM-DD)
Entity ID(s), comma-separated
Override saved row dimensions, comma-separated (e.g. vendor_id,account_id)
Drilldown parent keys
Include grand totals row
Journal type(s), comma-separated
Page size (max 10000)
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.
Only rows without a department
Only rows without tags
Only rows without a vendor
Pagination offset
Override saved column dimensions, comma-separated (e.g. date_month)
Enable pivot columns
Include zero-balance rows (defaults to the saved report's setting)
Sort by column id; prefix with '-' for descending
Start date (YYYY-MM-DD)
Tag ID(s), comma-separated
Tag group ID(s), comma-separated
Vendor ID(s), comma-separated
Response
Output schema for custom report data responses.
Total rows before pagination
Next page URL (null for datatable pagination)
Previous page URL
Result rows: group field values plus one key per aggregate/pivot column (sparse — zero pivot values omitted)
Execution engine used (absent on flat responses from reports without groupings/aggregations)
postgres- postgrespandas_pivot- pandas_pivot
postgres, pandas_pivot Grand totals across all rows (include_totals=true)
Sorted list of pivot column names
Mapping of pivot field -> {display_name: id} for drilldown