# OutputTransaction

A list of output transactions.
## Properties

| Name | Type | Required | Description |
|------|------|----------|-------------|
| **transaction_id** | **str** | Required | The unique identifier for the transaction. |
| **type** | **str** | Required | The type of the transaction e.g. &#39;Buy&#39;, &#39;Sell&#39;. The transaction type should have been pre-configured via the System Configuration API endpoint. |
| **description** | **str** | Optional | The description of the transaction. This only exists on transactions generated by LUSID e.g. a holdings adjustment transaction. |
| **instrument_identifiers** | **Dict[str, Optional[str]]** | Optional | A set of instrument identifiers that can resolve the transaction to a unique instrument. |
| **instrument_scope** | **str** | Optional | The scope in which the instrument lies. |
| **instrument_uid** | **str** | Required | The unique Lusid Instrument Id (LUID) of the instrument that the transaction is in. |
| **transaction_date** | **datetime** | Required | The date of the transaction. |
| **settlement_date** | **datetime** | Required | The settlement date of the transaction. |
| **units** | **float** | Required | The number of units transacted in the associated instrument. |
| **transaction_amount** | **float** | Optional | The total value of the transaction in the transaction currency. |
| **transaction_price** | [TransactionPrice](TransactionPrice.md) | Optional | *No description available.* |
| **total_consideration** | [CurrencyAndAmount](CurrencyAndAmount.md) | Optional | *No description available.* |
| **exchange_rate** | **float** | Optional | The exchange rate between the transaction and settlement currency (settlement currency being represented by the TotalConsideration.Currency). For example if the transaction currency is in USD and the settlement currency is in GBP this this the USD/GBP rate. |
| **transaction_to_portfolio_rate** | **float** | Optional | The exchange rate between the transaction and portfolio currency. For example if the transaction currency is in USD and the portfolio currency is in GBP this this the USD/GBP rate. |
| **transaction_currency** | **str** | Optional | The transaction currency. |
| **properties** | [Dict[str, PerpetualProperty]](PerpetualProperty.md) | Optional | Set of unique transaction properties and associated values to stored with the transaction. Each property will be from the &#39;Transaction&#39; domain. |
| **counterparty_id** | **str** | Optional | The identifier for the counterparty of the transaction. |
| **source** | **str** | Optional | The source of the transaction. This is used to look up the appropriate transaction group set in the transaction type configuration. |
| **transaction_status** | **str** | Optional | The status of the transaction. Available values: Active, Amended, Cancelled, ActiveReversal, ActiveTrueUp, CancelledTrueUp. |
| **entry_date_time** | **datetime** | Optional | The asAt datetime that the transaction was added to LUSID. |
| **cancel_date_time** | **datetime** | Optional | If the transaction has been cancelled, the asAt datetime that the transaction was cancelled. |
| **realised_gain_loss** | [List[RealisedGainLoss]](RealisedGainLoss.md) | Optional | The collection of realised gains or losses resulting from relevant transactions e.g. a sale transaction. The cost used in calculating the realised gain or loss is determined by the accounting method defined when the transaction portfolio is created. |
| **holding_ids** | **List[int]** | Optional | The collection of single identifiers for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio. |
| **source_type** | **str** | Optional | The type of source that the transaction originated from. Available values: Unknown, InputTransaction, InstrumentEvent, HoldingAdjustment, OverriddenVirtualTransaction. |
| **source_instrument_event_id** | **str** | Optional | The unique ID of the instrument event that the transaction is related to. |
| **custodian_account** | [CustodianAccount](CustodianAccount.md) | Optional | *No description available.* |
| **transaction_group_id** | **str** | Optional | The identifier for grouping economic events across multiple transactions |
| **resolved_transaction_type_details** | [TransactionTypeDetails](TransactionTypeDetails.md) | Optional | *No description available.* |
| **gross_transaction_amount** | **float** | Optional | The total gross value of the transaction in the transaction currency. |
| **otc_confirmation** | [OtcConfirmation](OtcConfirmation.md) | Optional | *No description available.* |
| **order_id** | [ResourceId](ResourceId.md) | Optional | *No description available.* |
| **allocation_id** | [ResourceId](ResourceId.md) | Optional | *No description available.* |
| **accounting_date** | **datetime** | Optional | The accounting date of the transaction. |
| **economics** | [List[Economics]](Economics.md) | Optional | Set of economic data related with the transaction impacts. |
| **data_model_membership** | [DataModelMembership](DataModelMembership.md) | Optional | *No description available.* |
| **sequence** | **int** | Optional | The sequential position in which this transaction was processed. |
| **sequence_priority** | **int** | Optional | The calculated priority level for this transaction. |
| **settlement_summary** | [TransactionSettlementSummary](TransactionSettlementSummary.md) | Optional | *No description available.* |
| **version** | [Version](Version.md) | Optional | *No description available.* |
| **staged_modifications** | [StagedModificationsInfo](StagedModificationsInfo.md) | Optional | *No description available.* |


## Usage

### Creating from keyword arguments

