Authentication

OAuth2
- OAuth2post

Customers API

Manage Customers

Connect API

Create a Connection
Manage a Connection
Ingest First Party Data

Financial Data API

Retrieve Financial Data
Correct Financial Data

Enrichment API

Enrichment Totals
Enrichment Resources

Smart Finders API

Regular Payments Finder
- Retrieve Regular Transactionsget
- Retrieve Future Forecasted Transactions V2get
Income Finder
Loan Finder
- Retrieve Loan Transactionsget
Debt Collection Finder
- Retrieve Debt Collection Transactionsget
Product Finder
- Retrieve Financial Products V2get
Subscription Finder
- Retrieve Subscriptionsget

Goals API

Savings Goals
Spending Budgets

Insights API

Retrieve Actionable Insights
Custom Insights
Frontend Widgets

Characteristics API

Retrieve Customer Characteristics

Intelligent Search API

Transaction Search

Assess API

Customer Applications
Customer Application Links
- Retrieve Customer Application URLpost
Aggregation Buckets
Retrieve Affordability Report
Retrieve Affordability Report V2
- Retrieve Affordability Report V2get
Retrieve Affordability Risk Insights

Create Spending Budget

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

Create a spending budget.

Body Params

name

string

required

The name of the spending budget.

Example: Travel

amount

object

required

The amount of money to be budgeted for. Must be greater than 0.

recurrency

object

required

Whether and/or how often the budget recurs.

The starting_day is only required for budgets with a recurring period e.g. monthly

New periods may be added without a breaking change notice.

account_id

string

The account id of the account the spending budget is associated with.

Only transactions from this account will be included in budget calculations.

Example: RxsYshVGded4JeilkXgWKdXA

include

object

The inclusion criteria for transactions to be included in the budget.

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.

Responses

Response body

object

operation_id

string

required

goals_v1_spending_budgets_post

data

object

required

name

string

required

The name of the spending budget.

Example: Travel

amount

object

required

The amount of money to be budgeted for. Must be greater than 0.

recurrency

object

required

Whether and/or how often the budget recurs.

The starting_day is only required for budgets with a recurring period e.g. monthly

New periods may be added without a breaking change notice.

account_id

string

The account id of the account the spending budget is associated with.

Only transactions from this account will be included in budget calculations.

Example: RxsYshVGded4JeilkXgWKdXA

include

object

The inclusion criteria for transactions to be included in the budget.

string

required

The ID of the spending budget.

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

spent

object

required

The amount of money spent from the budget for the given time period.

created_at

string

required

The date and time the budget was created in the format RFC-3339.

Example: 2023-10-17T00:00:00Z

_links

object

Useful follow up links

Response body

object

operation_id

string

required

A unique identifier/reference associated with a given endpoint/operation

code_id

string

required

A descriptive enough string that is linked to the reason for the error.

message

string

required

errors

required

Response body

object

operation_id

string

required

A unique identifier/reference associated with a given endpoint/operation

code_id

string

required

A descriptive enough string that is linked to the reason for the error.

message

string

required

An actual user friendly error message.

errors

Response body

object

operation_id

string

required

A unique identifier/reference associated with a given endpoint/operation

code_id

string

required

A descriptive enough string that is linked to the reason for the error.

message

string

required

An actual user friendly error message.

errors

Updated over 1 year ago

Remove Savings Goal Action

Retrieve Spending Budgets

Did this page help you?

Language

Credentials

OAuth2

Bearer


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api-sandbox.thisisbud.com/goals/v1/spending-budgets \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Choose an example:

application/json

Updated over 1 year ago

Remove Savings Goal Action

Retrieve Spending Budgets

Did this page help you?

Authentication
OAuth2
OAuth2post

Customers API
Manage Customers
Update Customer Contextput
Retrieve Customer Contextget
Retrieve Remove Customer V3 Statusget
Remove Customer V3delete
Create Customers V3 (Batch)post
Retrieve Customers V3get
Create Customer V3post

Connect API
Create a Connection
Retrieve Connection Statusget
Retrieve Authorisation Gateway URL (v2)post
Retrieve Bank Providersget
Manage a Connection
Retrieve Revoke Consent Statusget
Initiate Revoke Consentpost
Retrieve Customer Consentsget
Retrieve Refresh Status V2get
Initiate Refresh V2post
Retrieve Refresh Statusget
Initiate Refreshpost
Ingest First Party Data
Retrieve Ingestion Task Statusget
Decline Transactionspost
Book Transactionspost
Ingest Transactionspost
Ingest Accountspost

