Filter inputs
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
BrickId | Guid[] | Filter by array of BrickIds. BrickId is the internal id of a Business Transaction. | ||
ReturnCalculationType | string[] | "Trade", "Transfer" or "Payment" | 2.02.20160506 | |
BusinessTransactionTypeKeys | string[] | Filter by transaction type keys. | 2.12 | |
BusinessTransactionTypeIds | Guid[] | Filter by transaction types. | 2.03.01 | |
Accounts | Guid[] | Filter by array of Accounts. This is the GUID of the Account which can be retrieved using GetAccounts. | ||
Assets | Guid[] | Filter by array of Assets. This is the GUID of the Asset (financial instrument) which can be retrieved using GetInstruments | ||
AccountDimensionKeys | string[] | A business transaction may consist of two account transactions, one in settle and one in trade. | ||
AccountTypeKeys | string[] | The account type of the account where the transaction was made | 2.02 | |
AmountAsset1From | decimal? | When used, both from AmountAsset1 and to AmountAsset1 should be provided in the request | 2.02 | |
AmountAsset1To | decimal? | |||
AmountAsset2From | decimal? | When used, both from AmountAsset2 and to AmountAsset2 should be provided in the request | 2.02 | |
AmountAsset2To | decimal? | |||
TradeDateFrom | DateTime? | When used, both from date and to date should be provided in the request | ||
TradeDateTo | DateTime? | |||
SettlementDateFrom | DateTime? | When used, both from date and to date should be provided in the request | ||
SettlementDateTo | DateTime? | |||
SequenceNoFrom | Int |
| 2.02 | |
SequenceNoTo | Int | |||
CreatedDateFrom | DateTime? | When used, both from date and to date should be provided in the request | ||
CreatedDateTo | DateTime? | |||
BatchIds | Guid[] | Filter by the id of transaction batches | 2.03.01 | |
TransactionReferences | string[] | Filter by array of transaction references | 2.10 |
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version |
---|---|---|---|
BrickId | Guid[] | The BrickId of the transaction | |
SequenceNo | int | Transaction number | |
Account | Guid | The GUID of the account where the transaction was made | |
AccountTypeKey | string | The account type of the account where the transaction was made | 2.02 |
Leg1Dimensions | string[] | A business transaction may consist of two account transactions, one in settle and one in trade. | |
Leg2Dimensions | string[] | A business transaction may consist of two account transactions, one in settle and one in trade. | |
Asset1CurrencyCode | string | The currency code of the first asset in the transaction, the first leg of a trade so to speak | |
Asset2CurrencyCode | string | The currency code of the second asset in the transaction, the second leg of a trade so to speak | |
Asset1 | Guid | The GUID of the asset/financial instrument of the first leg of the transaction | |
Asset2 | Guid | The GUID of the asset/financial instrument of the second leg of the transaction | |
NameAsset1 | string | The name of asset1 | 2.02 |
NameAsset2 | string | The name of asset2 | 2.02 |
Asset1TypeKey | string | The type of asset1 | 2.02 |
Asset2TypeKey | string | The type of asset2 | 2.02 |
BusinessTransactionTypeKey | string | The type key of the transaction type that you can get from GetBusinessTransactionTypes | |
BusinessTransactionType | Guid | The GUID of the transaction type that you can get from GetBusinessTransactionTypes | |
AmountAsset1 | decimal | The amount of the first leg of the transaction | |
AmountAsset2 | decimal | The amount of the second leg of the transaction | |
InstrumentName | string | The name of Asset2 | |
TradeDate | DateTime | The trade date of the transaction | |
SettlementDate | DateTime | The settlement date of the transaction | |
ValueDate | DateTime | The value date of the transaction | |
AccountingDate | DateTime | The accounting date of the transaction | |
CreatedDate | DateTime | The timestamp of when the transaction was created | |
IsCorrected | bool | If the transaction was corrected by another linked transaction | |
CorrectionComment | string | A comment made in conjunction with a correction | |
Price | double | The price of Asset 2 | |
AcquisitionValue | double | Acquisition Value | |
AcquisitionValueAccountCurrency | double | The Acquisition Value expressed in the accounts currency | |
ReturnCalculationType | string | "Trade", "Transfer" or "Payment" | 2.02.20160506 |
TransactionReference | string | The reference text saved on a transaction | 2.02.20160708 |
SuperTransactionId | Guid | The BrickId of the parent transaction | 2.02.20160708 |
BatchId | Guid | The id of the transaction batch | 2.03.01 |
Code examples