API Reference

Create tax

post
https://open-api.guesty.com/v1/taxes

Create tax configuration with the provided settings.

Body Params
string
  1. The unit (listing) id on which the new tax will apply.
  2. To apply the tax on account level, leave this field empty.
string
enum
required
  1. The tax type.
  2. Each tax type can only be defined once on account/listing level.
string
enum
required

Determines whether the tax amount should be treated as a fixed or percentage value

Allowed:
number
required
≥ 0
  1. the amount of the tax, could be a fixed value or percentage whether units is 'FIXED' or 'PERCENTAGE' respectively.
  2. when 'FIXED' then 'amount' has to be greater then 0
  3. when 'PERCENTAGE' then 'amount' has to be greater then 0 and smaller or equal to 100
string
enum
required

Determines by what factor the tax amount will be multiplied

Allowed:
string
length ≤ 40

The name for the tax, which will be used accross guesty. there can be no two taxes with the same name.

boolean
  1. Relevant only when the units equals 'PERCENTAGE'
  2. When equals 'true', then the tax will be calculated on all fees and 'appliedOnFees' must contain all values
appliedOnFees
array of strings

  1. Relevant only when the unit equals 'PERCENTAGE'

  2. This defines the fees on which the tax will be calculated

appliedOnFees
boolean
  1. When set to 'true' and 'appliedByDefaultOnChannels' is not empty, then Guesty will prededuct the tax from the accommodation fare.
  2. can not be 'true' when 'appliedByDefaultOnChannels' is empty
appliedByDefaultOnChannels
array of strings
  1. When contains values and 'isAppliedByDefault' is set to 'true', then Guesty will prededuct the tax from the accommodation fare.
  2. can not contain elements when 'isAppliedByDefault' is 'false'
  3. currently, only supported for reservations received from source Airbnb
appliedByDefaultOnChannels
conditionalOverrides
object

Set additional conditions for this tax

Responses

400

The input provided is invalid.

Updated 3 months ago

Language
Credentials
Header
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 3 months ago