Skip to main content
GET
/
api
/
sys
/
currencies
/
{id}
Get one Currency
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/currencies/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "Name": "<string>",
  "Code": "<string>",
  "Format": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A Currency represents an ISO 4217 currency available in the system. Currencies are system-managed and read-only — they cannot be created, updated, or deleted via the API. Each business has a primary currency (CurrencyId on the Business entity) used for all invoices. A secondary currency can also be configured for payment processing in a different currency. Products, charges, and other billing entities reference a currency to determine the pricing denomination. Use the Code property (e.g. USD, EUR, GBP) to identify currencies programmatically, and Format to display monetary values in the correct locale format.

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the Currency-Read role.

​
Path Parameters

​
id
integer
required
The Id of the Currency record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/currencies/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Name
string
Full display name of the currency (e.g. ‘US Dollar’, ‘Euro’, ‘Pound sterling’).
​
Code
string
ISO 4217 three-letter currency code (e.g. ‘USD’, ‘EUR’, ‘GBP’).
​
Format
string
Display format string used to render monetary amounts in this currency.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "Name": "",
  "Code": "",
  "Format": "",
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "Currency Example",
  "LocalizationDetails": null,
  "CustomFields": null
}