Inputs (FeeRecordDto[]) inherits from DtoBase

The FeeRecordDto is an abstract class with four different concrete implementations: FixedAmountFeeRecordDto, AumPercentageFeeRecordDto, PerformancePercentageFeeRecordDto and DepositPercentageFeeRecordDto. These implementation classes reflect that it is possible to create four types of fees. Fixed fees are based on a nominal amount in a certain currency while percentage based fees extract a proportion of something (total assets held, total return or deposited amount).

Name	Type	Description	Mandatory	Available from version
Id	Guid	The id of the FeeRecord.	Yes	2.38
AccountBrickId	Guid	The brick id of the account that should receive the FeeRecord .	Yes	2.38
FeeRecordStatus	FeeRecordStatus	The status of the FeeRecord. Can be "Active" or "Inactive".	Yes	2.38
CurrencyCode	string	The currency code of the currency in which the fees should be applied.	Yes	2.38
SellToCoverMethod	SellToCoverMethod	If 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
PayerAccountTransactionDetails	Object	Contains information on who should pay the fee and which transactions types should be used.	Yes	2.38
FeeReceivers	List<Object>	A list of FeeReceivers. Each FeeReceiver object contains information on who should receive the applied fees and which transaction types should be used.	Yes	2.38
FrequencyDetails	Object	FrequencyDetails 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.	Yes	2.38

FixedAmountFeeRecordDto

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

Name	Type	Description	Mandatory	Available from version
FixedAmountToPay	decimal	How much should be extracted.	Yes	2.38

AumPercentageFeeRecordDto

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

Name	Type	Description	Mandatory	Available from version
PercentageAmountToPay	decimal	The AUM percentage that should be used.	Yes	2.38
AumPercentageDetails	AumPercentageDetails	Specific instructions on how the percentage based fee should be calculated.	Yes	2.38

PerformancePercentageFeeRecordDto

Performance fees are used to extract a percentage of total return above a high watermark threshold on an account.

Name	Type	Description	Mandatory	Available from version
PercentageAmountToPay	decimal	The percentage of return that should be extracted as a fee.	Yes	2.39
HighWatermarkType	HighWatermarkType	Specific instructions on how the percentage based fee should be calculated.	Yes	2.39

DepositPercentageFeeRecordDto

This type of FeeRecord can be used for event based fees that activate when customers deposit money.

Name	Type	Description	Mandatory	Available from version
PercentageAmountToPay	decimal	The percentage of deposited amount that should be extracted as fee.	Yes	2.39

Response UpdateFeeRecordResponse inherits from ResponseBase

Name	Type	Description	Available from version
Entities	FeeRecordDto[]	An array of updated FeeRecords. For example, if you updated FixedAmountFeeRecordDtos it will return this implementation class.	2.38
Message	string	A response message, "OK" if nothing went wrong and otherwise and error message.	2.38
IsError	bool	A bool to describe if the entire request went wrong. If true then nothing was updated, if false then all individual FeeRecords that could be updated were updated.	2.38

BFS API

UpdateFeeRecords