Get one Currency

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>'

import requests

url = "https://spaces.nexudus.com/api/sys/currencies/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/currencies/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/currencies/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/currencies/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

string

Full display name of the currency (e.g. ‘US Dollar’, ‘Euro’, ‘Pound sterling’).

string

ISO 4217 three-letter currency code (e.g. ‘USD’, ‘EUR’, ‘GBP’).

string

Display format string used to render monetary amounts in this currency.

integer

Unique record identifier.

string

UUID of the record.

string

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

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple CurrenciesRetrieve multiple Currency records by their Ids in a single request.

Get one Currency

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/currencies/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/currencies/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/currencies/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Name": "<string>",
  "Code": "<string>",
  "Format": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200