BookingSync API documentation

Overview

Introduction Changelog Requirements Libraries Authorization Testing the Authorization Enumerables

Endpoints

Accounts Amenities Applications Availabilities Bathrooms Bedrooms Booking Discount Codes Booking Discount Code Usages Bookings Booking Comments Bookings Fees Bookings Payments Bookings Tags Bookings Taxes Change Overs Clients Contacts Destinations Fees Fees Taxes Hosts Inbox Attachments Inbox Conversations Inbox Messages Inbox Participants Inquiries Living Rooms LOS Records Me Mid Term Rate Maps Nightly Rate Maps Payment Gateways Payments Periods Photos Rates Rates Rules Rates Tables Rentals Rental Contacts Rental Agreements Rental Cancelation Policies Rental Cancelation Policy Items Rentals Amenities ! Rentals Contents Overrides Rentals Fees Rental Link Groups Rental Links Rentals Tags Rentals Taxes Rental URLs Reviews Seasons Sources Special Offers Taxes Tax Rules

Overview

This resource represents Rentals Fees which are a way to define the relationship between Rentals and Fees and provide a configuration for the behavior of the Fee within the scope of a given ental.

Parameters

Name	Type	Read/Write	Description
account	Integer	Read	Account’s ID related to the Rentals Fee
fee	Integer	Read	Fee’s ID related to the Rentals Fee
rental	Integer	Read	Rental’s ID related to the Rentals Fee
seasons	Array	Read	Seasons’ IDs related to the Rentals Fee
id	Integer	Read	Rentals Fee’s ID.
always_applied	Boolean	Read	Rentals Fee will always be applicable if set to true (if set to false, the applicability periods are defined via `seasons` or `start_date`/`end_date`)
maximum_bookable	Integer	Read	Rentals Fee’s maximum booked count.
name	Object	Read	Rentals Fee’s name, list of locales described in enums section.
public	Boolean	Read	Publicly bookable by client if set to true.
rate	Decimal	Read	Rentals Fee’s rate.
rate_kind	String	Read	Rentals Fee’s rate kind, list of fee’s rate kinds described in enums section.
required	Boolean	Read	Always included for new bookings, also public if set to true.
archived_at	Time	Read	Rentals Fee’s archive time.
created_at	Time	Read	Rentals Fee’s create time.
updated_at	Time	Read	Rentals Fee’s update time.
start_date	Date	Read	Rentals Fee’s start date (applicable only if `always_applied` is false and `seasons` are empty).
end_date	Date	Read	Rentals Fee’s end date (applicable only if `always_applied` is false and `seasons` are empty).

Name	Type	Read/Write	Description	Constraints
account	Integer	Read	Account’s ID related to the Rentals Fee
fee	Integer	Read	Fee’s ID related to the Rentals Fee
rental	Integer	Read	Rental’s ID related to the Rentals Fee
seasons	Array	Read	Seasons’ IDs related to the Rentals Fee
id	Integer	Read	Rentals Fee’s ID.
fee_id	Integer	Write	Fee’s ID related to the Rentals Fee.	Required
season_ids	Array	Write	Seasons’ IDs related to the Rentals Fee.	Use only one of these: `season_ids`, `always_applied`, `start_date`/`end_date`
always_applied	Boolean	Read/Write	Rentals Fee will always be applicable if set to true	Use only one of these: `season_ids`, `always_applied`, `start_date`/`end_date`
maximum_bookable	Integer	Read/Write	Rentals Fee’s maximum booked count.	Must be greater than 0 if present
name	Object	Read	Rentals Fee’s name, list of locales described in enums section.
public	Boolean	Read	Publicly bookable by client if set to true.
rate	Decimal	Read	Rentals Fee’s rate.
rate_kind	String	Read	Rentals Fee’s rate kind, list of fee’s rate kinds described in enums section.
required	Boolean	Read	Always included for new bookings, also public if set to true.
status	Boolean	Write	Possible values are `public`, `required` or `private`.	Must be `public`, `required` or `private`
archived_at	Time	Read	Rentals Fee’s archive time.
created_at	Time	Read	Rentals Fee’s create time.
updated_at	Time	Read	Rentals Fee’s update time.
start_date	Date	Read/Write	Rentals Fee’s start date.	Use only one of these: `season_ids`, `always_applied`, `start_date`/`end_date`, required is `end_date` is present, must be before `end_date`
end_date	Date	Read/Write	Rentals Fee’s end date.	Use only one of these: `season_ids`, `always_applied`, `start_date`/`end_date`, required is `start_date` is present, must be after `start_date`

List rentals fees

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

GET /rentals_fees

OAuth Scopes:
public

Response

