Get Forecasted Transaction (by id)
GET {{base_url}}/forecasting/v2/transactions/:transactionId
A particular forecasted transaction can be retrieved by providing a transaction id.
Path variables
| Field | Type | Description |
|---|
| transactionId | string | Unique identifier for the transaction |
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 | Account 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 transactionId | 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
{"id":"transactionId1234","forecastId":"5fb529e2-2172-4a60-a16e-0d4c5da2546c","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"}