Struct fxoanda_definitions::TakeProfitOrderTransaction

pub struct TakeProfitOrderTransaction {
    pub time_in_force: Option<String>,
    pub trigger_condition: Option<String>,
    pub replaces_order_id: Option<String>,
    pub trade_id: Option<String>,
    pub price: Option<f32>,
    pub client_trade_id: Option<String>,
    pub user_id: Option<i32>,
    pub batch_id: Option<String>,
    pub reason: Option<String>,
    pub request_id: Option<String>,
    pub client_extensions: Option<ClientExtensions>,
    pub time: Option<DateTime<Utc>>,
    pub order_fill_transaction_id: Option<String>,
    pub cancelling_transaction_id: Option<String>,
    pub gtd_time: Option<DateTime<Utc>>,
    pub otype: Option<String>,
    pub id: Option<String>,
    pub account_id: Option<String>,
}

Fields

time_in_force: Option<String>

The time-in-force requested for the TakeProfit Order. Restricted to "GTC", "GFD" and "GTD" for TakeProfit Orders.

trigger_condition: Option<String>

Specification of which price component should be used when determining if an Order should be triggered and filled. This allows Orders to be triggered based on the bid, ask, mid, default (ask for buy, bid for sell) or inverse (ask for sell, bid for buy) price depending on the desired behaviour. Orders are always filled using their default price component. This feature is only provided through the REST API. Clients who choose to specify a non-default trigger condition will not see it reflected in any of OANDA's proprietary or partner trading platforms, their transaction history or their account statements. OANDA platforms always assume that an Order's trigger condition is set to the default value when indicating the distance from an Order's trigger price, and will always provide the default trigger condition when creating or modifying an Order. A special restriction applies when creating a guaranteed Stop Loss Order. In this case the TriggerCondition value must either be "DEFAULT", or the "natural" trigger side "DEFAULT" results in. So for a Stop Loss Order for a long trade valid values are "DEFAULT" and "BID", and for short trades "DEFAULT" and "ASK" are valid.

replaces_order_id: Option<String>

The ID of the Order that this Order replaces (only provided if this Order replaces an existing Order). format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

trade_id: Option<String>

The ID of the Trade to close when the price threshold is breached. format: The string representation of the OANDA-assigned TradeID. OANDA- assigned TradeIDs are positive integers, and are derived from the TransactionID of the Transaction that opened the Trade.

price: Option<f32>

The price threshold specified for the TakeProfit Order. The associated Trade will be closed by a market price that is equal to or better than this threshold. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

client_trade_id: Option<String>

The client ID of the Trade to be closed when the price threshold is breached.

user_id: Option<i32>

The ID of the user that initiated the creation of the Transaction.

batch_id: Option<String>

The ID of the "batch" that the Transaction belongs to. Transactions in the same batch are applied to the Account simultaneously. format: String representation of the numerical OANDA-assigned TransactionID

reason: Option<String>

The reason that the Take Profit Order was initiated

request_id: Option<String>

The Request ID of the request which generated the transaction.

client_extensions: Option<ClientExtensions>

A ClientExtensions object allows a client to attach a clientID, tag and comment to Orders and Trades in their Account. Do not set, modify, or delete this field if your account is associated with MT4.

time: Option<DateTime<Utc>>

The date/time when the Transaction was created. format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

order_fill_transaction_id: Option<String>

The ID of the OrderFill Transaction that caused this Order to be created (only provided if this Order was created automatically when another Order was filled). format: String representation of the numerical OANDA-assigned TransactionID

cancelling_transaction_id: Option<String>

The ID of the Transaction that cancels the replaced Order (only provided if this Order replaces an existing Order). format: String representation of the numerical OANDA-assigned TransactionID

gtd_time: Option<DateTime<Utc>>

The date/time when the TakeProfit Order will be cancelled if its timeInForce is "GTD". format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

otype: Option<String>

The Type of the Transaction. Always set to "TAKE_PROFIT_ORDER" in a TakeProfitOrderTransaction.

id: Option<String>

The Transaction's Identifier. format: String representation of the numerical OANDA-assigned TransactionID

account_id: Option<String>

The ID of the Account the Transaction was created for. format: "-"-delimited string with format "{siteID}-{divisionID}-{userID}-{accountNumber}"

Methods

impl TakeProfitOrderTransaction

pub fn new() -> TakeProfitOrderTransaction

pub fn with_time_in_force(self, x: String) -> Self

The time-in-force requested for the TakeProfit Order. Restricted to "GTC", "GFD" and "GTD" for TakeProfit Orders.

• param String
• return TakeProfitOrderTransaction

pub fn with_trigger_condition(self, x: String) -> Self

