Option

Fields

Field Description Type Min/max Notes
Options/
Option
Additional configuration for certain types of StandardPhrase. string 0..* -
Option/
@Name
The type of option. enum 1..1 Accepts: KeyCollectionAddressLine, KeyCollectionCityName, KeyCollectionPostalCode, RenovationFrom, RenovationUntil, SecurityDepositAmount, SecurityDepositCollectMethod, SecurityDepositCollectWhen, SecurityDepositCollectNumDays, SecurityDepositReturnMethod, SecurityDepositReturnWhen. See @Name for details.

@Name

Option[@Name] accepts the values in the table below.

Note

The first part of each value's name refers to a value of StandardPhrase[@Name]. This reference indicates a certain requirement, explained in the Description column.

Value Description
KeyCollectionAddressLine The street name and number for the key collection address. Required if StandardPhrase[@Name="KeyCollection"].
KeyCollectionCityName The city name for the key collection address. Required if StandardPhrase[@Name="KeyCollection"].
KeyCollectionPostalCode The postal code for the key collection address. Required if StandardPhrase[@Name="KeyCollection"].
RenovationFrom The start date of the renovations. Format: YYYY-MM-DD. Required if StandardPhrase[@Name="Renovation"].
RenovationUntil The end date of the renovations. Format: YYYY-MM-DD. Required if StandardPhrase[@Name="Renovation"].
SecurityDepositAmount The deposit amount, in the property's default currency. Required if StandardPhrase[@Name="SecurityDeposit"]. There is a limit on maximum deposit , see security deposit limits.
SecurityDepositCollectMethod The deposit collection method. Accepts: bank_transfer, credit_card, paypal, cash. Required if StandardPhrase[@Name="SecurityDeposit"].
SecurityDepositCollectWhen The moment when the property will collect the deposit. Accepts: before_arrival, upon_arrival, when_guest_books. Required if StandardPhrase[@Name="SecurityDeposit"].
SecurityDepositCollectNumDays The number of days before check-in when the property will collect the deposit. Accepts: 0, 3, 7, 30. Required if StandardPhrase[@Name="SecurityDeposit"].
SecurityDepositReturnMethod The deposit return method. Accepts: bank_transfer, credit_card, paypal, cash. Required if StandardPhrase[@Name="SecurityDeposit"].
SecurityDepositReturnWhen The moment when the property will return the deposit. Accepts: on_checkout, within_7_days, within_14_days. Required if StandardPhrase[@Name="SecurityDeposit"].

XML

<Option
  Name="KeyCollectionAddressLine">
  Rembrandtplein
</Option>
<Option
  Name="KeyCollectionCityName">
  Amsterdam
</Option>
<Option
  Name="KeyCollectionPostalCode">
  1017 CD
</Option>
...
<Option
  Name="RenovationFrom">
  2017-02-18
</Option>
<Option
  Name="RenovationUntil">
  2017-02-19
</Option>
...
<Option
  Name="SecurityDepositAmount">
  120
</Option>

Security Deposit Limits

There are limitations on amount you can set as a security deposit (SecurityDepositAmount). The limitations vary in different cases. If you exceed the maximum allowed amount - value of your security deposit will be reset to maximum possible and you will receive a warning message like this:

   SecurityDepositAmount exceeded the limit of X, the value has been set to X.