# info.description
# Introduction

Lodgix exposes some of its functionality via an Application Programming Interface (API).
This document is a reference for that functionality, and it aims to serve as a reference
for developers building tools that talk to Lodgix.com.

# Authentication

Lodgix uses api-keys to authenticate the API's requests. As a Lodgix user, you can obtain your api-key on
[Settings > Important Settings](https://www.lodgix.com/app/isettings/general/) page.

To use your api-key and authenticate your request, you have to pass it in the "Authorization" HTTP header,
prepended with the string "Token ":

```bash
curl -H "Authorization: Token <your-api-key-here>" -X GET "https://www.lodgix.com/public-api/v2/accounts/current/"
```

# Pagination

Offset-based pagination is often required when accessing collections.
APIs that use offset-based paging use the `offset` and `limit` query parameters to paginate through items in a collection.

To fetch the first page of items in a collection the API needs to be called either without the `offset` parameter,
or with the `offset` set to `0`. The `limit` field is optional:

```bash
curl -H "Authorization: Token <your-api-key-here>" -X GET "https://www.lodgix.com/public-api/v2/reservations/"
```

> **_NOTE:_** The default `limit` is `20` items per page. The max value of `limit` that you can specify is `50` items per page.

To fetch the next page of items the API needs to be called with an `offset` parameter that equals the sum of the previous
`offset` value and `limit` returned in the previous result, `previous_offset + previous_limit`:

```bash
curl -H "Authorization: Token <your-api-key-here>" -X GET "https://www.lodgix.com/public-api/v2/reservations/?offset=60&limit=30"
```

# Errors

Lodgix uses conventional HTTP response codes to indicate success or failure of an API request.

In general, codes in the **2xx** range indicate *successful* requests, codes in the **4xx** range indicate an *error*
within your request (e.g. a required parameter was missing, an external service call failed, etc.),
and codes in the **5xx** range indicate a *failure* of the Lodgix service (please contact us if you see these).

### Error Response Schema

Lodgix has a single format for all errors. It always returns a JSON object with
a message, code (identifier of the error), and field if the error is specific to a particular field. Example:

```
{
    "errors": [
        {
            "message": "Delete or cancel all reservations first.",
            "code": "invalid"
        },
        {
            "message": "Ensure this field has no more than 21 characters.",
            "code": "max_length",
            "field": "address.work_phone"
        },
        {
            "message": "This email already exists",
            "code": "unique",
            "field": "login_email"
        }
    ]
}
```

# Enums


## LanguageType


* `sq` - Albanian
* `ar` - Arabic
* `hy` - Armenian
* `eu` - Basque
* `bs` - Bosnian
* `bg` - Bulgarian
* `ca` - Catalan
* `zh-hans` - Chinese (Simplified)
* `zh-hant` - Chinese (Traditional)
* `hr` - Croatian
* `cs` - Czech
* `da` - Danish
* `nl` - Dutch
* `eo` - Esperanto
* `et` - Estonian
* `fi` - Finnish
* `fr` - French
* `de` - German
* `el` - Greek
* `he` - Hebrew
* `hi` - Hindi
* `hu` - Hungarian
* `is` - Icelandic
* `id` - Indonesian
* `ga` - Irish
* `it` - Italian
* `ja` - Japanese
* `ko` - Korean
* `ku` - Kurdish
* `la` - Latin
* `lv` - Latvian
* `lt` - Lithuanian
* `mk` - Macedonian
* `ms` - Malay
* `mt` - Maltese
* `mo` - Moldavian
* `mn` - Mongolian
* `ne` - Nepali
* `nb` - Norwegian Bokm
* `fa` - Persian
* `pl` - Polish
* `pt-pt` - Portuguese
* `pt-br` - Portuguese, Brazil
* `pa` - Punjabi
* `qu` - Quechua
* `ro` - Romanian
* `ru` - Russian
* `sr` - Serbian
* `sl` - Slavic
* `sl` - Slovenian
* `so` - Somali
* `es` - Spanish
* `sv` - Swedish
* `ta` - Tamil
* `th` - Thai
* `tr` - Turkish
* `uk` - Ukrainian
* `ur` - Urdu
* `uz` - Uzbek
* `vi` - Vietnamese
* `cy` - Welsh
* `yi` - Yiddish
* `zu` - Zulu

    
## PropertyType


* `APARTMENT` - Apartment
* `BARN` - Barn
* `BED_AND_BREAKFAST` - Bed and Breakfast
* `BOAT` - Boat
* `BUNGALOW` - Bungalow
* `CABIN` - Cabin
* `CAMPSITE` - Campsite
* `CASTLE` - Castle
* `CHACARA` - Chacara
* `CHALET` - Chalet
* `CONDO` - Condo
* `CONDOTEL` - CondoTel
* `COTTAGE` - Cottage
* `COTTAGE_RESORT` - Cottage Resort
* `COUNTRY_HOUSE_CHATEAU` - Country House / Chateau
* `ESTATE` - Estate
* `FARMHOUSE` - Farmhouse
* `GUESTHOUSE` - Guesthouse
* `GUEST_HOUSE` - Guest House
* `HOTEL` - Hotel
* `HOUSE` - House
* `HOUSE_BOAT` - House Boat
* `INN` - Inn
* `LODGE` - Lodge
* `LOG_CABIN` - Log Cabin
* `MILL` - Mill
* `MOBILE_HOME` - Mobile Home
* `MOTEL` - Motel
* `PARKING_SPACE` - Parking Space
* `PRIVATE_ISLAND` - Private Island
* `RESORT` - Resort
* `ROOM` - Room
* `ROOMS_FOR_RENT` - Rooms for Rent
* `ROOM_TYPE` - Room type
* `RV` - RV
* `STUDIO` - Studio
* `TINY_HOME` - Tiny Home
* `TOWER` - Tower
* `TOWNHOME` - Townhome
* `TREEHOUSE` - Treehouse
* `VILLA` - Villa
* `YACHT` - Yacht
* `YURT` - Yurt

    
## ReservationStateType


* `BLOCKED` - Blocked
* `CANCELLED` - Cancelled
* `NOTPAID` - Unconfirmed
* `PAID` - Paid In Full
* `PAIDDEPOSIT` - Confirmed
* `PAIDOTHER` - Paid

    

# paths.https://www.lodgix.com/public-api/v2/damage-templates/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/deposit-templates/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/discount-templates/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/fee-templates/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/guest-statuses/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/guests/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/owner-properties/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/owners/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/properties/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/properties/{id}/.get.description
Retrieves the details of an existing property.
Supply the unique property ID from either a property creation request or the property list.

# paths.https://www.lodgix.com/public-api/v2/properties/{property_pk}/am.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/properties/{property_pk}/ph.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/properties/{property_pk}/ra.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/properties/{property_pk}/re.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/property-availability-array.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/property-damages/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/property-deposits/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/property-discounts/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/property-fees/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/property-flexible-date-avai.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/property-flexible-date-avai.get.parameters[].description
Minimum number of nights for the stay (months mode)

# paths.https://www.lodgix.com/public-api/v2/property-flexible-date-avai.get.parameters[].description
Maximum number of nights for the stay (months mode)

# paths.https://www.lodgix.com/public-api/v2/property-flexible-date-avai.get.parameters[].description
Exact check in date (YYYY-MM-DD). Exact dates mode.

# paths.https://www.lodgix.com/public-api/v2/property-flexible-date-avai.get.parameters[].description
Exact check out date (YYYY-MM-DD). Exact dates mode.

# paths.https://www.lodgix.com/public-api/v2/property-flexible-date-avai.get.parameters[].description
Slide the check in date by plus or minus N days (0 to 14). Exact dates mode.

# paths.https://www.lodgix.com/public-api/v2/property-flexible-date-avai.get.parameters[].description
List of property IDs to check. Max 50 properties.

# paths.https://www.lodgix.com/public-api/v2/property-flexible-date-avai.get.parameters[].description
Whether to calculate pricing for each window (default: true)

# paths.https://www.lodgix.com/public-api/v2/property-services/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/property-taxes/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/rental-expenses/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/reservations/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/reservations/.get.parameters[].description
Start of the date range. Returns the reservations that start on or after this date.

# paths.https://www.lodgix.com/public-api/v2/reservations/.get.parameters[].description
End of the date range. Returns the reservations that end on or before this date.

# paths.https://www.lodgix.com/public-api/v2/reservations/.get.parameters[].description
Reservation properties IDs separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/.get.parameters[].description
Reservation guests IDs separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/.get.parameters[].description
ReservationStateType | Reservation states separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/.get.parameters[].description
Stay Type
* `GUEST` - Guest
* `OWNER` - Owner

# paths.https://www.lodgix.com/public-api/v2/reservations/.get.parameters[].description
Returns reservations created at or after this ISO 8601 datetime (e.g. 2026-04-29T12:34:56), in the format the `created` response field uses.

# paths.https://www.lodgix.com/public-api/v2/reservations/.get.parameters[].description
Returns reservations created strictly before this ISO 8601 datetime (e.g. 2026-04-29T12:34:56), in the format the `created` response field uses.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.get.parameters[].description
Start of the date range. Returns the reservations that start on or after this date.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.get.parameters[].description
End of the date range. Returns the reservations that end on or before this date.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.get.parameters[].description
Reservation properties IDs separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.get.parameters[].description
Reservation guests IDs separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.get.parameters[].description
ReservationStateType | Reservation states separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.get.parameters[].description
Stay Type
* `GUEST` - Guest
* `OWNER` - Owner

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.get.parameters[].description
Returns reservations created at or after this ISO 8601 datetime (e.g. 2026-04-29T12:34:56), in the format the `created` response field uses.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.get.parameters[].description
Returns reservations created strictly before this ISO 8601 datetime (e.g. 2026-04-29T12:34:56), in the format the `created` response field uses.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.patch.parameters[].description
Start of the date range. Returns the reservations that start on or after this date.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.patch.parameters[].description
End of the date range. Returns the reservations that end on or before this date.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.patch.parameters[].description
Reservation properties IDs separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.patch.parameters[].description
Reservation guests IDs separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.patch.parameters[].description
ReservationStateType | Reservation states separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.patch.parameters[].description
Stay Type
* `GUEST` - Guest
* `OWNER` - Owner

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.patch.parameters[].description
Returns reservations created at or after this ISO 8601 datetime (e.g. 2026-04-29T12:34:56), in the format the `created` response field uses.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.patch.parameters[].description
Returns reservations created strictly before this ISO 8601 datetime (e.g. 2026-04-29T12:34:56), in the format the `created` response field uses.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.delete.parameters[].description
Start of the date range. Returns the reservations that start on or after this date.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.delete.parameters[].description
End of the date range. Returns the reservations that end on or before this date.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.delete.parameters[].description
Reservation properties IDs separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.delete.parameters[].description
Reservation guests IDs separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.delete.parameters[].description
ReservationStateType | Reservation states separated by a comma

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.delete.parameters[].description
Stay Type
* `GUEST` - Guest
* `OWNER` - Owner

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.delete.parameters[].description
Returns reservations created at or after this ISO 8601 datetime (e.g. 2026-04-29T12:34:56), in the format the `created` response field uses.

# paths.https://www.lodgix.com/public-api/v2/reservations/{id}/.delete.parameters[].description
Returns reservations created strictly before this ISO 8601 datetime (e.g. 2026-04-29T12:34:56), in the format the `created` response field uses.

# paths.https://www.lodgix.com/public-api/v2/service-templates/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/tax-templates/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/team-members/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/work-order-expense-accounts.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/work-order-job-types/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/work-order-priorities/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/work-order-statuses/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/work-order-vendors/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/work-orders/.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/work-orders/{work_order_pk}.get.operationId
List all expenses/materials for a work order

# paths.https://www.lodgix.com/public-api/v2/work-orders/{work_order_pk}.get.parameters[].description
The initial index from which to return the results.

# paths.https://www.lodgix.com/public-api/v2/work-orders/{work_order_pk}.get.parameters[].description
The initial index from which to return the results.

# components.schemas.AccountOutput.properties.security_deposit_label.description
Security deposit label
* `0` - Security Deposit
* `1` - Damage Deposit
* `2` - Refundable Damage Deposit

# components.schemas.AccountOutput.properties.wordpress_chat_enabled.description
Is WordPress Chat enabled for the account

# components.schemas.DamageTemplatePartialUpdate.properties.name_id.description
Damage template name
* `1` - Security Deposit Waiver
* `2` - All Seasons Travel Plan
* `3` - Mishap
* `4` - Accidental Damage Protection

# components.schemas.DamageTemplatePartialUpdate.properties.override_universal_rules.description
Damage template override universal rules

# components.schemas.DiscountTemplateOutput.properties.type.description
Discount template type
* `0` - Regular
* `1` - Length of Stay
* `2` - Last Minute

# components.schemas.DiscountTemplateOutput.properties.status.description
Discount template status
* `0` - Active
* `1` - Expired

# components.schemas.DiscountTemplateOutput.properties.value_type.description
Discount template value type
* `0` - Percent
* `1` - Money

# components.schemas.DiscountTemplateOutput.properties.stack_with_auto.description
Discount template stack with auto discounts

# components.schemas.DiscountTemplateCreate.properties.type.description
Discount template type
* `0` - Regular
* `1` - Length of Stay
* `2` - Last Minute

# components.schemas.DiscountTemplateCreate.properties.value_type.description
Discount template value type
* `0` - Percent
* `1` - Money

# components.schemas.DiscountTemplateCreate.properties.stack_with_auto.description
Discount template stack with auto discounts

# components.schemas.DiscountTemplatePartialUpdate.properties.type.description
Discount template type
* `0` - Regular
* `1` - Length of Stay
* `2` - Last Minute

# components.schemas.DiscountTemplatePartialUpdate.properties.value_type.description
Discount template value type
* `0` - Percent
* `1` - Money

# components.schemas.DiscountTemplatePartialUpdate.properties.stack_with_auto.description
Discount template stack with auto discounts

# components.schemas.FeeTemplateOutput.properties.type.description
Fee template type
* `INTERNAL` - Internal
* `MANDATORY` - Mandatory
* `OPTIONAL` - Optional
* `PET_FEE_TRIGGER` - Pet Fee Trigger
* `STAY_COLLECTED` - VRBO Stay Collected

# components.schemas.FeeTemplateOutput.properties.commissionable.description
Fee template commissionable
* `0` - Not commissionable
* `1` - Commissionable
* `2` - Revenue Only

# components.schemas.FeeTemplateOutput.properties.value_type.description
Fee template value type
* `0` - Fixed
* `1` - Percent % rental charges
* `2` - Percent % total charges

# components.schemas.FeeTemplateCreate.properties.type.description
Fee template type
* `INTERNAL` - Internal
* `MANDATORY` - Mandatory
* `OPTIONAL` - Optional
* `PET_FEE_TRIGGER` - Pet Fee Trigger
* `STAY_COLLECTED` - VRBO Stay Collected

# components.schemas.FeeTemplateCreate.properties.commissionable.description
Fee template commissionable
* `0` - Not commissionable
* `1` - Commissionable
* `2` - Revenue Only

# components.schemas.FeeTemplateCreate.properties.value_type.description
Fee template value type
* `0` - Fixed
* `1` - Percent % rental charges
* `2` - Percent % total charges

# components.schemas.FeeTemplatePartialUpdate.properties.type.description
Fee template type
* `INTERNAL` - Internal
* `MANDATORY` - Mandatory
* `OPTIONAL` - Optional
* `PET_FEE_TRIGGER` - Pet Fee Trigger
* `STAY_COLLECTED` - VRBO Stay Collected

# components.schemas.FeeTemplatePartialUpdate.properties.commissionable.description
Fee template commissionable
* `0` - Not commissionable
* `1` - Commissionable
* `2` - Revenue Only

# components.schemas.FeeTemplatePartialUpdate.properties.value_type.description
Fee template value type
* `0` - Fixed
* `1` - Percent % rental charges
* `2` - Percent % total charges

# components.schemas.GuestOutput.properties.title.description
Guest title
* `DR` - Dr.
* `MISS` - Ms.
* `MISSIS` - Mrs.
* `MISTER` - Mr.
* `MRMRS` - Mr. & Mrs.

# components.schemas.GuestCreate.properties.title.description
Guest title
* `DR` - Dr.
* `MISS` - Ms.
* `MISSIS` - Mrs.
* `MISTER` - Mr.
* `MRMRS` - Mr. & Mrs.

# components.schemas.GuestPartialUpdate.properties.title.description
Guest title
* `DR` - Dr.
* `MISS` - Ms.
* `MISSIS` - Mrs.
* `MISTER` - Mr.
* `MRMRS` - Mr. & Mrs.

# components.schemas.OwnerDocumentInput.properties.path.description
Document relative path, example: `/Owner Documents/doc.pdf`

# components.schemas.OwnerPropertyOutput.properties.is_flat.description
If true then the commission is fixed, otherwise percent

# components.schemas.OwnerPropertyOutput.properties.commission_calculation.description
Commission calculation
* `GROSS` - Gross
* `NET` - Net
* `GROSS_LESS_CC` - Available if pass_cancellation_fees_to_owner is True
* `NET_LESS_CC` - Available if pass_cancellation_fees_to_owner is True

# components.schemas.OwnerPropertyOutput.properties.cleaning_fee_is_flat.description
If true then the cleaning fee is fixed, otherwise percent

# components.schemas.OwnerPropertyCreate.properties.commission_calculation.description
Commission calculation
* `GROSS` - Gross
* `NET` - Net
* `GROSS_LESS_CC` - Available if pass_cancellation_fees_to_owner is True
* `NET_LESS_CC` - Available if pass_cancellation_fees_to_owner is True

# components.schemas.OwnerPropertyCreate.properties.is_flat.description
If true then the commission is fixed, otherwise percent

# components.schemas.OwnerPropertyCreate.properties.cleaning_fee_is_flat.description
If true then the cleaning fee is fixed, otherwise percent

# components.schemas.OwnerPropertyPartialUpdate.properties.commission_calculation.description
Commission calculation
* `GROSS` - Gross
* `NET` - Net
* `GROSS_LESS_CC` - Available if pass_cancellation_fees_to_owner is True
* `NET_LESS_CC` - Available if pass_cancellation_fees_to_owner is True

# components.schemas.OwnerPropertyPartialUpdate.properties.is_flat.description
If true then the commission is fixed, otherwise percent

# components.schemas.OwnerPropertyPartialUpdate.properties.cleaning_fee_is_flat.description
If true then the cleaning fee is fixed, otherwise percent

# components.schemas.OwnerOutput.properties.title.description
Owner title
* `DR` - Dr.
* `MISS` - Ms.
* `MISSIS` - Mrs.
* `MISTER` - Mr.
* `MRMRS` - Mr. & Mrs.

# components.schemas.PropertyOutput.properties.property_type.description
PropertyType

# components.schemas.PropertyOutput.properties.places.items.properties.place_type.description
Property place type
* `ART_STUDIO` - Art Studio
* `BACKYARD` - Backyard
* `BALCONY` - Balcony
* `BEDROOM` - Bedroom
* `BOWLING_ALLEY` - Bowling Alley
* `CASINO` - Casino
* `CHILDRENS_PLAYROOM` - Childrens Playroom
* `COURTYARD` - Courtyard
* `DARKROOM` - Darkroom
* `DINING_ROOM` - Dining Room
* `EVENT_ROOM` - Event Room
* `EXTERIOR` - Exterior
* `FRONT_YARD` - Front Yard
* `FULL_BATHROOM` - Full Bathroom
* `GAME_ROOM` - Game Room
* `GARAGE` - Garage
* `GYM` - Gym
* `HALF_BATHROOM` - Half Bathroom
* `HOT_TUB` - Hot Tub
* `KITCHEN` - Kitchen
* `KITCHENETTE` - Kitchenette
* `LAUNDRY_ROOM` - Laundry Room
* `LIBRARY` - Library 
* `LIVING_ROOM` - Living Room
* `MOVIE_THEATER` - Movie Theater 
* `MUSIC_STUDIO` - Music Studio
* `OFFICE` - Office
* `PATIO` - Patio
* `PHOTOGRAPHY_STUDIO` - Photography Studio
* `POOL` - Pool
* `PORCH` - Porch
* `ROOFTOP` - Rooftop
* `STUDIO` - Studio
* `SUNROOM` - Sunroom
* `TERRACE` - Terrace
* `THEME_ROOM` - Theme Room
* `WINE_CELLAR` - Wine Cellar
* `WOODSHOP` - Woodshop
* `WORKSHOP` - Workshop
* `WORKSPACE` - workspace

# components.schemas.PropertyOutput.properties.places.items.properties.beds.items.properties.type.description
Property place bed type
* `AIR_MATTRESS` - Air Mattress
* `BUNK_BED` - Bunk Bed
* `COUCH` - Couch
* `CRIB` - Crib
* `DOUBLE_BED` - Double Bed
* `FLOOR_MATTRESS` - Floor Mattress
* `HAMMOCK` - Hammock
* `KING_BED` - King Bed
* `QUEEN_BED` - Queen Bed
* `SINGLE_BED` - Single Bed
* `SOFA_BED` - Sofa Bed
* `TODDLER_BED` - Toddler Bed
* `WATER_BED` - Water Bed

# components.schemas.PropertyOutput.properties.city_registration_code.description
Property city registration code. This field is no longer supported and will be removed in the future

# components.schemas.PropertyOutput.properties.rate_settings.properties.prorate_partial_period.description
How to calculate rate when a stay is > than a week or month?
* `PRORATE` - Weekly/monthly rental rate + pro-rate of weekly/monthly rental rate
* `USE_DAILY` - Weekly/monthly rental rate + one night daily rental rate

# components.schemas.PropertyOutput.properties.rate_settings.properties.several_rates_available.description
How to calculate rate when a stay spans two different rate periods?
* `LOWER` - Choose lower rate
* `HIGHER` - Choose higher rate
* `COMBINE` - Prorate each rate

# components.schemas.PropertyOutput.properties.rate_settings.properties.monthly_length_calculation.description
How to calculate Monthly Rate month length?
* `RESERVATION_START_MONTH_LENGTH` - Reservation start day month length
* `ALWAYS_30_DAYS` - Always 30 days
* `ALWAYS_28_DAYS` - Always 28 days

# components.schemas.PropertyOutput.properties.default_rate.properties.arrival_day.description
Arrival day
* `6` - Sunday
* `0` - Monday
* `1` - Tuesday
* `2` - Wednesday
* `3` - Thursday
* `4` - Friday
* `5` - Saturday

# components.schemas.PropertyOutput.properties.default_rate.properties.departure_day.description
Departure day
* `6` - Sunday
* `0` - Monday
* `1` - Tuesday
* `2` - Wednesday
* `3` - Thursday
* `4` - Friday
* `5` - Saturday

# components.schemas.PropertyOutput.properties.no_booking_widget.description
Property booking widget
* `0` - Accept online bookings
* `1` - Availability Only - NO Online Bookings
* `2` - No Availability Display / No Online Bookings

# components.schemas.PropertyOutput.properties.check_in_options.properties.category.description
Check in options category
* `DOORMAN_ENTRY` - Doorman Entry - 24 hours
* `FRONT_DESK` - Front Desk
* `FRONT_DESK_24H` - Front Desk - 24h
* `HOST_CHECKIN` - Host
* `KEYPAD` - Keypad
* `LOCKBOX` - Lockbox
* `OTHER_CHECKIN` - Other
* `SMARTLOCK` - Smart Lock

# components.schemas.PropertyOutput.properties.check_in_options.properties.category_airbnb.description
Check in options category for AirBnB
* `DOORMAN_ENTRY` - Doorman Entry - 24 hours
* `HOST_CHECKIN` - Host
* `KEYPAD` - Keypad
* `LOCKBOX` - Lockbox
* `OTHER_CHECKIN` - Other
* `SMARTLOCK` - Smart Lock

# components.schemas.PropertyCreate.properties.property_type.description
PropertyType

# components.schemas.PropertyCreate.properties.locations.properties.car.description
Car
* `0` - Necessary
* `1` - Not necessary
* `2` - Recommended

# components.schemas.PropertyCreate.properties.rate_settings.properties.prorate_partial_period.description
How to calculate rate when a stay is > than a week or month?
* `PRORATE` - Weekly/monthly rental rate + pro-rate of weekly/monthly rental rate
* `USE_DAILY` - Weekly/monthly rental rate + one night daily rental rate

# components.schemas.PropertyCreate.properties.rate_settings.properties.several_rates_available.description
How to calculate rate when a stay spans two different rate periods?
* `LOWER` - Choose lower rate
* `HIGHER` - Choose higher rate
* `COMBINE` - Prorate each rate

# components.schemas.PropertyCreate.properties.rate_settings.properties.monthly_length_calculation.description
How to calculate Monthly Rate month length?
* `RESERVATION_START_MONTH_LENGTH` - Reservation start day month length
* `ALWAYS_30_DAYS` - Always 30 days
* `ALWAYS_28_DAYS` - Always 28 days

# components.schemas.PropertyCreate.properties.city_registration_code.description
Property city registration code. This field is no longer supported and will be removed in the future

# components.schemas.PropertyCreate.properties.no_booking_widget.description
Property booking widget
* `0` - Accept online bookings
* `1` - Availability Only - NO Online Bookings
* `2` - No Availability Display / No Online Bookings

# components.schemas.PropertyCreate.properties.check_in_options.properties.category.description
Check in options category
* `DOORMAN_ENTRY` - Doorman Entry - 24 hours
* `FRONT_DESK` - Front Desk
* `FRONT_DESK_24H` - Front Desk - 24h
* `HOST_CHECKIN` - Host
* `KEYPAD` - Keypad
* `LOCKBOX` - Lockbox
* `OTHER_CHECKIN` - Other
* `SMARTLOCK` - Smart Lock

# components.schemas.PropertyCreate.properties.check_in_options.properties.category_airbnb.description
Check in options category for AirBnB
* `DOORMAN_ENTRY` - Doorman Entry - 24 hours
* `HOST_CHECKIN` - Host
* `KEYPAD` - Keypad
* `LOCKBOX` - Lockbox
* `OTHER_CHECKIN` - Other
* `SMARTLOCK` - Smart Lock

# components.schemas.PropertyPartialUpdate.properties.property_type.description
PropertyType

# components.schemas.PropertyPartialUpdate.properties.locations.properties.car.description
Car
* `0` - Necessary
* `1` - Not necessary
* `2` - Recommended

# components.schemas.PropertyPartialUpdate.properties.rate_settings.properties.prorate_partial_period.description
How to calculate rate when a stay is > than a week or month?
* `PRORATE` - Weekly/monthly rental rate + pro-rate of weekly/monthly rental rate
* `USE_DAILY` - Weekly/monthly rental rate + one night daily rental rate

# components.schemas.PropertyPartialUpdate.properties.rate_settings.properties.several_rates_available.description
How to calculate rate when a stay spans two different rate periods?
* `LOWER` - Choose lower rate
* `HIGHER` - Choose higher rate
* `COMBINE` - Prorate each rate

# components.schemas.PropertyPartialUpdate.properties.rate_settings.properties.monthly_length_calculation.description
How to calculate Monthly Rate month length?
* `RESERVATION_START_MONTH_LENGTH` - Reservation start day month length
* `ALWAYS_30_DAYS` - Always 30 days
* `ALWAYS_28_DAYS` - Always 28 days

# components.schemas.PropertyPartialUpdate.properties.city_registration_code.description
Property city registration code. This field is no longer supported and will be removed in the future

# components.schemas.PropertyPartialUpdate.properties.no_booking_widget.description
Property booking widget
* `0` - Accept online bookings
* `1` - Availability Only - NO Online Bookings
* `2` - No Availability Display / No Online Bookings

# components.schemas.PropertyPartialUpdate.properties.check_in_options.properties.category.description
Check in options category
* `DOORMAN_ENTRY` - Doorman Entry - 24 hours
* `FRONT_DESK` - Front Desk
* `FRONT_DESK_24H` - Front Desk - 24h
* `HOST_CHECKIN` - Host
* `KEYPAD` - Keypad
* `LOCKBOX` - Lockbox
* `OTHER_CHECKIN` - Other
* `SMARTLOCK` - Smart Lock

# components.schemas.PropertyPartialUpdate.properties.check_in_options.properties.category_airbnb.description
Check in options category for AirBnB
* `DOORMAN_ENTRY` - Doorman Entry - 24 hours
* `HOST_CHECKIN` - Host
* `KEYPAD` - Keypad
* `LOCKBOX` - Lockbox
* `OTHER_CHECKIN` - Other
* `SMARTLOCK` - Smart Lock

# components.schemas.RateOutput.properties.arrival_day.description
Arrival day
* `6` - Sunday
* `0` - Monday
* `1` - Tuesday
* `2` - Wednesday
* `3` - Thursday
* `4` - Friday
* `5` - Saturday

# components.schemas.RateOutput.properties.departure_day.description
Departure day
* `6` - Sunday
* `0` - Monday
* `1` - Tuesday
* `2` - Wednesday
* `3` - Thursday
* `4` - Friday
* `5` - Saturday

# components.schemas.RateCreate.properties.arrival_day.description
Arrival day
* `6` - Sunday
* `0` - Monday
* `1` - Tuesday
* `2` - Wednesday
* `3` - Thursday
* `4` - Friday
* `5` - Saturday

# components.schemas.RateCreate.properties.departure_day.description
Departure day
* `6` - Sunday
* `0` - Monday
* `1` - Tuesday
* `2` - Wednesday
* `3` - Thursday
* `4` - Friday
* `5` - Saturday

# components.schemas.RatePartialUpdate.properties.arrival_day.description
Arrival day
* `6` - Sunday
* `0` - Monday
* `1` - Tuesday
* `2` - Wednesday
* `3` - Thursday
* `4` - Friday
* `5` - Saturday

# components.schemas.RatePartialUpdate.properties.departure_day.description
Departure day
* `6` - Sunday
* `0` - Monday
* `1` - Tuesday
* `2` - Wednesday
* `3` - Thursday
* `4` - Friday
* `5` - Saturday

# components.schemas.ReviewOutput.properties.language.description
LanguageType

# components.schemas.ReviewCreate.properties.language.description
LanguageType

# components.schemas.ReviewPartialUpdate.properties.language.description
LanguageType

# components.schemas.PropertyAvailabilityOutput.properties.available_property_ids_rules_ignored.description
Returns a list of available properties before applying rules such as minimum or maximum night stays, or arrival/departure day violations.

# components.schemas.PropertyFlexibleDateAvailabilityQueryParams.properties.min_nights.description
Minimum number of nights for the stay (months mode)

# components.schemas.PropertyFlexibleDateAvailabilityQueryParams.properties.max_nights.description
Maximum number of nights for the stay (months mode)

# components.schemas.PropertyFlexibleDateAvailabilityQueryParams.properties.check_in.description
Exact check in date (YYYY-MM-DD). Exact dates mode.

# components.schemas.PropertyFlexibleDateAvailabilityQueryParams.properties.check_out.description
Exact check out date (YYYY-MM-DD). Exact dates mode.

# components.schemas.PropertyFlexibleDateAvailabilityQueryParams.properties.flexibility.description
Slide the check in date by plus or minus N days (0 to 14). Exact dates mode.

# components.schemas.PropertyFlexibleDateAvailabilityQueryParams.properties.properties.description
List of property IDs to check. Max 50 properties.

# components.schemas.PropertyFlexibleDateAvailabilityQueryParams.properties.include_pricing.description
Whether to calculate pricing for each window (default: true)

# components.schemas.PropertyFlexibleDateAvailabilityOutput.properties.available_windows.items.properties.from_date.description
Check-in date for this availability window

# components.schemas.PropertyFlexibleDateAvailabilityOutput.properties.available_windows.items.properties.to_date.description
Check-out date for this availability window

# components.schemas.PropertyFlexibleDateAvailabilityOutput.properties.available_windows.items.properties.distance_days.description
Days from the requested check in date (exact dates mode only)

# components.schemas.PropertyFlexibleDateAvailabilityOutput.properties.available_windows.description
List of available date windows matching the criteria

# components.schemas.ReservationOutput.properties.state.description
ReservationStateType | Reservation state

# components.schemas.ReservationOutput.properties.substate.description
ReservationStateType | Reservation sub state

# components.schemas.ReservationOutput.properties.block_type.description
Reservation block type. Returns `null` if `state` is not `BLOCKED`

# components.schemas.ReservationOutput.properties.services.items.properties.value_type.description
Service value type
* `0` - Fixed
* `1` - Percent % rental charges
* `2` - Percent % total charges

# components.schemas.ReservationOutput.properties.services.items.properties.time_type.description
Service billing time type
* `DAILY` - Daily
* `INSTANTLY` - One-time
* `MONTHLY` - Monthly
* `WEEKLY` - Weekly

# components.schemas.ReservationOutput.properties.services.items.properties.multiple.description
Whether multiple quantities can be purchased

# components.schemas.ReservationOutput.properties.services.items.properties.internal.description
Whether this is an internal-only service

# components.schemas.ReservationOutput.properties.services.items.properties.commissionable.description
Service commissionable status
* `0` - Not commissionable
* `1` - Commissionable
* `2` - Revenue Only

# components.schemas.ReservationOutput.properties.services.description
List of services purchased for this reservation

# components.schemas.ReservationOutput.properties.fees.description
List of fees applied to this reservation

# components.schemas.ReservationOutput.properties.taxes.description
List of taxes applied to this reservation

# components.schemas.ReservationOutput.properties.discounts.items.properties.id.description
Unique ID of the reservation discount record

# components.schemas.ReservationOutput.properties.discounts.items.properties.automatic.description
Whether discount was automatically applied

# components.schemas.ReservationOutput.properties.discounts.description
List of discounts applied to this reservation

# components.schemas.ServiceTemplateOutput.properties.time_type.description
Service template time type
* `DAILY` - Daily
* `INSTANTLY` - One-time
* `MONTHLY` - Monthly
* `WEEKLY` - Weekly

# components.schemas.ServiceTemplateOutput.properties.value_type.description
Service template value type
* `0` - Fixed
* `1` - Percent % rental charges
* `2` - Percent % total charges

# components.schemas.ServiceTemplateOutput.properties.commissionable.description
Service template commissionable
* `0` - Not commissionable
* `1` - Commissionable
* `2` - Revenue Only

# components.schemas.ServiceTemplateCreate.properties.commissionable.description
Service template commissionable
* `0` - Not commissionable
* `1` - Commissionable
* `2` - Revenue Only

# components.schemas.ServiceTemplateCreate.properties.value_type.description
Service template value type
* `0` - Fixed
* `1` - Percent % rental charges
* `2` - Percent % total charges

# components.schemas.ServiceTemplateCreate.properties.time_type.description
Fee template type
* `DAILY` - Daily
* `INSTANTLY` - One-time
* `MONTHLY` - Monthly
* `WEEKLY` - Weekly

# components.schemas.ServiceTemplatePartialUpdate.properties.commissionable.description
Service template commissionable
* `0` - Not commissionable
* `1` - Commissionable
* `2` - Revenue Only

# components.schemas.ServiceTemplatePartialUpdate.properties.value_type.description
Service template value type
* `0` - Fixed
* `1` - Percent % rental charges
* `2` - Percent % total charges

# components.schemas.ServiceTemplatePartialUpdate.properties.time_type.description
Fee template type
* `DAILY` - Daily
* `INSTANTLY` - One-time
* `MONTHLY` - Monthly
* `WEEKLY` - Weekly

# components.schemas.TaxTemplateOutput.properties.type.description
Tax template type
* `CITYTAX` - City tax
* `LOCALTAX` - Local tax
* `OTHERTAX` - Other tax
* `PROVINCETAX` - Province Tax
* `SALESTAX` - Sales Tax
* `STATETAX` - State tax

# components.schemas.TaxTemplateOutput.properties.is_flat.description
If true then the value is fixed, otherwise percent

# components.schemas.TaxTemplateOutput.properties.frequency.description
Tax template frequency when the value is fixed

# components.schemas.TaxTemplateCreate.properties.type.description
Tax template type
* `CITYTAX` - City tax
* `LOCALTAX` - Local tax
* `OTHERTAX` - Other tax
* `PROVINCETAX` - Province Tax
* `SALESTAX` - Sales Tax
* `STATETAX` - State tax

# components.schemas.TaxTemplateCreate.properties.is_flat.description
If true then the value is fixed, otherwise percent

# components.schemas.TaxTemplateCreate.properties.frequency.description
Tax template frequency when the value is fixed

# components.schemas.TaxTemplatePartialUpdate.properties.type.description
Tax template type
* `CITYTAX` - City tax
* `LOCALTAX` - Local tax
* `OTHERTAX` - Other tax
* `PROVINCETAX` - Province Tax
* `SALESTAX` - Sales Tax
* `STATETAX` - State tax

# components.schemas.TaxTemplatePartialUpdate.properties.is_flat.description
If true then the value is fixed, otherwise percent

# components.schemas.TaxTemplatePartialUpdate.properties.frequency.description
Tax template frequency when the value is fixed

# components.schemas.TeamMemberOutput.properties.reply_to_email.description
Team Member reply-to email
* `0` - Team Member Contact Email
* `1` - Subscriber Contact Email

# components.schemas.TeamMemberCreate.properties.reply_to_email.description
Team Member reply-to email
* `0` - Team Member Contact Email
* `1` - Subscriber Contact Email

# components.schemas.TeamMemberPartialUpdate.properties.reply_to_email.description
Team Member reply-to email
* `0` - Team Member Contact Email
* `1` - Subscriber Contact Email

# components.schemas.TeamMemberPartialUpdate.properties.reassign_reservations.description
Reassign reservations to a different housekeeper

# components.schemas.TeamMemberDelete.properties.reassign_reservations.description
Reassign reservations to a different housekeeper