Filter inputs
Name | Type | Description | Mandatory | Available from version |
---|---|---|---|---|
NoteBrickIds | Guid[] | Filter by array of BrickIds. BrickId is the internal id of a TransactionNote | Semi mandatory, Filter using <= 500 values | 2.27 |
CreatedDateFrom
DateTime?
When used, both from date and to date should be provided in the request
2.28
CreatedDateTo
DateTime?
2.28
AccountBrickIds | Guid[] | Filter by array of AccountBrickIds where the transaction note is connected to | Semi mandatory, Filter using <= 100 values | 2.27 |
NoteStatuses | Enum | The NoteStatus enum holds the following options: Open | 2.27 | |
NoteNumbers | string[] | Filter option based on note numbers. | Semi mandatory, Filter using <= 500 values | 2.28 |
CreatedDateFrom | DateTime? | When used, both from date and to date should be provided in the request These dates cannot be supplied on their own but has to be supplied together with at least one of the Semi mandatory filters defined above. | No | |
CreatedDateTo | DateTime? | No |
The filtering in GetTransactionNotes are a bit unusual because it is a demanding method involving several database entities. When filtering, you must use at least one of three semi mandatory properties NoteBrickIds, AccountBrickIds or NoteNumbers.
...
Response rows (Array) inherits from EntityBase
Name | Type | Description | Available from version |
---|---|---|---|
BrickId | Guid | The BrickId (unique id) of the TransactionNote | 2.27 |
CreatedDate | DateTime | The timestamp of when the transaction note was created | 2.27 |
TradeDate | DateTime | The trade date for the TransactionNote | 2.27 |
SettlementDate | DateTime | The settle date for the TransactionNote | 2.27 |
TransactionNoteNumber | string | The identification number of the TransactionNote | 2.27 |
AccountBrickId | Guid | The BrickId of the account that is linked to the TransactionNote | 2.27 |
BusinessEventBrickId | Guid | The BrickId of the BusinessEvent that is linked to the TransactionNote | 2.27 |
Status | Enum | The status of the TransactionNote Allowed values are: Open | 2.27 |
TransactionNoteType | Enum | The type of the TransactionNote Allowed values are: TradeNote | 2.27 |
AgentLegalEntityBrickId | Guid | This is the BrickId of the Legal Entities who are buying or selling from/to the principal | 2.27 |
PrincipalLegalEntityBrickId | Guid | This is the BrickId of the Legal Entities who are buying or selling from/to the agent | 2.27 |
TradeOrderDirectionKey | Enum | If this is a TradeNote this value will reflect if it is a buy or sell TransactionNote on behalf of the principal Allowed values are: Buy | 2.27 |
Marketplace | string | The marketplace where the underlying instrument was traded. | 2.28 |
AquisitionValue | decimal | The acquisition value of the number of units of instrument bought or sold. | 2.28 |
Currency | string | The currency in which the sold or bought instrument is traded. | 2.28 |
BusinessTransactionType | string | The transaction type of the transaction that generated the note. | 2.28 |
InstrumentName | string | The name of the instrument that was traded. | 2.28 |
ISIN | string | The ISIN identifier of the traded instrument. | 2.28 |
Price | double | The unit price of the instrument connected to the note. | 2.28 |
Quantity | decimal | The number of units of instrument traded. | 2.28 |
Code examples
C# - Get transaction notes from a BFS instance
...