Sign in
Tax Rates

Create a new Tax Rate

OAuth Scope

This endpoint requires the following OAuth scope manage_tax_rates.

Record UUID

UUID is optional for record creation. If no UUID is supplied, a UUID will be automatically generated for the new record and returned in the x-record-uuid response header.

post/taxrate.json

Request body

namestring required

Name of the tax rate used for identification. Examples include 'GST', 'VAT', 'Sales Tax', etc.

amountstring

The tax rate percentage value (stored as a decimal value). For example, 10 for a 10% tax rate. Used in calculations to determine tax amounts for invoices and quotes.

is_default_tax_rate0 | 1

Boolean flag indicating whether this tax rate is the system default (true) or not (false). Only one tax rate can be marked as default at any time. The default tax rate is automatically applied to new line items when no specific tax rate is selected.. Valid values are [0,1]

uuidstring uuid

Unique identifier for this record

Example request

{
  "uuid": "123e4567-1861-46a0-bda4-23f94014608b"
}

Response

Success

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

Changed in 3 of the 50 revisions of this API.15

  • 638a8df09bf41See the full diff
    • ●

      removed the request property active

      request-property-removed

  • ca9b053c43734See the full diff
    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the non-success response with the status 500

      response-non-success-status-added

  • e859f8c27a211See the full diff
    • ○

      the security scope manage_tax_rates was added to the endpoint's security scheme oauth2

      api-security-scope-added