Get Forecasts
GET {{base_url}}/forecasting/v2/forecasts
Get all forecasts for the company. Each forecast has an id, timestamp, source and name.
Query parameters
| Field | Type | Description |
|---|
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| pageId | string | Page offset of results |
Attributes
| Field | Type | Description |
|---|
| id | string | Unique identifier for the forecast |
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| date | datetime | Date when the forecast was generated |
| source | string | Source of forecast {MODEL, MANUALIMPORT} |
| name | string | Name of Forecast |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid accountId | 404 Not Found | |
| Invalid pageId | 400 Bad Request | |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | Page offset of results |
bankId | null | | Unique identifier for the bank |
accountId | null | | Unique identifier for the bank account |
| 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":"forecastId1234","bankId":16,"accountId":"9aed0933-8e38-4571-93dd-8e775c8233e7","name":"Forecast-Mar1","date":"2021-03-01T09:34:00.284Z","source":"MANUALIMPORT"},{"id":"forecastId3456","bankId":16,"accountId":"9aed0933-8e38-4571-93dd-8e775c8233e7","name":"model_forecast_21_03_01.09:32","date":"2021-03-01T09:32:39.831Z","source":"MODEL"}],"links":{}}