Retrieve Spending Budget Transactions

get

https://api-sandbox.thisisbud.com/goals/v1/spending-budgets/{budget_id}/transactions

Retrieve all of the transactions associated with a spending budget. The results of this endpoint are paginated with a default page size of 100 and a maximum of 200. The page size is configurable by the page_size query parameter. The next page of results can be retrieved using the page_token query parameter.

Account IDs can be supplied as part of the URL query to filter transactions to those only associated with the specified accounts. If no account IDs are specified, we will return transactions associated with all of the customer's accounts, relevant to the spending budget.

Path Params

budget_id

string

required

The ID of the spending budget.

Example: 81a68821-dca6-4771-80d4-002c7fce412e

Query Params

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

page_token

string

Use this paramater to fetch a specific page of results. Provided by the next_page_token field in the previous request.

page_size

integer

Use this parameter to set the maximum number of results to be returned. This defaults to 100, and has a maximum of 200.

account_id

string

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

Example: RxsYshVGded4JeilkXgWKdXA

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

200OK - The spending budget transactions were retrieved successfully

400The request contains an invalid payload.

401Unauthorized - The request was not authorised.

500Internal Server Error - An unexpected error occurred.