Reference data and account settingsList currencies

List currencies

Lists the account's currencies, optionally only active or inactive ones, with today's rate to the caller's legal-entity currency.

The value set for CurrencyID on customer create/update. The {status} segment filters on IsActive; omit it (GET /v1/currency) for all currencies. Obsolete currencies are not excluded. Each row's CurrentRate is computed per call against the CALLER's legal-entity currency, so two users in different legal entities see different rates for the same currency.

Use it to:

  • Map ISO currency codes (CurrencyABB) to CurrencyID before creating customers

Not for:

  • Authoritative exchange rates for accounting: on an exchange-rate-service failure the stored rate is returned silently

Behaviour:

  • Idempotent.
  • Safe to retry.
  • Side effect: Each uncached currency on the page triggers one outbound call to the exchange-rate service (with the account's retry count and timeout), sequentially — first call of the day for a large page can be slow.

Next: POST /v1/customer/create, PUT /v1/customer/update

See also: GET /v1/user-setting, GET /v1/country/get-all

Not yet documented: errors; request → path params → description.

curl -X GET "https://app3.timelog.com/your-account/api/v1/currency/-1?$page=1&$pagesize=10" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "Properties": {
    "TotalRecord": "example_string",
    "TotalPage": "example_string",
    "PageNumber": "example_string"
  },
  "Entities": [
    {
      "Properties": {
        "CurrencyID": 123,
        "CurrencyABB": "example_string",
        "DescriptiveName": "John Doe",
        "CurrentRate": 3.14,
        "IsActive": true
      },
      "Links": [
        {
          "Href": "example_string",
          "Rel": "example_string"
        }
      ],
      "Actions": [
        {}
      ]
    }
  ],
  "Links": [
    {
      "Href": "example_string",
      "Rel": "example_string"
    }
  ]
}
GET
/v1/currency/{status}
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.

OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp). The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user. > Not yet documented: how to obtain a token. > Not yet documented: token lifetime.
path
statusinteger
Required

ActiveStatus. Also bound from the member name. Filters on CurrencyRead.IsActive (eq). Allowed values: | Value | Name | Meaning | |---|---|---| | -1 | All | No filter: active and inactive currencies (default when omitted). | | 0 | Inactive | Only currencies with IsActive = false. | | 1 | Active | Only currencies with IsActive = true. |

Options: -1, 0, 1
query
$pageinteger

Page number.

query
$pagesizeinteger

Page size. No maximum enforced in the API layer.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. JWT and reference tokens are both accepted. The token must carry the required scope (default tlp).

The token's sub claim is the acting user. A token WITHOUT sub (client-credentials) acts as the system service user. If the sub user cannot log in (inactive, locked, deleted), the request is rejected with 401 — it is no longer let through without a user.

Not yet documented: how to obtain a token.

Not yet documented: token lifetime.

Path Parameters

statusinteger
Required

ActiveStatus. Also bound from the member name.

Filters on CurrencyRead.IsActive (eq).

Allowed values:

ValueNameMeaning
-1AllNo filter: active and inactive currencies (default when omitted).
0InactiveOnly currencies with IsActive = false.
1ActiveOnly currencies with IsActive = true.
Allowed values:-101

Query Parameters

$pageinteger

Page number.

$pagesizeinteger

Page size. No maximum enforced in the API layer.

Responses

Propertiesobject

Paging values. They are returned as STRINGS, for example "TotalRecord": "12".

Entitiesarray

Omitted (not []) when the list is empty.

Linksarray