v1

latestOpenAPI 3.0.32026-07-26362271803.3 KB

Accounts Receivable

Preview invoice report

Execute invoice report preview from query params.

:param request: HTTP request with report configuration :return: Paginated response or CSV stream

get/coa/api/v1/invoice/report/preview

Query parameters

aggregation_fieldsstring

Aggregates: sum:amount, sum:amount_paid, sum:amount_due, etc.

client_idstring

Filter by client ID(s)

contract_idstring

Filter by contract ID(s)

currencystring

Filter by currency code

department_idstring

Filter by department ID(s)

end_datestring

End date (YYYY-MM-DD)

entity_idstring

Entity ID(s), comma-separated

group_fieldsstring

Row dimensions: client_id, invoice_id, invoice_date_month, product_id, etc.

group_keysstring

Drilldown parent keys

include_totalsboolean

Include grand totals row

limitinteger

Page size (max 10000)

modestring

paginated | full | csv

offsetinteger

Pagination offset

payment_statusstring

Filter by status: draft,open,sent,partial,paid,uncollectible

pivot_fieldsstring

Column dimensions: product_id, client_id, etc.

product_idstring

Filter by product ID(s)

shouldPivotboolean

Enable pivot columns

start_datestring

Start date (YYYY-MM-DD)

Response

countinteger required

Total rows before pagination

nextstring nullable required

Next page URL (null for datatable pagination)

previousstring nullable required

Previous page URL

engine_used'postgres' required

postgres - postgres

pivot_result_fieldsstring[]

Sorted list of pivot column names

totals_rowobject

Grand totals across all rows

pivot_value_mappingsobject

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