Taxes

  1. Overview
  2. List taxes
  3. Get a single tax
  4. Create a new tax
  5. Update a tax

Overview

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

Parameters

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 greated 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

Response

{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "id": 4,
      "name": {
        "en": "Tax"
      },
      "percentage": "10.0",
      "created_at": "2023-12-11T08:26:23Z",
      "updated_at": "2023-12-11T08:26:23Z",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23",
      "links": {
        "account": 1
      }
    }
  ]
}
{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "id": 4,
      "name": {
        "en": "Tax"
      },
      "notes": "Private notes",
      "percentage": "10.0",
      "created_at": "2023-12-11T08:26:23Z",
      "updated_at": "2023-12-11T08:26:23Z",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23",
      "links": {
        "account": 1
      }
    }
  ]
}

Get a single tax

Returns a single tax identified by ID.

GET /taxes/:tax_id

Response

{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "id": 4,
      "name": {
        "en": "Tax"
      },
      "percentage": "10.0",
      "created_at": "2023-12-11T08:26:23Z",
      "updated_at": "2023-12-11T08:26:23Z",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23",
      "links": {
        "account": 1
      }
    }
  ]
}
{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "id": 4,
      "name": {
        "en": "Tax"
      },
      "notes": "Private notes",
      "percentage": "10.0",
      "created_at": "2023-12-11T08:26:23Z",
      "updated_at": "2023-12-11T08:26:23Z",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23",
      "links": {
        "account": 1
      }
    }
  ]
}

Create a new tax

Returns a newly created tax.

POST /taxes

Example JSON request

{
  "taxes": [
    {
      "name_en": "Tax",
      "notes": "Private notes",
      "percentage": "10.0",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23"
    }
  ]
}

Response

{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "id": 4,
      "name": {
        "en": "Tax"
      },
      "notes": "Private notes",
      "percentage": "10.0",
      "created_at": "2023-12-11T08:26:23Z",
      "updated_at": "2023-12-11T08:26:23Z",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23",
      "links": {
        "account": 1
      }
    }
  ]
}

Update a tax

Returns an updated tax identified by ID.

PUT /taxes/:tax_id

Example JSON request

{
  "taxes": [
    {
      "name_en": "Tax",
      "notes": "Private notes",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23"
    }
  ]
}

Response

{
  "links": {
    "taxes.account": "http://www.bookingsync.com/api/v3/accounts/{taxes.account}"
  },
  "taxes": [
    {
      "id": 4,
      "name": {
        "en": "Tax"
      },
      "notes": "Private notes",
      "percentage": "10.0",
      "created_at": "2023-12-11T08:26:23Z",
      "updated_at": "2023-12-11T08:26:23Z",
      "start_date": "2023-12-18",
      "end_date": "2024-08-23",
      "links": {
        "account": 1
      }
    }
  ]
}