Filter inputs
Name | Type | Description | Mandatory | Available from version |
|---|---|---|---|---|
BrickIds | Guid[] | Filter by array of BrickIds. BrickId is the internal id of a Business Transaction | ||
Keys | string[] | Filter by an array of BusinessTransactionType keys | ||
StatusKey | string | Filter by the status key of the BusinessTransactionType | ||
ManualTicket | bool? | Filter by if BusinessTransactionType is available in GUI or not | ||
CreatedDateFrom | DateTime | When used, both from date and to date should be provided in the request | 2.02.20160506 | |
CreatedDateTo | DateTime | 2.02.20160506 | ||
ReportingTypeKeys | string[] | Filter by array of ReportTypeKeys, these are:
| 2.24 |
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version |
|---|---|---|---|
BrickId | Guid | The BrickId of the transaction type | |
CreatedDate | DateTime | The date when the transaction was created | 2.02.20160506 |
Key | string | The BusinessTransactionType key | |
Label | string | The label for the BusinessTransactionType key | |
StatusKey | string | The status key of the BusinessTransactionType: Open, OpenAdmin, OpenPartner, Closed | |
ManualTicket | bool | True if the BusinessTransactionType is available in GUI | |
SortOrder | int | The sorting value of the TransactionType in the GUI. The value 0 is highest | |
TransactionReferenceIncluded | bool | Tells if the TransactionReference is used in TransactionType | |
SystemAccountIncluded | bool | Tells if the SystemAccount is used in TransactionType | |
AccountReportGroups | string | ||
Asset1Included | bool | Tells if the first leg of the transaction is used in the TransactionType | |
Asset1Key | string | Describes what you are using as payment in the first leg of the transaction: "Currency" or "Instrument" | |
Asset1TypeKey | string | Type key of the first leg of the transaction: "Cash" or "Instrument" | |
Asset2Included | bool | Tells if the second leg of the transaction is used in the TransactionType | |
Asset2Key | string | Describes what you are buying/selling in the second leg of the transaction: "Currency" or "Instrument" | |
Asset2TypeKey | string | Type key of the second leg of the transaction: "Cash" or "Instrument" | |
AmountAsset1Included | bool | Tells if AmountAsset1 is used in TransactionType | |
AmountAsset1Key | string | The unit that is used to describe the amount of the first leg of the transaction: "Quantity" or "Amount" | |
AmountAsset2Included | bool | Tells if AmountAsset2 is used in TransactionType | |
AmountAsset2Key | string | The unit that is used to describe the amount of the second leg of the transaction: "Quantity" or "Amount" | |
CustodyAccountAsset1Included | bool | Tells if CustodyAccountAsset1 is used in TransactionType | |
CustodyAccountAsset2Included | bool | Tells if CustodyAccountAsset2 is used in TransactionType | |
PriceIncluded | bool | True if price is used in TransactionType | |
ValueDateIncluded | bool | True if value date is used in TransactionType | |
SettlementDateIncluded | bool | True if settlement date is used in TransactionType | |
ReturnCalculationType | string | "Trade", "Transfer" or "Payment" | |
TaxTypeKey | string | ||
TradeDateIncluded | bool | True if |
trade date is used in TransactionType | ||
Tx_AcquisitionValueIncluded | bool | True if the acquisition |
value is used in TransactionType | ||
Tx_AcquisitionValueAccountCurrencyIncluded | bool | True if the base currency of the |
account is used in TransactionType | |||
ReportingTypeKey | string | This identifies what reporting type the transaction type belongs to. The available keys are:
| 2.24 |
Code examples
C# -
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
//Get |
| Blog Posts | ||||||
|---|---|---|---|---|---|---|
|