Taxes

Overview

This resource represents Taxes which can be later added to Rentals as Rentals Taxes or Fees as Rentals Fees.

Parameters

OAuth Scopes:
public
rates_read
rates_write

Name	Type	Read/Write	Description
account	Integer	Read	Account's ID related to the Tax
id	Integer	Read	Tax's ID.
name	Object	Read	Tax's name, list of locales described in enums section.
percentage	Decimal	Read	Tax's percentage.
kind	String	Read	Tax's kind, list of kinds described in enums section
created_at	Time	Read	Tax's create time.
updated_at	Time	Read	Tax's update time.
start_date	Date	Read	Beginning of the period when the tax is applicable.
end_date	Date	Read	Ending of the period when the tax is applicable. If left blank, the Tax is applicable indefinitely starting from `start_date`

Name	Type	Read/Write	Description
account	Integer	Read	Account's ID related to the Tax
id	Integer	Read	Tax's ID.
name	Object	Read	Tax's name, list of locales described in enums section.
notes	String	Read	Tax's private notes (requires `rates_read` or `rates_write scope)`.
percentage	Decimal	Read	Tax's percentage.
kind	String	Read	Tax's kind, list of kinds described in enums section
created_at	Time	Read	Tax's create time.
updated_at	Time	Read	Tax's update time.
start_date	Date	Read	Beginning of the period when the tax is applicable.
end_date	Date	Read	Ending of the period when the tax is applicable. If left blank, the Tax is applicable indefinitely starting from `start_date`

Name	Type	Read/Write	Description	Constraints
account	Integer	Read	Account's ID related to the Tax
id	Integer	Read	Tax's ID.
name	Object	Read/Write	Tax's name, list of locales described in enums section.	Required for Account's default locale, must not contain non-printing characters, maximum length: 50
notes	String	Read/Write	Tax's private notes (requires `rates_read` or `rates_write scope`).
percentage	Decimal	Read/Write	Tax's percentage.	Required, must be greater than or equal to 0, writable only during creation
kind	String	Read/Write	Tax's kind, list of kinds described in enums section	Required, Must be a valid tax kind
created_at	Time	Read	Tax's create time.
updated_at	Time	Read	Tax's update time.
start_date	Date	Read/Write	Beginning of the period when the tax is applicable.	Required, must be before `end_date` if `end_date` is present
end_date	Date	Read/Write	Ending of the period when the tax is applicable. If left blank, the Tax is applicable indefinitely starting from `start_date`	Must be after `start_date` if present

List taxes

List all taxes for a given account(s).

GET /taxes

OAuth Scopes:
public
rates_read / rates_write

response.json
{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "links": {
        "account": 1
      },
      "id": 4,
      "percentage": "10.0",
      "created_at": "2025-03-31T17:52:12.782Z",
      "updated_at": "2025-04-07T17:52:12.782Z",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "name": {
        "en": "Tax"
      }
    }
  ]
}

response.json
{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "links": {
        "account": 1
      },
      "id": 4,
      "percentage": "10.0",
      "created_at": "2025-03-31T17:52:12.783Z",
      "updated_at": "2025-04-07T17:52:12.783Z",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "notes": "Private notes",
      "name": {
        "en": "Tax"
      }
    }
  ]
}

Get a single tax

Returns a single tax identified by ID.

GET /taxes/:tax_id

OAuth Scopes:
public
rates_read / rates_write

response.json
{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "links": {
        "account": 1
      },
      "id": 4,
      "percentage": "10.0",
      "created_at": "2025-03-31T17:52:12.784Z",
      "updated_at": "2025-04-07T17:52:12.784Z",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "name": {
        "en": "Tax"
      }
    }
  ]
}

response.json
{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "links": {
        "account": 1
      },
      "id": 4,
      "percentage": "10.0",
      "created_at": "2025-03-31T17:52:12.785Z",
      "updated_at": "2025-04-07T17:52:12.785Z",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "notes": "Private notes",
      "name": {
        "en": "Tax"
      }
    }
  ]
}

Create a new tax

Returns a newly created tax.

POST /taxes

request.json
{
  "taxes": [
    {
      "name_en": "Tax",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "notes": "Private notes",
      "percentage": "10.0"
    }
  ]
}

response.json
{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "links": {
        "account": 1
      },
      "id": 4,
      "percentage": "10.0",
      "created_at": "2025-03-31T17:52:12.786Z",
      "updated_at": "2025-04-07T17:52:12.786Z",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "notes": "Private notes",
      "name": {
        "en": "Tax"
      }
    }
  ]
}

Update a tax

Returns an updated tax identified by ID.

PUT /taxes/:tax_id

request.json
{
  "taxes": [
    {
      "name_en": "Tax",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "notes": "Private notes"
    }
  ]
}

response.json
{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "links": {
        "account": 1
      },
      "id": 4,
      "percentage": "10.0",
      "created_at": "2025-03-31T17:52:12.787Z",
      "updated_at": "2025-04-07T17:52:12.787Z",
      "start_date": "2025-04-21",
      "end_date": "2025-04-28",
      "notes": "Private notes",
      "name": {
        "en": "Tax"
      }
    }
  ]
}

Overview​

Parameters​

List taxes​

Get a single tax​

Create a new tax​

Update a tax​