Get Tax List

Get Tax List

POST [PlatformAddress]/api/1.0/venue?action=getTaxListundefined

Return the tax list for the venue.

Path Parameters

NameTypeDescription

venueId

integer

The id of the venue

{
  "meta": {
    "totalResults": 1,
    "start": 0,
    "perPage": 1,
    "count": 1
  },
  "results": [
    {
      "id": 2,
      "name": "GST"
    }
  ]
}

Example Request

Get Venues Tax List

{
  "venueId": 2
}

Returns

A collection object with the following properties in the results

PropertyTypeDescription

id

integer

The unique invoice identifier

name

string

The name of Tax

type

integer Type

The type of the tax. Whether Tax / Service Fee

appliesTo

integer Applies To

Whether the tax only applies to accommodation

amountType

integer Amount Type

Tax or service fee amount / percent to apply on items. 1 = A percentage, 2 = An amount

amount

double

Percentage / Amount of the tax

taxIds

array

The taxes which are applied to the amount of the service fee

costcenterIds

array

The cost centers to which the tax /service fee apply

excludedTaxIds

array

The array of tax Ids which are excluded to apply on the booking

calculateExclusively

boolean

If enabled, the tax will not be included in the line item totals, only in the cost centre, booking and invoice totals

unitType

integer Unit Type

The metric of which to calculate the units of tax to be charged. Capacity - Max occupancy of the room. Occupants - Number of guest staying in the room, calculated from capacity or multi-occupancy values if enabled. Room Nights - Total number of room nights for the room type

Type

The tax types.

ValueDescription

1

Tax

2

Service Fees

Applies To

The applies to options.

ValueDescription

1

All

2

Accommodation Only

Amount Type

The amount options.

ValueDescription

1

Percentage

2

Amount

Unit Type

The unit type options.

ValueDescription

1

Room Nights

2

Capacity

3

Occupancy

Last updated