Currencies Configuration

Currencies are used to configure the currency type associated with monetary values in Mambu. For more information, see Currencies.

With Configuration as Code (CasC), you may batch configure your currencies configuration via the API using YAML. For general information on CasC, see Configuration as Code Overview.

API Operations

CasC for currencies supports two operations.

Requests

For general information on CasC requests such as authentication and required headers, see Configuration as Code Overview.

The following section shows sample requests using curl and basic authentication. For all examples, replace TENANT_NAME with your actual tenant name.

GET configuration

You can get your current currencies configuration either for all time periods, from a specified start date.

Retrieving all rates for all time periods

curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/currencies.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Authorization: Basic {auth}'

{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.

Retrieving rates for specified time periods

To retrieve rates from a specific start date, use the startDate parameter in the YYY-MM-DD format. The midnight value of the configuration start date is determined by your organization's timezone.

curl -X GET 'https://TENANT_NAME.mambu.com/api/configuration/currencies.yaml?startDate=2019-01-02' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Authorization: Basic {auth}'

{auth} is the base-64-encoded value of username:password. For more information, see Authentication in our API reference.

Sample response

The following example shows a reply for a query with a start date value of the 2nd of January, 2019.

---
startDate: "2019-01-02"
baseCurrency:
  code: "USD"
  name : "US Dollars"
  symbol: "$"
  symbolPosition: "BEFORE_NUMBER"
  digitsAfterDecimal: 2
  type: "FIAT_CURRENCY"
foreignCurrencies:
  - currency:
      code: "EUR"
      name: "Euro"
      symbol: "€"
      symbolPosition: "AFTER_NUMBER"
      digitsAfterDecimal: 2
      type: "FIAT_CURRENCY"
    accountingRates:
      - startDate: "2018-01-02T00:00+11:00"
        rate: 100
      - startDate: "2020-01-02T00:00+11:00"
        rate: 100
    exchangeRates:
      - startDate: "2018-01-02T00:00+11:00"
        buyRate: 100
        sellRate: 110
      - startDate: "2020-01-02T00:00+11:00"
        buyRate: 200
        sellRate: 210     

Note that in this example the returned accounting and exchange rates have a start date of the 2nd of January, 2018, and that this date falls before our specified query start date of the 2nd of January, 2019, as shown in the first line.

This is because the returned values for accounting and exchange rates begin with the value that was in effect at the time of the query startDate. That value is reported along with its start date, which is the date the rate was added to Mambu. See the timeline below for an illustration.

If you specify a query startDate value that lies before the start date of a foreign currency exchange or accounting rate - that is, before the currency was added to Mambu - you will receive a reply that begins with the earliest exchange or accounting rate that was entered into Mambu along with its start date. That date will be after the specified query startDate. See the timeline below for an illustration:

PUT configuration

curl -X PUT 'https://tenanturl.mambu.com/api/configuration/currencies.yaml' \
-H 'Accept: application/vnd.mambu.v2+yaml' \
-H 'Content-Type: application/yaml' \
-H 'Authorization: Basic {auth}' \
--data-binary @currencies.yaml

“@currencies.yaml” represents the absolute path of the file on your device.

Use “--data-raw” if you want to specify the YAML body inline.

Configuration body example

startDate: "2019-01-02" 
baseCurrency:
  code: "USD"
  name : "US Dollars"
  symbol: "$"
  symbolPosition: "BEFORE_NUMBER"
  digitsAfterDecimal: 2
  type: "FIAT_CURRENCY"
foreignCurrencies:
  - currency:
      code: "EUR"
      name: "Euro"
      symbol: "€"
      symbolPosition: "AFTER_NUMBER"
      digitsAfterDecimal: 2
      type: "FIAT_CURRENCY"
    accountingRates:
      - startDate: "2019-01-02T00:00+11:00"
        rate: 100
      - startDate: "2019-01-05T00:00+11:00"
        rate: 100
    exchangeRates:
      - startDate: "2019-01-02T00:00+11:00"
        buyRate: 100
        sellRate: 110
      - startDate: "2020-06-29T00:00+10:00"
        buyRate: 200
        sellRate: 210  

Attributes

Base currency attributes

Foreign currency attributes

Replies

Validations

Warnings

You will receive a list of warnings if you try to delete a foreign currency which is in use because those cannot be deleted.

You will also receive warnings if a foreign currency does not have an accounting rate specified or an exchange rate specified.