Create Spending Groups

post deprecated

https://api-sandbox.thisisbud.com/v1/affordability/spending-groups

Provide a list of groups and categories to be returned as a breakdown of spending, along with all sources of income. If no groups are specified by the client, return default categories and groups.
The header parameters X-From-Month and X-To-Month allow you to filter the result to a specified range of months.

NOTE: Headers X-From and X-To are deprecated. The following headers should be used moving forward:

X-From-Month
X-To-Month

❗️ Deprecation:

Please note: support will cease for this endpoint on the 16/11/2023 - please complete your migration to the
aggregations_v2_buckets_post
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…

Body Params

The requested structure of the spend groups and their underlying categories.

Affordability Spending Groups Request Schema

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).

X-From-Month

string

Month (YYYY-MM) from which the transactions should be returned from, this works in pair with the X-To parameter.
This X-From-Month format of (YYYY-MM) will become the default format in 3 months see the release notes for more details.

Default behaviour: Set X-From-Month to be today's date minus 3 months.

X-To-Month

string

Month (YYYY-MM) from which the transactions should be returned to, this works in pair with the X-From parameter.
This X-To-Month format of (YYYY-MM) will become the default format in 3 months see the release notes for more details.

Default behaviour: Set X-To-Month to be today's date.

X-Currency

string

Defaults to GBP

ISO code for the currency of the transactions that will be aggregated over.

X-From

string

deprecated

Date (YYYY-MM-DD) from which the transactions should be returned from, this works in pair with the X-To parameter.
This X-From format of (YYYY-MM-DD) will still be backwards compatible for 3 months see the release notes for more details.
Header will be replaced by #/parameters/FromMonthSpendingGroups.

Default behaviour: Set X-From to be today's date minus 3 months.

X-To

string

deprecated

Date (YYYY-MM-DD) from which the transactions should be returned to, this works in pair with the X-From parameter.
This X-To format of (YYYY-MM-DD) will still be backwards compatible for 3 months see the release notes for more details.
Header will be replaced by #/parameters/ToMonthSpendingGroups.

Default behaviour: Set X-To to be today's date.

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

Loading…

Response

Choose an example:

application/json

200The request was successfully processed