This resource represents Rental Cancelation Policies which define the rules and potential penalties for the cancelation of Bookings (defined either via Rental Cancelation Policy Items or preset)
The Rental Cancelation Policy can be defined on the Account level (a global one that will be applied to all Rentals), a custom one for Rental (if not defined, it defaults to Account’s one) and on the Booking level (which is the copy of the Rental’s one at time of Booking creation).
| Name | Type | Read/Write | Description |
|---|---|---|---|
| account | Integer | Read | Account’s ID related to the Rental Cancelation Policy |
| rental | Integer | Read | Rental’s ID related to the Rental Cancelation Policy |
| rental_cancelation_policy_items | Array | Read | Rental Cancelation Policy Items’ defined for the Rental Cancelation Policy |
| policeable_id | Integer | Read | ID of the resource to which Rental Cancelation Policy belongs to (Rental, Account or Booking) |
| policeable_type | String | Read | Type of the resource to which Rental Cancelation Policy belongs to (Rental, Account or Booking) |
| id | Integer | Read | Rental cancelation policy’s ID. |
| body | String | Read | Rental cancelation policy’s body in Account’s default locale. |
| body_translations | Object | Read | Rental cancelation policy’s body translations, list of locales described in enums section. |
| preset | String | Read | Rental cancelation policy’s preset, list of presets described in enums section. |
| created_at | Time | Read | Rental cancelation policy’s create time. |
| updated_at | Time | Read | Rental cancelation policy’s update time. |
List all rental cancelation policies for given account(s).
GET /rental_cancelation_policies
{
"links": {
"rental_cancelation_policies.rental": "https://www.bookingsync.com/api/v3/rentals/{rental_cancelation_policies.rental}",
"rental_cancelation_policies.rental_cancelation_policy_items": "https://www.bookingsync.com/api/v3/rental_cancelation_policy_items/{rental_cancelation_policies.rental_cancelation_policy_items}"
},
"rental_cancelation_policies": [
{
"id": 1,
"body": "Cancellation Policy: \nIn case of cancelation the downpayment paid upon booking is non-refundable.",
"body_translations": {
"en": "Cancellation Policy: \nIn case of cancelation the downpayment paid upon booking is non-refundable.",
"fr": "Annulation : \nEn cas d'annulation l'acompte payé lors de la réservation ne sera pas remboursé."
},
"created_at": "2023-12-11T08:26:25Z",
"updated_at": "2023-12-11T08:26:25Z",
"links": {
"rental": 1,
"rental_cancelation_policy_items": [
1,
2
]
}
}
]
}Returns a single rental cancelation policy identified by ID.
GET /rental_cancelation_policies/:rental_cancelation_policy_id
{
"links": {
"rental_cancelation_policies.rental": "https://www.bookingsync.com/api/v3/rentals/{rental_cancelation_policies.rental}",
"rental_cancelation_policies.rental_cancelation_policy_items": "https://www.bookingsync.com/api/v3/rental_cancelation_policy_items/{rental_cancelation_policies.rental_cancelation_policy_items}"
},
"rental_cancelation_policies": [
{
"id": 1,
"body": "Cancellation Policy: \nIn case of cancelation the downpayment paid upon booking is non-refundable.",
"body_translations": {
"en": "Cancellation Policy: \nIn case of cancelation the downpayment paid upon booking is non-refundable.",
"fr": "Annulation : \nEn cas d'annulation l'acompte payé lors de la réservation ne sera pas remboursé."
},
"created_at": "2023-12-11T08:26:25Z",
"updated_at": "2023-12-11T08:26:25Z",
"links": {
"rental": 1,
"rental_cancelation_policy_items": [
1,
2
]
}
}
]
}