Long-range revenue forecast

get

https://{tenant}.latner.app/api/external/v1/reporting/long-range-revenue-forecast/

Get the long-range revenue forecast projected by reporting month, optionally grouped by any combination of the dimensions listed under group_by. The single measure revenue is tax-exclusive (sub-total).

Rows are keyed by reporting month: revenue from contracts running across several months is apportioned to the month it is expected to be earned in, not the month the contract started. How far ahead the projection runs is a tenant setting (12 months by default, at most 24), so the horizon differs between tenants.

Use Get Monthly Revenue Forecast for the current billing month in more detail, and Get Revenue Summary for invoiced actuals. All three share the same row shape and group_by dimensions, so their answers join on the *_id keys.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

from_date

string

Optionally limit to reporting months on/after this date (YYYY-MM-DD).

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

Optionally limit to reporting months on/before this date (YYYY-MM-DD).

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.