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

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 Bearer Token provided.

Get Tax by ID

Retrieve specific Tax associated with User by ID.

Request:

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

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 Bearer Token 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:

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

Query body (JSON):

{
  "tax": {
    "title": "VAT",
    "logic": "percent",
    "type": "tax",
    "rate": "20.00",
    "is_inclusive": true,
    "property_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
    "skip_nights": 1,
    "max_nights": 10,
    "applicable_date_ranges": [
      {
        "after": "2024-01-01",
        "before": "2024-12-31"
    ]
  }
}

Fields

title [required]

Any non-empty string with maximum length of 255 symbols. Note: The Group 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 of logic is not percent. Should 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:

{
  "after": "2024-01-01",
  "before": "2024-12-31"
}

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.

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 Bearer Token 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:

PUT https://staging.channex.io/api/v1/taxes/:id

Query body (JSON):

{
  "tax": {
    "title": "New Tax Title"
  }
}

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 Bearer Token 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:

DELETE https://staging.channex.io/api/v1/taxes/:id

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 Bearer Token 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:

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

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 Bearer Token provided.

Get Tax Set by ID

Retrieve specific Tax Set associated with User by ID.

Request:

GET https://staging.channex.io/api/v1/tax_sets/:id

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 Bearer Token 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:

POST https://staging.channex.io/api/v1/tax_sets

Query body (JSON):

{
  "tax_set": {
    "title": "Tax Set Title",
    "property_id": "716305c4-561a-4561-a187-7f5b8aeb5920",
    "associated_rate_plan_ids": ["77229f71-8c8f-4d79-92ed-749002407267"],
    "taxes": [
      {"id": "c1fb94b3-ce95-4233-be0e-2748b3728715"},
      {"id": "a3c4f3c8-841c-4492-b5ff-ce9ca92c1c83"}
    ],
    "currency": "USD"
  }
}

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 a valid currency code. Represent Tax Set currency.

taxes [required]

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

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 Bearer Token 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:

PUT https://staging.channex.io/api/v1/tax_set/:id

Query body (JSON):

{
  "tax": {
    "title": "New Tax Set Title",
    "associated_rate_plan_ids": ["77229f71-8c8f-4d79-92ed-749002407267"]
  }
}

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 Bearer Token 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:

DELETE https://staging.channex.io/api/v1/tax_sets/:id

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 Bearer Token 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 CollectionNextMessages Collection

Last updated