Enumerables

  1. Account statuses
  2. Availability map statuses
  3. Change-over map statuses
  4. Booking statuses
  5. Currencies
  6. Formats
  7. Genders
  8. Locales
  9. LOS kinds
  10. Fee kinds
  11. Fee rate kinds
  12. Payment kinds
  13. Payment gateway names
  14. Photo kinds
  15. Rental Link kinds
  16. Rates types
  17. Rates Rules types
  18. Rental types
  19. Rental residency categories
  20. Rental management type
  21. Inbox Message Channels
  22. Inbox Message Origins
  23. Inbox Message visibilities
  24. Rental Contact kinds
  25. Rental Contact roles
  26. Rental Certifications

Account statuses

Status Description
trial Account currently in trial period
paying Account active and paying
suspended Suspended account, it might get active again if payment made

Availability map statuses

Status Description
0 Available
1 Booked
2 Tentative
3 Unavailable

Change-over map statuses

Status Description
X No action possible
C Check-In and Check-Out
O Check-Out only
I Check-In only

Booking statuses

Status Description
Booked A regular reservation
Tentative Tentative, this is a hold for a certain length of time
Unavailable Unavailable period, often used to mark closed seasons or maintenance
Locked Booking is locked by an other application or user
Canceled This booking have been canceled

Currencies

Currency Code
إ.د AED
A$ AUD
R$ BRL
C$ CAD
CHF CHF
CZK
kr DKK
EUR
£ GBP
Ft HUF
Rp IDR
INR
¥ JPY
RM MYR
NZ$ NZD
PLN
RUB
฿ THB
UAH
$ USD

Formats

Name Description
date ISO 8601 compatible %Y-%m-%d 2014-08-21
decimal Decimal value returned as a string. Big.js is recommended for Javascript users.
object A Javascript Object.
time ISO 8601 compatible %Y-%m-%dT%H:%M:%SZ 2014-08-21T08:40:44Z

Note: Translation objects are having locales as string keys and translations as string values. {"en": "Wonderful living room", "fr": "Merveilleux séjour"}

Genders

Value
male
female

Locales

Code Name
bg Bulgarian
cs Czech
da Danish
de German
el Greek
en English
es Spanish
fi Finish
fr French
hu Hungarian
id Bahasa Indonesian
it Italian
ja Japanese
ko Korean
lt Lithuanian
lv Latvian
mk Macedonian
nb Norvegian
nl Dutch
pl Polish
pt Portuguese
ro Romanian
rs Serbian
ru Russian
sk Slovak
sv Swedish
uk Ukrainian
zh Simplified Chinese
zh-TW Traditional Chinese

LOS kinds

Name Description
rental_price_before_special_offers Price for the rent only, before special offers discounts being applied.
rental_price Price for the rent only, after all discounts applied.
final_price Price including all required fees and taxes.

Fee kinds

Name Description
other Any other type of fee
air_conditioning AC
airport_shuttle Airport shuttle
bed_linen Bed sheets and such
city_tax City tax where it’s a fixed amount
cleaning Cleaning fee
club_card Club card
conservation Conservation
credit_card Credit card
destination Destination
electricity Electricity
environment Environment
final_cleaning Final cleaning
gas Gas
heating Heating
heritage_charge Heritage charge
housekeeping Housekeeping
internet Internet
kitchen_linen Kitchen towels and such
linen_package All linens
municipality Municipality
oil Oil
parking Parking
public_transit_day_ticket Public transport day ticket
resort Resort
sea_plane Sea plane
service_charge Service charge
shuttle_boat Shuttle boat
ski_pass Ski pass
tourism Tourism
towel_charge Towel
transfer Transfer
visa_support Visa support
water_park Water park
water_usage Water usage
wood Wood
wristband Wristband

Fee rate kinds

Name Description
fixed Fixed price
fixed_per_person Fixed price per person
fixed_per_adult Fixed price per adult
fixed_per_child Fixed price per child
fixed_per_night Fixed price per night
fixed_per_person_per_night Fixed price per person per night
fixed_per_adult_per_night Fixed price per adult per night
fixed_per_child_per_night Fixed price per child per night
percentage Percentage of the rental price
percentage_per_person Percentage of the rental price per person
percentage_per_adult Percentage of the rental price per adult
percentage_per_child Percentage of the rental price per child
individual_percentage_per_adult Percentage of the rental price per adult per night

