Get Forecasted Balances
GET {{base_url}}/forecasting/v2/balances
'Get Forecasted Balances' will return all the forecasted balances for the provided forecast id.
Query Parameters
| Field | Type | Description |
|---|
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| forecastId | string | Unique identifier for the forecast |
| pageId | string | Page offset of results |
| from | dateTime | Returns balances posted on or after from date |
| to | dateTime | Returns balances posted on or before to date |
Attributes
| Field | Type | Description |
|---|
| id | string | Unique identifier for the balance |
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| forecastId | string | Unique identifier for the forecast |
| date | datetime | Balance date |
| currency | string | Balance currency |
| amount | integer | Balance amount |
| type | string | Transaction type {DEBIT,CREDIT} |
| source | string | Source of data import {MANUALIMPORT, MODEL} |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid accountId | 404 Not Found | |
| Invalid forecastId | 404 Not Found | |
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Invalid pageId | 400 Bad Request | |
Request Params
| Key | Datatype | Required | Description |
|---|
from | null | | Returns forecasted balances on or after "from" date |
to | null | | Returns forecasts balances until "to" date |
bankId | null | | Unique identifier for the bank |
accountId | null | | Unique identifier for the bank account |
forecastId | null | | Unique identifier for the forecast |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-partner-id | string | | |
X-Api-Key | string | | |
Authorization | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
{"results":[{"id":"90044386-1c09-40bf-b75f-622555da29f5","bankId":16,"accountId":"accountId1234","forecastId":"forecastId1234","date":"2020-11-30T03:59Z","amount":"100000.00","currency":"GBP","type":"CREDIT","source":"MANUALIMPORT"},{"id":"6cb6c2d1-5b8e-4efc-8e69-7e051a6c3820","bankId":18,"accountId":"accountId2345","forecastId":"forecastId2345","date":"2020-12-30T03:59Z","amount":"110000.00","currency":"GBP","type":"CREDIT","source":"MANUALIMPORT"}],"links":{}}