Retrieve Financial Forecast

get deprecated

https://api-sandbox.thisisbud.com/v1/signal/forecast

Provides a list of the regular and predicted transactions over a given period, noting whether they are booked, pending or predicted.

Deprecation:

Support will cease for this endpoint on the 1st of December 2023 - please complete your migration to the Retrieve Forecasted Transactions V2 endpoints 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…

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

string

Date (YYYY-MM-DD) from which the transactions should be returned from, this works in pair with the 'X-To' parameter

X-To

string

Date (YYYY-MM-DD) from which the transactions should be returned to, this works in pair with the 'X-From' parameter

X-Delta

number

≥ 0

Defaults to 3

Number of days error to match regular payments when they could be off by a few days from month to month. E.g. if your predicted rent payment is on 25th but you paid it on 23rd, a delta of 2 would treat your predicted transaction for 25th as Booked/Pending.

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