Skip to main content
POST
/
api
/
currencies
Create a new currency
curl --request POST \
  --url https://api.example.com/api/currencies \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'organization-id: <organization-id>' \
  --data '
{
  "currencyName": "USD",
  "currencyCode": "USD",
  "currencySign": "$"
}
'
{
  "id": 1,
  "currencyName": "US Dollar",
  "currencyCode": "USD",
  "currencySign": "$",
  "isBaseCurrency": true,
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:00:00Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Value must be 'Bearer ' where is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json
​
currencyName
string
required

The currency name

Example:

"USD"

​
currencyCode
string
required

The currency code

Example:

"USD"

​
currencySign
string
required

The currency sign

Example:

"$"

Response

The currency has been successfully created.

​
id
number
required

The unique identifier of the currency

Example:

1

​
currencyName
string
required

The name of the currency

Example:

"US Dollar"

​
currencyCode
string
required

The code of the currency

Example:

"USD"

​
currencySign
string
required

The sign/symbol of the currency

Example:

"$"

​
isBaseCurrency
boolean
required

Whether this is the base currency for the organization

Example:

true

​
createdAt
string<date-time>
required

The creation timestamp

Example:

"2024-03-20T10:00:00Z"

​
updatedAt
string<date-time>
required

The last update timestamp

Example:

"2024-03-20T10:00:00Z"