Budget Summary Get

get

https://api.scalepad.com/lifecycle-manager/v1/budget/{client_id}/summary

Retrieve aggregate per-type totals for a client's budget forecast across the requested period window.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

client_id

string

required

The unique Core identifier of the client.

Query Params

frequency

string

enum

Reporting cadence.

Allowed:

period_count

int32

1 to 12

Number of periods to include; integer between 1 and 12 inclusive.

starting_date

date-time

Anchor date-time for the first period. Use midnight UTC when calling with a calendar-day anchor.

include_overdue

boolean

Include items whose status is overdue. Defaults to true.

include_not_scheduled

boolean

Include items whose status is not scheduled. Defaults to true.

filter[type]

string

^(eq|in):.+$

Budget type filter using the "eq:" or "in:" operator, e.g. eq:"INITIATIVE" or in:"INITIATIVE,CONTRACT".

filter[status]

string

^(eq|in):.+$

Initiative status filter using the "eq:" or "in:" operator.

filter[asset_type.id]

string

^(eq|in):.+$

Asset-type id filter for IT_DEBT rows using the "in:" operator.

filter[is_third_party]

string

^(eq):.+$

Third-party contract flag filter using the "eq:" operator, e.g. eq:true.

filter[name]

string

^(cont|eq):.+$

Name filter using the "cont:" or "eq:" operator.

it_debt_group_by_asset_type

boolean

When true, IT_DEBT totals are split into one row per asset type with a non-null asset_type discriminator.

Responses

200OK

400Bad Request

402Payment Required

403Forbidden

404Not Found