Get Forecast (by id)
GET {{base_url}}/forecasting/v2/forecasts/:forecastId
A specific forecast can be retrieved by providing a forecast id.
The response will include a timestamp, source and name of the forecast.
Get all forecasts for the company. Each forecast has an id, timestamp, source and name.
Path variables
| Field | Type | Description |
|---|---|---|
| forecastId | string | Unique identifier for the forecast |
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 forecastId | 404 Not Found |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
X-Partner-Id | string | ||
X-APi-Key | string | ||
Authorization | string | ||
X-Company-Id | string |
RESPONSES
status: OK
{"id":"forecastId1234","bankId":16,"accountId":"9aed0933-8e38-4571-93dd-8e775c8233e7","name":"Forecast-Mar1","date":"2021-03-01T09:34:00.284Z","source":"MANUALIMPORT"}