Struct fxoanda_definitions::AccountSummary

pub struct AccountSummary {

    pub resettable_pl_time: Option<DateTime<Utc>>,
    pub margin_used: Option<f32>,
    pub margin_closeout_position_value: Option<f32>,
    pub margin_call_extension_count: Option<i32>,
    pub currency: Option<String>,
    pub resettable_pl: Option<f32>,
    pub nav: Option<f32>,
    pub last_margin_call_extension_time: Option<DateTime<Utc>>,
    pub margin_closeout_margin_used: Option<f32>,
    pub open_trade_count: Option<i32>,
    pub id: Option<String>,
    pub open_position_count: Option<i32>,
    pub margin_closeout_nav: Option<f32>,
    pub margin_closeout_percent: Option<f32>,
    pub margin_call_margin_used: Option<f32>,
    pub commission: Option<f32>,
    pub hedging_enabled: Option<bool>,
    pub position_value: Option<f32>,
    pub pl: Option<f32>,
    pub guaranteed_stop_loss_order_mode: Option<String>,
    pub last_transaction_id: Option<String>,
    pub margin_available: Option<f32>,
    pub margin_rate: Option<f32>,
    pub margin_call_percent: Option<f32>,
    pub margin_call_enter_time: Option<DateTime<Utc>>,
    pub guaranteed_execution_fees: Option<f32>,
    pub financing: Option<f32>,
    pub balance: Option<f32>,
    pub pending_order_count: Option<i32>,
    pub withdrawal_limit: Option<f32>,
    pub unrealized_pl: Option<f32>,
    pub alias: Option<String>,
    pub created_by_user_id: Option<i32>,
    pub margin_closeout_unrealized_pl: Option<f32>,
    pub created_time: Option<DateTime<Utc>>,
    pub last_order_fill_timestamp: Option<DateTime<Utc>>,
}

Fields

resettable_pl_time: Option<DateTime<Utc>>

The date/time that the Account’s resettablePL was last reset. 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).

margin_used: Option<f32>

Margin currently used for the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

margin_closeout_position_value: Option<f32>

The value of the Account’s open positions as used for margin closeout calculations represented in the Account’s home currency. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

margin_call_extension_count: Option<i32>

The number of times that the Account’s current margin call was extended.

currency: Option<String>

The home currency of the Account format: A string containing an ISO 4217 currency (http://en.wikipedia.org/wiki/ISO_4217)

resettable_pl: Option<f32>

The total realized profit/loss for the Account since it was last reset by the client. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

nav: Option<f32>

The net asset value of the Account. Equal to Account balance + unrealizedPL. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

last_margin_call_extension_time: Option<DateTime<Utc>>

The date/time of the Account’s last margin call extension. 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).

margin_closeout_margin_used: Option<f32>

The Account’s margin closeout margin used. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

open_trade_count: Option<i32>

The number of Trades currently open in the Account.

id: Option<String>

The Account’s identifier format: “-”-delimited string with format “{siteID}-{divisionID}-{userID}-{accountNumber}”

open_position_count: Option<i32>

The number of Positions currently open in the Account.

margin_closeout_nav: Option<f32>

The Account’s margin closeout NAV. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

margin_closeout_percent: Option<f32>

The Account’s margin closeout percentage. When this value is 1.0 or above the Account is in a margin closeout situation. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

margin_call_margin_used: Option<f32>

The Account’s margin call margin used. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

commission: Option<f32>

The total amount of commission paid over the lifetime of the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

hedging_enabled: Option<bool>

Flag indicating that the Account has hedging enabled.

position_value: Option<f32>

The value of the Account’s open positions represented in the Account’s home currency. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

pl: Option<f32>

The total profit/loss realized over the lifetime of the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

guaranteed_stop_loss_order_mode: Option<String>

The current guaranteed Stop Loss Order mode of the Account.

last_transaction_id: Option<String>

The ID of the last Transaction created for the Account. format: String representation of the numerical OANDA-assigned TransactionID

margin_available: Option<f32>

Margin available for Account currency. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

margin_rate: Option<f32>

Client-provided margin rate override for the Account. The effective margin rate of the Account is the lesser of this value and the OANDA margin rate for the Account’s division. This value is only provided if a margin rate override exists for the Account. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

margin_call_percent: Option<f32>

The Account’s margin call percentage. When this value is 1.0 or above the Account is in a margin call situation. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

margin_call_enter_time: Option<DateTime<Utc>>

The date/time when the Account entered a margin call state. Only provided if the Account is in a margin call. 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).

