...
...
...
...
Inputs (Array of
...
CurrencyExchangeOrder) inherits from EntityBase
The object CurrencyExchangeOrdersCollection takes two objects that are the only ones that should be supplied and those are Entity takes an array of CurrencyExchangeBuyOrders and CurrencyExchangeSellOrders. The only difference between the buy and sell orders is the field SellAmount (only available for sell orders) and BuyAmount (only available for buy orders). The table below describes the properties for CurrencyExchangeBuyOrders and CurrencyExchangeSellOrders.
| Name | Type | Description | Mandatory | Available from version |
|---|---|---|---|---|
| BrickId | Guid | Not used as an input, the id of the order is populated by BFS after creation | 2.25 | |
| Account | Guid | The account to be associated with the order. This is the BrickId of the Account | True | 2.25 |
| AllocationOrder | Guid | The BrickId of an allocation order if this order should be associated to such an order. | 2.25 | |
| Batch | Guid | The BrickId of a currency batch order. This is set by BFS after this order has been moved along in its workflow and included in a batch order that can be executed with a counterparty. | 2.25 | |
| BuyCashAssetBrickId | Guid | The BrickId of the Cash asset that should be bought. For example a cash asset representing the currency USD. | True | 2.25 |
| SellCashAssetBrickId | Guid | The BrickId of the Cash asset that should be sold. For example a cash asset representing the currency SEK. | True | 2.25 |
| Comment | string | A general comment for the order in free text. | 2.25 | |
| CustomFields | Object[] | CustomFields is an array of CustomField objects. Each CustomField consists of two strings, FieldName and Value. There are no datatypes associated with these properties, they are just a way for api-users to add custimized data to the object. | 2.25 | |
| OrderNo | string | Not used as an input. The created order will receive an order number that is returned in the output. | 2.25 | |
| RequestReference | string | A general free text field that will be returned in the output for the same object that it was supplied to. | 2.25 | |
| BuyAmount | Decimal | The amount that should be bought of the BuyCashAssetBrickId, this only exists on the CurrencyExchangeBuyOrders and must not be a value below 0. | True | 2.25 |
| SellAmount | Decimal | The amount that should be sold of the SellCashAssetBrickId, this only exists on the CurrencyExchangeSellOrders and must not be a value below 0. | True | 2.25 |
...