Rentals

  1. List rentals
  2. Search rentals
  3. Get a single rental
  4. Create a new rental
  5. Update a rental
  6. Destroy a rental

Parameters

Name Type Read/Write Description
id Integer Read Rental’s id.
absolute_min_price Decimal Read Rental’s minimum price based on base_rate_kind.
base_rate Decimal Read Rental’s base rate, used by the rates table to calculate the seasonability and discounted prices. We recommend using the highest price as base rate.
base_rate_kind String Read Rental’s rate type attached to the base rate. List of types described in enums section.
bathrooms_count Integer Read Rental’s bathrooms count.
bedrooms_count Integer Read Rental’s bedrooms count.
bookable_online Boolean Read Rental’s online booking status.
checkin_time Integer Read Rental’s checkin time.
checkout_time Integer Read Rental’s checkout time.
city String Read Rental’s city.
contact_name String Read Rental’s contact name.
country_code String Read Rental’s country code, list of codes is available at wikipedia.
currency String Read Rental’s currency code, list of codes described in enums section.
description Object Read Rental’s description, list of locales described in enums section.
downpayment Integer Read Rental’s default downpayment percentage. If none defined, the default downpayment percentage of the account will be used.
final_price Integer Read Rental’s final price (after discount). Available only for a search query with valid dates, for other cases please refer to base_rate and base_rate_kind.
floor String Read Rental’s floor
headline Object Read Rental’s headline, list of locales described in enums section.
initial_price Integer Read Rental’s initial price. Available only for a search query with valid dates, for other cases please refer to base_rate and base_rate_kind.
lat Float Read Rental’s latitude.
lng Float Read Rental’s longitude.
max_price Decimal Read Rental’s maximum price.
min_price Decimal Read Rental’s minimum price.
name String Read Rental’s name.
nightly_rates_managed_externally Boolean Read Defines whether nightly_rate_map can be updated via API. Defaults to false.
permit_number String Read Rental’s Registration/License/Permit number.
position Integer Read Rental’s position on the list.
price_public_notes Object Read Rental’s price notes for public, list of locales described in enums section.
rental_type String Read Rental’s type (example: villa, apartment), all types described in enums section.
reviews_average_rating Decimal Read Rental’s overall rating from reviews.
reviews_count Integer Read Rental’s count of all reviews.
sleeps Integer Read Rental’s number of comfortable sleeps.
sleeps_max Integer Read Rental’s maximum number of sleeps.
state String Read Rental’s state.
stories_count Integer Read Rental’s number of stories.
summary Object Read Rental’s summary, list of locales described in enums section.
surface Integer Read Rental’s surface area.
surface_unit String Read Rental’s surface area unit, either metric or imperial.
website_url Object Read Rental’s primary website url, list of locales described in enums section.
created_at Time Read Rental’s create time.
updated_at Time Read Rental’s update time.
published_at Time Read Rental’s publish time.
Name Type Read/Write Description
id Integer Read Rental’s id.
absolute_min_price Decimal Read Rental’s minimum price based on base_rate_kind.
address1 String Read Rental’s primary address.
address2 String Read Rental’s optional address.
base_rate Decimal Read Rental’s base rate, used by the rates table to calculate the seasonability and discounted prices. We recommend using the highest price as base rate.
base_rate_kind String Read Rental’s rate type attached to the base rate. List of types described in enums section.
bathrooms_count Integer Read Rental’s bathrooms count.
bedrooms_count Integer Read Rental’s bedrooms count.
bookable_online Boolean Read Rental’s online booking status.
checkin_details Object Read Rental’s check-in details, list of locales described in enums section.
checkout_details Object Read Rental’s check-out details, list of locales described in enums section.
checkin_time Integer Read Rental’s checkin time.
checkout_time Integer Read Rental’s checkout time.
city String Read Rental’s city.
contact_name String Read Rental’s contact name.
country_code String Read Rental’s country code, list of codes is available at wikipedia.
currency String Read Rental’s currency code, list of codes described in enums section.
description Object Read Rental’s description, list of locales described in enums section.
downpayment Integer Read Rental’s default downpayment percentage. If none defined, the default downpayment percentage of the account will be used.
final_price Integer Read Rental’s final price (after discount). Available only for a search query with valid dates, for other cases please refer to base_rate and base_rate_kind.
floor String Read Rental’s floor
headline Object Read Rental’s headline, list of locales described in enums section.
initial_price Integer Read Rental’s initial price. Available only for a search query with valid dates, for other cases please refer to base_rate and base_rate_kind.
lat Float Read Rental’s latitude.
lng Float Read Rental’s longitude.
max_price Decimal Read Rental’s maximum price.
min_price Decimal Read Rental’s minimum price.
name String Read Rental’s name.
nightly_rates_managed_externally Boolean Read Defines whether nightly_rate_map can be updated via API. Defaults to false.
notes Text Read Rental’s private notes.
permit_number String Read Rental’s Registration/License/Permit number.
position Integer Read Rental’s position on the list.
price_public_notes Object Read Rental’s price notes for public, list of locales described in enums section.
rental_type String Read Rental’s type (example: villa, apartment), all types described in enums section.
reviews_average_rating Decimal Read Rental’s overall rating from reviews.
reviews_count Integer Read Rental’s count of all reviews.
sleeps Integer Read Rental’s number of comfortable sleeps.
sleeps_max Integer Read Rental’s maximum number of sleeps.
state String Read Rental’s state.
stories_count Integer Read Rental’s number of stories.
summary Object Read Rental’s summary, list of locales described in enums section.
surface Integer Read Rental’s surface area.
surface_unit String Read Rental’s surface area unit, either metric or imperial.
website_url Object Read Rental’s primary website url, list of locales described in enums section.
zip String Read Rental’s zip code.
created_at Time Read Rental’s create time.
updated_at Time Read Rental’s update time.
published_at Time Read Rental’s publish time.
Name Type Read/Write Description
id Integer Read Rental’s id.
amenity_ids Array Write Amenity ids related to the rental.
destination_id Integer Write Destination id related to the rental.
payment_gateway_id Integer Write PaymentGateway id related to the rental.
rates_table_id Integer Write Rates Table id related to the rental.
rentals_contact_id Integer Write Contact id related to the rental.
absolute_min_price Decimal Read/Write Rental’s minimum price based on base_rate_kind.
address1 String Read/Write Rental’s primary address.
address2 String Read/Write Rental’s optional address.
base_rate Decimal Read/Write Rental’s base rate, used by the rates table to calculate the seasonability and discounted prices. We recommend using the highest price as base rate. (greater than 0)
base_rate_kind String Read/Write Rental’s rate type attached to the base rate. List of types described in enums section.
bathrooms_count Integer Read/Write Rental’s bathrooms count. (between 0 and 100)
bedrooms_count Integer Read/Write Rental’s bedrooms count. (between 0 and 100)
bookable_online Boolean Read/Write Rental’s online booking status.
checkin_details Object Read/Write Rental’s check-in details, list of locales described in enums section.
checkout_details Object Read/Write Rental’s check-out details, list of locales described in enums section.
checkin_time Integer Read Rental’s checkin time.
checkout_time Integer Read Rental’s checkout time.
city String Read/Write Rental’s city.
contact_name String Read Rental’s contact name.
country_code String Read/Write Rental’s country code, list of codes is available at wikipedia.
currency String Read/Write Rental’s currency code, list of codes described in enums section.
description Object Read/Write Rental’s description, list of locales described in enums section. (5000 characters max)
downpayment Integer Read/Write Rental’s default downpayment percentage. If none defined, the default downpayment percentage of the account will be used. (between 0 and 100)
final_price Integer Read Rental’s final price (after discount). Available only for a search query with valid dates, for other cases please refer to base_rate and base_rate_kind.
floor String Read/Write Rental’s floor
headline Object Read Rental’s headline, list of locales described in enums section.
initial_price Integer Read Rental’s initial price. Available only for a search query with valid dates, for other cases please refer to base_rate and base_rate_kind.
lat Float Read/Write Rental’s latitude. (between -90 and 90)
lng Float Read/Write Rental’s longitude. (between -180 and 180)
max_price Decimal Read Rental’s maximum price.
min_price Decimal Read Rental’s minimum price.
name String Read/Write Required. Rental’s name. (3 min, 40 max characters)
nightly_rates_managed_externally Boolean Read/Write Defines whether nightly_rate_map can be updated via API. Defaults to false.
notes Text Read/Write Rental’s private notes. (1000 characters max)
permit_number String Read Rental’s Registration/License/Permit number.
position Integer Read/Write Rental’s position on the list.
price_public_notes Object Read Rental’s price notes for public, list of locales described in enums section. Write is possible through RatesTables.
rental_type String Read/Write Rental’s type (example: villa, apartment), all types described in enums section.
reviews_average_rating Decimal Read Rental’s overall rating from reviews.
reviews_count Integer Read Rental’s count of all reviews.
sleeps Integer Read/Write Rental’s number of comfortable sleeps. (between 0 and 100)
sleeps_max Integer Read/Write Rental’s maximum number of sleeps. (between 0 and 100)
state String Read/Write Rental’s state.
stories_count Integer Read/Write Rental’s number of stories.
summary Object Read/Write Rental’s summary, list of locales described in enums section. (150 characters max)
surface Integer Read/Write Rental’s surface area. (greater than 0)
surface_unit String Read/Write Rental’s surface area unit, either metric or imperial.
website_url Object Read/Write Rental’s primary website url, list of locales described in enums section.
zip String Read/Write Rental’s zip code.
created_at Time Read Rental’s create time.
updated_at Time Read Rental’s update time.
published_at Time Read Rental’s publish time.

