Replace Income
PUT {{BASE_URL}}/transactions/income
Cancels and replaces an existing income transaction.
This represents either an accrual or receipt, or both.
This is determined by the TradeDate and SettlementDate values as follows:
If only TradeDate is set this represents an accrual.
If only SettlementDate is set this represents an receipt.
If both are set this is treated as an accrual from TradeDate -> SettlementDate and a receipt on SettlementDate.
DTO
| Field | Value |
|---|---|
| Id | The Id of the existing transaction |
| Account | The shortcode of the financial account for the income |
| AccrualAccount | The shortcode of the financial accrual account for the income before it is received |
| Amount | The numerical amount |
| CounterpartyAccount | (Optional) The shortcode of thecounterparty account to receive the income |
| Currency | ISO currency code |
| Description | |
| Extended | (Optional) JSON object of additional key-value pairs to be stored with the transaction |
| Fund | The shortcode of the fund |
| SettlementDate | (Optional)The payment date of the income |
| Strategy | (Optional) The shortcode of the strategy |
| TradeDate | (Optional) The accounting date of the income |
Request Body
{"Id"=>"123-345-456", "Account"=>nil, "AccrualAccount"=>nil, "Amount"=>0, "CounterpartyAccount"=>nil, "Currency"=>nil, "Description"=>"RevenueReceived", "Fund"=>nil, "SettlementDate"=>nil, "Strategy"=>nil, "TradeDate"=>nil}