Get Forecasted Balance (by id)
GET {{base_url}}/forecasting/v2/balances/:balanceId
'Get Forecasted Balance' will return the forecasted balance for the provided forecast id
Path variables
| Field | Type | Description |
|---|
| balanceId | string | Unique identifier for the balance |
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 balanceId | 404 Not Found | |
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Key | Datatype | Required | Description |
|---|
Content-Type | string | | |
X-partner-id | string | | |
X-Api-Key | string | | |
Authorization | string | | |
X-Company-Id | string | | |
RESPONSES
status: OK
"{\n \"id\": \"balanceId1234\",\n \"bankId\": 16,\n \"accountId\": \"accountId1234\",\n \"forecastId\": \"forecastId1234\"\n \"date\": \"2020-11-30T03:59Z\",\n \"amount\": \"100000.00\",\n \"currency\": \"GBP\",\n \"type\": \"CREDIT\",\n \"source\": \"MANUALIMPORT\"\n}\n"