Billhighway Cloud API

ExchangeRateBaseParams

The following routes are available for this service:
POST	/api/Financial/ExchangeRateBase

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 ExchangeRate(ILazyLoadMemoryCacheValue):
    base_currency: Optional[str] = None
    foreign_currency: Optional[str] = None
    rate: Optional[Decimal] = None
    time_stamp: Optional[datetime.datetime] = None
    from_cache: Optional[bool] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExchangeRateBase:
    exchange_rate: Optional[ExchangeRate] = None
    base_amount: Optional[Decimal] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ExchangeRateBaseParams(ExchangeRateBaseParams):
    pass

Python ExchangeRateBaseParams 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.

POST /api/Financial/ExchangeRateBase HTTP/1.1 
Host: devapi.billhighway.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ExchangeRateBaseParams xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="https://www.billhighway.com/api">
  <AmountDue xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">0</AmountDue>
  <BaseCurrency xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</BaseCurrency>
  <ProcessingCurrency xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">String</ProcessingCurrency>
</ExchangeRateBaseParams>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ExchangeRateBase xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BH.CloudAPI.Common.DTO">
  <BaseAmount>0</BaseAmount>
  <ExchangeRate>
    <BaseCurrency>String</BaseCurrency>
    <ForeignCurrency>String</ForeignCurrency>
    <FromCache>false</FromCache>
    <Rate>0</Rate>
    <TimeStamp>0001-01-01T00:00:00</TimeStamp>
  </ExchangeRate>
</ExchangeRateBase>