Get one TaxRate

GET

api

sys

taxrates

{id}

Get one TaxRate

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/taxrates/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/taxrates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Rate": 123,
  "ExemptionReason": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

A tax rate is a location-specific percentage applied to products, plans, booking rates, event tickets, and charges; it can also carry a VAT exemption reason for compliance integrations.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the TaxRate-Read role.

Path Parameters

integer

required

The Id of the TaxRate record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/taxrates/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/taxrates/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/taxrates/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location that owns this tax rate; tax-rate names must be unique within that location and can be used in other locations..

string

Required name used to identify this tax rate; it must be unique within the location..

number

Tax percentage applied to net amounts, expressed as a whole percentage; for example, enter 20 for 20%..

integer

Portuguese VAT exemption reason code used by compliance integrations; use None when no exemption code applies, otherwise select the applicable M-code.. See eTaxExemptionReason enum values: 1 = None, 2 = M01, 3 = M02, 4 = M04, 5 = M05, 6 = M06, 7 = M07, 8 = M09, 9 = M10, 10 = M11, 11 = M12, 12 = M13, 13 = M14, 14 = M15, 15 = M16, 16 = M19, 17 = M20, 18 = M21, 19 = M25, 20 = M26, 21 = M30, 22 = M31, 23 = M32, 24 = M33, 25 = M34, 26 = M40, 27 = M41, 28 = M42, 29 = M43, 30 = M99.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "Name": "",
  "Rate": 0,
  "ExemptionReason": 0,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "TaxRate Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get one TaxRate

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/taxrates/{id} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/taxrates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "Rate": 123,
  "ExemptionReason": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200