Billhighway Cloud API

<back to all web services

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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProcessingCurrency: String,
	AmountDue: 0,
	BaseCurrency: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ExchangeRate: 
	{
		BaseCurrency: String,
		ForeignCurrency: String,
		Rate: 0,
		TimeStamp: 0001-01-01,
		FromCache: False
	},
	BaseAmount: 0
}