Retrieve Affordability Report

get

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

Get an overview of a customer's financial status.

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 month_from/month_to dates relativised to the correct 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

Bud Customer identifier

X-Customer-Secret

string

The Bud Customer secret used to encrypt customer data. This is optional only if the customer secret is already stored with Bud (i.e. the host_secret was set to true in the Customer Context when the customer was created).

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

Language

Credentials

OAuth2

Response

Choose an example:

application/json

200The request was successfully processed