Read the caller's branch currency

Any signed in user. Returns the currency this till formats money in, plus its rate. The branch comes from the session, not the query string, so there is no branch_id to forge.

GET/api/v1/currency/branch

Authorization

AuthorizationBearer token (JWT) · headerrequired

JWT from POST /api/v1/auth/login sent as Authorization Bearer.

Responses

200

The branch currency and its rate

currency_codestringrequired

base_currency_codestringrequired

namestringrequired

symbolstringrequired

exponentintegerrequired

min -9007199254740991 · max 9007199254740991

ratenumberrequired

rate_idstring | nullrequired

effective_atstring | nullrequired

is_stalebooleanrequired

age_daysinteger | nullrequired

Show properties

Any of:

integer

integer

null

null

400

No exchange rate is filed for this branch currency

detailstringrequired

401

Not authenticated

detailstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Request

curl -X GET 'http://localhost:8000/api/v1/currency/branch' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch("http://localhost:8000/api/v1/currency/branch", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

import requests

response = requests.get(
    "http://localhost:8000/api/v1/currency/branch",
    headers={
        "Authorization": "Bearer YOUR_TOKEN"
    },
)

Response

{
  "currency_code": "string",
  "base_currency_code": "string",
  "name": "string",
  "symbol": "string",
  "exponent": -9007199254740991,
  "rate": 0,
  "rate_id": "string",
  "effective_at": "string",
  "is_stale": true,
  "age_days": -9007199254740991
}

{
  "detail": "string"
}

{
  "detail": "string"
}