Tax Rates

Retrieve a Tax Rate

Changed on

OAuth Scope

This endpoint requires the following OAuth scope read_tax_rates.

get/taxrate/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/taxrate/{uuid}.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: read_tax_rates

Path parameters

uuidstring uuid required

UUID of the Tax Rate

Response

Tax Rate record retrieved successfully

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

active0 | 1

Record active/deleted flag. Valid values are [0,1]

edit_datestring

Timestamp at which record was last modified

Example response

{
  "uuid": "123e4567-849d-4753-b124-23f946a2134b",
  "edit_date": "2026-03-01 12:00:00"
}

Changes

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • e859f8c27a21Revision changes
    • info

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