Currencies

Some data, especially Products can be tied to a Currency which is listed in CRM CareCloud. You can get here the list of currencies available.

Available methods

All available methods for resource currencies.

HTTP method Endpoint Description
[badge-blue GET] /currencies Collection of available currencies
[badge-blue GET] /currencies/{currency_id} Detail of a currency


Get all currencies

Get a list of currencies accepted in CRM CareCloud
[badge-blue GET] /currencies

Response

Status code: 200 OK
Output structure : object

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/currencies
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NTRlMDVkNzM3MTY3NTGE4N2VhYWU1MDg4N2M1NTA2OWU0NDM5ZDEwOTEwMWM1ODNiOA==

Example response

HTTP/1.1 200 OK
Date: Thu, 06 Aug 2020 11:24:53 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "currencies": [
      {
        "currency_id": "86e05affc7a7abefcd513ab400",
        "name": "CZK",
        "code": "CZK"
      },
      {
        "currency_id": "8bed991c68a470e7aaeffbf048",
        "name": "EUR",
        "code": "EUR"
      }
    ],
    "total_items": 2
  }
}
Parameter name Type Description
currencies Currency[] Structure of currency
total_items integer Total count of found items of resource currencies


Detail of a currency

Get information about a specific currency
[badge-blue GET] /currencies/{currency_id}

Path parameters

Parameter name Type Description
currency_id string The unique id of a currency in CareCloud

Response

Status code: 200 OK
Output structure : Currency

Example Request

GET https://<projectURL>/rest-api/enterprise-interface/v1.0/currencies/86e05affc7a7abefcd513ab400
Content-Type: application/json
Accept-Language: cs, en-gb;q=0.8
Authorization: Basic ZW50ZXJwcmlzZV9pbnRlcmZhY2U6NTRlMDVkNzM3MTY3NTU0ODNjYzY3YjM1MTBkMGE4N2VhYWU1MDg4N2M1NTA2OWU0NDM5ZDEwOTEwMWM1ODNiOA==

Example response

HTTP/1.1 200 OK
Date: Thu, 06 Aug 2020 11:25:30 GMT
Content-Type: application/json; charset=utf-8

{
  "data": {
    "currency_id": "86e05affc7a7abefcd513ab400",
    "name": "CZK",
    "code": "CZK"
  }
}