Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Taxes and Tax Sets

To represent Taxes associated with Property and Rate Plans at Channex.io you can use Taxes and Tax Sets.

Taxes

Entity which represent specific tax applicable to your Rate Plan or Property. Example: VAT 20%, City Tax 1 EUR per Guest per Night or any other.

Tax Sets

Entity which represent group of Taxes applicable to your Rate Plan or Property.

Each property can have many Tax Sets and Taxes, but only one can be selected as Default Tax Set. Default Tax Set will be applied to each new Rate Plan automatically.

Taxes List

Retrieve list of Taxes associated with user.

Request:

GET https://staging.channex.io/api/v1/taxes

Success Response Example

Status Code: 200 OK

{
  "data": [
    {
      "attributes": {
        "applicable_after": null,
        "applicable_before": null,
        "applicable_date_ranges": [],
        "currency": null,
        "id": "6d30137e-74a1-41f6-aa96-2c0371e94dbf",
        "is_inclusive": true,
        "logic": "percent",
        "max_nights": null,
        "rate": "10.00",
        "skip_nights": null,
        "title": "10% VAT",
        "type": "tax"
      },
      "relationships": {
        "property": {
          "data": {
            "type": "property",
            "id": "716305c4-561a-4561-a187-7f5b8aeb5920"
          }
        }
      },
      "id": "6d30137e-74a1-41f6-aa96-2c0371e94dbf",
      "type": "tax"
    }
  ]
}

Unauthorised Error Response

Status Code: 401 Unauthorized

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a list of Tax objects in the answer. Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided.

Get Tax by ID

Retrieve specific Tax associated with User by ID.

Request:

Success Response Example

Status Code: 200 OK

Unauthorised Error Response

Status Code: 401 Unauthorized

Not Found Error

Status Code: 404 Not Found

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Tax object in the answer. Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided or User not have access to requested Tax.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Tax with provided ID is not present at system.

Create Tax

Create a new Tax.

Request:

Query body (JSON):

Success Response Example

Status Code: 201 Created

Unauthorised Error Response

Status Code: 401 Unauthorized

Validation Error Response

Status Code: 422 Unprocessable Entity

Fields

title [required]

Any non-empty string with maximum length of 255 symbols. Note: The Tax will be represented in the system under that title.

logic [required]

One of possible values: percent , per_room, per_room_per_night, per_person, per_person_per_night, per_night, per_booking

type [required]

One of possible values: tax, fee, city_tax.

rate [required]

String value with amount applicable to tax. If logic is percent, can be between 0 and 100 only. At other cases, represent fixed amount of tax.

currency [required]*

Required only if logic is not percent. Should be a valid currency code. Represent Tax amount currency.

is_inclusive [required]

Boolean value. Represent include tax into room price or should be added atop.

property_id [required]

UUID. Relation to associated Property.

skip_nights [optional]

Positive Integer value. Represent count of days what should be skipped at tax calculation. Useful for long-stay taxes, which should be applied from 8 day of stay.

max_nights [optional]

Positive Integer value. Represent max count of days what should be used as a taxable base for this Tax. Useful for long-stay or short-stay taxes when tax should be applied only for first 7 days of stay.

applicable_date_ranges [optional]

List of applicable date ranges, represented as an object:

Where after and before is a valid date at ISO format.

This ranges define a ranges of dates when this tax should be applied. Useful to define periodical City Tax or Touristic Tax which is applicable for High Season. Example: Touristic Tax should be collected from 1 June to 31 August. At other dates this Tax is not applied.

You can define up to 20 date ranges.

Note: API responses always contain applicable_after, applicable_before and applicable_date_ranges. The applicable_after / applicable_before pair is a legacy representation of a single date range — if you provide them on create or update, applicable_date_ranges will be populated with that range automatically. If you provide only applicable_date_ranges, the legacy fields stay null.

Returns

Success Method can return a Success result with 201 Created HTTP Code if operation is successful. Will contain a Tax object in the answer.

Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided.

