GET
View a currency
Company space User accounts only For: Administrator · Permission: currencies.retrieve Conditions
  • Agent accounts are refused.
  • The currency must be a shared one or one of the company’s own.
Part of Company profile, settings and currencies.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

currencyId
string
required

Identifier of the currency (27-character KSUID string). It must be a shared currency or one owned by the company.

Query Parameters

response
enum<string>
default:resource

Response mode. Default resource; none answers 204 No Content.

Available options:
resource
fields
string

Comma-separated JSON keys of the root resource (id is always rendered). Available: id, exponent, code, name, company_id, created_at, updated_at.

include
string

Comma-separated include paths, each optionally followed by its fields in parentheses: units(id,sku),units.uomUnit(id,name). Max depth 6, max 40 paths. Available: .

Response

200 - application/json

Resource.

id

Identifier of the currency (27-character KSUID string).

exponent
integer

Number of decimal places of the currency (0 for XOF); an amount in minor units divided by 10 to this power gives the amount in the currency.

code

3-character currency code, stored in uppercase.

name

Name of the currency, stored in uppercase.

company_id

Identifier of the company the record belongs to.

created_at

Date and time the record was created (ISO 8601, UTC).

updated_at

Date and time the record was last changed (ISO 8601, UTC).