Skip to main content

Bookings Fees

Overview​

This resource represents the Booking's Fees, which contribute to Booking's final price.

Bookings Fees are usually related to RentalsFees, but they might be also not related at all to any Fee. These fees are called "standalone fees". Bookings originating from external Channels are likely to have standalone Bookings Fees.

Parameters​

NameTypeRead/WriteDescription
rentals_feeIntegerRead/WriteRentalsFee's ID related to the Bookings Fee
bookingIntegerReadBooking's ID related to the Bookings Fee
feeIntegerReadFee's ID related to the Bookings Fee
accountIntegerReadAccount's ID related to the Bookings Fee
bookings_taxesArrayReadArray of Bookings Taxes IDs where the given Bookings Fee is a taxable item
idIntegerReadBookings Fee's id.
nameObjectRead/WriteBookings Fee's name, list of locales described in enums section. When not filled it will be sourced it from associated Fee.
priceDecimalRead/WriteBookings Fee's price.
kindStringRead/WriteKind of fee, see available values in Fee kinds enum. When not filled it will be sourced it from associated Fee.
requiredBooleanRead/WriteAlways included for new bookings if set to true. When not filled it will be sourced it from associated Fee.
publicBooleanRead/WriteWhether the fee is visible publicly. When not filled it will be sourced it from associated Fee.
times_bookedIntegerRead/WriteNumber of times the fee is applied to the booking.
included_in_priceBooleanReadWhether Bookings Fee contributes to the final price or not.
lockedStringRead/WriteBookingsFee's locked status.
canceled_atTimeReadWhen the Bookings Fee was canceled (if ever).
created_atTimeReadBookings Fee's create time.
updated_atTimeReadBookings Fee's update time.

List bookings fees​

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

ScopeRead Permissions
:bookings_write_ownedDisplay fees only for bookings created by app that is making the request
:bookings_readDisplay fees for all bookings
:bookings_writeDisplay fees for all bookings

Other scopes will return no results.

List all bookings fees for a given account(s).

GET /bookings_fees
response.json
{
  "links": {
    "bookings_fees.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_fees.account}",
    "bookings_fees.rentals_fee": "https://www.bookingsync.com/api/v3/rentals_fees/{bookings_fees.rentals_fee}",
    "bookings_fees.booking": "https://www.bookingsync.com/api/v3/bookings/{bookings_fees.booking}",
    "bookings_fees.fee": "https://www.bookingsync.com/api/v3/fees/{bookings_fees.fee}",
    "bookings_fees.bookings_taxes": "https://www.bookingsync.com/api/v3/bookings_taxes/{bookings_fees.bookings_taxes}"
  },
  "bookings_fees": [
    {
      "links": {
        "account": 3,
        "rentals_fee": 6,
        "booking": 1313,
        "fee": 9,
        "bookings_taxes": []
      },
      "id": 13,
      "name": {
        "en": "Bookings Fee"
      },
      "price": "12.0",
      "required": false,
      "included_in_price": false,
      "times_booked": 0,
      "created_at": "2015-03-20T16:04:05Z",
      "updated_at": "2015-03-20T16:04:05Z"
    }
  ],
  "meta": {}
}

Get a single bookings fee​

Returns a single bookings fee identified by ID.

GET /bookings_fees/:bookings_fee_id
response.json
{
  "links": {
    "bookings_fees.account": "https://www.bookingsync.com/api/v3/accounts/{bookings_fees.account}",
    "bookings_fees.rentals_fee": "https://www.bookingsync.com/api/v3/rentals_fees/{bookings_fees.rentals_fee}",
    "bookings_fees.booking": "https://www.bookingsync.com/api/v3/bookings/{bookings_fees.booking}",
    "bookings_fees.fee": "https://www.bookingsync.com/api/v3/fees/{bookings_fees.fee}",
    "bookings_fees.bookings_taxes": "https://www.bookingsync.com/api/v3/bookings_taxes/{bookings_fees.bookings_taxes}"
  },
  "bookings_fees": [
    {
      "links": {
        "account": 3,
        "rentals_fee": 6,
        "booking": 1313,
        "fee": 9,
        "bookings_taxes": []
      },
      "id": 13,
      "name": {
        "en": "Bookings Fee"
      },
      "price": "12.0",
      "required": false,
      "included_in_price": false,
      "times_booked": 0,
      "created_at": "2015-03-20T16:04:05Z",
      "updated_at": "2015-03-20T16:04:05Z"
    }
  ],
  "meta": {}
}

Add a single bookings fee​

Adds a fee to an existing booking.

PATCH /bookings/:id/add_bookings_fee

Remove a single bookings fee​

Removes a fee from an existing booking.

PATCH /bookings/:id/remove_bookings_fee/:bookings_fee_id