List rentals

List all rentals for a given account(s).

GET /rentals

Response

{
  "links": {
    "rentals.account": "https://www.bookingsync.com/api/v3/accounts/{rentals.account}",
    "rentals.availability": "https://www.bookingsync.com/api/v3/availabilities/{rentals.availability}",
    "rentals.bathrooms": "https://www.bookingsync.com/api/v3/bathrooms/{rentals.bathrooms}",
    "rentals.bedrooms": "https://www.bookingsync.com/api/v3/bedrooms/{rentals.bedrooms}",
    "rentals.change_over": "https://www.bookingsync.com/api/v3/change_overs/{rentals.change_over}",
    "rentals.destination": "https://www.bookingsync.com/api/v3/destinations/{rentals.destination}",
    "rentals.nightly_rate_map": "https://www.bookingsync.com/api/v3/nightly_rate_maps/{rentals.nightly_rate_map}",
    "rentals.photos": "https://www.bookingsync.com/api/v3/photos/{rentals.photos}",
    "rentals.rates": "https://www.bookingsync.com/api/v3/rates/{rentals.rates}",
    "rentals.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{rentals.rates_table}",
    "rentals.rental_agreement": "https://www.bookingsync.com/api/v3/rental_agreements/{rentals.rental_agreement}",
    "rentals.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rentals.rental_cancelation_policy}",
    "rentals.rentals_amenities": "https://www.bookingsync.com/api/v3/rentals_amenities/{rentals.rentals_amenities}",
    "rentals.rentals_fees": "https://www.bookingsync.com/api/v3/rentals_fees/{rentals.rentals_fees}",
    "rentals.rentals_tags": "https://www.bookingsync.com/api/v3/rentals_tags/{rentals.rentals_tags}",
    "rentals.reviews": "https://www.bookingsync.com/api/v3/reviews/{rentals.reviews}",
    "rentals.special_offers": "https://www.bookingsync.com/api/v3/special_offers/{rentals.special_offers}"
  },
  "rentals": [
    {
      "id": 1,
      "absolute_min_price": "300.0",
      "base_rate": "600.0",
      "base_rate_kind": "weekly",
      "bathrooms_count": 3,
      "bedrooms_count": 4,
      "bookable_online": false,
      "checkin_time": 16,
      "checkout_time": 10,
      "city": "Nevache",
      "contact_name": "Betty Reichert",
      "country_code": "FR",
      "currency": "EUR",
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area."
      },
      "downpayment": 30,
      "final_price": null,
      "floor": "A",
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "initial_price": null,
      "lat": 45.02,
      "lng": 6.6,
      "max_price": "600.0",
      "min_price": "420.0",
      "name": "Cottage 1",
      "nightly_rates_managed_externally": false,
      "permit_number": "AQD9382857",
      "position": 1,
      "price_public_notes": {
        "en": null
      },
      "rental_type": "villa",
      "reviews_average_rating": "4.0",
      "reviews_count": 5,
      "sleeps": 8,
      "sleeps_max": 9,
      "state": null,
      "stories_count": 2,
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "surface": 120,
      "surface_unit": "metric",
      "website_url": {
        "en": "https://example.com/en/rentals/123-rental-headline"
      },
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "published_at": "2017-11-09T09:08:17Z",
      "links": {
        "account": 1,
        "availability": 1,
        "bathrooms": [
          5,
          6,
          7
        ],
        "bedrooms": [
          8,
          9,
          10,
          11
        ],
        "change_over": 1,
        "destination": 134,
        "nightly_rate_map": 1,
        "photos": [
          1
        ],
        "rates": [
          1
        ],
        "rates_table": 1,
        "rental_agreement": 1,
        "rental_cancelation_policy": 1,
        "rentals_amenities": [
          1,
          2,
          3
        ],
        "rentals_fees": [

        ],
        "rentals_tags": [

        ],
        "reviews": [
          1,
          2,
          3,
          4,
          5
        ],
        "special_offers": [
          1
        ]
      }
    }
  ],
  "meta": {
  }
}
{
  "links": {
    "rentals.account": "https://www.bookingsync.com/api/v3/accounts/{rentals.account}",
    "rentals.availability": "https://www.bookingsync.com/api/v3/availabilities/{rentals.availability}",
    "rentals.bathrooms": "https://www.bookingsync.com/api/v3/bathrooms/{rentals.bathrooms}",
    "rentals.bedrooms": "https://www.bookingsync.com/api/v3/bedrooms/{rentals.bedrooms}",
    "rentals.change_over": "https://www.bookingsync.com/api/v3/change_overs/{rentals.change_over}",
    "rentals.destination": "https://www.bookingsync.com/api/v3/destinations/{rentals.destination}",
    "rentals.nightly_rate_map": "https://www.bookingsync.com/api/v3/nightly_rate_maps/{rentals.nightly_rate_map}",
    "rentals.photos": "https://www.bookingsync.com/api/v3/photos/{rentals.photos}",
    "rentals.rates": "https://www.bookingsync.com/api/v3/rates/{rentals.rates}",
    "rentals.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{rentals.rates_table}",
    "rentals.rental_agreement": "https://www.bookingsync.com/api/v3/rental_agreements/{rentals.rental_agreement}",
    "rentals.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rentals.rental_cancelation_policy}",
    "rentals.rentals_amenities": "https://www.bookingsync.com/api/v3/rentals_amenities/{rentals.rentals_amenities}",
    "rentals.rentals_fees": "https://www.bookingsync.com/api/v3/rentals_fees/{rentals.rentals_fees}",
    "rentals.rentals_tags": "https://www.bookingsync.com/api/v3/rentals_tags/{rentals.rentals_tags}",
    "rentals.reviews": "https://www.bookingsync.com/api/v3/reviews/{rentals.reviews}",
    "rentals.special_offers": "https://www.bookingsync.com/api/v3/special_offers/{rentals.special_offers}"
  },
  "rentals": [
    {
      "id": 2,
      "absolute_min_price": "300.0",
      "address1": "58 Ville Haute",
      "address2": null,
      "base_rate": "700.0",
      "base_rate_kind": "weekly",
      "bathrooms_count": 3,
      "bedrooms_count": 5,
      "bookable_online": false,
      "checkin_details": {
        "en": "Please call us 15 min before your arrival so we can welcome you at the villa."
      },
      "checkin_time": 16,
      "checkout_details": {
        "en": "Please confirm us your departure time the day before so we can wish you a good travel back in person."
      },
      "checkout_time": 10,
      "city": "Nevache",
      "contact_name": "Betty Reichert",
      "country_code": "FR",
      "currency": "EUR",
      "description": {
        "en": "First class Villa for 9 people with private pool. Situated in a pleasant residential area."
      },
      "downpayment": 30,
      "final_price": null,
      "floor": "A",
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "initial_price": null,
      "lat": 45.02,
      "lng": 6.6,
      "max_price": "700.0",
      "min_price": "490.0",
      "name": "Cottage 2",
      "nightly_rates_managed_externally": false,
      "notes": "Private comments.",
      "position": 1,
      "price_public_notes": {
        "en": null
      },
      "rental_type": "villa",
      "reviews_average_rating": "4.5",
      "reviews_count": 1,
      "sleeps": 9,
      "sleeps_max": 10,
      "state": null,
      "stories_count": 2,
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "surface": 120,
      "surface_unit": "metric",
      "website_url": {
        "en": "https://example.com/en/rentals/123-rental-headline"
      },
      "zip": "05100",
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "published_at": "2017-11-09T09:08:17Z",
      "links": {
        "account": 1,
        "availability": 2,
        "bathrooms": [
          5,
          6,
          7
        ],
        "bedrooms": [
          8,
          9,
          10,
          11,
          12
        ],
        "change_over": 1,
        "destination": 135,
        "nightly_rate_map": 1,
        "photos": [
          2
        ],
        "rates": [
          3
        ],
        "rates_table": 1,
        "rental_agreement": 1,
        "rental_cancelation_policy": 1,
        "rentals_amenities": [
          4
        ],
        "rentals_fees": [

        ],
        "rentals_tags": [

        ],
        "reviews": [
          2
        ],
        "special_offers": [
          3
        ]
      }
    }
  ],
  "meta": {
  }
}

