Bridge

<back to all web services

ETSForwardOptions

ETS
The following routes are available for this service:
GET/ETS/Forward-Options
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ETSForwardOptions:
    quote_id: Optional[str] = None
    quantity: int = 0
    month_number: int = 0
    start_date: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ETSQuoteViewModel:
    id: int = 0
    quote_guid: Optional[str] = None
    quote_date_time: datetime.datetime = datetime.datetime(1, 1, 1)
    quantity: int = 0
    grey_epoch_price: float = 0.0
    grey_epoch_fee: float = 0.0
    pay_now_total: float = 0.0
    service_fee_type: Optional[str] = None
    service_fee: float = 0.0
    finance_status: Optional[str] = None
    finance_fee: float = 0.0
    finance_total: float = 0.0
    service_fee_description: Optional[str] = None
    finance_percentage: float = 0.0
    service_fee_value: float = 0.0
    device_type: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetETSForwardDepositOptionsForEntityContactViewModel:
    invoice_from: Optional[str] = None
    allowance_cost_each: float = 0.0
    dep_available: bool = False
    credit_available: bool = False
    markup_percentage: float = 0.0
    eua_price: float = 0.0
    order_total_value: float = 0.0
    deposit_percentage: float = 0.0
    deposit_total_value: float = 0.0
    margin_percentage_covered: float = 0.0
    margin_covered_to: float = 0.0
    service_fee_type: Optional[str] = None
    total_service_fee: float = 0.0
    deposit_cash_required: float = 0.0
    margin_cash_risk: float = 0.0
    total_cash_risk: float = 0.0
    deposit_title: Optional[str] = None
    header_bar_text: Optional[str] = None
    header_bar_value: Optional[str] = None
    more_details_string: Optional[str] = None
    price_to_bridge: float = 0.0
    bridge_deposit_value: float = 0.0
    external_fee_per_ticket: float = 0.0
    our_commission: float = 0.0
    sort: int = 0
    service_fee_description: Optional[str] = None
    api_to_use: Optional[str] = None
    aither_settlement_u_u_i_d: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ETSForwardOptionsViewModel:
    quote_guid: Optional[str] = None
    quantity: int = 0
    month_number: int = 0
    start_date: datetime.datetime = datetime.datetime(1, 1, 1)
    invoiced_by: Optional[str] = None
    selected_deposit_percentage: Optional[str] = None
    selected_forward_option: Optional[str] = None
    third_party_name: Optional[str] = None
    current_server_time: datetime.datetime = datetime.datetime(1, 1, 1)
    is_bridge_client: bool = False
    ets_quote: Optional[ETSQuoteViewModel] = None
    get_e_t_s_forward_deposit_options_for_entity_contact: Optional[List[GetETSForwardDepositOptionsForEntityContactViewModel]] = None

Python ETSForwardOptions DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /ETS/Forward-Options HTTP/1.1 
Host: internal.thebunkerbridge.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ETSForwardOptionsViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Core.ViewModels">
  <CurrentServerTime>0001-01-01T00:00:00</CurrentServerTime>
  <ETSQuote>
    <DeviceType>String</DeviceType>
    <FinanceFee>0</FinanceFee>
    <FinancePercentage>0</FinancePercentage>
    <FinanceStatus>String</FinanceStatus>
    <FinanceTotal>0</FinanceTotal>
    <GreyEpochFee>0</GreyEpochFee>
    <GreyEpochPrice>0</GreyEpochPrice>
    <Id>0</Id>
    <PayNowTotal>0</PayNowTotal>
    <Quantity>0</Quantity>
    <QuoteDateTime>0001-01-01T00:00:00</QuoteDateTime>
    <QuoteGuid>00000000-0000-0000-0000-000000000000</QuoteGuid>
    <ServiceFee>0</ServiceFee>
    <ServiceFeeDescription>String</ServiceFeeDescription>
    <ServiceFeeType>String</ServiceFeeType>
    <ServiceFeeValue>0</ServiceFeeValue>
  </ETSQuote>
  <GetETSForwardDepositOptionsForEntityContact>
    <GetETSForwardDepositOptionsForEntityContactViewModel>
      <AitherSettlementUUID>String</AitherSettlementUUID>
      <AllowanceCostEach>0</AllowanceCostEach>
      <ApiToUse>String</ApiToUse>
      <BridgeDepositValue>0</BridgeDepositValue>
      <CreditAvailable>false</CreditAvailable>
      <DepAvailable>false</DepAvailable>
      <DepositCashRequired>0</DepositCashRequired>
      <DepositPercentage>0</DepositPercentage>
      <DepositTitle>String</DepositTitle>
      <DepositTotalValue>0</DepositTotalValue>
      <EUAPrice>0</EUAPrice>
      <ExternalFeePerTicket>0</ExternalFeePerTicket>
      <HeaderBarText>String</HeaderBarText>
      <HeaderBarValue>String</HeaderBarValue>
      <InvoiceFrom>String</InvoiceFrom>
      <MarginCashRisk>0</MarginCashRisk>
      <MarginCoveredTo>0</MarginCoveredTo>
      <MarginPercentageCovered>0</MarginPercentageCovered>
      <MarkupPercentage>0</MarkupPercentage>
      <MoreDetailsString>String</MoreDetailsString>
      <OrderTotalValue>0</OrderTotalValue>
      <OurCommission>0</OurCommission>
      <PriceToBridge>0</PriceToBridge>
      <ServiceFeeDescription>String</ServiceFeeDescription>
      <ServiceFeeType>String</ServiceFeeType>
      <Sort>0</Sort>
      <TotalCashRisk>0</TotalCashRisk>
      <TotalServiceFee>0</TotalServiceFee>
    </GetETSForwardDepositOptionsForEntityContactViewModel>
  </GetETSForwardDepositOptionsForEntityContact>
  <InvoicedBy>String</InvoicedBy>
  <IsBridgeClient>false</IsBridgeClient>
  <MonthNumber>0</MonthNumber>
  <Quantity>0</Quantity>
  <QuoteGuid>00000000-0000-0000-0000-000000000000</QuoteGuid>
  <SelectedDepositPercentage>String</SelectedDepositPercentage>
  <SelectedForwardOption>String</SelectedForwardOption>
  <StartDate>0001-01-01T00:00:00</StartDate>
  <ThirdPartyName>String</ThirdPartyName>
</ETSForwardOptionsViewModel>