Revenue summary (actuals)

get

https://{tenant}.latner.app/api/external/v1/reporting/revenue-summary/

Get an aggregated revenue summary for Completed/Paid invoices, optionally grouped by any combination of the dimensions listed under group_by. All amounts are tax-exclusive (invoice sub-total); each row's measures are revenue and credits (gross buckets) plus net_revenue (revenue minus credits).

This is the actuals counterpart to the two forecast endpoints. All three share the same {dimensions, measures} row shape and the same group_by dimensions, so the same question can be asked of each and the answers joined on the *_id keys.

from_date is required and the window is capped at 12 months; ask for a longer period in several calls. Rows are paginated, so a wide group_by returns many pages - follow next until it is null before totalling anything.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from_date

string

required

Start of the window (YYYY-MM-DD). Required.

group_by

string

Comma-separated dimensions to group by. Allowed: month, year, branch, customer, line_type, equipment_category, equipment_class, equipment_model. Omit for a single whole-period total. Each entity dimension expands to three keys under dimensions: <dimension>_id, which is stable across renames and is what to join on, plus its labels -- _name and _description, or _code and _name for customer. year and line_type are single scalar keys (line_type is an enum, so its code is the key); month always comes with year alongside it, so a month bucket is unambiguous across years. A dimension is null where the line has none (e.g. a non-equipment line grouped by equipment_model), so the rows still sum to the ungrouped total.

page

integer

A page number within the paginated result set.

page_size

integer

Number of results to return per page.

to_date

string

End of the window (YYYY-MM-DD). Defaults to today. At most 12 months after from_date.

Responses

200

400The request body or query parameters failed validation. Body failures are keyed by field name, query-string failures by parameter name.

401The token is missing, malformed, expired, or not signed for this environment. Obtain a new access token - see Get Access Token via Kinde - rather than retrying.

403The token is valid, but the account behind it does not hold the permission this endpoint requires, or the record is outside the branches it can act in. Ask your Latner contact to grant the permission; retrying will not help.

429Rate limit exceeded: 60 requests per minute per account. The limit is shared by every token issued to the same service account or user, not counted per token. The response carries a Retry-After header with the number of seconds to wait.