Search rentals

Search parameters allow to filter rentals by specified fields.

Example:

GET /rentals/search?start_at=20140324&end_at=20140330

Search Parameters

Name Type Default Description
amenities String   List of comma separated amenities to include.
adults Integer   Number of adults to take into account when calculating final_price.
bb_ne Float   Rentals located between bb_sw & bb_ne. Format latitude, longitude.
bb_sw Float   Rentals located between bb_sw & bb_ne. Format latitude, longitude.
bedrooms_count Integer   Rentals with amount of bedrooms equal to or above given number.
bookable_online Boolean blank true to get rentals that are instantly bookable (requiring no human interaction), false to get those that are not.
children Integer   Number of children to take into account when calculating final_price.
city String   Rentals matching given city.
country_code String   Rentals matching given country code, list of codes is available at wikipedia.
destination String   List of comma separated destinations.
direction String   Direction to sort rentals, either asc or desc.
exchange_to_currency String   Convert amounts to the currency of your choice (ex: EUR, USD, …)
guests Integer   Used to filter out rentals with maximum number of sleeps below given number of guests.
id String   List of comma separated rental ids.
include_not_available Boolean false Include not available rentals in the response.
include_tentative Boolean false Treat tentative periods as available ones.
max_price Integer   Rentals with max_price below given price. Will use final_price if computed.
min_price Integer   Rentals with min_price above given price. Will use final_price if computed.
page Integer   Used to browse multi-paged listings.
per_page Integer   Limit amount of returned rentals to given number. Full list can then be browsed with page parameter.
published_only Boolean false Show only published rentals.
reject_amenities String   List of comma separated amenities to exclude.
rental_id String   List of comma separated rental ids.
rental_type String   List of comma separated types, all types described in enums section.
rentals_tags String   List of comma separated rentals tags.
sort String   Sort rentals by given attribute. Possible values: price, sleeps.
special_offers Boolean false Show only rentals with special offers.
start_at Time   Rentals available between start_at & end_at.
end_at Time   Rentals available between start_at & end_at.

