Currency

Version 1.0

The Currency Entity is a core component facilitating standardized representation of monetary values in our platform. It supports multi-currency transactions, accurate pricing, and international commerce by providing essential data fields such as Currency Code, Currency Name, Exchange Rate, and Symbol. This entity ensures financial consistency and enables seamless interactions in a global marketplace.

# Endpoints
GET
/v1/currencies# Retrieve all currencies
GET
/v1/currencies/USD# Retrieve a single currency

Currency Entity

  • Name
    id
    Type
    string
    Required
    Description

    The unique identifier for the currency, serving as the primary key.

  • Name
    code
    Type
    string
    Required
    Description

    A three-letter currency code, such as USD or EUR, uniquely identifying the currency.

  • Name
    name
    Type
    string
    Required
    Description

    The name of the currency, providing a human-readable identification.

  • Name
    units
    Type
    string
    Description

    The units used for the currency, providing additional information about the currency denomination.

  • Name
    created_at
    Type
    timestamp
    Description

    The timestamp indicating when the currency was created, formatted in ISO 8601.

  • Name
    updated_at
    Type
    timestamp
    Description

    The timestamp indicating when the currency was last updated, formatted in ISO 8601.

  • Name
    created_by
    Type
    foreignId
    Description

    The foreign ID indicating the user who created the currency.

  • Name
    updated_by
    Type
    foreignId
    Description

    The foreign ID indicating the user who last updated the currency.

The Currency resource

JSON
{
  "id": "123456789",
  "code": "USD",
  "name": "United States Dollar",
  "units": "1$ = 100",
  "created_at": "2024-01-19T08:45:00Z",
  "updated_at": "2024-01-19T10:30:00Z",
  "created_by": "789012345",
  "updated_by": "123456789"
}

Retrieve all currencies

This endpoint allows you to retrieve all currencies.

Examples

Retrieve a single currency

GET
/v1/currencies
curl --request GET \
  --url https://api.qooly.io/v1/currencies

Retrieve a single currency

GET
/v1/currencies
curl --request GET \
  --url https://api.qooly.io/v1/currencies
JSON
[
  {
    "id": "123456789",
    "code": "USD",
    "name": "United States Dollar",
    "units": "1$ = 100",
    "created_at": "2024-01-19T08:45:00Z",
    "updated_at": "2024-01-19T10:30:00Z",
    "created_by": "789012345",
    "updated_by": "123456789"
  },
  {
    "id": "987654321",
    "code": "EUR",
    "name": "Euro",
    "units": "1€ = 100",
    "created_at": "2024-01-19T08:45:00Z",
    "updated_at": "2024-01-19T10:30:00Z",
    "created_by": "789012345",
    "updated_by": "123456789"
  }
]

Retrieve a single currency

This endpoint allows you to retrieve details about a specific currency.

Required Parameters

  • Name
    id
    Type
    string
    Required
    Description

Examples

Retrieve a single currency

GET
/v1/currencies/123456789
curl --request GET \
  --url https://api.qooly.io/v1/currencies/123456789

Retrieve a single currency

GET
/v1/currencies/123456789
curl --request GET \
  --url https://api.qooly.io/v1/currencies/123456789
JSON
{
  "id": "123456789",
  "code": "USD",
  "name": "United States Dollar",
  "units": "1$ = 100",
  "created_at": "2024-01-19T08:45:00Z",
  "updated_at": "2024-01-19T10:30:00Z",
  "created_by": "789012345",
  "updated_by": "123456789"
}