Skip to main content
POST
What the suppliers are likely to invoice over the coming months, from the invoices accepted

Headers

Prefer
enum<string>

Preference

Available options:
params=single-object

Body

What the suppliers are likely to invoice over the coming months, from the invoices accepted against past work orders.

Two halves, returned side by side and never blended. planned is the rounds the active maintenance plans will raise in the horizon, each priced at what that plan has been invoiced on that asset per completed round over the look-back (falling back to the plan's average across its assets). A round the plant has done itself has been invoiced nothing and costs nothing here. run_rate is everything with no round behind it — breakdowns and ad-hoc jobs — as the look-back's monthly average carried forward. unpriced_rounds counts rounds of plans with no completed round in the look-back, which are in no amount. estimated_rounds counts rounds placed by extrapolating a meter rather than by a calendar.

One row per group — TOTAL, SITE, VENDOR, ASSET_CATEGORY or ASSET — with months holding each month of the horizon in order, so every group has every month. The horizon starts on the first of next month. Largest total first. Amounts are in the organisation's counting currency; invoices with no conversion into it are left out and counted by api.vendor_spend_forecast_basis.

p_group_by
string<text>
p_lookback_months
integer<integer>
p_months
integer<integer>
p_site_id
string<uuid>

Response

200

OK