Validation Error Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.

Update Tax

Update a Tax.

Request:

Query body (JSON):

Success Response Example

Status Code: 200 OK

Unauthorised Error Response

Status Code: 401 Unauthorized

Not Found Error

Status Code: 404 Not Found

Validation Error Response

Status Code: 422 Unprocessable Entity

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Tax object in the answer. Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Tax with provided ID is not present at system.

Validation Error Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.

Remove Tax

Remove a Tax.

Request:

Success Response Example

Status Code: 200 OK

Unauthorised Error Response

Status Code: 401 Unauthorized

Not Found Error

Status Code: 404 Not Found

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Meta object with message in the answer.

Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Tax with provided ID is not present at system.

Tax Sets List

Retrieve list of Tax Sets associated with user.

Request:

Success Response Example

Status Code: 200 OK

Unauthorised Error Response

Status Code: 401 Unauthorized

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a list of Tax Set objects in the answer. Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided.

Get Tax Set by ID

Retrieve specific Tax Set associated with User by ID.

Request:

Success Response Example

Status Code: 200 OK

Unauthorised Error Response

Status Code: 401 Unauthorized

Not Found Error

Status Code: 404 Not Found

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Tax Set object in the answer. Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided or User not have access to requested Tax Set.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Tax Set with provided ID is not present at system.

Create Tax Set

Create a new Tax Set.

Request:

Query body (JSON):

Success Response Example

Status Code: 201 Created

Unauthorised Error Response

Status Code: 401 Unauthorized

Validation Error Response

Status Code: 422 Unprocessable Entity

Fields

title [required]

Any non-empty string with maximum length of 255 symbols. Note: The Tax Set will be represented in the system under that title.

property_id [required]

UUID of Property which is associated with Tax Set. Note: If it is first Tax Set for Property, it will be automatically installed as default_tax_set for this property.

currency [required]*

String. Should be a valid currency code. Represent Tax Set currency.

taxes [required]

List of object with associated taxes IDs. Can contain another taxes inside.

Taxes in the request should look like:

However, if one tax needs to be calculated after another, you can use the level field to define the calculation order:

Example: Assume you have a Cleaning Fee of $10.00 per night and VAT of 20%. VAT should be calculated on top of the Cleaning Fee.

To achieve this, you define the order using the level field. In this example, you'll use two levels: level 1 for the Cleaning Fee and level 0 for VAT.

Our calculation logic processes taxes from the deepest level (highest number) to the top level (lowest number). So we first calculate level 1, then calculate level 0 based on:

Final request example:

associated_rate_plan_ids [optional]

List of Strings which represent Rate Plan UUID which should be associated with created / updated Tax Set.

Returns

Success Method can return a Success result with 201 Created HTTP Code if operation is successful. Will contain a Tax Set object in the answer.

Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided.

Validation Error Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.

Update Tax Set

Update a Tax Set.

Request:

Query body (JSON):

Success Response Example

Status Code: 200 OK

Unauthorised Error Response

Status Code: 401 Unauthorized

Not Found Error

Status Code: 404 Not Found

Validation Error Response

Status Code: 422 Unprocessable Entity

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Tax Set object in the answer. Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Tax Set with provided ID is not present at system.

Validation Error Method can return a Validation Error result with 422 Unprocessable Entity HTTP Code if any validation rule is failed.

Remove Tax Set

Remove a Tax Set.

Request:

Success Response Example

Status Code: 200 OK

Unauthorised Error Response

Status Code: 401 Unauthorized

Not Found Error

Status Code: 404 Not Found

Returns

Success Method can return a Success result with 200 OK HTTP Code if operation is successful. Will contain a Meta object with message in the answer.

Unauthorised Error Method can return a Unauthorised Error result with 401 Unauthorized HTTP Code if wrong API Key provided.

Not Found Error Method can return a Not Found Error result with 404 Not Found HTTP Code if Tax Set with provided ID is not present at system.

PreviousFacilities Collection
NextApplications API

Last updated