Currencies

The Currencies resource allows currency data to be listed and viewed.

/Currencies - Returns the names, codes, and exchange rates for all currencies.

The full range of URIs and HTTP Verbs supported are:

Operation	HTTP Action
View the Currencies	GET `/Currencies`

GET Currencies

Available filters for GET Currencies

Filter	Description
`inUse`	False by default. If set to true then retrieves only currencies that are deemed in-use, meaning a buy rate is assigned (default currency will not be included).

Filters are used by adding the filter and value to the URI:

/Currencies?inUse=true

Available fields for GET Currencies

Property	Type	Length	Notes
CurrencyCode	String	3
DefaultBuyRate	Nullable Decimal		Given to 6 d.p
DefaultSellRate	Nullable Decimal		Given to 6 d.p
Description	String	200
Guid	Guid		Unique identifier.
LastModifiedOn	Nullable DateTime		Null if exchange rates have never been set for this currency.

Examples for Response GET `/Currencies?inUse=true`

show xml example

 
<?xml version="1.0"?>
<Currencies xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://api.unleashedsoftware.com/version/1">
    <Currency>
        <Guid>275b44d4-77d0-4676-ae1f-f207dcab7c4b</Guid>
        <LastModifiedOn>2021-11-21T20:37:43.6866667</LastModifiedOn>
        <CurrencyCode>AUD</CurrencyCode>
        <Description>Australia, Dollars</Description>
        <DefaultBuyRate>0.949200</DefaultBuyRate>
        <DefaultSellRate>0.893300</DefaultSellRate>
    </Currency>
    <Currency>
        <Guid>8f804325-817c-4cc4-96c0-b090f550a8d1</Guid>
        <LastModifiedOn>2021-11-21T20:37:43.6866667</LastModifiedOn>
        <CurrencyCode>GBP</CurrencyCode>
        <Description>United Kingdom, Pounds</Description>
        <DefaultBuyRate>0.444400</DefaultBuyRate>
        <DefaultSellRate>0.411700</DefaultSellRate>
    </Currency>
    <Currency>
        <Guid>7e1965c5-9b8a-4011-8b1c-2cd106ac0fb6</Guid>
        <LastModifiedOn>2021-11-21T20:37:43.6866667</LastModifiedOn>
        <CurrencyCode>USD</CurrencyCode>
        <Description>United States of America, Dollars</Description>
        <DefaultBuyRate>0.672500</DefaultBuyRate>
        <DefaultSellRate>0.624000</DefaultSellRate>
    </Currency>
</Currencies>

show json example

{
    "Items": [
        {
            "CurrencyCode": "AUD",
            "Description": "Australia, Dollars",
            "DefaultBuyRate": 0.949200,
            "DefaultSellRate": 0.893300,
            "Guid": "275b44d4-77d0-4676-ae1f-f207dcab7c4b",
            "LastModifiedOn": "/Date(1637527063686)/"
        },
        {
            "CurrencyCode": "GBP",
            "Description": "United Kingdom, Pounds",
            "DefaultBuyRate": 0.444400,
            "DefaultSellRate": 0.411700,
            "Guid": "8f804325-817c-4cc4-96c0-b090f550a8d1",
            "LastModifiedOn": "/Date(1637527063686)/"
        },
        {
            "CurrencyCode": "USD",
            "Description": "United States of America, Dollars",
            "DefaultBuyRate": 0.672500,
            "DefaultSellRate": 0.624000,
            "Guid": "7e1965c5-9b8a-4011-8b1c-2cd106ac0fb6",
            "LastModifiedOn": "/Date(1637527063686)/"
        }
    ]
}

Currencies

The full range of URIs and HTTP Verbs supported are:

GET Currencies

Examples for Response GET /Currencies?inUse=true

Examples for Response GET `/Currencies?inUse=true`