{
  "links": {
    "rentals_fees.fee": "http://www.bookingsync.com/api/v3/fees/{rentals_fees.fee}",
    "rentals_fees.rental": "http://www.bookingsync.com/api/v3/rentals/{rentals_fees.rental}",
    "rentals_fees.seasons": "http://www.bookingsync.com/api/v3/seasons/{rentals_fees.seasons}"
  },
  "rentals_fees": [
    {
      "id": 6,
      "always_applied": true,
      "maximum_bookable": 12,
      "name": {
        "en": "NAME"
      },
      "public": true,
      "rate": 10,
      "rate_kind": "fixed",
      "required": false,
      "created_at": "2015-03-18T09:34:01Z",
      "updated_at": "2015-03-18T09:34:01Z",
      "start_date": null,
      "end_date": null,
      "archived_at": null,
      "links": {
        "fee": 9,
        "rental": 1,
        "seasons": [

        ]
      }
    }
  ]
}

Get a single rentals fee

Returns a single rentals fee identified by ID.

GET /rentals_fees/:rentals_fee_id

OAuth Scopes:
public

Response

{
  "links": {
    "rentals_fees.fee": "http://www.bookingsync.com/api/v3/fees/{rentals_fees.fee}",
    "rentals_fees.rental": "http://www.bookingsync.com/api/v3/rentals/{rentals_fees.rental}",
    "rentals_fees.seasons": "http://www.bookingsync.com/api/v3/seasons/{rentals_fees.seasons}"
  },
  "rentals_fees": [
    {
      "id": 6,
      "always_applied": true,
      "maximum_bookable": 12,
      "name": {
        "en": "NAME"
      },
      "public": true,
      "rate": 10,
      "rate_kind": "fixed",
      "required": false,
      "created_at": "2015-03-18T09:34:01Z",
      "updated_at": "2015-03-18T09:34:01Z",
      "start_date": null,
      "end_date": null,
      "archived_at": null,
      "links": {
        "fee": 9,
        "rental": 1,
        "seasons": [

        ]
      }
    }
  ]
}

Create a new rentals fee

Creates a rentals fee for given rental.

POST /rentals/:rental_id/rentals_fees

OAuth Scopes:
rentals_write

Example JSON request

{
  "rentals_fees": [
    {
      "always_applied": true,
      "fee_id": 9,
      "maximum_bookable": 12,
      "status": "public"
    }
  ]
}

Response

{
  "links": {
    "rentals_fees.fee": "http://www.bookingsync.com/api/v3/fees/{rentals_fees.fee}",
    "rentals_fees.rental": "http://www.bookingsync.com/api/v3/rentals/{rentals_fees.rental}",
    "rentals_fees.seasons": "http://www.bookingsync.com/api/v3/seasons/{rentals_fees.seasons}"
  },
  "rentals_fees": [
    {
      "id": 6,
      "always_applied": true,
      "maximum_bookable": 12,
      "name": {
        "en": "NAME"
      },
      "public": true,
      "rate": 10,
      "rate_kind": "fixed",
      "required": false,
      "created_at": "2015-03-18T09:34:01Z",
      "updated_at": "2015-03-18T09:34:01Z",
      "start_date": null,
      "end_date": null,
      "archived_at": null,
      "links": {
        "fee": 9,
        "rental": 1,
        "seasons": [

        ]
      }
    }
  ]
}

Update a rentals fee

Returns an updated rentals fee identified by ID.

PUT /rentals_fees/:rentals_fee_id

OAuth Scopes:
rentals_write

Example JSON request

{
  "rentals_fees": [
    {
      "always_applied": "true",
      "maximum_bookable": 12,
      "status": "public"
    }
  ]
}

Response

{
  "links": {
    "rentals_fees.fee": "http://www.bookingsync.com/api/v3/fees/{rentals_fees.fee}",
    "rentals_fees.rental": "http://www.bookingsync.com/api/v3/rentals/{rentals_fees.rental}",
    "rentals_fees.seasons": "http://www.bookingsync.com/api/v3/seasons/{rentals_fees.seasons}"
  },
  "rentals_fees": [
    {
      "id": 6,
      "always_applied": true,
      "maximum_bookable": 12,
      "name": {
        "en": "NAME"
      },
      "public": true,
      "rate": 10,
      "rate_kind": "fixed",
      "required": false,
      "created_at": "2015-03-18T09:34:01Z",
      "updated_at": "2015-03-18T09:34:01Z",
      "start_date": null,
      "end_date": null,
      "archived_at": null,
      "links": {
        "fee": 9,
        "rental": 1,
        "seasons": [

        ]
      }
    }
  ]
}

Archive a rentals fee

Required OAuth scope: :rentals_write

Returns empty response with ‘204 No Content’ status code on success.

DELETE /rentals_fees/:rentals_fee_id