guaranteed_execution_fees: Option<f32>

The total amount of fees charged over the lifetime of the Account for the execution of guaranteed Stop Loss Orders. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

financing: Option<f32>

The total amount of financing paid/collected over the lifetime of the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

balance: Option<f32>

The current balance of the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

pending_order_count: Option<i32>

The number of Orders currently pending in the Account.

withdrawal_limit: Option<f32>

The current WithdrawalLimit for the account which will be zero or a positive value indicating how much can be withdrawn from the account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

unrealized_pl: Option<f32>

The total unrealized profit/loss for all Trades currently open in the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

alias: Option<String>

Client-assigned alias for the Account. Only provided if the Account has an alias set

created_by_user_id: Option<i32>

ID of the user that created the Account.

margin_closeout_unrealized_pl: Option<f32>

The Account’s margin closeout unrealized PL. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

created_time: Option<DateTime<Utc>>

The date/time when the Account 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).

last_order_fill_timestamp: Option<DateTime<Utc>>

The date/time of the last order that was filled for this account. 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).

Implementations

impl AccountSummary

pub fn new() -> AccountSummary

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

The date/time that the Account’s resettablePL was last reset. 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 AccountSummary

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

Margin currently used for the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The value of the Account’s open positions as used for margin closeout calculations represented in the Account’s home currency. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

• param f32
• return AccountSummary

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

The number of times that the Account’s current margin call was extended.

• param i32
• return AccountSummary

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

The home currency of the Account format: A string containing an ISO 4217 currency (http://en.wikipedia.org/wiki/ISO_4217)

• param String
• return AccountSummary

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

The total realized profit/loss for the Account since it was last reset by the client. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The net asset value of the Account. Equal to Account balance + unrealizedPL. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The date/time of the Account’s last margin call extension. 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 AccountSummary

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

The Account’s margin closeout margin used. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The number of Trades currently open in the Account.

• param i32
• return AccountSummary

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

The Account’s identifier format: “-”-delimited string with format “{siteID}-{divisionID}-{userID}-{accountNumber}”

• param String
• return AccountSummary

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

The number of Positions currently open in the Account.

• param i32
• return AccountSummary

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

The Account’s margin closeout NAV. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The Account’s margin closeout percentage. When this value is 1.0 or above the Account is in a margin closeout situation. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

• param f32
• return AccountSummary

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

The Account’s margin call margin used. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The total amount of commission paid over the lifetime of the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

pub fn with_hedging_enabled(self, x: bool) -> Self

Flag indicating that the Account has hedging enabled.

• param bool
• return AccountSummary

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

The value of the Account’s open positions represented in the Account’s home currency. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The total profit/loss realized over the lifetime of the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The current guaranteed Stop Loss Order mode of the Account.

• param String
• return AccountSummary

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

The ID of the last Transaction created for the Account. format: String representation of the numerical OANDA-assigned TransactionID

• param String
• return AccountSummary

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

Margin available for Account currency. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

Client-provided margin rate override for the Account. The effective margin rate of the Account is the lesser of this value and the OANDA margin rate for the Account’s division. This value is only provided if a margin rate override exists for the Account. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

• param f32
• return AccountSummary

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

The Account’s margin call percentage. When this value is 1.0 or above the Account is in a margin call situation. format: A decimal number encoded as a string. The amount of precision provided depends on what the number represents.

• param f32
• return AccountSummary

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

The date/time when the Account entered a margin call state. Only provided if the Account is in a margin call. 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 AccountSummary

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

The total amount of fees charged over the lifetime of the Account for the execution of guaranteed Stop Loss Orders. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The total amount of financing paid/collected over the lifetime of the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The current balance of the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The number of Orders currently pending in the Account.

• param i32
• return AccountSummary

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

The current WithdrawalLimit for the account which will be zero or a positive value indicating how much can be withdrawn from the account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The total unrealized profit/loss for all Trades currently open in the Account. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

Client-assigned alias for the Account. Only provided if the Account has an alias set

• param String
• return AccountSummary

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

ID of the user that created the Account.

• param i32
• return AccountSummary

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

The Account’s margin closeout unrealized PL. format: A decimal number encoded as a string. The amount of precision provided depends on the Account’s home currency.

• param f32
• return AccountSummary

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

The date/time when the Account 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 AccountSummary

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

The date/time of the last order that was filled for this account. 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 AccountSummary

Trait Implementations

impl Debug for AccountSummary

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AccountSummary

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for AccountSummary

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

where __S: Serializer,

Serialize this value into the given Serde serializer.