Aggregate Invoices

Aggregate invoices by group-by fields — ideal for dashboards, charts, and analytics.

Use this endpoint to build invoice status distributions, revenue charts by stage, or AR (accounts receivable) dashboards.

Request Body (AggregateRequest): Same as leads/aggregate.

Examples:

Invoices by stage: {"group_by_fields": ["stage"]}
Invoices by stage with amount: {"group_by_fields": ["stage"], "aggregate_field": "total_amount"}

post/crm/invoices/aggregate

Request

Base URL
https://fapi.ambivo.com (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/ambivo/apis/ambivo-api/docs/crm/invoices/aggregate/post.ts
A function with typed inputs. Its response is checked against the schema.

group_by_fieldsstring[] required

Fields to group by, e.g. ["lead_status"], ["stage", "marketing_source"]

aggregate_fieldstring nullable

Numeric field to aggregate, e.g. "value_of_sale", "estimated_budget"

match_filter_dictstring nullable

JSON-stringified MongoDB filter to narrow the dataset before aggregation

sort_dictstring nullable

JSON-stringified sort criteria, e.g. {"count": -1}

page_sizeinteger

Maximum number of groups to return

page_numinteger

Page number (1-indexed)

Successful Response

total_groupsinteger

Total number of groups returned

aggregate_fieldstring nullable

The numeric field that was aggregated

group_by_fieldsstring[]

Fields that were grouped by

No recorded changes to this operation across all 1 revision of this API.