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

Rental Cancelation Policy Items

  1. Overview
  2. List rental cancelation policy items
  3. Get a single rental cancelation policy item

Overview

This resource represents Rental Cancelation Policy Items which describe the rules and penalties for the cancelation of Bookings for the specific Rental Cancelation Policy

Parameters

Name Type Read/Write Description
account Integer Read Account’s ID related to the Rental Cancelation Policy Item
rental_cancelation_policy Integer Read Rental Cancelation Policy’s ID related to the Rental Cancelation Policy Item
id Integer Read Rental cancelation policy item’s ID.
eligible_days Integer Read Number of days before the check-in from which the penalty applies (For example, if there is only a single Item defined for a Policy with eligible_days as 30, penalty_percentage doesn’t apply before 30 days prior to check-in, only from 30 days and less).
penalty_percentage Decimal Read Percentage of penalty from the booking price.
created_at Time Read Rental cancelation policy’s create time.
updated_at Time Read Rental cancelation policy’s update time.

List rental cancelation policy items

List all rental cancelation policy items for given account(s).

GET /rental_cancelation_policy_items

Response

{
  "links": {
    "rental_cancelation_policy_items.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rental_cancelation_policy_items.rental_cancelation_policy}"
  },
  "rental_cancelation_policy_items": [
    {
      "id": 1,
      "eligible_days": 120,
      "penalty_percentage": "10.0",
      "created_at": "2023-12-11T08:26:25Z",
      "updated_at": "2023-12-11T08:26:25Z",
      "links": {
        "rental_cancelation_policy": 1
      }
    }
  ]
}

Get a single rental cancelation policy item

Returns a single rental cancelation policy item identified by ID.

GET /rental_cancelation_policy_items/:rental_cancelation_policy_item_id

Response

{
  "links": {
    "rental_cancelation_policy_items.rental_cancelation_policy": "https://www.bookingsync.com/api/v3/rental_cancelation_policies/{rental_cancelation_policy_items.rental_cancelation_policy}"
  },
  "rental_cancelation_policy_items": [
    {
      "id": 1,
      "eligible_days": 120,
      "penalty_percentage": "10.0",
      "created_at": "2023-12-11T08:26:25Z",
      "updated_at": "2023-12-11T08:26:25Z",
      "links": {
        "rental_cancelation_policy": 1
      }
    }
  ]
}