Retrieve Balances Actionable Insights

get

https://api-sandbox.thisisbud.com/insights/v1/actionable/balances

Generate balances actionable insights.

Note:

For more information about Actionable Insights, please refer to our guide.

Query Params

from

string

A start time to check financial data for insights from. Configures the earliest financial data which may be used to generate insights. If omitted, defaults to the start of the sixth complete month prior to the latest ingested financial data. Note that some insights will only be checked for complete months entirely between the from and to dates.

string

An end time to check financial data for insights up to. Configures the latest financial data which may be used to generate insights. If omitted, defaults to the date of the latest ingested financial data. Note that some insights will only be checked for complete months entirely between the from and to dates. Insights relating to potential future events, such as cannot_cover_bills, may forecast them up to a month after this point.

enabled_insights

string

enum

A comma-separated list of insight types to check for. If not specified, a default list will be used, which may be added to over time.

Allowed:

close_to_credit_limit.percentage_utilisation_threshold

number

A minimum percentage utilisation of the credit limit for this insight to trigger. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

low_balance.balance_threshold

number

A balance threshold such that balances lower than this will trigger the low balance insight. If not specified, a configured value will be used. Please note that including this request on a customer level will increase latency of this endpoint. Instead, we recommend to update the thresholds for your organisation by raising a support request.

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.

Response

200OK