Retrieve Spending Budgets

get

https://api-sandbox.thisisbud.com/goals/v1/spending-budgets

Retrieve all spending budgets.

Accounts IDs can be supplied as part of the URL query to return budgets with values filtered to the accounts IDs supplied. These budgets' spent amounts will only consider transactions associated with the specified accounts. If no account IDs are specified, the returned budgets will have a value combined from transactions across all of the customer's accounts.

Query Params

account_id

string

Use this parameter to filter the results on data associated with the given account id.

Example: RxsYshVGded4JeilkXgWKdXA

day

string

The day for which results are to be retrieved in the format RFC 3339.

Examples:

2023-01-17T17:29:51Z
2023-01-17T17:29:51-08:00

Headers

X-Client-Id

string

required

The API Client Identifier (Service Application Identifier).

X-Customer-Id

uuid

required

A unique identifier for a Customer, as registered on Bud's platform.

X-Customer-Idempotent-Identifier

string

Use the internal client identifier, provided in the client_metadata object when creating the customer in Create Customer V3, in place of an X-Customer-Id header.

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is required only if the customer secret is not already stored with Bud.

Responses

Language

Credentials

OAuth2

Response

Choose an example:

application/json

200OK - The spending budgets were retrieved successfully

400The request contains an invalid payload.

401Unauthorized - The request was not authorised.

500Internal Server Error - An unexpected error occurred.