Response

{
  "rentals": [
    {
      "id": 1,
      "currency": "EUR",
      "damage_deposit": 35.5,
      "final_price": 858.33,
      "initial_price": 700.0,
      "price_details": {
        "taxes": [
          {
            "name": {
              "en": "VAT"
            },
            "percentage": "10.0",
            "amount": "58.33",
            "taxable_type": "Rental",
            "taxable_id": 2,
            "tax_id": 1,
            "included": false
          }
        ],
        "fees": [
          {
            "name": {
              "en": "some fee"
            },
            "required": true,
            "price": "100.0",
            "quantity": 1,
            "id": 10,
            "rentals_fee_id": 12
          }
        ]
      },
      "price_to_pay_now": 858.33,
      "taxes": [
        {
          "name": {
            "en": "VAT"
          },
          "percentage": "10.0",
          "amount": "58.33"
        }
      ],
      "updated_at": "2014-01-21T11:46:15Z",
      "links": {
        "rentals_fees": "http://www.bookingsync.com/api/v3/rentals_fees/{rentals.rentals_fees}"
      }
    }
  ]
}

Search response Parameters

Group Subgroup Name Type Description
    damage_deposit Float Rental’s required damage deposit.
    final_price Float Rental’s price with fees and taxes.
    initial_price Float Rental’s price.
    price_to_pay_now Float Part of the price to pay at this moment if the rental was to be booked now.
