Enumerables

  1. Account statuses
  2. Availability map statuses
  3. Change-over map statuses
  4. Booking statuses
  5. Currencies
  6. Formats
  7. Locales
  8. LOS kinds
  9. Fee kinds
  10. Fee rate kinds
  11. Payment kinds
  12. Photo kinds
  13. Rental Link kinds
  14. Rates types
  15. Rates Rules types
  16. Rental types

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"}

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
cleaning Cleaning fee
other Any other type of fee

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

Payment kinds

Name Description
bookingsync Payment made 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.

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

Name Description
apartment Apartment
boat Boat
bungalow Bungalow
cabin Cabin
castle Castle
chalet Chalet
cottage Cottage
farmhouse Farmhouse
holiday-home Holiday Home
house House
private-room Private room
studio Studio
villa Villa