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 use a proportion of a value (total assets held, total asset return or sum of deposit) and extract a percentage of that as the nominal fee amount.

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	Mandatory	Available from version
Id	Guid	The id of the FeeRecord.	No	2.38
AccountBrickId	Guid	The brick id of the account that should receive the FeeRecord .	Yes	2.38
FeeRecordStatus	string	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	string	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. The system will automatically try to exchange between different currencies to cover a fee.	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, be event based or if it should be recurring. If it is recurring or event based, there is additional fields to specify.	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

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

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

This fee type handles performance based fees - that is extracting proportions of positive return.

Name	Type	Description	Mandatory	Available from version

Name	Type	Description	Mandatory	Available from version
PercentageAmountToPay	decimal	The percentage of return above a high watermark (hwt) threshold that should be extracted.	Yes	2.39
HighWatermarkType	HighWatermarkType	Whether "OnlyPositions" should be considered or if previous performance fees should be included in the hwt.	Yes	2.39

DepositPercentageFeeRecordDto

DepositPercentageFeeRecordDto is the first event based fee. It triggers on deposits that customers make into their accounts.

Name	Type	Description	Mandatory	Available from version

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

Response CreateFeeRecordResponse inherits from ResponseBase

Name	Type	Description	Available from version

Name	Type	Description	Available from version
Entities	FeeRecordDto[]	An array of created FeeRecords. If you created 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 created, if false then all individual FeeRecords that could be created were created.	2.38

BFS API

CreateFeeRecords