Create TaxRate

POST

api

sys

taxrates

Create TaxRate

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/taxrates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Rate": 123,
  "ExemptionReason": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/taxrates"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Rate": 123,
    "ExemptionReason": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Name: '<string>', Rate: 123, ExemptionReason: 123})
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<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-Create role.

Enums

eTaxExemptionReason — ExemptionReason values

Value	Name
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

Request Body

Required Fields

integer

required

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

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

number

required

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

integer

required

Portuguese VAT exemption reason code used by compliance integrations; use None when no exemption code applies, otherwise select the applicable M-code..

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/taxrates" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Rate": 0,
    "ExemptionReason": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/taxrates',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: '',
      Rate: 0,
      ExemptionReason: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/taxrates',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': '',
        'Rate': 0,
        'ExemptionReason': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the taxrate was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "TaxRate was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Create TaxRate

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/taxrates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Rate": 123,
  "ExemptionReason": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/taxrates"

payload = {
    "BusinessId": 123,
    "Name": "<string>",
    "Rate": 123,
    "ExemptionReason": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Name: '<string>', Rate: 123, ExemptionReason: 123})
};

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

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Code Examples

Response

200

400