Skip to content

Commit 38f0ba8

Browse files
pyromaniacpyromaniac
committed
Add missing fields to Rentals endpoint
1 parent ed4bf81 commit 38f0ba8

File tree

2 files changed

+40
-14
lines changed

2 files changed

+40
-14
lines changed

‎content/reference/endpoints/rentals.md‎

Lines changed: 28 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,15 +19,18 @@ id | Integer | Read | Rental's id.
1919
absolute_min_price | [Decimal](/reference/enums#formats) | Read | Rental's minimum price based on `base_rate_kind`.
2020
base_rate | [Decimal](/reference/enums#formats) | 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.
2121
base_rate_kind | String | Read | Rental's rate type attached to the base rate. List of types described in [enums section](/reference/enums#rates-types).
22+
balance_due | Integer | Read | Number of day since the booking confirmation to collect the full booking price.
2223
bathrooms_count | Integer | Read | Rental's bathrooms count.
2324
bedrooms_count | Integer | Read | Rental's bedrooms count.
2425
bookable_online | Boolean | Read | Rental's online booking status.
2526
checkin_time | Integer | Read | Rental's checkin time.
27+
checkin_end_time | Integer | Read | Rental's checkin end time.
2628
checkout_time | Integer | Read | Rental's checkout time.
2729
city | String | Read | Rental's city.
2830
contact_name | String | Read | Rental's contact name.
2931
country_code | String | Read | Rental's country code, list of codes is available at [wikipedia](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
3032
currency | String | Read | Rental's currency code, list of codes described in [enums section](/reference/enums#currencies).
33+
damage_deposit | [Decimal](/reference/enums#formats) | Read | Rental's required damage deposit.
3134
description | [Object](/reference/enums#formats) | Read | Rental's description, list of locales described in [enums section](/reference/enums#locales).
3235
downpayment | Integer | Read | Rental's default downpayment percentage. If none defined, the default downpayment percentage of the account will be used.
3336
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`.
@@ -41,12 +44,14 @@ mid_term_pricing_active | Boolean | Read | Enable mid term pricin
4144
min_price | [Decimal](/reference/enums#formats) | Read | Rental's minimum weekly or nightly price, depending on the base_rate_kind.
4245
name | String | Read | Rental's name.
4346
nightly_rates_managed_externally | Boolean | Read | Defines whether `nightly_rate_map` can be updated via API. Defaults to `false`.
47+
permit_issue_date | [Time](/reference/enums#formats) | Read | Rental's Registration/License/Permit number's issue date.
4448
permit_number | String | Read | Rental's Registration/License/Permit number.
4549
position | Integer | Read | Rental's position on the list.
4650
price_public_notes | [Object](/reference/enums#formats) | Read | Rental's price notes for public, list of locales described in [enums section](/reference/enums#locales).
4751
rental_type | String | Read | Rental's type (example: villa, apartment), all types described in [enums section](/reference/enums#rental-types).
4852
reviews_average_rating | [Decimal](/reference/enums#formats) | Read | Rental's overall rating from reviews.
4953
reviews_count | Integer | Read | Rental's count of all reviews.
54+
rounding_kind | String | Read | Rounding kind for initial_price. All the possible values described at [enums section](/reference/enums#rental-rounding-kinds)
5055
sleeps | Integer | Read | Rental's number of comfortable sleeps.
5156
sleeps_max | Integer | Read | Rental's maximum number of sleeps.
5257
state | String | Read | Rental's state.
@@ -74,17 +79,20 @@ address1 | String | Read | Rental's primary addre
7479
address2 | String | Read | Rental's optional address.
7580
base_rate | [Decimal](/reference/enums#formats) | 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.
7681
base_rate_kind | String | Read | Rental's rate type attached to the base rate. List of types described in [enums section](/reference/enums#rates-types).
82+
balance_due | Integer | Read | Number of day since the booking confirmation to collect the full booking price.
7783
bathrooms_count | Integer | Read | Rental's bathrooms count.
7884
bedrooms_count | Integer | Read | Rental's bedrooms count.
7985
bookable_online | Boolean | Read | Rental's online booking status.
8086
checkin_details | [Object](/reference/enums#formats) | Read | Rental's check-in details, list of locales described in [enums section](/reference/enums#locales).
81-
checkout_details | [Object](/reference/enums#formats) | Read | Rental's check-out details, list of locales described in [enums section](/reference/enums#locales).
8287
checkin_time | Integer | Read | Rental's checkin time.
88+
checkin_end_time | Integer | Read | Rental's checkin end time.
89+
checkout_details | [Object](/reference/enums#formats) | Read | Rental's check-out details, list of locales described in [enums section](/reference/enums#locales).
8390
checkout_time | Integer | Read | Rental's checkout time.
8491
city | String | Read | Rental's city.
8592
contact_name | String | Read | Rental's contact name.
8693
country_code | String | Read | Rental's country code, list of codes is available at [wikipedia](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
8794
currency | String | Read | Rental's currency code, list of codes described in [enums section](/reference/enums#currencies).
95+
damage_deposit | [Decimal](/reference/enums#formats) | Read | Rental's required damage deposit.
8896
description | [Object](/reference/enums#formats) | Read | Rental's description, list of locales described in [enums section](/reference/enums#locales).
8997
downpayment | Integer | Read | Rental's default downpayment percentage. If none defined, the default downpayment percentage of the account will be used.
9098
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`.
@@ -99,12 +107,14 @@ min_price | [Decimal](/reference/enums#formats) | Read
99107
name | String | Read | Rental's name.
100108
nightly_rates_managed_externally | Boolean | Read | Defines whether `nightly_rate_map` can be updated via API. Defaults to `false`.
101109
notes | Text | Read | Rental's private notes.
110+
permit_issue_date | [Time](/reference/enums#formats) | Read | Rental's Registration/License/Permit number's issue date.
102111
permit_number | String | Read | Rental's Registration/License/Permit number.
103112
position | Integer | Read | Rental's position on the list.
104113
price_public_notes | [Object](/reference/enums#formats) | Read | Rental's price notes for public, list of locales described in [enums section](/reference/enums#locales).
105114
rental_type | String | Read | Rental's type (example: villa, apartment), all types described in [enums section](/reference/enums#rental-types).
106115
reviews_average_rating | [Decimal](/reference/enums#formats) | Read | Rental's overall rating from reviews.
107116
reviews_count | Integer | Read | Rental's count of all reviews.
117+
rounding_kind | String | Read | Rounding kind for initial_price. All the possible values described at [enums section](/reference/enums#rental-rounding-kinds)
108118
sleeps | Integer | Read | Rental's number of comfortable sleeps.
109119
sleeps_max | Integer | Read | Rental's maximum number of sleeps.
110120
state | String | Read | Rental's state.
@@ -132,28 +142,32 @@ destination_id | Integer | Write | Destination id related
132142
payment_gateway_id | Integer | Write | PaymentGateway id related to the rental.
133143
rates_table_id | Integer | Write | Rates Table id related to the rental.
134144
rentals_contact_id | Integer | Write | Contact id related to the rental.
145+
rentals_tag_ids | Array | Write | Tag ids related to the rental.
135146
--------------------------------|----------|------------|--------------
136147
absolute_min_price | [Decimal](/reference/enums#formats) | Read/Write | Rental's minimum price based on `base_rate_kind`.
137148
address1 | String | Read/Write | Rental's primary address.
138149
address2 | String | Read/Write | Rental's optional address.
139150
base_rate | [Decimal](/reference/enums#formats) | 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)
140151
base_rate_kind | String | Read/Write | Rental's rate type attached to the base rate. List of types described in [enums section](/reference/enums#rates-types).
152+
balance_due | Integer | Read/Write | Number of day since the booking confirmation to collect the full booking price.
141153
bathrooms_count | Integer | Read/Write | Rental's bathrooms count. (between 0 and 100)
142154
bedrooms_count | Integer | Read/Write | Rental's bedrooms count. (between 0 and 100)
143155
bookable_online | Boolean | Read/Write | Rental's online booking status.
144-
checkin_details | [Object](/reference/enums#formats) | Read/Write | Rental's check-in details, list of locales described in [enums section](/reference/enums#locales).
145-
checkout_details | [Object](/reference/enums#formats) | Read/Write | Rental's check-out details, list of locales described in [enums section](/reference/enums#locales).
146-
checkin_time | Integer | Read | Rental's checkin time.
147-
checkout_time | Integer | Read | Rental's checkout time.
156+
checkin_details | [Object](/reference/enums#formats) | Read/Write | Rental's check-in details, list of locales described in [enums section](/reference/enums#locales).
157+
checkin_time | Integer | Read/Write | Rental's checkin time.
158+
checkin_end_time | Integer | Read/Write | Rental's checkin end time.
159+
checkout_details | [Object](/reference/enums#formats) | Read/Write | Rental's check-out details, list of locales described in [enums section](/reference/enums#locales).
160+
checkout_time | Integer | Read/Write | Rental's checkout time.
148161
city | String | Read/Write | Rental's city.
149162
contact_name | String | Read | Rental's contact name.
150163
country_code | String | Read/Write | Rental's country code, list of codes is available at [wikipedia](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements).
151164
currency | String | Read/Write | Rental's currency code, list of codes described in [enums section](/reference/enums#currencies).
152-
description | [Object](/reference/enums#formats) | Read/Write | Rental's description, list of locales described in [enums section](/reference/enums#locales). (5000 characters max)
153-
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)
165+
damage_deposit | [Decimal](/reference/enums#formats) | Read/Write | Rental's required damage deposit.
166+
description | [Object](/reference/enums#formats) | Read/Write | Rental's description, list of locales described in [enums section](/reference/enums#locales). (5000 characters max)
167+
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)
154168
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`.
155169
floor | String | Read/Write | Rental's floor
156-
headline | [Object](/reference/enums#formats) | Read | Rental's headline, list of locales described in [enums section](/reference/enums#locales).
170+
headline | [Object](/reference/enums#formats) | Read | Rental's headline, list of locales described in [enums section](/reference/enums#locales).
157171
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`.
158172
lat | Float | Read/Write | Rental's latitude. (between -90 and 90)
159173
lng | Float | Read/Write | Rental's longitude. (between -180 and 180)
@@ -163,24 +177,26 @@ min_price | [Decimal](/reference/enums#formats) | Read
163177
name | String | Read/Write | **Required**. Rental's name. (3 min, 40 max characters)
164178
nightly_rates_managed_externally | Boolean | Read/Write | Defines whether `nightly_rate_map` can be updated via API. Defaults to `false`.
165179
notes | Text | Read/Write | Rental's private notes. (1000 characters max)
166-
permit_number | String | Read | Rental's Registration/License/Permit number.
180+
permit_issue_date | [Time](/reference/enums#formats) | Read/Write | Rental's Registration/License/Permit number's issue date.
181+
permit_number | String | Read/Write | Rental's Registration/License/Permit number.
167182
position | Integer | Read/Write | Rental's position on the list.
168183
price_public_notes | [Object](/reference/enums#formats) | Read | Rental's price notes for public, list of locales described in [enums section](/reference/enums#locales). Write is possible through RatesTables.
169184
rental_type | String | Read/Write | Rental's type (example: villa, apartment), all types described in [enums section](/reference/enums#rental-types).
170185
reviews_average_rating | [Decimal](/reference/enums#formats) | Read | Rental's overall rating from reviews.
171186
reviews_count | Integer | Read | Rental's count of all reviews.
187+
rounding_kind | String | Read/Write | Rounding kind for initial_price. All the possible values described at [enums section](/reference/enums#rental-rounding-kinds)
172188
sleeps | Integer | Read/Write | Rental's number of comfortable sleeps. (between 0 and 100)
173189
sleeps_max | Integer | Read/Write | Rental's maximum number of sleeps. (between 0 and 100)
174190
state | String | Read/Write | Rental's state.
175191
stories_count | Integer | Read/Write | Rental's number of stories.
176-
summary | [Object](/reference/enums#formats) | Read/Write | Rental's summary, list of locales described in [enums section](/reference/enums#locales). (150 characters max)
192+
summary | [Object](/reference/enums#formats) | Read/Write | Rental's summary, list of locales described in [enums section](/reference/enums#locales). (150 characters max)
177193
surface | Integer | Read/Write | Rental's surface area. (greater than 0)
178194
surface_unit | String | Read/Write | Rental's surface area unit, either <i>metric</i> or <i>imperial</i>.
179195
website_url | [Object](/reference/enums#formats) | Read/Write | Rental's primary website url, list of locales described in [enums section](/reference/enums#locales).
180196
zip | String | Read/Write | Rental's zip code.
181-
residency_category | String | Read | Rental's residency category. All types are described in [enums section](/reference/enums#rental-residency-categories)
197+
residency_category | String | Read/Write | Rental's residency category. All types are described in [enums section](/reference/enums#rental-residency-categories)
182198
certifications | [Object](/reference/enums#formats) | Read/Write | Rental's certifications, all allowed values described in [enums section](/reference/enums#rental-certifications).
183-
management_type | String | Read/Write | Rental's management type. All types are described in [enums section](/reference/enums#rental-management-type)
199+
management_type | String | Read/Write | Rental's management type. All types are described in [enums section](/reference/enums#rental-management-type)
184200
--------------------------------|----------|------------|--------------
185201
created_at | [Time](/reference/enums#formats) | Read | Rental's create time.
186202
updated_at | [Time](/reference/enums#formats) | Read | Rental's update time.

‎content/reference/enums.md‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ visa_support | Visa support
173173
water_park | Water park
174174
water_usage | Water usage
175175
wood | Wood
176-
wristband | Wristband
176+
wristband | Wristband
177177
{: class="table table-bordered"}
178178

179179

@@ -201,7 +201,7 @@ individual_percentage_per_adult | Percentage of the rental price per adult per n
201201
<div class="callout callout-warning" markdown="1">
202202
<h4>Warning</h4>
203203
Internal payment kinds are not allowed to be used outside of our PCI DSS compliant payment platform flow, for more details please refer to [secure payments by BookingSync](/guides/secure-payments-by-bookingsync/).
204-
204+
205205
</div>
206206

207207
Name | Description
@@ -406,3 +406,13 @@ gites_de_france | 1_epi 2_epis 3_epis 4_epis
406406
clevacances | 1_cle 2_cles 3_cles 4_cles
407407
accueil_velo | accueil_velo
408408
{: class="table table-bordered"}
409+
410+
## Rental Rounding kinds
411+
412+
Name | Description
413+
------------------|------------
414+
no-rounding | No rounding
415+
round-up | Round to the integer that is just above.
416+
closest-exact | Round to the closest tens
417+
closest-marketing | Round to the closest marketing number (i.e ending with 9)
418+
{: class="table table-bordered"}

0 commit comments

Comments
 (0)