```python
from finbourne.sdk.services.lusid.models.OutputTransaction import OutputTransaction

instance = OutputTransaction(
    transaction_id="...",  # required — The unique identifier for the transaction.
    type="...",  # required — The type of the transaction e.g. &#39;Buy&#39;, &#39;Sell&#39;. The transaction type should have been pre-configured via the System Configuration API endpoint.
    description="...",  # optional — The description of the transaction. This only exists on transactions generated by LUSID e.g. a holdings adjustment transaction.
    instrument_identifiers=,  # optional — A set of instrument identifiers that can resolve the transaction to a unique instrument.
    instrument_scope="...",  # optional — The scope in which the instrument lies.
    instrument_uid="...",  # required — The unique Lusid Instrument Id (LUID) of the instrument that the transaction is in.
    transaction_date=datetime.now(),  # required — The date of the transaction.
    settlement_date=datetime.now(),  # required — The settlement date of the transaction.
    units=0.0,  # required — The number of units transacted in the associated instrument.
    transaction_amount=0.0,  # optional — The total value of the transaction in the transaction currency.
    transaction_price=TransactionPrice(...),  # optional
    total_consideration=CurrencyAndAmount(...),  # optional
    exchange_rate=0.0,  # optional — The exchange rate between the transaction and settlement currency (settlement currency being represented by the TotalConsideration.Currency). For example if the transaction currency is in USD and the settlement currency is in GBP this this the USD/GBP rate.
    transaction_to_portfolio_rate=0.0,  # optional — The exchange rate between the transaction and portfolio currency. For example if the transaction currency is in USD and the portfolio currency is in GBP this this the USD/GBP rate.
    transaction_currency="...",  # optional — The transaction currency.
    properties=PerpetualProperty(...),  # optional — Set of unique transaction properties and associated values to stored with the transaction. Each property will be from the &#39;Transaction&#39; domain.
    counterparty_id="...",  # optional — The identifier for the counterparty of the transaction.
    source="...",  # optional — The source of the transaction. This is used to look up the appropriate transaction group set in the transaction type configuration.
    transaction_status="...",  # optional — The status of the transaction. Available values: Active, Amended, Cancelled, ActiveReversal, ActiveTrueUp, CancelledTrueUp.
    entry_date_time=datetime.now(),  # optional — The asAt datetime that the transaction was added to LUSID.
    cancel_date_time=datetime.now(),  # optional — If the transaction has been cancelled, the asAt datetime that the transaction was cancelled.
    realised_gain_loss=[],  # optional — The collection of realised gains or losses resulting from relevant transactions e.g. a sale transaction. The cost used in calculating the realised gain or loss is determined by the accounting method defined when the transaction portfolio is created.
    holding_ids=,  # optional — The collection of single identifiers for the holding within the portfolio. The holdingId is constructed from the LusidInstrumentId, sub-holding keys and currrency and is unique within the portfolio.
    source_type="...",  # optional — The type of source that the transaction originated from. Available values: Unknown, InputTransaction, InstrumentEvent, HoldingAdjustment, OverriddenVirtualTransaction.
    source_instrument_event_id="...",  # optional — The unique ID of the instrument event that the transaction is related to.
    custodian_account=CustodianAccount(...),  # optional
    transaction_group_id="...",  # optional — The identifier for grouping economic events across multiple transactions
    resolved_transaction_type_details=TransactionTypeDetails(...),  # optional
    gross_transaction_amount=0.0,  # optional — The total gross value of the transaction in the transaction currency.
    otc_confirmation=OtcConfirmation(...),  # optional
    order_id=ResourceId(...),  # optional
    allocation_id=ResourceId(...),  # optional
    accounting_date=datetime.now(),  # optional — The accounting date of the transaction.
    economics=[],  # optional — Set of economic data related with the transaction impacts.
    data_model_membership=DataModelMembership(...),  # optional
    sequence=0,  # optional — The sequential position in which this transaction was processed.
    sequence_priority=0,  # optional — The calculated priority level for this transaction.
    settlement_summary=TransactionSettlementSummary(...),  # optional
    version=Version(...),  # optional
    staged_modifications=StagedModificationsInfo(...)  # optional
)
```

- [TransactionPrice](TransactionPrice.md)
- [CurrencyAndAmount](CurrencyAndAmount.md)
- [PerpetualProperty](PerpetualProperty.md) — used in `properties`
- [RealisedGainLoss](RealisedGainLoss.md) — used in `realised_gain_loss`
- [CustodianAccount](CustodianAccount.md)
- [TransactionTypeDetails](TransactionTypeDetails.md)
- [OtcConfirmation](OtcConfirmation.md)
- [ResourceId](ResourceId.md)
- [ResourceId](ResourceId.md)
- [Economics](Economics.md) — used in `economics`
- [DataModelMembership](DataModelMembership.md)
- [TransactionSettlementSummary](TransactionSettlementSummary.md)
- [Version](Version.md)
- [StagedModificationsInfo](StagedModificationsInfo.md)


[Back to top](#) · [Back to API list](../../api_endpoints.md) · [Back to Model list](../../models.md) · [Back to README](../../../../../README.md)