price_details     Hash Fees and taxes breakdown contributing to the final price.
  taxes   Array Detailed breakdown of Taxes with reference to the item which was taxed by the Tax (Fee or Rental) and own ID.
    name String Tax’s name.
    percentage String Tax’s percentage.
    amount String Tax’s amount.
    taxable_type String Taxed item type (Fee or Rental)
    taxable_id Integer Fee or Rental ID
    tax_id Integer Tax’s ID
    included Boolean True/False status if this tax is already included in taxable’s (Fee or Rental) price or not
  fees   Array Details of the bookings fees required to be booked with the rental.
    name String Fee’s name.
    required Boolean True/False status for always required.
    price String Fee’s price.
    quantity String Fee’s quantity.
    id Integer Fee’s ID
    rentals_fee_id Integer Rentals Fee’s ID
taxes     Array Grouped taxes by their identity with summed amounts.
    name String Tax’s name.
    percentage String Tax’s percentage.
    amount String Tax’s amount.

Get a single rental

Returns a single rental identified by ID.

GET /rentals/:rental_id

Response

{
  "links": {
    "rentals.account": "https://www.bookingsync.com/api/v3/accounts/{rentals.account}",
    "rentals.availability": "https://www.bookingsync.com/api/v3/availabilities/{rentals.availability}",
    "rentals.bathrooms": "https://www.bookingsync.com/api/v3/bathrooms/{rentals.bathrooms}",
    "rentals.bedrooms": "https://www.bookingsync.com/api/v3/bedrooms/{rentals.bedrooms}",
    "rentals.change_over": "https://www.bookingsync.com/api/v3/change_overs/{rentals.change_over}",
    "rentals.destination": "https://www.bookingsync.com/api/v3/destinations/{rentals.destination}",
    "rentals.nightly_rate_map": "https://www.bookingsync.com/api/v3/nightly_rate_maps/{rentals.nightly_rate_map}",
    "rentals.photos": "https://www.bookingsync.com/api/v3/photos/{rentals.photos}",
    "rentals.rates": "https://www.bookingsync.com/api/v3/rates/{rentals.rates}",
    "rentals.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{rentals.rates_table}",
    "rentals.rental_agreement": "https://www.bookingsync.com/api/v3/rental_agreements/{rentals.rental_agreement}",
    "rentals.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rentals.rental_cancelation_policy}",
    "rentals.rentals_amenities": "https://www.bookingsync.com/api/v3/rentals_amenities/{rentals.rentals_amenities}",
    "rentals.rentals_fees": "https://www.bookingsync.com/api/v3/rentals_fees/{rentals.rentals_fees}",
    "rentals.rentals_tags": "https://www.bookingsync.com/api/v3/rentals_tags/{rentals.rentals_tags}",
    "rentals.reviews": "https://www.bookingsync.com/api/v3/reviews/{rentals.reviews}",
    "rentals.special_offers": "https://www.bookingsync.com/api/v3/special_offers/{rentals.special_offers}"
  },
  "rentals": [
    {
      "id": 1,
      "absolute_min_price": "300.0",
      "base_rate": "600.0",
      "base_rate_kind": "weekly",
      "bathrooms_count": 3,
      "bedrooms_count": 4,
      "bookable_online": false,
      "checkin_time": 16,
      "checkout_time": 10,
      "city": "Nevache",
      "contact_name": "Betty Reichert",
      "country_code": "FR",
      "currency": "EUR",
      "description": {
        "en": "First class Villa for 8 people with private pool. Situated in a pleasant residential area."
      },
      "downpayment": 30,
      "final_price": null,
      "floor": "A",
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "initial_price": null,
      "lat": 45.02,
      "lng": 6.6,
      "max_price": "600.0",
      "min_price": "420.0",
      "name": "Cottage 1",
      "nightly_rates_managed_externally": false,
      "permit_number": "AQD9382857",
      "position": 1,
      "price_public_notes": {
        "en": null
      },
      "rental_type": "villa",
      "reviews_average_rating": "4.0",
      "reviews_count": 5,
      "sleeps": 8,
      "sleeps_max": 9,
      "state": null,
      "stories_count": 2,
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "surface": 120,
      "surface_unit": "metric",
      "website_url": {
        "en": "https://example.com/en/rentals/123-rental-headline"
      },
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "published_at": "2017-11-09T09:08:17Z",
      "links": {
        "account": 1,
        "availability": 1,
        "bathrooms": [
          5,
          6,
          7
        ],
        "bedrooms": [
          8,
          9,
          10,
          11
        ],
        "change_over": 1,
        "destination": 134,
        "nightly_rate_map": 1,
        "photos": [
          1
        ],
        "rates": [
          1
        ],
        "rates_table": 1,
        "rental_agreement": 1,
        "rental_cancelation_policy": 1,
        "rentals_amenities": [
          1,
          2,
          3
        ],
        "rentals_fees": [

        ],
        "rentals_tags": [

        ],
        "reviews": [
          1,
          2,
          3,
          4,
          5
        ],
        "special_offers": [
          1
        ]
      }
    }
  ],
  "meta": {
  }
}
{
  "links": {
    "rentals.account": "https://www.bookingsync.com/api/v3/accounts/{rentals.account}",
    "rentals.availability": "https://www.bookingsync.com/api/v3/availabilities/{rentals.availability}",
    "rentals.bathrooms": "https://www.bookingsync.com/api/v3/bathrooms/{rentals.bathrooms}",
    "rentals.bedrooms": "https://www.bookingsync.com/api/v3/bedrooms/{rentals.bedrooms}",
    "rentals.change_over": "https://www.bookingsync.com/api/v3/change_overs/{rentals.change_over}",
    "rentals.destination": "https://www.bookingsync.com/api/v3/destinations/{rentals.destination}",
    "rentals.nightly_rate_map": "https://www.bookingsync.com/api/v3/nightly_rate_maps/{rentals.nightly_rate_map}",
    "rentals.photos": "https://www.bookingsync.com/api/v3/photos/{rentals.photos}",
    "rentals.rates": "https://www.bookingsync.com/api/v3/rates/{rentals.rates}",
    "rentals.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{rentals.rates_table}",
    "rentals.rental_agreement": "https://www.bookingsync.com/api/v3/rental_agreements/{rentals.rental_agreement}",
    "rentals.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rentals.rental_cancelation_policy}",
    "rentals.rentals_amenities": "https://www.bookingsync.com/api/v3/rentals_amenities/{rentals.rentals_amenities}",
    "rentals.rentals_fees": "https://www.bookingsync.com/api/v3/rentals_fees/{rentals.rentals_fees}",
    "rentals.rentals_tags": "https://www.bookingsync.com/api/v3/rentals_tags/{rentals.rentals_tags}",
    "rentals.reviews": "https://www.bookingsync.com/api/v3/reviews/{rentals.reviews}",
    "rentals.special_offers": "https://www.bookingsync.com/api/v3/special_offers/{rentals.special_offers}"
  },
  "rentals": [
    {
      "id": 2,
      "absolute_min_price": "300.0",
      "address1": "58 Ville Haute",
      "address2": null,
      "base_rate": "700.0",
      "base_rate_kind": "weekly",
      "bathrooms_count": 3,
      "bedrooms_count": 5,
      "bookable_online": false,
      "checkin_details": {
        "en": "Please call us 15 min before your arrival so we can welcome you at the villa."
      },
      "checkin_time": 16,
      "checkout_details": {
        "en": "Please confirm us your departure time the day before so we can wish you a good travel back in person."
      },
      "checkout_time": 10,
      "city": "Nevache",
      "contact_name": "Betty Reichert",
      "country_code": "FR",
      "currency": "EUR",
      "description": {
        "en": "First class Villa for 9 people with private pool. Situated in a pleasant residential area."
      },
      "downpayment": 30,
      "final_price": null,
      "floor": "A",
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "initial_price": null,
      "lat": 45.02,
      "lng": 6.6,
      "max_price": "700.0",
      "min_price": "490.0",
      "name": "Cottage 2",
      "nightly_rates_managed_externally": false,
      "notes": "Private comments.",
      "position": 1,
      "price_public_notes": {
        "en": null
      },
      "rental_type": "villa",
      "reviews_average_rating": "4.5",
      "reviews_count": 1,
      "sleeps": 9,
      "sleeps_max": 10,
      "state": null,
      "stories_count": 2,
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "surface": 120,
      "surface_unit": "metric",
      "website_url": {
        "en": "https://example.com/en/rentals/123-rental-headline"
      },
      "zip": "05100",
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "published_at": "2017-11-09T09:08:17Z",
      "links": {
        "account": 1,
        "availability": 2,
        "bathrooms": [
          5,
          6,
          7
        ],
        "bedrooms": [
          8,
          9,
          10,
          11,
          12
        ],
        "change_over": 1,
        "destination": 135,
        "nightly_rate_map": 1,
        "photos": [
          2
        ],
        "rates": [
          3
        ],
        "rates_table": 1,
        "rental_agreement": 1,
        "rental_cancelation_policy": 1,
        "rentals_amenities": [
          4
        ],
        "rentals_fees": [

        ],
        "rentals_tags": [

        ],
        "reviews": [
          2
        ],
        "special_offers": [
          3
        ]
      }
    }
  ],
  "meta": {
  }
}