Financial Data API
Retrieve Financial Data
Retrieve Enriched Transactions V2get
Retrieve Account By ID V2get
Retrieve Balances Over Time By Account V3get
Retrieve Balances Over Time V3get
Retrieve Balances Over Time By Accountget
Retrieve Balances Over Timeget
Retrieve Accounts V2get
Retrieve Account By ID V3get
Retrieve Accounts V3get
Correct Financial Data
Suggests changes to a merchantpost
Similar Transactions Including Merchantsget
Similar Transactionsget
Fetch custom merchants for customerget
Create a new custom merchantpost
Correction Merchant Searchget
Correct Transaction Merchantpost
Correct Transaction Categories V2post

Enrichment API
Enrichment Totals
Retrieve Merchant Totals V2get
Retrieve Statistics For Essential Total Spendget
Retrieve Category Totals Trendsget
Retrieve Category Totals V2get
Enrichment Resources
Retrieve Categoriesget
Retrieve Categories V2get
Retrieve Available Categorisation Models V2get

Smart Finders API
Regular Payments Finder
Retrieve Future Forecasted Transactions V2get
Retrieve Regular Transactionsget
Income Finder
Retrieve Benefits Totalsget
Retrieve Benefits Transactionsget
Retrieve Income Transactions V2get
Loan Finder
Retrieve Loan Transactionsget
Debt Collection Finder
Retrieve Debt Collection Transactionsget
Product Finder
Retrieve Financial Products V2get
Subscription Finder
Retrieve Subscriptionsget

Goals API
Savings Goals
Remove Savings Goal Actiondelete
Update Savings Goal Actionpatch
Retrieve Savings Goal Actionsget
Create Savings Goal Actionpost
Remove Savings Goaldelete
Update Savings Goalpatch
Remove All Savings Goalsdelete
Retrieve Savings Goalsget
Create Savings Goalpost
Spending Budgets
Retrieve Spending Budget Transactionsget
Delete a Spending Budgetdelete
Patch a Spending Budgetpatch
Delete all Spending Budgetsdelete
Retrieve Spending Budgetsget
Create Spending Budgetpost

Insights API
Retrieve Actionable Insights
Retrieve Spending Actionable Insight Detailsget
Retrieve Spending Actionable Insightsget
Retrieve Income Actionable Insight Detailsget
Retrieve Income Actionable Insightsget
Retrieve Balances Actionable Insight Detailsget
Retrieve Balances Actionable Insightsget
Custom Insights
Retrieve custom insights profileget
Build custom insights profilepost
Delete all existing custom insightsdelete
Update existing custom insightpatch
Delete existing custom insightdelete
Detail the transactions used to generate a custom insightget
List existing custom insightsget
Create new custom insightpost
Frontend Widgets
Generate Spending Analysis URLpost
Generate Recurring and Forecasted Transactions URLpost
Generate Balances Over Time URLpost
Generate Financial Calendar URLpost
Generate Card Summary URLpost

Characteristics API
Retrieve Customer Characteristics
Retrieve Customer Characteristics - Saverget
Retrieve Customer Characteristics - Overdraftget
Retrieve Customer Characteristics - Loanget
Retrieve Customer Characteristics - Credit Cardget
Retrieve Customer Characteristicsget

Intelligent Search API
Transaction Search
Get transactions used by the search insight.get
Get transaction search insight.get
Get transaction search by ID.get
Search customer transactions.get
Create Intelligent Search Frontend Widget URLpost

Assess API
Customer Applications
Delete Customer Applicationdelete
Retrieve Customer Applicationget
Retrieve Customer Applicationsget
Create Customer Applicationpost
Customer Application Links
Retrieve Customer Application URLpost
Aggregation Buckets
Retrieve Bucket Totalsget
Delete Bucketsdelete
Update Bucketput
Retrieve Bucketget
Retrieve All Bucketsget
Create Bucketspost
Retrieve Affordability Report
Retrieve Affordability Transactions V2get
Retrieve Affordability Transactionsget
Retrieve Affordability Reportget
Retrieve Affordability Report V2
Retrieve Affordability Report V2get
Retrieve Affordability Risk Insights
Retrieve transactions relating to a specific insight report section.get
Retrieve a health report on a customers financial profile.get
Retrieve transactions relating to a specific insight report section.get
Retrieve a report on a customers unauthorised overdraft.get
Retrieve transactions relating to a specific insight report section.get
Retrieve merchant-specific breakdown reports.get
Retrieve transactions relating to a specific insight report section.get
Retrieve income/expenditure break down reportsget

201Created - The budget was created successfully.

400The request contains an invalid payload.

401Unauthorized - The request was not authorised.

500Internal Server Error - An unexpected error occurred.