Bookings Taxes

Overview

This resource represents the Booking's Taxes which contribute to Booking's final price. Each Booking can have multiple taxes, that can be either included in the price of the taxable item or not. For example, if Rental's initial price is 1000 and there is an included BookingsTax for that Rental with amount of 100, the overall contribution to the Booking's final_price is still 1000, because the tax is already included in that amount. However, if the tax was not included in the price, the overall contribution would be 1000 + 100 = 1100.

Parameters

OAuth Scopes:

bookings_read / bookings_write / bookings_write_owned

Name	Type	Read/Write	Description
account	Integer	Read	Account's ID related to the Bookings Tax
booking	Integer	Read	Booking's ID related to the Bookings Tax.
tax	Integer	Read	Tax's ID related to the Bookings Tax.
taxable_id	Integer	Read	Taxable's ID related to the Bookings Tax. (Rental's, Fee's, or Bookings Fee's - this is a polymorphic association)
taxable_type	String	Read	Taxable's type related to the Bookings Tax. (Rental Fee, or Bookings Fee - this is a polymorphic association)
id	Integer	Read	Bookings Tax's id.
amount	Decimal	Read	Bookings Tax's amount.
name	Object	Read	Bookings Tax's name, list of locales described in enums section.
percentage	Decimal	Read	Bookings Tax's percentage.
tax_included_in_price	Boolean	Read	Tax amount already included in taxable's price if set to true.
created_at	Time	Read	Bookings Tax's create time.
updated_at	Time	Read	Bookings Tax's update time.

List bookings taxes

Based on the OAuth token scopes bookings taxes will be limited to a certain range.

Scope	Read Permissions
:bookings_write_owned	Display only bookings taxes for bookings created by app making the request
:bookings_read	Display all bookings taxes
:bookings_write	Display all bookings taxes

List all bookings taxes for current account(s).

GET /bookings_taxes

OAuth Scopes:

bookings_read / bookings_write / bookings_write_owned

response.json

{
  "links": {
    "bookings_taxes.booking": "http://www.bookingsync.com/api/v3/bookings/{bookings_taxes.booking}",
    "bookings_taxes.tax": "http://www.bookingsync.com/api/v3/taxes/{bookings_taxes.tax}",
    "bookings_taxes.rental": "http://www.bookingsync.com/api/v3/rentals/{bookings_taxes.taxable.id}",
    "bookings_taxes.fee": "http://www.bookingsync.com/api/v3/fees/{bookings_taxes.taxable.id}"
  },
  "bookings_taxes": [
    {
      "links": {
        "account": 3,
        "booking": 1382,
        "tax": 7,
        "taxable": {
          "id": 1,
          "type": "Rental"
        }
      },
      "id": 52,
      "name": {
        "en": "Bookings Tax"
      },
      "tax_included_in_price": false,
      "percentage": "455.0",
      "amount": "1565.2"
    }
  ],
  "meta": {}
}

Get a single bookings tax

Returns a single bookings tax identified by ID.

GET /bookings_taxes/:bookings_tax_id

OAuth Scopes:

bookings_read / bookings_write / bookings_write_owned

response.json

{
  "links": {
    "bookings_taxes.booking": "http://www.bookingsync.com/api/v3/bookings/{bookings_taxes.booking}",
    "bookings_taxes.tax": "http://www.bookingsync.com/api/v3/taxes/{bookings_taxes.tax}",
    "bookings_taxes.rental": "http://www.bookingsync.com/api/v3/rentals/{bookings_taxes.taxable.id}",
    "bookings_taxes.fee": "http://www.bookingsync.com/api/v3/fees/{bookings_taxes.taxable.id}"
  },
  "bookings_taxes": [
    {
      "links": {
        "account": 3,
        "booking": 1382,
        "tax": 7,
        "taxable": {
          "id": 1,
          "type": "Rental"
        }
      },
      "id": 52,
      "name": {
        "en": "Bookings Tax"
      },
      "tax_included_in_price": false,
      "percentage": "455.0",
      "amount": "1565.2"
    }
  ],
  "meta": {}
}