Account Budget Summary Get

Retrieve account-scoped aggregate budget totals across every accessible, Budget Forecast-enabled client.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Reporting cadence for the forecast columns. One of Quarter, Year, or Month. Month is available only to accounts enrolled in monthly budgeting.

Allowed:
int32
1 to 12

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

date-time

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

boolean

Include items whose status is overdue. Defaults to true.

boolean

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

string
^(eq|in):.+$

Budget type filter using the "eq:" or "in:" operator.

string
^(eq|in):.+$

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

string
^(eq|in):.+$

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

string
^(eq):.+$

Third-party contract flag filter using the "eq:" operator.

string
^(cont|eq):.+$

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

boolean

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

boolean

When true, INITIATIVE totals are split into one row per initiative status with a non-null initiative_status discriminator.

filter[client.segment_id]
array of strings

Narrows results to clients in any supplied segment. Repeat eq: for each segment, or use in: with a
comma-separated list. Use null:true to match clients with no segment; combined with ids it matches either.

filter[client.segment_id]
filter[client.vertical_id]
array of strings

Narrows results to clients in any supplied vertical. Repeat eq: for each vertical, or use in: with a
comma-separated list. Use null:true to match clients with no vertical; combined with ids it matches either.

filter[client.vertical_id]
filter[client.client_access_group_id]
array of strings

Narrows results to clients in any supplied client access group. Repeat eq: for each group, or use in: with
a comma-separated list. Use null:true to match clients with no access group; combined with ids it matches
either.

filter[client.client_access_group_id]
Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json