Update tax

patch

https://open-api.guesty.com/v1/taxes/{id}

Update tax by id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The tax id

Query Params

applyRequiredChangesToTaxesWithSameType

boolean

When true, applies required changes to all taxes with the same type.

Body Params

type

string

enum

The tax type.
Multiple taxes of the same type are allowed on the same account/listing level, each represented as a distinct tax entity, but they must have distinct names.
All taxes sharing a type must agree on whether they are inclusive: an inclusive tax cannot be mixed with an exclusive tax of the same type.
Multiple inclusive taxes can share a type only if each has non-overlapping 'appliedOnFees'; 'appliedToAllFees' cannot be 'true' when more than one tax shares the type.

units

string

enum

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

Allowed:

amount

number

≥ 0

the amount of the tax, could be a fixed value or percentage whether units is 'FIXED' or 'PERCENTAGE' respectively.
when 'FIXED' then 'amount' has to be greater then 0
when 'PERCENTAGE' then 'amount' has to be greater then 0 and smaller or equal to 100

quantifier

string

enum

Determines by what factor the tax amount will be multiplied

Allowed:

appliedToAllFees

boolean

Relevant only when the units equals 'PERCENTAGE'
When equals 'true', then the tax will be calculated on all fees and 'appliedOnFees' must contain all values

appliedOnFees

array of strings

appliedOnFees

isAppliedByDefault

boolean

When set to 'true' and 'appliedByDefaultOnChannels' is not empty, then Guesty will prededuct the tax from the accommodation fare.
can not be 'true' when 'appliedByDefaultOnChannels' is empty

appliedByDefaultOnChannels

array of strings

appliedByDefaultOnChannels

Allowed:

conditionalOverrides

object

Set additional conditions for this tax

isInclusive

boolean

When 'true', the tax amount is included in the accommodation fare rather than added on top.
Cannot be 'true' together with 'isAppliedByDefault', 'appliedByDefaultOnChannels', or 'conditionalOverrides'.

channelOverrides

array of objects

Channel-specific overrides for this tax. Each entry customizes the tax for a specific channel.

channelOverrides

name

string

length ≤ 40

The name for the tax, which will be used accross guesty. there can be no two taxes with the same name. to remove a name of existing tax pass empty string

Responses

400

The input provided is invalid.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The tax has been successfully updated.