Struct fxoanda_definitions::FixedPriceOrderTransaction

pub struct FixedPriceOrderTransaction {

    pub client_extensions: Option<ClientExtensions>,
    pub trailing_stop_loss_on_fill: Option<TrailingStopLossDetails>,
    pub price: Option<f32>,
    pub stop_loss_on_fill: Option<StopLossDetails>,
    pub user_id: Option<i32>,
    pub take_profit_on_fill: Option<TakeProfitDetails>,
    pub batch_id: Option<String>,
    pub instrument: Option<String>,
    pub reason: Option<String>,
    pub position_fill: Option<String>,
    pub trade_client_extensions: Option<ClientExtensions>,
    pub request_id: Option<String>,
    pub time: Option<DateTime<Utc>>,
    pub units: Option<f32>,
    pub trade_state: Option<String>,
    pub otype: Option<String>,
    pub id: Option<String>,
    pub account_id: Option<String>,
}

Fields

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.

trailing_stop_loss_on_fill: Option<TrailingStopLossDetails>

TrailingStopLossDetails specifies the details of a Trailing Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Trailing Stop Loss, or when a Trade’s dependent Trailing Stop Loss Order is modified directly through the Trade.

price: Option<f32>

The price specified for the Fixed Price Order. This price is the exact price that the Fixed Price Order will be filled at. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

stop_loss_on_fill: Option<StopLossDetails>

StopLossDetails specifies the details of a Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Stop Loss, or when a Trade’s dependent Stop Loss Order is modified directly through the Trade.

user_id: Option<i32>

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

take_profit_on_fill: Option<TakeProfitDetails>

TakeProfitDetails specifies the details of a Take Profit Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Take Profit, or when a Trade’s dependent Take Profit Order is modified directly through the Trade.

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

instrument: Option<String>

The Fixed Price Order’s Instrument. format: A string containing the base currency and quote currency delimited by a “_”.

reason: Option<String>

The reason that the Fixed Price Order was created

position_fill: Option<String>

Specification of how Positions in the Account are modified when the Order is filled.

trade_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.

request_id: Option<String>

The Request ID of the request which generated the transaction.

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).

units: Option<f32>

The quantity requested to be filled by the Fixed Price Order. A posititive number of units results in a long Order, and a negative number of units results in a short Order. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

trade_state: Option<String>

The state that the trade resulting from the Fixed Price Order should be set to.

otype: Option<String>

The Type of the Transaction. Always set to “FIXED_PRICE_ORDER” in a FixedPriceOrderTransaction.

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}”

Implementations

impl FixedPriceOrderTransaction

pub fn new() -> FixedPriceOrderTransaction

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 FixedPriceOrderTransaction

pub fn with_trailing_stop_loss_on_fill(self, x: TrailingStopLossDetails) -> Self

TrailingStopLossDetails specifies the details of a Trailing Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Trailing Stop Loss, or when a Trade’s dependent Trailing Stop Loss Order is modified directly through the Trade.

• param TrailingStopLossDetails
• return FixedPriceOrderTransaction

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

The price specified for the Fixed Price Order. This price is the exact price that the Fixed Price Order will be filled at. format: A decimal number encodes as a string. The amount of precision provided depends on the Instrument.

• param f32
• return FixedPriceOrderTransaction

pub fn with_stop_loss_on_fill(self, x: StopLossDetails) -> Self

StopLossDetails specifies the details of a Stop Loss Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Stop Loss, or when a Trade’s dependent Stop Loss Order is modified directly through the Trade.

• param StopLossDetails
• return FixedPriceOrderTransaction

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

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

• param i32
• return FixedPriceOrderTransaction

pub fn with_take_profit_on_fill(self, x: TakeProfitDetails) -> Self

TakeProfitDetails specifies the details of a Take Profit Order to be created on behalf of a client. This may happen when an Order is filled that opens a Trade requiring a Take Profit, or when a Trade’s dependent Take Profit Order is modified directly through the Trade.

• param TakeProfitDetails
• return FixedPriceOrderTransaction

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 FixedPriceOrderTransaction

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

The Fixed Price Order’s Instrument. format: A string containing the base currency and quote currency delimited by a “_”.

• param String
• return FixedPriceOrderTransaction

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

The reason that the Fixed Price Order was created

• param String
• return FixedPriceOrderTransaction

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

Specification of how Positions in the Account are modified when the Order is filled.

• param String
• return FixedPriceOrderTransaction

pub fn with_trade_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 FixedPriceOrderTransaction

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

The Request ID of the request which generated the transaction.

• param String
• return FixedPriceOrderTransaction

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 FixedPriceOrderTransaction

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

The quantity requested to be filled by the Fixed Price Order. A posititive number of units results in a long Order, and a negative number of units results in a short Order. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

• param f32
• return FixedPriceOrderTransaction

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

The state that the trade resulting from the Fixed Price Order should be set to.

• param String
• return FixedPriceOrderTransaction

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

The Type of the Transaction. Always set to “FIXED_PRICE_ORDER” in a FixedPriceOrderTransaction.

• param String
• return FixedPriceOrderTransaction

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

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

• param String
• return FixedPriceOrderTransaction

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 FixedPriceOrderTransaction

Trait Implementations

impl Debug for FixedPriceOrderTransaction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FixedPriceOrderTransaction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FixedPriceOrderTransaction

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

where __S: Serializer,

Serialize this value into the given Serde serializer.