Get Forecasted Transactions
GET {{base_url}}/forecasting/v2/transactions
All forecasted transactions linked to the provided forecast id will be returned.
Query Parameters
| Field | Type | Description |
|---|
| pageId | string | Page offset of results |
| from | dateTime | Returns forecasted transactions posted on or after from date |
| to | dateTime | Returns forecasted transactions posted on or before to date |
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| forecastId | string | Unique identifier for the forecast |
Attributes
| Field | Type | Description |
|---|
| id | string | Unique identifier for the transaction |
| bankId | integer | Unique identifier for the bank |
| accountId | string | Unique identifier for the bank account |
| forecastId | string | Unique identifier for the forecast |
| valueDate | dateTime | Value date for the transaction |
| currency | string | Transaction currency |
| amount | integer | Transaction amount |
| type | string | Transaction type {DEBIT,CREDIT} |
| merchant | string | Name of the merchant |
| category | string | Name of the category |
| reasons | string | Reasons why a particular transaction has been added to the forecast |
| source | string | Source of data import {MANUALIMPORT, MODEL} |
Error Messages
| Condition | Response Status | Response Body |
|---|
| Invalid partnerId | 403 Forbidden | |
| Invalid companyId | 403 Forbidden | |
| Invalid pageId | 400 Bad Request | |
| Invalid accountId | 404 Not Found | |
| Invalid forecastId | 404 Not Found | |
Request Params
| Key | Datatype | Required | Description |
|---|
pageId | null | | Page offset of results |
from | null | | Returns forecasts posted on or after "from" date |
to | null | | Returns forecasts posted on or before "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 | | |
X-Company-Id | string | | |
Authorization | string | | |
RESPONSES
status: OK
{"results":[{"id":"transactionId1234","forecastId":"forecastId1234","bankId":16,"accountId":"9aed0933-8e38-4571-93dd-8e775c8233e7","valueDate":"2020-09-18T03:59Z","amount":"1000.00","currency":"USD","type":"CREDIT","merchant":"LLoyds","category":"Tax","reasons":"","source":"MANUALIMPORT"},{"id":"transactionId2345","forecastId":"forecastId2345","bankId":16,"accountId":"9aed0933-8e38-4571-93dd-8e775c8233e7","valueDate":"2020-09-18T03:59Z","amount":"1000.00","currency":"USD","type":"CREDIT","merchant":"LLoyds","category":"Tax","reasons":"","source":"MANUALIMPORT"},{"id":"transactionId3456","forecastId":"forecastId3456","bankId":16,"accountId":"9aed0933-8e38-4571-93dd-8e775c8233e7","valueDate":"2020-09-18T03:59Z","amount":"1000.00","currency":"USD","type":"CREDIT","merchant":"LLoyds","category":"Tax","reasons":"","source":"MANUALIMPORT"}],"links":{}}