Fx Rates

class q2_sdk.models.adapters.fx_rates.ReplyStatus[source]

ReplyStatus()

success = (0,)
error = (-1,)
throttling_limit = (-2,)
usd_amount_too_small = -3
class q2_sdk.models.adapters.fx_rates.FxCustomerRate(buy_or_sell, base_currency_code, contra_currency_code, exchange_rate, maximum_amount)[source]

FxCustomerRate(buy_or_sell: str, base_currency_code: str, contra_currency_code: str, exchange_rate: float, maximum_amount: float)

buy_or_sell: str
base_currency_code: str
contra_currency_code: str
exchange_rate: float
maximum_amount: float
class q2_sdk.models.adapters.fx_rates.FxRateBaseReply(status, status_description)[source]

FxRateBaseReply(status: int, status_description: str)

status: int
status_description: str
class q2_sdk.models.adapters.fx_rates.FxRateExchangeRateReply(status, status_description, base_rate, usd_equivalent_amount, exchange_rate)[source]

FxRateExchangeRateReply(status: int, status_description: str, base_rate: float, usd_equivalent_amount: float, exchange_rate: float)

base_rate: float

(rate not including markup) - must be persisted with transaction for data extract during file creation - new field to store.

usd_equivalent_amount: float

converted fx amount to usd

exchange_rate: float

(rate including markup) - to be included in approval success message

class q2_sdk.models.adapters.fx_rates.FxRateExchangeRateReplyUSDEquivalent(status, status_description, base_rate, amount, exchange_rate)[source]

FxRateExchangeRateReplyUSDEquivalent(status: int, status_description: str, base_rate: float, amount: float, exchange_rate: float)

base_rate: float
amount: float
exchange_rate: float
class q2_sdk.models.adapters.fx_rates.FxRateQuoteReply(status, status_description, base_rate, usd_equivalent_amount, exchange_rate, quote_id, expiration_date)[source]

FxRateQuoteReply(status: int, status_description: str, base_rate: float, usd_equivalent_amount: float, exchange_rate: float, quote_id: str, expiration_date: str)

quote_id: str

ID to be used later during the booking process

expiration_date: str
class q2_sdk.models.adapters.fx_rates.FxRateQuoteReplyUSDEquivalent(status, status_description, base_rate, amount, exchange_rate, quote_id, expiration_date)[source]

FxRateQuoteReplyUSDEquivalent(status: int, status_description: str, base_rate: float, amount: float, exchange_rate: float, quote_id: str, expiration_date: str)

quote_id: str

ID to be used later during the booking process

expiration_date: str
class q2_sdk.models.adapters.fx_rates.FxRateExchangeDealReply(status, status_description, base_rate, usd_equivalent_amount, exchange_rate, deal_id, value_date, top_tier='')[source]

FxRateExchangeDealReply(status: int, status_description: str, base_rate: float, usd_equivalent_amount: float, exchange_rate: float, deal_id: str, value_date: str, top_tier: Optional[str] = ‘’)

deal_id: str

unique id to reference the order

value_date: str

date the value was calculated

top_tier: Optional[str] = ''
class q2_sdk.models.adapters.fx_rates.FxRateExchangeDealReplyUSDEquivalent(status, status_description, base_rate, amount, exchange_rate, deal_id, value_date, top_tier='')[source]

FxRateExchangeDealReplyUSDEquivalent(status: int, status_description: str, base_rate: float, amount: float, exchange_rate: float, deal_id: str, value_date: str, top_tier: Optional[str] = ‘’)

deal_id: str

unique id to reference the order

value_date: str

date the value was calculated

top_tier: Optional[str] = ''
class q2_sdk.models.adapters.fx_rates.FxRateSheetsReply(status, status_description, effective_start_date, effective_end_date, customer_rates)[source]

FxRateSheetsReply(status: int, status_description: str, effective_start_date: str, effective_end_date: str, customer_rates: List[q2_sdk.models.adapters.fx_rates.FxCustomerRate])

effective_start_date: str
effective_end_date: str
customer_rates: List[FxCustomerRate]