Currency Code

The currency code resource.

Basehttps://rest.carbon.ms/currencyCode

GET/currencyCode

List currency codes

Retrieve a paginated list of currency codes. Filter, order, and select columns with PostgREST query parameters.

Query parameters

selectstring

Comma-separated columns to return. Defaults to all.

orderstring

Column to sort by, e.g. `createdAt.desc`.

limitinteger

Maximum rows to return.

offsetinteger

Rows to skip, for pagination.

GEThttps://rest.carbon.ms/currencyCode

curl --request GET \
  --url 'https://rest.carbon.ms/currencyCode?select=*&limit=10' \
  --header 'Authorization: Bearer <api-key>'

Response

[
  {
    "code": "string",
    "name": "Example"
  }
]

GET/currencyCode

Retrieve a currency code

Fetch a single currency code by filtering on `code`.

Query parameters

codestring

Match on the currency code's `code`, e.g. `eq.{id}`.

GEThttps://rest.carbon.ms/currencyCode

curl --request GET \
  --url 'https://rest.carbon.ms/currencyCode?code=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

Response

{
  "code": "string",
  "name": "Example"
}

POST/currencyCode

Create a currency code

Create a new currency code.

Body parameters

namestringrequired

POSThttps://rest.carbon.ms/currencyCode

curl --request POST \
  --url https://rest.carbon.ms/currencyCode \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'

Response

{
  "code": "string",
  "name": "Example"
}

PATCH/currencyCode

Update a currency code

Update an existing currency code, matched on `code`.

Body parameters

namestringrequired

PATCHhttps://rest.carbon.ms/currencyCode

curl --request PATCH \
  --url 'https://rest.carbon.ms/currencyCode?code=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Prefer: return=representation' \
  --data '{"name":"Example"}'

Response

{
  "code": "string",
  "name": "Example"
}

DELETE/currencyCode

Delete a currency code

Delete a currency code, matched on `code`. Returns 204 No Content.

Query parameters

codestring

The `code` of the currency code to delete, e.g. `eq.{id}`.

DELETEhttps://rest.carbon.ms/currencyCode

curl --request DELETE \
  --url 'https://rest.carbon.ms/currencyCode?code=eq.%7Bid%7D' \
  --header 'Authorization: Bearer <api-key>'

204 No Content