Retrieve Affordability Report

get deprecated

https://api-sandbox.thisisbud.com/v1/affordability/report

Get an overview of a customer's financial status.

Deprecation:

Support will cease for this endpoint on the 31st of August 2025 - please complete your migration to the Retrieve Affordability Report V2 endpoint by that point in time. For further details, contact your Bud account manager or email [email protected].

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

month_from

string

Month (YYYY-MM) from which the transactions should be returned from, this works in pair with the month_to parameter.

month_to

string

Month (YYYY-MM) from which the transactions should be returned to, this works in pair with the month_from parameter.

timezone

string

Defaults to Etc/UTC

Timezone identifier (e.g. Europe/London) to make dates relativised to the target location.

In the case of daylight savings in a location, this ensures that the overall start/end date accounts for those shifts.

See here for list of valid timezone identifiers under TZ identifier.

overall_totals

boolean

If true, shows the overall totals in the affordability report (under overall_total property).

monthly_totals

boolean

If true, shows the monthly totals in the affordability report (under monthly_totals property).

currency

string

Currency code for relevant transactions (default GBP).

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

400

The request contains an invalid payload.

401

Unauthorised request

405

An unexpected HTTP method was used

5XX

An unexpected error occurred on the server side

200The request was successfully processed