GetBusinessTransactionTypes

Filter inputs

NameTypeDescriptionMandatoryAvailable from version
BrickIdsGuid[]Filter by array of BrickIds. BrickId is the internal id of a Business Transaction

Keysstring[]Filter by an array of BusinessTransactionType keys

StatusKeystringFilter by the status key of the BusinessTransactionType

ManualTicketbool?Filter by if BusinessTransactionType is available in GUI or not

CreatedDateFromDateTimeWhen used, both from date and to date should be provided in the request 
2.02.20160506
CreatedDateToDateTime
2.02.20160506
 ReportingTypeKeys string[]

Filter by array of ReportTypeKeys, these are:

  • Fee
  • Dividend
  • Compensation
  • Other
  • Tax
  • Withdrawal
  • Deposit
  • Coupon
  • Interest
  • Trade

2.24

Response rows (Array) inherits from EntityBase

NameTypeDescriptionAvailable from version
BrickIdGuidThe BrickId of the transaction type
CreatedDateDateTimeThe date when the transaction was created2.02.20160506
KeystringThe BusinessTransactionType key
LabelstringThe label for the BusinessTransactionType key
StatusKeystringThe status key of the BusinessTransactionType: Open, OpenAdmin, OpenPartner, Closed
ManualTicketboolTrue if the BusinessTransactionType is available in GUI
SortOrderintThe sorting value of the TransactionType in the GUI. The value 0 is highest
TransactionReferenceIncludedboolTells if the TransactionReference is used in TransactionType
SystemAccountIncludedboolTells if the SystemAccount is used in TransactionType
AccountReportGroupsstring

Asset1IncludedboolTells if the first leg of the transaction is used in the TransactionType
Asset1KeystringDescribes what you are using as payment in the first leg of the transaction: "Currency" or "Instrument"
Asset1TypeKeystringType key of the first leg of the transaction: "Cash" or "Instrument"
Asset2IncludedboolTells if the second leg of the transaction is used in the TransactionType
Asset2KeystringDescribes what you are buying/selling in the second leg of the transaction: "Currency" or "Instrument"
Asset2TypeKeystringType key of the second leg of the transaction: "Cash" or "Instrument"
AmountAsset1IncludedboolTells if AmountAsset1 is used in TransactionType
AmountAsset1KeystringThe unit that is used to describe the amount of the first leg of the transaction: "Quantity" or "Amount"
AmountAsset2IncludedboolTells if AmountAsset2 is used in TransactionType
AmountAsset2KeystringThe unit that is used to describe the amount of the second leg of the transaction: "Quantity" or "Amount"
CustodyAccountAsset1IncludedboolTells if CustodyAccountAsset1 is used in TransactionType
CustodyAccountAsset2IncludedboolTells if CustodyAccountAsset2 is used in TransactionType
PriceIncludedboolTrue if price is used in TransactionType
ValueDateIncludedboolTrue if value date is used in TransactionType
SettlementDateIncludedboolTrue if settlement date is used in TransactionType
ReturnCalculationTypestring"Trade", "Transfer" or "Payment"
TaxTypeKeystring

TradeDateIncludedboolTrue if trade date is used in TransactionType
Tx_AcquisitionValueIncludedboolTrue if the acquisition value is used in TransactionType
Tx_AcquisitionValueAccountCurrencyIncludedboolTrue if the base currency of the account is used in TransactionType
ReportingTypeKeystring

This identifies what reporting type the transaction type belongs to.

The available keys are:

  • Fee
  • Dividend
  • Compensation
  • Other
  • Tax
  • Withdrawal
  • Deposit
  • Coupon
  • Interest
  • Trade
2.24


Code examples

C# -
//Get

Blog Posts