Sign in

v1

latestOpenAPI 3.0.02026-07-1498163181.9 KB
TaxRate

Create a tax rate

Creates a tax rate

post/api/v1/tax-rates

Request body

namestring required

The name of the tax rate.

descriptionstring

The description of the tax rate.

countrystring

The country of the tax rate.

percentagenumber required

Percent that will be added to subtotal as a tax.

isActiveboolean

Whether the tax rate is currently active

metadataobject

The metadata of the tax rate

Example request

{
  "percentage": 1
}

Response

idstring required
createdAtstring date-time
updatedAtstring date-time
namestring required

The name of the tax rate.

descriptionstring

The description of the tax rate.

countrystring

The country of the tax rate.

percentagenumber required

Percent that will be added to subtotal as a tax.

type'exclusive' | 'inclusive' required
isActiveboolean

Whether the tax rate is currently active

metadataobject

The metadata of the tax rate

Example response

{
  "percentage": 1
}