Payment kinds

Warning

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.

Name Description
bookingsync Internal payment made through BookingSync.
instant-booking Internal payment made during Instant Booking flow, through BookingSync.
cash Payment made by Cash.
cheque Payment made by Cheque.
credits Payment made using Credits. Credits are money you might have kept from your guest after a cancellation.
credit-card Payment made by Credit Card.
online Payment made Online, outside of BookingSync.
paypal Payment made with PayPal, outside of BookingSync.
travel-cheque Payment made by Travel Cheque.
wiretransfer Payment made by Wire Transfer.

Payment gateway names

Name Description
booking_pay BookingPay gateway.
ogone Ogone gateway.
stripe Stripe gateway.
bogus Bogus gateway.

Photo kinds

Name Description
bathroom Bathroom’s photo.
bedroom Bedroom’s photo.
floor_plan Floor plan
inside Inside’s photo.
kitchen Kitchen’s photo.
livingroom Livingroom’s photo.
outside Outside’s photo.
surroundings Surroundings’s photo.
Name Description
mirror Mirroring rental link

Rates types

Name Description
nightly The reference rate is nightly based.
weekly The reference rate is weekly based.

Rates Rules types

Name Description
arrival_only Rule applied on arrival.
departure_only Rule applied on departure.
early_booking Rule applied on early booking.
full_period_only Rule applied for full period.
late_booking Rule applied for late booking.
prevent_if_booked_ahead_of Rule applied if booked ahead.
stay_at_least Rule applied for minimum stay.
strict_minimum_price_per_night Rule applied for minimum price per night.
weekend_night Rule applied for weekend night.

Rental types

New Rental types

From 3rd of June 2020 six new rental types will be available:

mill, manor, bastide, longere, gite, mas

Name Description
apartment Apartment
bastide Bastide
boat Boat
bungalow Bungalow
bed-and-breakfast Bed & breakfast
cabin Cabin
castle Castle
cave Cave
chalet Chalet
condominium Condominium
cottage Cottage
dormitory Dormitory
earth-house Earth House
farmhouse Farmhouse
gite Gite
holiday-home Holiday Home
house House
hut Hut
igloo Igloo
island Island
lighthouse Lighthouse
loft Loft
longere Longere
manor Manor
mas Mas
mill Mill
plane Plane
private-room Private room
private-room-in-apartment Private room in an apartment
private-room-in-house Private room in a house
recreational-vehicle Camper/RV
studio Studio
tent Tent
tipi Tipi
townhouse Townhouse
train Train
treehouse Treehouse
villa Villa
yurt Yurt

Rental residency categories

Name Description
primary_residence Primary residence.
secondary_residence Secondary residence.
non_residential Non residential.

Rental management type

Name Description
professional Professional.
non_professional Non professional.

Inbox Message Channels

Name Description
airbnb Airbnb
homeaway HomeAway
email Email

Inbox Message Origins

Name Origin
bookingsync_inbox BookingSync Inbox
airbnb_message Airbnb message
airbnb_email Airbnb email
booking-com Booking.com
homeaway HomeAway
tripadvisor TripAdvisor
email Email
messenger Messenger
whatsapp WhatsApp
inquiry Inquiry
sms SMS

Inbox Message visibilities

Name Description
internal Internal visibility
external External visibility

Rental Contact kinds

Name Description
owner Contact is an owner
manager Contact is a manager

Rental Contact roles

Name Description
general For general purposes
contract For contract
reservations For reservations information
invoices Regarding invoice
availability Regarding availability
site_content Regarding site content
parity For parity information
requests Handling requests
central_reservations Regarding central reservations

Rental Certifications

Key Allowed values
meubles_de_tourisme 1_etoile 2_etoiles 3_etoiles 4_etoiles 5_etoiles
gites_de_france 1_epi 2_epis 3_epis 4_epis
clevacances 1_cle 2_cles 3_cles 4_cles
accueil_velo accueil_velo