Specification of which price component should be used when determining if an Order should be triggered and filled. This allows Orders to be triggered based on the bid, ask, mid, default (ask for buy, bid for sell) or inverse (ask for sell, bid for buy) price depending on the desired behaviour. Orders are always filled using their default price component. This feature is only provided through the REST API. Clients who choose to specify a non-default trigger condition will not see it reflected in any of OANDA's proprietary or partner trading platforms, their transaction history or their account statements. OANDA platforms always assume that an Order's trigger condition is set to the default value when indicating the distance from an Order's trigger price, and will always provide the default trigger condition when creating or modifying an Order. A special restriction applies when creating a guaranteed Stop Loss Order. In this case the TriggerCondition value must either be "DEFAULT", or the "natural" trigger side "DEFAULT" results in. So for a Stop Loss Order for a long trade valid values are "DEFAULT" and "BID", and for short trades "DEFAULT" and "ASK" are valid.

• param String
• return TakeProfitOrderTransaction

pub fn with_replaces_order_id(self, x: String) -> Self

The ID of the Order that this Order replaces (only provided if this Order replaces an existing Order). format: The string representation of the OANDA-assigned OrderID. OANDA- assigned OrderIDs are positive integers, and are derived from the TransactionID of the Transaction that created the Order.

• param String
• return TakeProfitOrderTransaction

pub fn with_trade_id(self, x: String) -> Self

The ID of the Trade to close when the price threshold is breached. format: The string representation of the OANDA-assigned TradeID. OANDA- assigned TradeIDs are positive integers, and are derived from the TransactionID of the Transaction that opened the Trade.

• param String
• return TakeProfitOrderTransaction

pub fn with_price(self, x: f32) -> Self

The price threshold specified for the TakeProfit Order. The associated Trade will be closed by a market price that is equal to or better than this threshold. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

• param f32
• return TakeProfitOrderTransaction

pub fn with_client_trade_id(self, x: String) -> Self

The client ID of the Trade to be closed when the price threshold is breached.

• param String
• return TakeProfitOrderTransaction

pub fn with_user_id(self, x: i32) -> Self

The ID of the user that initiated the creation of the Transaction.

• param i32
• return TakeProfitOrderTransaction

pub fn with_batch_id(self, x: String) -> Self

The ID of the "batch" that the Transaction belongs to. Transactions in the same batch are applied to the Account simultaneously. format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return TakeProfitOrderTransaction

pub fn with_reason(self, x: String) -> Self

The reason that the Take Profit Order was initiated

• param String
• return TakeProfitOrderTransaction

pub fn with_request_id(self, x: String) -> Self

The Request ID of the request which generated the transaction.

• param String
• return TakeProfitOrderTransaction

pub fn with_client_extensions(self, x: ClientExtensions) -> Self

A ClientExtensions object allows a client to attach a clientID, tag and comment to Orders and Trades in their Account. Do not set, modify, or delete this field if your account is associated with MT4.

• param ClientExtensions
• return TakeProfitOrderTransaction

pub fn with_time(self, x: DateTime<Utc>) -> Self

The date/time when the Transaction was created. format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

• param DateTime
• return TakeProfitOrderTransaction

pub fn with_order_fill_transaction_id(self, x: String) -> Self

The ID of the OrderFill Transaction that caused this Order to be created (only provided if this Order was created automatically when another Order was filled). format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return TakeProfitOrderTransaction

pub fn with_cancelling_transaction_id(self, x: String) -> Self

The ID of the Transaction that cancels the replaced Order (only provided if this Order replaces an existing Order). format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return TakeProfitOrderTransaction

pub fn with_gtd_time(self, x: DateTime<Utc>) -> Self

The date/time when the TakeProfit Order will be cancelled if its timeInForce is "GTD". format: The RFC 3339 representation is a string conforming to https://tools.ietf.org/rfc/rfc3339.txt. The Unix representation is a string representing the number of seconds since the Unix Epoch (January 1st, 1970 at UTC). The value is a fractional number, where the fractional part represents a fraction of a second (up to nine decimal places).

• param DateTime
• return TakeProfitOrderTransaction

pub fn with_otype(self, x: String) -> Self

The Type of the Transaction. Always set to "TAKE_PROFIT_ORDER" in a TakeProfitOrderTransaction.

• param String
• return TakeProfitOrderTransaction

pub fn with_id(self, x: String) -> Self

The Transaction's Identifier. format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return TakeProfitOrderTransaction

pub fn with_account_id(self, x: String) -> Self

The ID of the Account the Transaction was created for. format: "-"-delimited string with format "{siteID}-{divisionID}-{userID}-{accountNumber}"

• param String
• return TakeProfitOrderTransaction

Trait Implementations

impl Debug for TakeProfitOrderTransaction

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for TakeProfitOrderTransaction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for TakeProfitOrderTransaction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.