Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Inputs (FeeRecordDto[]) inherits from DtoBase

The FeeRecordDto is an abstract class with two different concrete implementations, FixedAmountFeeRecordDto and AumPercentageFeeRecordDto. These two implementation classes reflect that it is possible to delete two types of fees. Fixed fees are based on a nominal amount in a certain currency while percentage based fees use the sum of customer holdings and extract a percentage of that as the nominal fee amount. 

NameTypeDescriptionMandatoryAvailable from version
IdGuidThe id of the FeeRecord. No 2.38
AccountBrickIdGuidThe brick id of the account that should receive the FeeRecord . Yes 2.38
FeeRecordStatusstringThe status of the FeeRecord. Can be  "Active" or "Inactive". Yes 2.38
 CurrencyCodestringThe currency code of the currency in which the fees should be applied. Yes 2.38
 SellToCoverMethodstringIf and how to create TradeOrders to sell instrument positions if a customer does not have sufficient funds on account. Use "All" to create sell orders for the full fee amount regardless of cash positions. Use "MissingCash" to only create TradeOrders for missing funds and "None" to only try to extract liquid cash. Yes 2.38
PayerAccountTransactionDetailsObjectContains information on who should pay the fee and which transactions types should be used.Yes2.38
FeeReceiversList<Object>A list of FeeReceivers. Each FeeReceiver object contains information on who should receive the applied fees and which transaction types should be used.Yes2.38
FrequencyDetailsObjectFrequencyDetails contain information on if the fee should be created once or if it should be recurring. If it is recurring, there is additional fields to specify when it should recurr.Yes2.38


Use this to create fees of type "FixedAmount" - that is fees that extract nominal amounts from accounts.

NameTypeDescriptionMandatoryAvailable from version
FixedAmountToPaydecimalHow much should be extracted.Yes2.38


This implementation is used to  create percentage based asset under management (AUM) fees.

NameTypeDescriptionMandatoryAvailable from version
PercentageAmountToPaydecimalThe AUM percentage that should be used.Yes2.38
AumPercentageDetailsAumPercentageDetailsSpecific instructions on how the percentage based fee should be calculated.Yes2.38

Response UpdateFeeRecordResponse inherits from ResponseBase

NameTypeDescriptionAvailable from version
EntitiesFeeRecordDto[]An array of created FeeRecords. If you created FixedAmountFeeRecordDtos it will return this implementation class.2.38
MessagestringA response message, "OK" if nothing went wrong and otherwise and error message.2.38
IsErrorboolA bool to describe if the entire request went wrong. If true then nothing was created, if false then all individual FeeRecords that could be created were created.2.38

Code examples

  • No labels