Create a new rental

Price increase

Please note that creating rentals will increase the account monthly fee. For further details, check our pricing.

Translated attributes

Please note that translated attributes are updated differenly than you read them.
To set the English headline, locale en, you need to use the headline_en attribute.

List of locales described in enums section.

Returns a newly created rental.

POST /rentals

Example JSON request

{
  "rentals": [
    {
      "absolute_min_price": "300.0",
      "amenity_ids": [
        4
      ],
      "bathrooms_count": 3,
      "bedrooms_count": 5,
      "headline_en": "Villa in Nevache, France",
      "lat": 45.02,
      "lng": 6.6,
      "name": "Cottage 2",
      "sleeps": 9,
      "stories_count": 2,
      "surface": 120,
      "surface_unit": "metric"
    }
  ]
}

Response

{
  "links": {
    "rentals.account": "https://www.bookingsync.com/api/v3/accounts/{rentals.account}",
    "rentals.availability": "https://www.bookingsync.com/api/v3/availabilities/{rentals.availability}",
    "rentals.bathrooms": "https://www.bookingsync.com/api/v3/bathrooms/{rentals.bathrooms}",
    "rentals.bedrooms": "https://www.bookingsync.com/api/v3/bedrooms/{rentals.bedrooms}",
    "rentals.change_over": "https://www.bookingsync.com/api/v3/change_overs/{rentals.change_over}",
    "rentals.destination": "https://www.bookingsync.com/api/v3/destinations/{rentals.destination}",
    "rentals.nightly_rate_map": "https://www.bookingsync.com/api/v3/nightly_rate_maps/{rentals.nightly_rate_map}",
    "rentals.photos": "https://www.bookingsync.com/api/v3/photos/{rentals.photos}",
    "rentals.rates": "https://www.bookingsync.com/api/v3/rates/{rentals.rates}",
    "rentals.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{rentals.rates_table}",
    "rentals.rental_agreement": "https://www.bookingsync.com/api/v3/rental_agreements/{rentals.rental_agreement}",
    "rentals.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rentals.rental_cancelation_policy}",
    "rentals.rentals_amenities": "https://www.bookingsync.com/api/v3/rentals_amenities/{rentals.rentals_amenities}",
    "rentals.rentals_fees": "https://www.bookingsync.com/api/v3/rentals_fees/{rentals.rentals_fees}",
    "rentals.rentals_tags": "https://www.bookingsync.com/api/v3/rentals_tags/{rentals.rentals_tags}",
    "rentals.reviews": "https://www.bookingsync.com/api/v3/reviews/{rentals.reviews}",
    "rentals.special_offers": "https://www.bookingsync.com/api/v3/special_offers/{rentals.special_offers}"
  },
  "rentals": [
    {
      "id": 2,
      "absolute_min_price": "300.0",
      "address1": "58 Ville Haute",
      "address2": null,
      "base_rate": "700.0",
      "base_rate_kind": "weekly",
      "bathrooms_count": 3,
      "bedrooms_count": 5,
      "bookable_online": false,
      "checkin_details": {
        "en": "Please call us 15 min before your arrival so we can welcome you at the villa."
      },
      "checkin_time": 16,
      "checkout_details": {
        "en": "Please confirm us your departure time the day before so we can wish you a good travel back in person."
      },
      "checkout_time": 10,
      "city": "Nevache",
      "contact_name": "Betty Reichert",
      "country_code": "FR",
      "currency": "EUR",
      "description": {
        "en": "First class Villa for 9 people with private pool. Situated in a pleasant residential area."
      },
      "downpayment": 30,
      "final_price": null,
      "floor": "A",
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "initial_price": null,
      "lat": 45.02,
      "lng": 6.6,
      "max_price": "700.0",
      "min_price": "490.0",
      "name": "Cottage 2",
      "nightly_rates_managed_externally": false,
      "notes": "Private comments.",
      "position": 1,
      "price_public_notes": {
        "en": null
      },
      "rental_type": "villa",
      "reviews_average_rating": "4.5",
      "reviews_count": 1,
      "sleeps": 9,
      "sleeps_max": 10,
      "state": null,
      "stories_count": 2,
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "surface": 120,
      "surface_unit": "metric",
      "website_url": {
        "en": "https://example.com/en/rentals/123-rental-headline"
      },
      "zip": "05100",
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "published_at": "2017-11-09T09:08:17Z",
      "links": {
        "account": 1,
        "availability": 2,
        "bathrooms": [
          5,
          6,
          7
        ],
        "bedrooms": [
          8,
          9,
          10,
          11,
          12
        ],
        "change_over": 1,
        "destination": 135,
        "nightly_rate_map": 1,
        "photos": [
          2
        ],
        "rates": [
          3
        ],
        "rates_table": 1,
        "rental_agreement": 1,
        "rental_cancelation_policy": 1,
        "rentals_amenities": [
          4
        ],
        "rentals_fees": [

        ],
        "rentals_tags": [

        ],
        "reviews": [
          2
        ],
        "special_offers": [
          3
        ]
      }
    }
  ],
  "meta": {
  }
}

