GET api/currency

List all the currencies.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/currency. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

  • OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an array of currencies.

Collection of CurrencyDto
NameDescriptionTypeAdditional information
CurrencyID

Unique identifier of currency.

integer
DecimalPlaces

Number of decimal places of currency.

byte
Description

Currency description.

string
Symbol

Currency symbol.

string
MaximumAmount

Currency maximum amount.

decimal number

Response Formats

application/json, text/json

Sample:
[
  {
    "currencyID": 1,
    "decimalPlaces": 64,
    "description": "sample string 1",
    "symbol": "sample string 2",
    "maximumAmount": 1.0
  },
  {
    "currencyID": 1,
    "decimalPlaces": 64,
    "description": "sample string 1",
    "symbol": "sample string 2",
    "maximumAmount": 1.0
  }
]

application/xml, text/xml

Sample:
<ArrayOfCurrencyDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <CurrencyDto>
    <CurrencyID>1</CurrencyID>
    <DecimalPlaces>64</DecimalPlaces>
    <Description>sample string 1</Description>
    <MaximumAmount>1</MaximumAmount>
    <Symbol>sample string 2</Symbol>
  </CurrencyDto>
  <CurrencyDto>
    <CurrencyID>1</CurrencyID>
    <DecimalPlaces>64</DecimalPlaces>
    <Description>sample string 1</Description>
    <MaximumAmount>1</MaximumAmount>
    <Symbol>sample string 2</Symbol>
  </CurrencyDto>
</ArrayOfCurrencyDto>