Currency Type

A list of currencies used by an organization for which the multi currency feature is enabled.

conversionRate
number <float>

Conversion rate of this currency type against the default currency.

createdAt
string <date-time>

The date and time the factor when currency type was created.

isActive
boolean

Indicates whether this currency type is active or not.

isDefault
boolean

Indicates whether this currency type is the default or not.

isoCode
string <= 3 characters

ISO code of the currency,three-letter currency ISO codes defined by the ISO 4217 standard, such as USD, GBP, or JPY.

updatedAt
string <date-time>

The date and time the factor when currency type was updated.

{
}

Currency Type Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta

⌵ Currency Type Actions

Get a Collection of Currency Types

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/currencyTypes
Request samples 
Response samples 
application/vnd.api+json
{
}
Create a New Currency Type
SecuritybearerAuth 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/currencyTypes
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}
Delete an Existing Currency Type by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/currencyTypes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Get a Currency Type by ID
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/currencyTypes/{id}
Request samples 
Response samples 
application/vnd.api+json
{
}
Update a Currency Type
SecuritybearerAuth 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/currencyTypes/{id}
Request samples 
application/vnd.api+json
{
}
Response samples 
application/vnd.api+json
{
}