Update a rental

Returns an updated rental identified by ID.

Translated attributes

Please note that translated attributes are updated differenly than you read them.
To set the English headline, locale en, you need to use the headline_en attribute.

List of locales described in enums section.

PUT /rentals/:rental_id

Example JSON request

{
  "rentals": [
    {
      "absolute_min_price": "300.0",
      "amenity_ids": [
        4
      ],
      "bathrooms_count": 3,
      "bedrooms_count": 5,
      "headline_en": "Villa in Nevache, France",
      "lat": 45.02,
      "lng": 6.6,
      "name": "Cottage 2",
      "sleeps": 9,
      "stories_count": 2,
      "surface": 120,
      "surface_unit": "metric"
    }
  ]
}

Response

{
  "links": {
    "rentals.account": "https://www.bookingsync.com/api/v3/accounts/{rentals.account}",
    "rentals.availability": "https://www.bookingsync.com/api/v3/availabilities/{rentals.availability}",
    "rentals.bathrooms": "https://www.bookingsync.com/api/v3/bathrooms/{rentals.bathrooms}",
    "rentals.bedrooms": "https://www.bookingsync.com/api/v3/bedrooms/{rentals.bedrooms}",
    "rentals.change_over": "https://www.bookingsync.com/api/v3/change_overs/{rentals.change_over}",
    "rentals.destination": "https://www.bookingsync.com/api/v3/destinations/{rentals.destination}",
    "rentals.nightly_rate_map": "https://www.bookingsync.com/api/v3/nightly_rate_maps/{rentals.nightly_rate_map}",
    "rentals.photos": "https://www.bookingsync.com/api/v3/photos/{rentals.photos}",
    "rentals.rates": "https://www.bookingsync.com/api/v3/rates/{rentals.rates}",
    "rentals.rates_table": "https://www.bookingsync.com/api/v3/rates_tables/{rentals.rates_table}",
    "rentals.rental_agreement": "https://www.bookingsync.com/api/v3/rental_agreements/{rentals.rental_agreement}",
    "rentals.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rentals.rental_cancelation_policy}",
    "rentals.rentals_amenities": "https://www.bookingsync.com/api/v3/rentals_amenities/{rentals.rentals_amenities}",
    "rentals.rentals_fees": "https://www.bookingsync.com/api/v3/rentals_fees/{rentals.rentals_fees}",
    "rentals.rentals_tags": "https://www.bookingsync.com/api/v3/rentals_tags/{rentals.rentals_tags}",
    "rentals.reviews": "https://www.bookingsync.com/api/v3/reviews/{rentals.reviews}",
    "rentals.special_offers": "https://www.bookingsync.com/api/v3/special_offers/{rentals.special_offers}"
  },
  "rentals": [
    {
      "id": 2,
      "absolute_min_price": "300.0",
      "address1": "58 Ville Haute",
      "address2": null,
      "base_rate": "700.0",
      "base_rate_kind": "weekly",
      "bathrooms_count": 3,
      "bedrooms_count": 5,
      "bookable_online": false,
      "checkin_details": {
        "en": "Please call us 15 min before your arrival so we can welcome you at the villa."
      },
      "checkin_time": 16,
      "checkout_details": {
        "en": "Please confirm us your departure time the day before so we can wish you a good travel back in person."
      },
      "checkout_time": 10,
      "city": "Nevache",
      "contact_name": "Betty Reichert",
      "country_code": "FR",
      "currency": "EUR",
      "description": {
        "en": "First class Villa for 9 people with private pool. Situated in a pleasant residential area."
      },
      "downpayment": 30,
      "final_price": null,
      "floor": "A",
      "headline": {
        "en": "Villa in Nevache, France"
      },
      "initial_price": null,
      "lat": 45.02,
      "lng": 6.6,
      "max_price": "700.0",
      "min_price": "490.0",
      "name": "Cottage 2",
      "nightly_rates_managed_externally": false,
      "notes": "Private comments.",
      "position": 1,
      "price_public_notes": {
        "en": null
      },
      "rental_type": "villa",
      "reviews_average_rating": "4.5",
      "reviews_count": 1,
      "sleeps": 9,
      "sleeps_max": 10,
      "state": null,
      "stories_count": 2,
      "summary": {
        "en": "Great value. A place to enjoy peace and tranquility, away from mass tourism."
      },
      "surface": 120,
      "surface_unit": "metric",
      "website_url": {
        "en": "https://example.com/en/rentals/123-rental-headline"
      },
      "zip": "05100",
      "created_at": "2017-11-09T09:08:17Z",
      "updated_at": "2017-11-09T09:08:17Z",
      "published_at": "2017-11-09T09:08:17Z",
      "links": {
        "account": 1,
        "availability": 2,
        "bathrooms": [
          5,
          6,
          7
        ],
        "bedrooms": [
          8,
          9,
          10,
          11,
          12
        ],
        "change_over": 1,
        "destination": 135,
        "nightly_rate_map": 1,
        "photos": [
          2
        ],
        "rates": [
          3
        ],
        "rates_table": 1,
        "rental_agreement": 1,
        "rental_cancelation_policy": 1,
        "rentals_amenities": [
          4
        ],
        "rentals_fees": [

        ],
        "rentals_tags": [

        ],
        "reviews": [
          2
        ],
        "special_offers": [
          3
        ]
      }
    }
  ],
  "meta": {
  }
}

Destroy a rental

Price decrease

Please note that destroying rentals will decrease the account monthly fee. For further details, check our pricing.

Required OAuth scope: :rentals_write

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

DELETE /rentals/:rental_id