--- title: "POST reservation" method: POST path: "/v3/channels/{channel_id}/reservations" tags: ["Channel Reservations"] --- # POST reservation `POST /v3/channels/{channel_id}/reservations` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/channels/{channel_id}/reservations` - Auth: one of: - API key in header `X-API-KEY` - OAuth 2 - Authorization code: `/oauth/authorize` - Token URL: `/oauth/token` - TypeScript: (a function with typed inputs; its response is checked against the schema) Create a new reservation ## Path parameters - `channel_id` string, required ## Query parameters - `fields[reservation]` string - `include` string - `confirm` boolean - `validate_minimum_advance_notice` boolean - `allow_reservations_in_the_past` boolean - `validate_length_of_stay_does_not_exceed_max_av_cache_length_of_stay` boolean ## Headers - `Accept-Language` string ## Request body - object - `data` object: A reservation of a single accommodation (InventoryObject) as part of a Booking. Each Reservation in a Booking may have mutiple order items. The total price of a Booking is the sum of all order items belonging to its reservations. - `type` string: Type - `attributes` object: Attributes - `start_date` string, date, required - `end_date` string, date, required - `late_checkout` boolean - `remote_reservation_key` string: Channel room booking ID - `guest_name` string: When having multiple reservations for an order, this can be used to store the guest name for this specific reservation. - `payment_guarantee` 'none' | 'cc/dc/voucher' | 'profile' | 'deposit' | 'pre_pay' | 'deposit_required': An optional payment guarantee - `note` string: An optional note or remark of the customer. - `promotion_token` string: Optional, can be used for passing the promotion token of the owner of the accommodation. This will check if the promotion token is correct for the given InventoryObject - `guest_group` object - `seniors` integer - `adults` integer - `adolescents` integer - `children` integer - `babies` integer - `pets` integer - `fixed_rentable` boolean: Whether or not reservation is made on a specific rentable, as opposed to a type. - `price_according_to_channel` object: Set the price according to the channel. Can only be specified on creation, a change request should be created otherwise. - `currency` string - `value` string - `price_according_to_channel_calculation` 'rent' | 'total' | 'total_excluding_hidden_costs' | 'total_including_all_costs_except_hidden_costs': How the price according to the channel should be interpreted, i.e., if it covers only the rent, or the total (the full all-in price). Can only be specified on creation, a change request should be created otherwise. - `checked_in_on` string, date-time: Timestamp that is set when the reservation is checked in. - `checked_out_on` string, date-time: Timestamp that is set when the reservation is checked out. - `is_cancelled_by_external_party` boolean: Whether the reservation has been cancelled by an external party - `cancellation_insurance` boolean: Whether this reservation has cancellation insurance - `license_plates` string[] - `cancel_date` string, date: Date on which the reservation has been cancelled - `cancel_reason` string: Reason why the reservation is cancelled - `requires_pet_free` boolean: Specifies if the reservation requires a pet free accommodation. true => no pets allowed, false => no preference - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `option_validity` integer: DEPRECATED moved to Booking - `remote_booking_nr` string: DEPRECATED moved to Booking - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': DEPRECATED moved to Booking - `memo` string: DEPRECATED moved to Booking - `currency` 'EUR' | 'USD' | 'CHF' | 'CZK' | 'TRY' | 'CVE' | 'XCG' | 'GBP' | 'NOK' | 'DKK' | 'ZAR': DEPRECATED moved to Booking - `relationships` object: Relationships - `category` object: DEPRECATED use rentable_type instead - `data` object - `id` string: category ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `rentable_type` object - `data` object - `id` string: rentable_type ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `rentable_identity` object: DEPRECATED use inventory_object instead - `data` object - `id` string: rentable_identity ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `inventory_object` object - `data` object - `id` string: inventory_object ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `booking` object: Returns the booking of the reservation. This relationship can be managed via sideposting. - `data` object - `id` string: booking ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `links` object - `related` string - `order` object: DEPRECATED use booking instead - `data` object - `id` string: order ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `links` object - `related` string - `discount_card` object - `data` object - `id` string: discount_card ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `primary_package` object - `data` object - `id` string: primary_package ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `extra_packages` object - `data` object[] - `id` string: extra_packages ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `extra_order_items` object: Returns a list of all extras that were ordered. This relationship can also be used to manage the ordered extras via sideposting. - `data` object[] - `id` string: extra_order_items ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `cancellation_rules` object: Returns a list of all cancellation rules. This relationship can also be used to manage the ordered extras via sideposting. - `data` object[] - `id` string: cancellation_rules ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `reservation_amenities` object - `data` object[] - `id` string: reservation_amenities ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `available_optional_amenities` object: Returns a list of the optional amenities of the rentables that are available for this reservation. - `data` object[] - `id` string: available_optional_amenities ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `labels` object - `data` object[] - `id` string: labels ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` union[] - union - Category - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `short_description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `additional_house_rules` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `invoice_details` object: Additional information that appears on every booking invoice and when making a booking in the front office. - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `usps` object: Translated unique selling points - `cs` string[] - `da-DK` string[] - `de` string[] - `de-AT` string[] - `de-CH` string[] - `en-US` string[] - `en-GB` string[] - `es` string[] - `fr` string[] - `fr-BE` string[] - `fr-LU` string[] - `it` string[] - `nb` string[] - `nl` string[] - `nl-BE` string[] - `pl` string[] - `pt` string[] - `tr` string[] - `en` string[] - `da` string[] - `highlighted` boolean: DEPRECATED: Use highlight_priority instead - `highlight_priority` integer: The score between 0 and 5 determining how prominently this type should be highlighted on the website. 0 means no highlighting and 5 means top priority. Used when using the highlighted sorter in the availabilities endpoint - `reference` string - `original_identifier` string: Identification code from the previous system, if any - `registration_number` string: Registration number for this type. It can be required by legislation to show this number when this type is advertised - `additional_registration_number` string: Additional registration number for this type. Some countries (e.g., Italy) require multiple registration numbers - `minimum_number_of_nights` integer - `maximum_number_of_nights` integer - `number_of_bedrooms` integer - `number_of_beds` integer - `number_of_showers` integer - `number_of_toilets` integer - `number_of_bathrooms` integer - `number_of_parking_spots` integer - `number_of_child_beds` integer - `number_of_child_chairs` integer - `surface_area` integer: The surface area for this type in square meters - `summer_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `winter_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `whole_year_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `master_price_list_price_factor` number, double: The prices in the price list are multiplied by this value. For example, if the factor is 1.1, 10% is added to the prices. Values below 1.0 are also possible. - `master_price_list_fixed_rate` number, double: This rate is added to (or subtracted from if negative) the prices of the price list. The value is per night, so a midweek price for monday to friday, gets this value added times four. - `same_day_bookings_allowed` boolean - `same_day_booking_closing_time` string, time - `address` string - `postal_code` string - `latitude` number, double - `longitude` number, double - `checkin_times_for_week` string[]: The check-in times for each day of the week, starting with sunday. DEPRECATED: Use checkin_timetable instead. - `checkout_times_for_week` string[]: The check-out times for each day of the week, starting with sunday. DEPRECATED: Use checkout_timetable instead. - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Yields the lowest energy label of all objects (if any have been set) - `energy_labels` string[]: Yields the unique energy labels of all objects (if any have been set) - `virtual` boolean: A rentable type is virtual when it groups accommodations in order for them to be rented as if it was one accommodation. This is the case for grouped rentable types. - `archived` boolean - `max_number_of_people` integer - `max_number_of_seniors` integer - `max_number_of_adults` integer - `max_number_of_adolescents` integer - `max_number_of_children` integer - `max_number_of_babies` integer - `max_number_of_pets` integer - `highlighted_amenity_ids` integer[]: IDs of the amenities that should be highlighted for this rentable type - `prices_updated_at` string, date-time: Timestamp when the prices of this type were last updated - `prices_indexed_at` string, date-time: Timestamp when the prices of this type were last indexed for availability search - `stock_updated_at` string, date-time: Timestamp when the stock of this type was last updated - `stock_indexed_at` string, date-time: Timestamp when the stock of this type was last indexed for availability search - `costs_updated_at` string, date-time: Timestamp when the costs of this type were last updated - `extras_updated_at` string, date-time: Timestamp when the extras of this type were last updated - `bookable_discounts_changed_at` string, date-time: Timestamp when the bookable discounts of this type were last updated - `agreements_changed_at` string, date-time: Timestamp when the agreements of this type were last updated - `max_baby_age` integer - `max_child_age` integer - `max_adolescent_age` integer - `min_senior_age` integer - `pets_allowed` 'all' | 'some' | 'none': Whether pets are allowed on all, some or none of the accommodations of this type - `last_date_with_price` string, date - `city` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `region` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'XK' | 'AN' | 'ZZ' | 'WW' - `location_is_exact` boolean - `has_current_or_future_owner_that_should_check_reservations` boolean - `created_at` string, date-time - `updated_at` string, date-time - `rentable_type` string: DEPRECATED use RentableSegment#semantic_segment instead - `links` object: Links - `parkcms_url` string: Link to parkcms_url - `relationships` object: Relationships - `city` object - `data` object - … - `terms` object - `data` object - … - `rentable_segment` object - `data` object - … - `master_price_list` object - `data` object - … - `guest_group_limits` object - `data` object[] - … - `administration` object - `data` object - … - `rent_earned_ledger_account` object - `data` object - … - `checkin_timetable` object: The timetable that defines the check-in times for this rentable type. - `data` object - … - `checkout_timetable` object: The timetable that defines the check-out times for this rentable type. - `data` object - … - `images` object - `data` object[] - … - `rooms` object - `data` object[] - … - `rentable_type_amenities` object - `data` object[] - … - `optional_amenities` object - `data` object[] - … - `attachments` object - `data` object[] - … - `accommodation_type` object: DEPRECATED use rentable_segment instead - `data` object - … - `category_amenities` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - RentableType: A RentableType represents a type and thus can have multiple underlying Rentables. The specific Rentables are not advertised to the guest. The exact Rentable is hidden from the guest so that the organization is flexible in assigning guests to different accommodations. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `short_description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `additional_house_rules` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `invoice_details` object: Additional information that appears on every booking invoice and when making a booking in the front office. - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `usps` object: Translated unique selling points - `cs` string[] - `da-DK` string[] - `de` string[] - `de-AT` string[] - `de-CH` string[] - `en-US` string[] - `en-GB` string[] - `es` string[] - `fr` string[] - `fr-BE` string[] - `fr-LU` string[] - `it` string[] - `nb` string[] - `nl` string[] - `nl-BE` string[] - `pl` string[] - `pt` string[] - `tr` string[] - `en` string[] - `da` string[] - `highlighted` boolean: DEPRECATED: Use highlight_priority instead - `highlight_priority` integer: The score between 0 and 5 determining how prominently this type should be highlighted on the website. 0 means no highlighting and 5 means top priority. Used when using the highlighted sorter in the availabilities endpoint - `reference` string - `original_identifier` string: Identification code from the previous system, if any - `registration_number` string: Registration number for this type. It can be required by legislation to show this number when this type is advertised - `additional_registration_number` string: Additional registration number for this type. Some countries (e.g., Italy) require multiple registration numbers - `minimum_number_of_nights` integer - `maximum_number_of_nights` integer - `number_of_bedrooms` integer - `number_of_beds` integer - `number_of_showers` integer - `number_of_toilets` integer - `number_of_bathrooms` integer - `number_of_parking_spots` integer - `number_of_child_beds` integer - `number_of_child_chairs` integer - `surface_area` integer: The surface area for this type in square meters - `summer_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `winter_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `whole_year_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `master_price_list_price_factor` number, double: The prices in the price list are multiplied by this value. For example, if the factor is 1.1, 10% is added to the prices. Values below 1.0 are also possible. - `master_price_list_fixed_rate` number, double: This rate is added to (or subtracted from if negative) the prices of the price list. The value is per night, so a midweek price for monday to friday, gets this value added times four. - `same_day_bookings_allowed` boolean - `same_day_booking_closing_time` string, time - `address` string - `postal_code` string - `latitude` number, double - `longitude` number, double - `checkin_times_for_week` string[]: The check-in times for each day of the week, starting with sunday. DEPRECATED: Use checkin_timetable instead. - `checkout_times_for_week` string[]: The check-out times for each day of the week, starting with sunday. DEPRECATED: Use checkout_timetable instead. - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Yields the lowest energy label of all objects (if any have been set) - `energy_labels` string[]: Yields the unique energy labels of all objects (if any have been set) - `virtual` boolean: A rentable type is virtual when it groups accommodations in order for them to be rented as if it was one accommodation. This is the case for grouped rentable types. - `archived` boolean - `max_number_of_people` integer - `max_number_of_seniors` integer - `max_number_of_adults` integer - `max_number_of_adolescents` integer - `max_number_of_children` integer - `max_number_of_babies` integer - `max_number_of_pets` integer - `highlighted_amenity_ids` integer[]: IDs of the amenities that should be highlighted for this rentable type - `prices_updated_at` string, date-time: Timestamp when the prices of this type were last updated - `prices_indexed_at` string, date-time: Timestamp when the prices of this type were last indexed for availability search - `stock_updated_at` string, date-time: Timestamp when the stock of this type was last updated - `stock_indexed_at` string, date-time: Timestamp when the stock of this type was last indexed for availability search - `costs_updated_at` string, date-time: Timestamp when the costs of this type were last updated - `extras_updated_at` string, date-time: Timestamp when the extras of this type were last updated - `bookable_discounts_changed_at` string, date-time: Timestamp when the bookable discounts of this type were last updated - `agreements_changed_at` string, date-time: Timestamp when the agreements of this type were last updated - `max_baby_age` integer - `max_child_age` integer - `max_adolescent_age` integer - `min_senior_age` integer - `pets_allowed` 'all' | 'some' | 'none': Whether pets are allowed on all, some or none of the accommodations of this type - `last_date_with_price` string, date - `city` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `region` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'XK' | 'AN' | 'ZZ' | 'WW' - `location_is_exact` boolean - `has_current_or_future_owner_that_should_check_reservations` boolean - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `parkcms_url` string: Link to parkcms_url - `relationships` object: Relationships - `city` object - `data` object - … - `terms` object - `data` object - … - `rentable_segment` object - `data` object - … - `master_price_list` object - `data` object - … - `guest_group_limits` object - `data` object[] - … - `administration` object - `data` object - … - `rent_earned_ledger_account` object - `data` object - … - `checkin_timetable` object: The timetable that defines the check-in times for this rentable type. - `data` object - … - `checkout_timetable` object: The timetable that defines the check-out times for this rentable type. - `data` object - … - `images` object - `data` object[] - … - `rooms` object - `data` object[] - … - `rentable_type_amenities` object - `data` object[] - … - `optional_amenities` object - `data` object[] - … - `attachments` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - RentableIdentity - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `original_identifier` string: The identifier of this object in a previous system - `door_name` string - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Energy label of building, may be any of the official energy labels or "exempt" if the accommodation is exempt from the energy label requirement.When blank, the current energy label of the acommmodation is unknown. - `surface_area` integer: The surface area in square meters - `lot_number` string: The lot number of the object - `blocked` boolean: Whether the inventory object is blocked or not from being booked - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `attachment_text` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `name_with_type` string - `cluster_parent` boolean: If an object is a cluster parent, it represents a cluster of other (real) objects. - `archived` boolean - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `current_or_future_external_blocked_agenda_periods` object: Relationship for sideposting external blocked agenda periods. This relationship will never be returned in a response. - `data` object[] - … - `labels` object - `data` object[] - … - `administration` object - `data` object - … - `cluster_children` object: The objects that form this cluster object - `data` object[] - … - `images` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - InventoryObject: An accommodation that can be booked as part of a Reservation - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `original_identifier` string: The identifier of this object in a previous system - `door_name` string - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Energy label of building, may be any of the official energy labels or "exempt" if the accommodation is exempt from the energy label requirement.When blank, the current energy label of the acommmodation is unknown. - `surface_area` integer: The surface area in square meters - `lot_number` string: The lot number of the object - `blocked` boolean: Whether the inventory object is blocked or not from being booked - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `attachment_text` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `name_with_type` string - `cluster_parent` boolean: If an object is a cluster parent, it represents a cluster of other (real) objects. - `archived` boolean - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `current_or_future_external_blocked_agenda_periods` object: Relationship for sideposting external blocked agenda periods. This relationship will never be returned in a response. - `data` object[] - … - `labels` object - `data` object[] - … - `administration` object - `data` object - … - `cluster_children` object: The objects that form this cluster object - `data` object[] - … - `images` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Booking: A Booking consists of one or more reservations. It should be considered a shopping cart. The Booking defines the total amount that needs to be paid. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `customer_desires_downpayment` boolean: DEPRECATED use booker_desires_downpayment instead - `booker_desires_downpayment` boolean: When true, only the initial downpayment will be invoiced on visiting the returned pay_url. - `after_payment_return_url` string - `redeemable_codes` string[] - `option_validity` integer: Returns the option validity in days when this is an option. Specify this attribute on create to make an option. - `remote_booking_nr` string: External booking number - `reference_nr` string: Reference number - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': Locale of customer. Is used for communication. - `memo` string: Returns the current content of the memo. Can be specified as input to set an initial memo. - `currency` 'EUR' | 'USD' | 'CHF' | 'CZK' | 'TRY' | 'CVE' | 'XCG' | 'GBP' | 'NOK' | 'DKK' | 'ZAR': Depends on the configured currency on the administration - `cancel_date` string, date: Date on which the reservation has been cancelled - `cancel_reason` string: Reason why the reservation is cancelled - `state` 'initial' | 'concept' | 'concept_to_be_accepted' | 'concept_option' | 'concept_to_be_accepted_option' | 'temporary' | 'temporary_to_be_accepted' | 'temporary_to_be_checked' | 'temporary_to_be_accepted_and_checked' | 'temporary_option' | 'temporary_to_be_accepted_option' | 'to_be_accepted' | 'to_be_accepted_option' | 'to_be_checked' | 'to_be_accepted_and_checked' | 'option' | 'rejected' | 'cancelling' | 'confirmed' | 'imported' | 'cancelled': Marks the state of the reservation. - `token` string: Unique token which is used to prevent tampering. Token is mostly used for all customer facing urls. - `confirmed_at` string, date-time: Moment at which the reservation has been confirmed. - `paid_by_customer` boolean: Indicates if the customer has fully paid. - `deposit_completed` boolean: Marks if the deposit fulfilled. - `booking_nr` string: Unique number to identify the booking. - `owner_reservation` boolean: Indicates if this is a reservation of the owner of the accommodation. - `original_total` object - `currency` string - `value` string - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_without_vat_without_deposit` object - `currency` string - `value` string - `guest_payment_due` object - `currency` string - `value` string - `guest_total_paid` object - `currency` string - `value` string - `deposit` object - `currency` string - `value` string - `rent_turnover` object - `currency` string - `value` string - `rent_turnover_without_vat` object - `currency` string - `value` string - `provision` object - `currency` string - `value` string - `payment_deadlines` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `payment_deadlines_with_deposit` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `included_security_deposits` object[] - … - `pending_vouchers` object[] - `code` string - `balance` object - … - `amount` object - … - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `self` string: Link to self - `url` string: Link to url - `payment_portal_url` string: URL for the booking or current guest invoice in the payment portal. Will show available payment terms when the booking has not been fully paid by the guest. - `pay_url` string: URL for collecting payments for this booking. Price can be set via query parameter `payment_request[price]`. - `relationships` object: Relationships - `customer` object: When included, returns the customer details of the booking. This relationship can be managed via sideposting. - `data` object - … - `owner` object: Returns the Owner if this is a booking for an owner. - `data` object - … - `traffic_source` object - `data` object - … - `conversation` object: Optionally create a conversation linked to this booking - `data` object - … - `credit_cards` object - `data` object[] - … - `security_deposits` object - `data` object[] - … - `administration` object - `data` object - … - `channel` object - `data` object - … - `guest_invoice` object: DEPRECATED use customer_invoice instead - `data` object - … - `customer_invoice` object - `data` object - … - `channel_invoice` object - `data` object - … - `reservations` object - `data` object[] - … - `payments` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Order - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `customer_desires_downpayment` boolean: DEPRECATED use booker_desires_downpayment instead - `booker_desires_downpayment` boolean: When true, only the initial downpayment will be invoiced on visiting the returned pay_url. - `after_payment_return_url` string - `redeemable_codes` string[] - `option_validity` integer: Returns the option validity in days when this is an option. Specify this attribute on create to make an option. - `remote_booking_nr` string: External booking number - `reference_nr` string: Reference number - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': Locale of customer. Is used for communication. - `memo` string: Returns the current content of the memo. Can be specified as input to set an initial memo. - `currency` 'EUR' | 'USD' | 'CHF' | 'CZK' | 'TRY' | 'CVE' | 'XCG' | 'GBP' | 'NOK' | 'DKK' | 'ZAR': Depends on the configured currency on the administration - `cancel_date` string, date: Date on which the reservation has been cancelled - `cancel_reason` string: Reason why the reservation is cancelled - `state` 'initial' | 'concept' | 'concept_to_be_accepted' | 'concept_option' | 'concept_to_be_accepted_option' | 'temporary' | 'temporary_to_be_accepted' | 'temporary_to_be_checked' | 'temporary_to_be_accepted_and_checked' | 'temporary_option' | 'temporary_to_be_accepted_option' | 'to_be_accepted' | 'to_be_accepted_option' | 'to_be_checked' | 'to_be_accepted_and_checked' | 'option' | 'rejected' | 'cancelling' | 'confirmed' | 'imported' | 'cancelled': Marks the state of the reservation. - `token` string: Unique token which is used to prevent tampering. Token is mostly used for all customer facing urls. - `confirmed_at` string, date-time: Moment at which the reservation has been confirmed. - `paid_by_customer` boolean: Indicates if the customer has fully paid. - `deposit_completed` boolean: Marks if the deposit fulfilled. - `booking_nr` string: Unique number to identify the booking. - `owner_reservation` boolean: Indicates if this is a reservation of the owner of the accommodation. - `original_total` object - `currency` string - `value` string - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_without_vat_without_deposit` object - `currency` string - `value` string - `guest_payment_due` object - `currency` string - `value` string - `guest_total_paid` object - `currency` string - `value` string - `deposit` object - `currency` string - `value` string - `rent_turnover` object - `currency` string - `value` string - `rent_turnover_without_vat` object - `currency` string - `value` string - `provision` object - `currency` string - `value` string - `payment_deadlines` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `payment_deadlines_with_deposit` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `included_security_deposits` object[] - … - `pending_vouchers` object[] - `code` string - `balance` object - … - `amount` object - … - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `self` string: Link to self - `url` string: Link to url - `payment_portal_url` string: URL for the booking or current guest invoice in the payment portal. Will show available payment terms when the booking has not been fully paid by the guest. - `pay_url` string: URL for collecting payments for this booking. Price can be set via query parameter `payment_request[price]`. - `relationships` object: Relationships - `customer` object: When included, returns the customer details of the booking. This relationship can be managed via sideposting. - `data` object - … - `owner` object: Returns the Owner if this is a booking for an owner. - `data` object - … - `traffic_source` object - `data` object - … - `conversation` object: Optionally create a conversation linked to this booking - `data` object - … - `credit_cards` object - `data` object[] - … - `security_deposits` object - `data` object[] - … - `administration` object - `data` object - … - `channel` object - `data` object - … - `guest_invoice` object: DEPRECATED use customer_invoice instead - `data` object - … - `customer_invoice` object - `data` object - … - `channel_invoice` object - `data` object - … - `reservations` object - `data` object[] - … - `payments` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - DiscountCard: Discount cards (for example the ASCI camping card) implicitly represent a package, usually with a custom price per night or a discount depending on the time of stay. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `logo` object - `original` string - `thumb` string - `square_128` string - `square_256` string - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - PrimaryPackage: In contrast to ExtraPackages, primary packages can be applied only once to a Reservation. They usually provide a fixed price for a stay that is combined with several special costs and/or extras. For example: a Sauna package which includes "Towels", "Sauna tickets" and "Bathrobes" can be bought together as one package that is normally cheaper than buying all the same extras individually. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `short_description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `confirm_by_guest` boolean - `searchable` boolean - `fixed_period` boolean - `start_date` string, date - `end_date` string, date - `fixed_number_of_nights` string - `position` integer - `archived` boolean: Whether this primary package has been archived or not. - `applies_to_all_categories` boolean: Whether this primary package applies to all RentableTypes of the Administration. DEPRECATED: use applies_to_all_rentable_types instead. - `applies_to_all_rentable_types` boolean: Whether this primary package applies to all RentableTypes of the Administration. - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `administration` object - `data` object - … - `book_period` object: Applies to reservations that were booked in the given period - `data` object - … - `stay_period` object: Applies to reservations with stay overlapping with the given period - `data` object - … - `discount_action` object - `data` object - … - `images` object - `data` object[] - … - `package_entries` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - ExtraPackage: An ExtraPackage is a Package that can be user selected. They can have prices that change over time. Will yield a price when returned within the context of a Reservation. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `confirm_by_guest` boolean: When set, guests should explicitly confirm the terms mentioned in the description - `available_as_upgrade` boolean: When set, indicates that the packages is available as an upgrade after booking - `price` object: When returned as an include of the reservation#available_extras relationship, this will yield the (unit) price of the extra package - `currency` string - `value` string - `archived` boolean: Whether this extra package has been archived or not. - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `administration` object - `data` object - … - `book_period` object: Applies to reservations that were booked in the given period - `data` object - … - `stay_period` object: Applies to reservations with stay overlapping with the given period - `data` object - … - `images` object - `data` object[] - … - `package_entries` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - ExtraOrderItem: Persists that an Extra has been ordered with a given quantity. The price of an ExtraOrderItem is the total price based on the unit price and quantity. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: A localized name for the extra. - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `is_rent` boolean: Whether this item is counted as rent for settlement - `is_deferred` boolean: Whether this item is deferred, meaning it should be paid on arrival - `vat_rate` number, double - `sku` string: Internal code (SKU) - `price` object - `currency` string - `value` string - `price_without_vat` object - `currency` string - `value` string - `position` integer - `created_at` string, date-time - `updated_at` string, date-time - `unit_price` object: The unit price of the extra. Can optionally be passed as input to specify a custom unit price. This requires that the associated extra does not perform price calculation based on a percentage. - `currency` string - `value` string - `description` object: A localized description for the extra. Can optionally be passed as input to specify a custom description. - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `quantity` number, double: The ordered quantity of this extra. Used to calculate the total price based on the unit price. - `quantity_type` 'per_person' | 'per_person_per_day' | 'per_pet' | 'per_pet_per_day' | 'fixed' | 'per_day' | 'per_piece' | 'per_piece_per_day' | 'percentage_over_default_costs' | 'percentage_over_total' | 'percentage_over_base_rent' | 'percentage_over_default_rent' | 'percentage_over_default_rent_per_person' | 'percentage_over_rent' - `guest_answer` string: Answer to the question for the guest as configured in the associated extra (if any) - `relationships` object: Relationships - `extra` object: Extra to which this item belongs (if any) - `data` object - … - `extra_package` object: ExtraPackage to which this item belongs (if any) - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - CancellationRule: Defines the percentage of the total price & administrative costs to be paid for Reservation cancellation. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `percentage` number, double: Percentage of total to be paid on cancellation - `days_before_arrival` integer: Number of days before arrival when this rule applies - `administration_costs` object - `currency` string - `value` string - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - ReservationAmenity: A ReservationAmenity is a relationship between a Reservation and an Amenity. - `id` string: ID - `type` string: Type - `relationships` object: Relationships - `reservation` object - `data` object - … - `amenity` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Amenity: Amenities are for external and internal use. They can be used to signify amenities of a RentableType or Rentable that are important to the guest. For example: * With sauna * Free wi-fi An Amenity can optionally be numerical or multiple choice. When an Amenity is numerical, the values of linked amenities (RentableTypeAmenity, RentableAmenity, ReservationAmenity and RoomAmenity) denote the numerical value belonging to the amenity. When an Amenity is multiple choice, the values of linked amenities denote the ID of the AmenityOption that applies. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: Name of the amenity - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object: Description to display along with the highlightable amenity - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `icon_url` string: URL of icon to display along with highlightable amenity - `type` 'Amenity' | 'Amenities::NumericalAmenity' | 'Amenities::MultipleChoiceAmenity': Type of the amenity - `position` integer - `semantic_amenity_type` 'accessible_toilet' | 'accessible_washbasin' | 'afternoon_sun' | 'air_hockey' | 'airco' | 'amazon_prime' | 'animation' | 'baby_bath' | 'baby_monitor' | 'balcony' | 'bathtub' | 'bbq' | 'beach_front' | 'beach_view' | 'bed_linen_provided' | 'bedroom_tv' | 'bicycle' | 'bicycle_rental' | 'bicycle_storage' | 'bidet' | 'billiard_table' | 'bluray_player' | 'boat' | 'bocce_ball' | 'bowling_alley' | 'box_bed' | 'boxspring' | 'breakfast_service' | 'bunk_bed' | 'cabinet_locks' | 'cable_tv' | 'cai_hookup' | 'canoe' | 'car_free' | 'carbon_monoxide_detector' | 'cd_player' | 'ceiling_fan' | 'central_heating' | 'central_location' | 'ceramic_cooktop' | 'child_friendly' | 'childproof_electrical_outlets' | 'close_to_beach' | 'coffee_brewing_system' | 'coffee_capsule_system' | 'coffee_pad_system' | 'combi_microwave' | 'combi_oven' | 'communal_pool' | 'computer_monitor' | 'conservatory' | 'cookware' | 'corner_site' | 'cot' | 'cradle' | 'crib' | 'cutlery' | 'dartboard' | 'deck' | 'decorative_fireplace' | 'desk' | 'desk_chair' | 'dining_table' | 'disco' | 'dishes' | 'dishwasher' | 'disinfected' | 'disney_plus' | 'double_bed' | 'double_washbasin' | 'downtown' | 'drinking_glasses' | 'dryer' | 'drying_rack' | 'dvd_player' | 'ebike_charging_point' | 'electric_cooktop' | 'electricity_hookup' | 'elevator' | 'enhanced_cleaning' | 'ev_charging_point' | 'evening_sun' | 'extractor_hood' | 'fenced_pool' | 'fenced_yard' | 'final_cleaning' | 'fire_extinguisher' | 'fire_pit' | 'fireplace' | 'first_aid_kit' | 'fitness_room' | 'flatscreen_tv' | 'floor' | 'football_pitch' | 'forest' | 'forest_front' | 'forest_view' | 'free_standing' | 'free_wifi' | 'freezer' | 'gaming_console' | 'garden' | 'garden_furniture' | 'gas_cooktop' | 'gas_heater' | 'golf_course_front' | 'golf_course_view' | 'golfcourt' | 'grill' | 'guest_gap_period_24_hours' | 'guest_gap_period_48_hours' | 'guest_gap_period_72_hours' | 'hair_dryer' | 'hammock' | 'hangers' | 'hbo' | 'heated_pool' | 'heater' | 'high_chair' | 'high_touch_surfaces_disinfected' | 'horseriding' | 'hot_tub' | 'indoor_playground' | 'indoor_pool' | 'induction_cooktop' | 'insect_screens' | 'internet' | 'iron' | 'ironing_board' | 'jacuzzi' | 'kettle' | 'kingsize_bed' | 'kitchen' | 'kitchen_island' | 'kitchen_utensils' | 'kitchenette' | 'lake_front' | 'lake_view' | 'linens_high_temp_wash' | 'lounge_set' | 'loungers' | 'marina' | 'microwave' | 'minibar' | 'minigolf' | 'morning_sun' | 'motion_detector' | 'mountain_view' | 'mountains' | 'netflix' | 'ocean_front' | 'ocean_view' | 'office' | 'other' | 'outdoor_kitchen' | 'outdoor_playground' | 'outdoor_pool' | 'outdoor_shower' | 'oven' | 'paid_wifi' | 'parasol' | 'parking_area' | 'party_games' | 'patio' | 'paved_surface' | 'pedal_gokarts' | 'pellet_stove' | 'pet_friendly' | 'petting_zoo' | 'playground_front' | 'playground_view' | 'playpen' | 'pool_front' | 'pool_table' | 'printer' | 'private_garage' | 'private_golf' | 'private_parking' | 'private_pool' | 'private_sanitary' | 'private_tennis' | 'quay' | 'queensize_bed' | 'quiet_location' | 'radio' | 'refrigerator' | 'resort' | 'restaurant' | 'river' | 'rowboat' | 'rural' | 'safe' | 'sanitary_front' | 'satellite_tv' | 'sauna' | 'self_service_check_in' | 'semi_double_bed' | 'sewer_hookup' | 'shadow' | 'shower' | 'shower_chair' | 'single_bed' | 'single_floor' | 'smart_tv' | 'smoke_detector' | 'smoke_free' | 'smoking_allowed' | 'sofa_bed' | 'sound_system' | 'stair_gate' | 'storage_room' | 'streaming_service' | 'sunshower' | 'swing' | 'table_football_table' | 'table_tennis_table' | 'tanning_bed' | 'telephone' | 'tenniscourt' | 'toaster' | 'toilet' | 'towels' | 'toys' | 'trampoline' | 'twin_beds' | 'underfloor_heating' | 'vacuum_cleaner' | 'veranda' | 'videoland' | 'village' | 'volleyball_court' | 'wardrobe' | 'washbasin' | 'washer' | 'water_front' | 'water_hookup' | 'water_view' | 'wellness' | 'wheelchair_accessible' | 'wifi' | 'wood_stove' - `filterable` boolean: Administration has configured the amenity to appear as a filter - `highlightable` boolean: Administration has configured the amenity to appear as a highlight - `relationships` object: Relationships - `amenity_group` object: Group that the amenity belongs to - `data` object - … - `amenity_options` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Label: A label provides a way to categorize InventoryObjects, Owners and Reservations. These categorizations are created by backoffice users. **Important: A label is for internal use only and should never be exposed outside the Organization itself. This can for example be used to flag Customers that have been known for making a mess.** - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `background` string: The background color of the label. The foreground color is automatically determined when the label is saved. - `foreground` string: The foreground color of the label. This color is automatically determined based on the background color when updating or creating the label. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. ## Response `200` ReservationResponse - object - `data` Reservation: A reservation of a single accommodation (InventoryObject) as part of a Booking. Each Reservation in a Booking may have mutiple order items. The total price of a Booking is the sum of all order items belonging to its reservations. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `start_date` string, date, required - `end_date` string, date, required - `late_checkout` boolean - `remote_reservation_key` string: Channel room booking ID - `guest_name` string: When having multiple reservations for an order, this can be used to store the guest name for this specific reservation. - `payment_guarantee` 'none' | 'cc/dc/voucher' | 'profile' | 'deposit' | 'pre_pay' | 'deposit_required': An optional payment guarantee - `note` string: An optional note or remark of the customer. - `promotion_token` string: Optional, can be used for passing the promotion token of the owner of the accommodation. This will check if the promotion token is correct for the given InventoryObject - `guest_group` object - `seniors` integer - `adults` integer - `adolescents` integer - `children` integer - `babies` integer - `pets` integer - `fixed_rentable` boolean: Whether or not reservation is made on a specific rentable, as opposed to a type. - `price_according_to_channel` object: Set the price according to the channel. Can only be specified on creation, a change request should be created otherwise. - `currency` string - `value` string - `price_according_to_channel_calculation` 'rent' | 'total' | 'total_excluding_hidden_costs' | 'total_including_all_costs_except_hidden_costs': How the price according to the channel should be interpreted, i.e., if it covers only the rent, or the total (the full all-in price). Can only be specified on creation, a change request should be created otherwise. - `checked_in_on` string, date-time: Timestamp that is set when the reservation is checked in. - `checked_out_on` string, date-time: Timestamp that is set when the reservation is checked out. - `is_cancelled_by_external_party` boolean: Whether the reservation has been cancelled by an external party - `cancellation_insurance` boolean: Whether this reservation has cancellation insurance - `license_plates` string[] - `cancel_date` string, date: Date on which the reservation has been cancelled - `cancel_reason` string: Reason why the reservation is cancelled - `requires_pet_free` boolean: Specifies if the reservation requires a pet free accommodation. true => no pets allowed, false => no preference - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `option_validity` integer: DEPRECATED moved to Booking - `remote_booking_nr` string: DEPRECATED moved to Booking - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': DEPRECATED moved to Booking - `memo` string: DEPRECATED moved to Booking - `currency` 'EUR' | 'USD' | 'CHF' | 'CZK' | 'TRY' | 'CVE' | 'XCG' | 'GBP' | 'NOK' | 'DKK' | 'ZAR': DEPRECATED moved to Booking - `letter_in_booking` string: Yields the letter of the Reservation in the (multi) Booking - `created_at_date` string, date: Local date of creation of this reservation - `checkin_time` string: Guests should checkin from this time. - `checkout_time` string: Guests should checkout before this time. - `access_code` string: A generated numeric access code that is unique for all current and future reservations of the Administration. It is at least 4 characters long. - `stay_reason` 'tourism' | 'business': Reason of stay for the reservation - `blocking_todos_finished` boolean: Indicates if all blocking todos have been finished - `available_parking_spots` integer - `packaged_date_range` string[] - `late_checkout_possible` boolean: Whether or not it's possible for the customer to check out later than the normal checkout time. This depends on the next arrival. - `late_checkout_details` object - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `price` object - `currency` string - `value` string - `original_total` object - `currency` string - `value` string - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_without_vat_without_deposit` object - `currency` string - `value` string - `deposit` object - `currency` string - `value` string - `rent_turnover` object - `currency` string - `value` string - `rent_turnover_without_vat` object - `currency` string - `value` string - `base_rent_including_discount` object: Base rent including the discount. This cannot be calculated for reservations with state `imported`, as they have no order. - `currency` string - `value` string - `provision` object - `currency` string - `value` string - `questions_completed` boolean: Marks if the customer answered the questions after reservation. These questsions can be configured. - `guest_list_completed` boolean: Marks if the guest list has been filled in. - `license_plates_completed` boolean: Marks if the guest provided license plates. Mostly used for access control. - `labels` string[]: User configurable labels. These labels are for internal use and thus never visible to the customer. - `created_at` string, date-time - `updated_at` string, date-time - `state` 'initial' | 'concept' | 'concept_to_be_accepted' | 'concept_option' | 'concept_to_be_accepted_option' | 'temporary' | 'temporary_to_be_accepted' | 'temporary_to_be_checked' | 'temporary_to_be_accepted_and_checked' | 'temporary_option' | 'temporary_to_be_accepted_option' | 'to_be_accepted' | 'to_be_accepted_option' | 'to_be_checked' | 'to_be_accepted_and_checked' | 'option' | 'rejected' | 'cancelling' | 'confirmed' | 'imported' | 'cancelled' - `deposit_completed` boolean - `booking_nr` string - `token` string - `confirmed_at` string, date-time - `owner_reservation` boolean - `paid_by_customer` boolean - `option_expires_at` string, date-time - `links` object: Links - `self` string: Link to self - `url` string: Link to url - `relationships` object: Relationships - `category` object: DEPRECATED use rentable_type instead - `data` object - `id` string: category ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `rentable_type` object - `data` object - `id` string: rentable_type ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `rentable_identity` object: DEPRECATED use inventory_object instead - `data` object - `id` string: rentable_identity ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `inventory_object` object - `data` object - `id` string: inventory_object ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `booking` object: Returns the booking of the reservation. This relationship can be managed via sideposting. - `data` object - `id` string: booking ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `links` object - `related` string - `order` object: DEPRECATED use booking instead - `data` object - `id` string: order ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `links` object - `related` string - `discount_card` object - `data` object - `id` string: discount_card ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `primary_package` object - `data` object - `id` string: primary_package ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `extra_packages` object - `data` object[] - `id` string: extra_packages ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `extra_order_items` object: Returns a list of all extras that were ordered. This relationship can also be used to manage the ordered extras via sideposting. - `data` object[] - `id` string: extra_order_items ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `cancellation_rules` object: Returns a list of all cancellation rules. This relationship can also be used to manage the ordered extras via sideposting. - `data` object[] - `id` string: cancellation_rules ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `reservation_amenities` object - `data` object[] - `id` string: reservation_amenities ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `available_optional_amenities` object: Returns a list of the optional amenities of the rentables that are available for this reservation. - `data` object[] - `id` string: available_optional_amenities ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `labels` object - `data` object[] - `id` string: labels ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `administration` object - `data` object - `id` string: administration ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `links` object - `related` string - `discount_action` object - `data` object - `id` string: discount_action ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `order_items` object: Returns a list of all order items. Costs and extras may possibly be grouped. This relationship should be used to render order details for the customer. - `data` object[] - `id` string: order_items ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `main_order_items` object: Returns a list of all main order items. No grouping is applied. Should not be used to render order details for the customer. - `data` object[] - `id` string: main_order_items ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `available_discount_cards` object - `data` object[] - `id` string: available_discount_cards ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `available_primary_packages` object - `data` object[] - `id` string: available_primary_packages ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `available_extra_packages` object - `data` object[] - `id` string: available_extra_packages ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `available_extras` object - `data` object[] - `id` string: available_extras ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `question_answers` object - `data` object[] - `id` string: question_answers ID - `type` string - `meta` object - `temp_id` string: UUID for internal resource linking of included relationships. Should be omitted when the relationship ID is known. - `method` string: Required when this relationship must be created or updated and is included in the request. Must be omitted when only an association needs to be made with the resource. One of: create, update. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` union[] - union - Category - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `short_description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `additional_house_rules` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `invoice_details` object: Additional information that appears on every booking invoice and when making a booking in the front office. - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `usps` object: Translated unique selling points - `cs` string[] - `da-DK` string[] - `de` string[] - `de-AT` string[] - `de-CH` string[] - `en-US` string[] - `en-GB` string[] - `es` string[] - `fr` string[] - `fr-BE` string[] - `fr-LU` string[] - `it` string[] - `nb` string[] - `nl` string[] - `nl-BE` string[] - `pl` string[] - `pt` string[] - `tr` string[] - `en` string[] - `da` string[] - `highlighted` boolean: DEPRECATED: Use highlight_priority instead - `highlight_priority` integer: The score between 0 and 5 determining how prominently this type should be highlighted on the website. 0 means no highlighting and 5 means top priority. Used when using the highlighted sorter in the availabilities endpoint - `reference` string - `original_identifier` string: Identification code from the previous system, if any - `registration_number` string: Registration number for this type. It can be required by legislation to show this number when this type is advertised - `additional_registration_number` string: Additional registration number for this type. Some countries (e.g., Italy) require multiple registration numbers - `minimum_number_of_nights` integer - `maximum_number_of_nights` integer - `number_of_bedrooms` integer - `number_of_beds` integer - `number_of_showers` integer - `number_of_toilets` integer - `number_of_bathrooms` integer - `number_of_parking_spots` integer - `number_of_child_beds` integer - `number_of_child_chairs` integer - `surface_area` integer: The surface area for this type in square meters - `summer_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `winter_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `whole_year_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `master_price_list_price_factor` number, double: The prices in the price list are multiplied by this value. For example, if the factor is 1.1, 10% is added to the prices. Values below 1.0 are also possible. - `master_price_list_fixed_rate` number, double: This rate is added to (or subtracted from if negative) the prices of the price list. The value is per night, so a midweek price for monday to friday, gets this value added times four. - `same_day_bookings_allowed` boolean - `same_day_booking_closing_time` string, time - `address` string - `postal_code` string - `latitude` number, double - `longitude` number, double - `checkin_times_for_week` string[]: The check-in times for each day of the week, starting with sunday. DEPRECATED: Use checkin_timetable instead. - `checkout_times_for_week` string[]: The check-out times for each day of the week, starting with sunday. DEPRECATED: Use checkout_timetable instead. - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Yields the lowest energy label of all objects (if any have been set) - `energy_labels` string[]: Yields the unique energy labels of all objects (if any have been set) - `virtual` boolean: A rentable type is virtual when it groups accommodations in order for them to be rented as if it was one accommodation. This is the case for grouped rentable types. - `archived` boolean - `max_number_of_people` integer - `max_number_of_seniors` integer - `max_number_of_adults` integer - `max_number_of_adolescents` integer - `max_number_of_children` integer - `max_number_of_babies` integer - `max_number_of_pets` integer - `highlighted_amenity_ids` integer[]: IDs of the amenities that should be highlighted for this rentable type - `prices_updated_at` string, date-time: Timestamp when the prices of this type were last updated - `prices_indexed_at` string, date-time: Timestamp when the prices of this type were last indexed for availability search - `stock_updated_at` string, date-time: Timestamp when the stock of this type was last updated - `stock_indexed_at` string, date-time: Timestamp when the stock of this type was last indexed for availability search - `costs_updated_at` string, date-time: Timestamp when the costs of this type were last updated - `extras_updated_at` string, date-time: Timestamp when the extras of this type were last updated - `bookable_discounts_changed_at` string, date-time: Timestamp when the bookable discounts of this type were last updated - `agreements_changed_at` string, date-time: Timestamp when the agreements of this type were last updated - `max_baby_age` integer - `max_child_age` integer - `max_adolescent_age` integer - `min_senior_age` integer - `pets_allowed` 'all' | 'some' | 'none': Whether pets are allowed on all, some or none of the accommodations of this type - `last_date_with_price` string, date - `city` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `region` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'XK' | 'AN' | 'ZZ' | 'WW' - `location_is_exact` boolean - `has_current_or_future_owner_that_should_check_reservations` boolean - `created_at` string, date-time - `updated_at` string, date-time - `rentable_type` string: DEPRECATED use RentableSegment#semantic_segment instead - `links` object: Links - `parkcms_url` string: Link to parkcms_url - `relationships` object: Relationships - `city` object - `data` object - … - `terms` object - `data` object - … - `rentable_segment` object - `data` object - … - `master_price_list` object - `data` object - … - `guest_group_limits` object - `data` object[] - … - `administration` object - `data` object - … - `rent_earned_ledger_account` object - `data` object - … - `checkin_timetable` object: The timetable that defines the check-in times for this rentable type. - `data` object - … - `checkout_timetable` object: The timetable that defines the check-out times for this rentable type. - `data` object - … - `images` object - `data` object[] - … - `rooms` object - `data` object[] - … - `rentable_type_amenities` object - `data` object[] - … - `optional_amenities` object - `data` object[] - … - `attachments` object - `data` object[] - … - `accommodation_type` object: DEPRECATED use rentable_segment instead - `data` object - … - `category_amenities` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - RentableType: A RentableType represents a type and thus can have multiple underlying Rentables. The specific Rentables are not advertised to the guest. The exact Rentable is hidden from the guest so that the organization is flexible in assigning guests to different accommodations. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `short_description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `additional_house_rules` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `invoice_details` object: Additional information that appears on every booking invoice and when making a booking in the front office. - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `usps` object: Translated unique selling points - `cs` string[] - `da-DK` string[] - `de` string[] - `de-AT` string[] - `de-CH` string[] - `en-US` string[] - `en-GB` string[] - `es` string[] - `fr` string[] - `fr-BE` string[] - `fr-LU` string[] - `it` string[] - `nb` string[] - `nl` string[] - `nl-BE` string[] - `pl` string[] - `pt` string[] - `tr` string[] - `en` string[] - `da` string[] - `highlighted` boolean: DEPRECATED: Use highlight_priority instead - `highlight_priority` integer: The score between 0 and 5 determining how prominently this type should be highlighted on the website. 0 means no highlighting and 5 means top priority. Used when using the highlighted sorter in the availabilities endpoint - `reference` string - `original_identifier` string: Identification code from the previous system, if any - `registration_number` string: Registration number for this type. It can be required by legislation to show this number when this type is advertised - `additional_registration_number` string: Additional registration number for this type. Some countries (e.g., Italy) require multiple registration numbers - `minimum_number_of_nights` integer - `maximum_number_of_nights` integer - `number_of_bedrooms` integer - `number_of_beds` integer - `number_of_showers` integer - `number_of_toilets` integer - `number_of_bathrooms` integer - `number_of_parking_spots` integer - `number_of_child_beds` integer - `number_of_child_chairs` integer - `surface_area` integer: The surface area for this type in square meters - `summer_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `winter_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `whole_year_video_id` string: YouTube video ID per season. You can create an iframe with source "https://www.youtube.com/embed/:id" on your website to embed this. - `master_price_list_price_factor` number, double: The prices in the price list are multiplied by this value. For example, if the factor is 1.1, 10% is added to the prices. Values below 1.0 are also possible. - `master_price_list_fixed_rate` number, double: This rate is added to (or subtracted from if negative) the prices of the price list. The value is per night, so a midweek price for monday to friday, gets this value added times four. - `same_day_bookings_allowed` boolean - `same_day_booking_closing_time` string, time - `address` string - `postal_code` string - `latitude` number, double - `longitude` number, double - `checkin_times_for_week` string[]: The check-in times for each day of the week, starting with sunday. DEPRECATED: Use checkin_timetable instead. - `checkout_times_for_week` string[]: The check-out times for each day of the week, starting with sunday. DEPRECATED: Use checkout_timetable instead. - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Yields the lowest energy label of all objects (if any have been set) - `energy_labels` string[]: Yields the unique energy labels of all objects (if any have been set) - `virtual` boolean: A rentable type is virtual when it groups accommodations in order for them to be rented as if it was one accommodation. This is the case for grouped rentable types. - `archived` boolean - `max_number_of_people` integer - `max_number_of_seniors` integer - `max_number_of_adults` integer - `max_number_of_adolescents` integer - `max_number_of_children` integer - `max_number_of_babies` integer - `max_number_of_pets` integer - `highlighted_amenity_ids` integer[]: IDs of the amenities that should be highlighted for this rentable type - `prices_updated_at` string, date-time: Timestamp when the prices of this type were last updated - `prices_indexed_at` string, date-time: Timestamp when the prices of this type were last indexed for availability search - `stock_updated_at` string, date-time: Timestamp when the stock of this type was last updated - `stock_indexed_at` string, date-time: Timestamp when the stock of this type was last indexed for availability search - `costs_updated_at` string, date-time: Timestamp when the costs of this type were last updated - `extras_updated_at` string, date-time: Timestamp when the extras of this type were last updated - `bookable_discounts_changed_at` string, date-time: Timestamp when the bookable discounts of this type were last updated - `agreements_changed_at` string, date-time: Timestamp when the agreements of this type were last updated - `max_baby_age` integer - `max_child_age` integer - `max_adolescent_age` integer - `min_senior_age` integer - `pets_allowed` 'all' | 'some' | 'none': Whether pets are allowed on all, some or none of the accommodations of this type - `last_date_with_price` string, date - `city` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `region` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `country_code` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AX' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BL' | 'BM' | 'BN' | 'BO' | 'BQ' | 'BR' | 'BS' | 'BT' | 'BV' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CU' | 'CV' | 'CW' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GG' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GU' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IM' | 'IN' | 'IO' | 'IQ' | 'IR' | 'IS' | 'IT' | 'JE' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KP' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MF' | 'MG' | 'MH' | 'MK' | 'ML' | 'MM' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PR' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SD' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'SS' | 'ST' | 'SV' | 'SX' | 'SY' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VI' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW' | 'XK' | 'AN' | 'ZZ' | 'WW' - `location_is_exact` boolean - `has_current_or_future_owner_that_should_check_reservations` boolean - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `parkcms_url` string: Link to parkcms_url - `relationships` object: Relationships - `city` object - `data` object - … - `terms` object - `data` object - … - `rentable_segment` object - `data` object - … - `master_price_list` object - `data` object - … - `guest_group_limits` object - `data` object[] - … - `administration` object - `data` object - … - `rent_earned_ledger_account` object - `data` object - … - `checkin_timetable` object: The timetable that defines the check-in times for this rentable type. - `data` object - … - `checkout_timetable` object: The timetable that defines the check-out times for this rentable type. - `data` object - … - `images` object - `data` object[] - … - `rooms` object - `data` object[] - … - `rentable_type_amenities` object - `data` object[] - … - `optional_amenities` object - `data` object[] - … - `attachments` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - RentableIdentity - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `original_identifier` string: The identifier of this object in a previous system - `door_name` string - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Energy label of building, may be any of the official energy labels or "exempt" if the accommodation is exempt from the energy label requirement.When blank, the current energy label of the acommmodation is unknown. - `surface_area` integer: The surface area in square meters - `lot_number` string: The lot number of the object - `blocked` boolean: Whether the inventory object is blocked or not from being booked - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `attachment_text` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `name_with_type` string - `cluster_parent` boolean: If an object is a cluster parent, it represents a cluster of other (real) objects. - `archived` boolean - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `current_or_future_external_blocked_agenda_periods` object: Relationship for sideposting external blocked agenda periods. This relationship will never be returned in a response. - `data` object[] - … - `labels` object - `data` object[] - … - `administration` object - `data` object - … - `cluster_children` object: The objects that form this cluster object - `data` object[] - … - `images` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - InventoryObject: An accommodation that can be booked as part of a Reservation - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `original_identifier` string: The identifier of this object in a previous system - `door_name` string - `energy_label` 'exempt' | 'A++++' | 'A+++' | 'A++' | 'A+' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H': Energy label of building, may be any of the official energy labels or "exempt" if the accommodation is exempt from the energy label requirement.When blank, the current energy label of the acommmodation is unknown. - `surface_area` integer: The surface area in square meters - `lot_number` string: The lot number of the object - `blocked` boolean: Whether the inventory object is blocked or not from being booked - `custom_fields` object[]: Custom attributes assigned to this resource - `key` string - `text_value` string - `integer_value` integer - `attachment_text` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `name_with_type` string - `cluster_parent` boolean: If an object is a cluster parent, it represents a cluster of other (real) objects. - `archived` boolean - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `current_or_future_external_blocked_agenda_periods` object: Relationship for sideposting external blocked agenda periods. This relationship will never be returned in a response. - `data` object[] - … - `labels` object - `data` object[] - … - `administration` object - `data` object - … - `cluster_children` object: The objects that form this cluster object - `data` object[] - … - `images` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Booking: A Booking consists of one or more reservations. It should be considered a shopping cart. The Booking defines the total amount that needs to be paid. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `customer_desires_downpayment` boolean: DEPRECATED use booker_desires_downpayment instead - `booker_desires_downpayment` boolean: When true, only the initial downpayment will be invoiced on visiting the returned pay_url. - `after_payment_return_url` string - `redeemable_codes` string[] - `option_validity` integer: Returns the option validity in days when this is an option. Specify this attribute on create to make an option. - `remote_booking_nr` string: External booking number - `reference_nr` string: Reference number - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': Locale of customer. Is used for communication. - `memo` string: Returns the current content of the memo. Can be specified as input to set an initial memo. - `currency` 'EUR' | 'USD' | 'CHF' | 'CZK' | 'TRY' | 'CVE' | 'XCG' | 'GBP' | 'NOK' | 'DKK' | 'ZAR': Depends on the configured currency on the administration - `cancel_date` string, date: Date on which the reservation has been cancelled - `cancel_reason` string: Reason why the reservation is cancelled - `state` 'initial' | 'concept' | 'concept_to_be_accepted' | 'concept_option' | 'concept_to_be_accepted_option' | 'temporary' | 'temporary_to_be_accepted' | 'temporary_to_be_checked' | 'temporary_to_be_accepted_and_checked' | 'temporary_option' | 'temporary_to_be_accepted_option' | 'to_be_accepted' | 'to_be_accepted_option' | 'to_be_checked' | 'to_be_accepted_and_checked' | 'option' | 'rejected' | 'cancelling' | 'confirmed' | 'imported' | 'cancelled': Marks the state of the reservation. - `token` string: Unique token which is used to prevent tampering. Token is mostly used for all customer facing urls. - `confirmed_at` string, date-time: Moment at which the reservation has been confirmed. - `paid_by_customer` boolean: Indicates if the customer has fully paid. - `deposit_completed` boolean: Marks if the deposit fulfilled. - `booking_nr` string: Unique number to identify the booking. - `owner_reservation` boolean: Indicates if this is a reservation of the owner of the accommodation. - `original_total` object - `currency` string - `value` string - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_without_vat_without_deposit` object - `currency` string - `value` string - `guest_payment_due` object - `currency` string - `value` string - `guest_total_paid` object - `currency` string - `value` string - `deposit` object - `currency` string - `value` string - `rent_turnover` object - `currency` string - `value` string - `rent_turnover_without_vat` object - `currency` string - `value` string - `provision` object - `currency` string - `value` string - `payment_deadlines` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `payment_deadlines_with_deposit` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `included_security_deposits` object[] - … - `pending_vouchers` object[] - `code` string - `balance` object - … - `amount` object - … - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `self` string: Link to self - `url` string: Link to url - `payment_portal_url` string: URL for the booking or current guest invoice in the payment portal. Will show available payment terms when the booking has not been fully paid by the guest. - `pay_url` string: URL for collecting payments for this booking. Price can be set via query parameter `payment_request[price]`. - `relationships` object: Relationships - `customer` object: When included, returns the customer details of the booking. This relationship can be managed via sideposting. - `data` object - … - `owner` object: Returns the Owner if this is a booking for an owner. - `data` object - … - `traffic_source` object - `data` object - … - `conversation` object: Optionally create a conversation linked to this booking - `data` object - … - `credit_cards` object - `data` object[] - … - `security_deposits` object - `data` object[] - … - `administration` object - `data` object - … - `channel` object - `data` object - … - `guest_invoice` object: DEPRECATED use customer_invoice instead - `data` object - … - `customer_invoice` object - `data` object - … - `channel_invoice` object - `data` object - … - `reservations` object - `data` object[] - … - `payments` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Order - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `customer_desires_downpayment` boolean: DEPRECATED use booker_desires_downpayment instead - `booker_desires_downpayment` boolean: When true, only the initial downpayment will be invoiced on visiting the returned pay_url. - `after_payment_return_url` string - `redeemable_codes` string[] - `option_validity` integer: Returns the option validity in days when this is an option. Specify this attribute on create to make an option. - `remote_booking_nr` string: External booking number - `reference_nr` string: Reference number - `locale` 'cs' | 'da-DK' | 'de' | 'de-AT' | 'de-CH' | 'en-US' | 'en-GB' | 'es' | 'fr' | 'fr-BE' | 'fr-LU' | 'it' | 'nb' | 'nl' | 'nl-BE' | 'pl' | 'pt' | 'tr' | 'en' | 'da': Locale of customer. Is used for communication. - `memo` string: Returns the current content of the memo. Can be specified as input to set an initial memo. - `currency` 'EUR' | 'USD' | 'CHF' | 'CZK' | 'TRY' | 'CVE' | 'XCG' | 'GBP' | 'NOK' | 'DKK' | 'ZAR': Depends on the configured currency on the administration - `cancel_date` string, date: Date on which the reservation has been cancelled - `cancel_reason` string: Reason why the reservation is cancelled - `state` 'initial' | 'concept' | 'concept_to_be_accepted' | 'concept_option' | 'concept_to_be_accepted_option' | 'temporary' | 'temporary_to_be_accepted' | 'temporary_to_be_checked' | 'temporary_to_be_accepted_and_checked' | 'temporary_option' | 'temporary_to_be_accepted_option' | 'to_be_accepted' | 'to_be_accepted_option' | 'to_be_checked' | 'to_be_accepted_and_checked' | 'option' | 'rejected' | 'cancelling' | 'confirmed' | 'imported' | 'cancelled': Marks the state of the reservation. - `token` string: Unique token which is used to prevent tampering. Token is mostly used for all customer facing urls. - `confirmed_at` string, date-time: Moment at which the reservation has been confirmed. - `paid_by_customer` boolean: Indicates if the customer has fully paid. - `deposit_completed` boolean: Marks if the deposit fulfilled. - `booking_nr` string: Unique number to identify the booking. - `owner_reservation` boolean: Indicates if this is a reservation of the owner of the accommodation. - `original_total` object - `currency` string - `value` string - `total` object - `currency` string - `value` string - `total_without_vat` object - `currency` string - `value` string - `total_without_vat_without_deposit` object - `currency` string - `value` string - `guest_payment_due` object - `currency` string - `value` string - `guest_total_paid` object - `currency` string - `value` string - `deposit` object - `currency` string - `value` string - `rent_turnover` object - `currency` string - `value` string - `rent_turnover_without_vat` object - `currency` string - `value` string - `provision` object - `currency` string - `value` string - `payment_deadlines` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `payment_deadlines_with_deposit` object[] - `date` string, date - `open_amount` object - … - `paid_amount` object - … - `included_security_deposits` object[] - … - `pending_vouchers` object[] - `code` string - `balance` object - … - `amount` object - … - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `self` string: Link to self - `url` string: Link to url - `payment_portal_url` string: URL for the booking or current guest invoice in the payment portal. Will show available payment terms when the booking has not been fully paid by the guest. - `pay_url` string: URL for collecting payments for this booking. Price can be set via query parameter `payment_request[price]`. - `relationships` object: Relationships - `customer` object: When included, returns the customer details of the booking. This relationship can be managed via sideposting. - `data` object - … - `owner` object: Returns the Owner if this is a booking for an owner. - `data` object - … - `traffic_source` object - `data` object - … - `conversation` object: Optionally create a conversation linked to this booking - `data` object - … - `credit_cards` object - `data` object[] - … - `security_deposits` object - `data` object[] - … - `administration` object - `data` object - … - `channel` object - `data` object - … - `guest_invoice` object: DEPRECATED use customer_invoice instead - `data` object - … - `customer_invoice` object - `data` object - … - `channel_invoice` object - `data` object - … - `reservations` object - `data` object[] - … - `payments` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - DiscountCard: Discount cards (for example the ASCI camping card) implicitly represent a package, usually with a custom price per night or a discount depending on the time of stay. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `logo` object - `original` string - `thumb` string - `square_128` string - `square_256` string - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - PrimaryPackage: In contrast to ExtraPackages, primary packages can be applied only once to a Reservation. They usually provide a fixed price for a stay that is combined with several special costs and/or extras. For example: a Sauna package which includes "Towels", "Sauna tickets" and "Bathrobes" can be bought together as one package that is normally cheaper than buying all the same extras individually. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `short_description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `confirm_by_guest` boolean - `searchable` boolean - `fixed_period` boolean - `start_date` string, date - `end_date` string, date - `fixed_number_of_nights` string - `position` integer - `archived` boolean: Whether this primary package has been archived or not. - `applies_to_all_categories` boolean: Whether this primary package applies to all RentableTypes of the Administration. DEPRECATED: use applies_to_all_rentable_types instead. - `applies_to_all_rentable_types` boolean: Whether this primary package applies to all RentableTypes of the Administration. - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `administration` object - `data` object - … - `book_period` object: Applies to reservations that were booked in the given period - `data` object - … - `stay_period` object: Applies to reservations with stay overlapping with the given period - `data` object - … - `discount_action` object - `data` object - … - `images` object - `data` object[] - … - `package_entries` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - ExtraPackage: An ExtraPackage is a Package that can be user selected. They can have prices that change over time. Will yield a price when returned within the context of a Reservation. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `confirm_by_guest` boolean: When set, guests should explicitly confirm the terms mentioned in the description - `available_as_upgrade` boolean: When set, indicates that the packages is available as an upgrade after booking - `price` object: When returned as an include of the reservation#available_extras relationship, this will yield the (unit) price of the extra package - `currency` string - `value` string - `archived` boolean: Whether this extra package has been archived or not. - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `administration` object - `data` object - … - `book_period` object: Applies to reservations that were booked in the given period - `data` object - … - `stay_period` object: Applies to reservations with stay overlapping with the given period - `data` object - … - `images` object - `data` object[] - … - `package_entries` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - ExtraOrderItem: Persists that an Extra has been ordered with a given quantity. The price of an ExtraOrderItem is the total price based on the unit price and quantity. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: A localized name for the extra. - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `is_rent` boolean: Whether this item is counted as rent for settlement - `is_deferred` boolean: Whether this item is deferred, meaning it should be paid on arrival - `vat_rate` number, double - `sku` string: Internal code (SKU) - `price` object - `currency` string - `value` string - `price_without_vat` object - `currency` string - `value` string - `position` integer - `created_at` string, date-time - `updated_at` string, date-time - `unit_price` object: The unit price of the extra. Can optionally be passed as input to specify a custom unit price. This requires that the associated extra does not perform price calculation based on a percentage. - `currency` string - `value` string - `description` object: A localized description for the extra. Can optionally be passed as input to specify a custom description. - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `quantity` number, double: The ordered quantity of this extra. Used to calculate the total price based on the unit price. - `quantity_type` 'per_person' | 'per_person_per_day' | 'per_pet' | 'per_pet_per_day' | 'fixed' | 'per_day' | 'per_piece' | 'per_piece_per_day' | 'percentage_over_default_costs' | 'percentage_over_total' | 'percentage_over_base_rent' | 'percentage_over_default_rent' | 'percentage_over_default_rent_per_person' | 'percentage_over_rent' - `guest_answer` string: Answer to the question for the guest as configured in the associated extra (if any) - `relationships` object: Relationships - `extra` object: Extra to which this item belongs (if any) - `data` object - … - `extra_package` object: ExtraPackage to which this item belongs (if any) - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - CancellationRule: Defines the percentage of the total price & administrative costs to be paid for Reservation cancellation. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `percentage` number, double: Percentage of total to be paid on cancellation - `days_before_arrival` integer: Number of days before arrival when this rule applies - `administration_costs` object - `currency` string - `value` string - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - ReservationAmenity: A ReservationAmenity is a relationship between a Reservation and an Amenity. - `id` string: ID - `type` string: Type - `relationships` object: Relationships - `reservation` object - `data` object - … - `amenity` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Amenity: Amenities are for external and internal use. They can be used to signify amenities of a RentableType or Rentable that are important to the guest. For example: * With sauna * Free wi-fi An Amenity can optionally be numerical or multiple choice. When an Amenity is numerical, the values of linked amenities (RentableTypeAmenity, RentableAmenity, ReservationAmenity and RoomAmenity) denote the numerical value belonging to the amenity. When an Amenity is multiple choice, the values of linked amenities denote the ID of the AmenityOption that applies. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: Name of the amenity - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object: Description to display along with the highlightable amenity - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `icon_url` string: URL of icon to display along with highlightable amenity - `type` 'Amenity' | 'Amenities::NumericalAmenity' | 'Amenities::MultipleChoiceAmenity': Type of the amenity - `position` integer - `semantic_amenity_type` 'accessible_toilet' | 'accessible_washbasin' | 'afternoon_sun' | 'air_hockey' | 'airco' | 'amazon_prime' | 'animation' | 'baby_bath' | 'baby_monitor' | 'balcony' | 'bathtub' | 'bbq' | 'beach_front' | 'beach_view' | 'bed_linen_provided' | 'bedroom_tv' | 'bicycle' | 'bicycle_rental' | 'bicycle_storage' | 'bidet' | 'billiard_table' | 'bluray_player' | 'boat' | 'bocce_ball' | 'bowling_alley' | 'box_bed' | 'boxspring' | 'breakfast_service' | 'bunk_bed' | 'cabinet_locks' | 'cable_tv' | 'cai_hookup' | 'canoe' | 'car_free' | 'carbon_monoxide_detector' | 'cd_player' | 'ceiling_fan' | 'central_heating' | 'central_location' | 'ceramic_cooktop' | 'child_friendly' | 'childproof_electrical_outlets' | 'close_to_beach' | 'coffee_brewing_system' | 'coffee_capsule_system' | 'coffee_pad_system' | 'combi_microwave' | 'combi_oven' | 'communal_pool' | 'computer_monitor' | 'conservatory' | 'cookware' | 'corner_site' | 'cot' | 'cradle' | 'crib' | 'cutlery' | 'dartboard' | 'deck' | 'decorative_fireplace' | 'desk' | 'desk_chair' | 'dining_table' | 'disco' | 'dishes' | 'dishwasher' | 'disinfected' | 'disney_plus' | 'double_bed' | 'double_washbasin' | 'downtown' | 'drinking_glasses' | 'dryer' | 'drying_rack' | 'dvd_player' | 'ebike_charging_point' | 'electric_cooktop' | 'electricity_hookup' | 'elevator' | 'enhanced_cleaning' | 'ev_charging_point' | 'evening_sun' | 'extractor_hood' | 'fenced_pool' | 'fenced_yard' | 'final_cleaning' | 'fire_extinguisher' | 'fire_pit' | 'fireplace' | 'first_aid_kit' | 'fitness_room' | 'flatscreen_tv' | 'floor' | 'football_pitch' | 'forest' | 'forest_front' | 'forest_view' | 'free_standing' | 'free_wifi' | 'freezer' | 'gaming_console' | 'garden' | 'garden_furniture' | 'gas_cooktop' | 'gas_heater' | 'golf_course_front' | 'golf_course_view' | 'golfcourt' | 'grill' | 'guest_gap_period_24_hours' | 'guest_gap_period_48_hours' | 'guest_gap_period_72_hours' | 'hair_dryer' | 'hammock' | 'hangers' | 'hbo' | 'heated_pool' | 'heater' | 'high_chair' | 'high_touch_surfaces_disinfected' | 'horseriding' | 'hot_tub' | 'indoor_playground' | 'indoor_pool' | 'induction_cooktop' | 'insect_screens' | 'internet' | 'iron' | 'ironing_board' | 'jacuzzi' | 'kettle' | 'kingsize_bed' | 'kitchen' | 'kitchen_island' | 'kitchen_utensils' | 'kitchenette' | 'lake_front' | 'lake_view' | 'linens_high_temp_wash' | 'lounge_set' | 'loungers' | 'marina' | 'microwave' | 'minibar' | 'minigolf' | 'morning_sun' | 'motion_detector' | 'mountain_view' | 'mountains' | 'netflix' | 'ocean_front' | 'ocean_view' | 'office' | 'other' | 'outdoor_kitchen' | 'outdoor_playground' | 'outdoor_pool' | 'outdoor_shower' | 'oven' | 'paid_wifi' | 'parasol' | 'parking_area' | 'party_games' | 'patio' | 'paved_surface' | 'pedal_gokarts' | 'pellet_stove' | 'pet_friendly' | 'petting_zoo' | 'playground_front' | 'playground_view' | 'playpen' | 'pool_front' | 'pool_table' | 'printer' | 'private_garage' | 'private_golf' | 'private_parking' | 'private_pool' | 'private_sanitary' | 'private_tennis' | 'quay' | 'queensize_bed' | 'quiet_location' | 'radio' | 'refrigerator' | 'resort' | 'restaurant' | 'river' | 'rowboat' | 'rural' | 'safe' | 'sanitary_front' | 'satellite_tv' | 'sauna' | 'self_service_check_in' | 'semi_double_bed' | 'sewer_hookup' | 'shadow' | 'shower' | 'shower_chair' | 'single_bed' | 'single_floor' | 'smart_tv' | 'smoke_detector' | 'smoke_free' | 'smoking_allowed' | 'sofa_bed' | 'sound_system' | 'stair_gate' | 'storage_room' | 'streaming_service' | 'sunshower' | 'swing' | 'table_football_table' | 'table_tennis_table' | 'tanning_bed' | 'telephone' | 'tenniscourt' | 'toaster' | 'toilet' | 'towels' | 'toys' | 'trampoline' | 'twin_beds' | 'underfloor_heating' | 'vacuum_cleaner' | 'veranda' | 'videoland' | 'village' | 'volleyball_court' | 'wardrobe' | 'washbasin' | 'washer' | 'water_front' | 'water_hookup' | 'water_view' | 'wellness' | 'wheelchair_accessible' | 'wifi' | 'wood_stove' - `filterable` boolean: Administration has configured the amenity to appear as a filter - `highlightable` boolean: Administration has configured the amenity to appear as a highlight - `relationships` object: Relationships - `amenity_group` object: Group that the amenity belongs to - `data` object - … - `amenity_options` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Label: A label provides a way to categorize InventoryObjects, Owners and Reservations. These categorizations are created by backoffice users. **Important: A label is for internal use only and should never be exposed outside the Organization itself. This can for example be used to flag Customers that have been known for making a mess.** - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `background` string: The background color of the label. The foreground color is automatically determined when the label is saved. - `foreground` string: The foreground color of the label. This color is automatically determined based on the background color when updating or creating the label. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Administration: An organization can have multiple administrations, usually a holiday park or camping. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `email` string - `phone` string - `website` string - `native_currency` string - `address` string - `country_code` string - `postal_code` string - `city` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object: A description of the administration - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `surroundings_description` object: A description of the surroundings - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `tin` string: Tax Identification Number - `vat_nr` string: VAT Number - `available_locales` string[]: Enabled locales - `native_locale` string: The default locale used by the administration internally, and which should be used for communication with the administration - `timezone` string: The timezone of the administration, for example: Amsterdam - `invoice_email` string: The email address to contact for invoicing questions - `invoice_phone` string: The phone number to contact for invoicing questions - `invoice_address` string: The address to use for invoicing - `invoice_postalcode` string: The postal code to use for invoicing - `invoice_city` string: The city to use for invoicing - `invoice_country_code` string: The country code to use for invoicing - `billing_vat_percentage` integer - `available_currencies` string[]: Enabled currencies - `map_available` boolean: If a map is available. The map can be used to pick a specific accommodation or pitch. - `guest_list_group` 'main_guest' | 'all' | 'adults' | 'none' - `guest_accepted_document_type` string[] - `guest_identification_required` 'none' | 'main_guest' | 'all' | 'adults' - `ask_for_guest_gender` boolean - `ask_for_guest_address` boolean - `ask_for_guest_postal_code` boolean - `ask_for_guest_city` boolean - `ask_for_guest_country` boolean - `ask_for_guest_email` boolean - `ask_for_guest_phone` boolean - `ask_for_guest_profession` boolean - `ask_for_guest_signature` boolean - `ask_for_fellow_guest_gender` boolean - `ask_for_fellow_guest_address` boolean - `ask_for_fellow_guest_postal_code` boolean - `ask_for_fellow_guest_city` boolean - `ask_for_fellow_guest_country` boolean - `ask_for_fellow_guest_email` boolean - `ask_for_fellow_guest_phone` boolean - `ask_for_fellow_guest_profession` boolean - `ask_for_fellow_guest_signature` boolean - `default_option_validity` integer: The default option validity in days. When 0, customer options are not allowed. - `max_options_per_customer` integer: DEPRECATED use max_options_per_booker instead - `max_options_per_booker` integer: The maximum number of options that can be created at the same time by a particular customer - `latitude` number, double - `longitude` number, double - `allow_multi_reservation_bookings_through_api` boolean: Whether the administration accepts bookings containing multiple reservations. - `accounting_closed_upto` string, date: Date up to which accounting is closed. All financial transactions made before this date are locked and cannot be changed. - `enable_license_plates` boolean: Whether the administration accepts license plates for bookings. - `iban` string: International Bank Account Number - `bic` string: Bank Identifier Code - `peppol_identifiers` object[]: PEPPOL Identifiers for the administration with scheme ID. See https://docs.peppol.eu/edelivery/codelists/v9.4/Peppol%20Code%20Lists%20-%20Participant%20identifier%20schemes%20v9.4.html - `scheme` string - `value` string - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `self` string: Link to self - `url` string: Link to url - `relationships` object: Relationships - `city` object - `data` object - … - `checkin_timetable` object: The timetable that defines the default check-in times for this administration. It can be overridden for each rentable type. - `data` object - … - `checkout_timetable` object: The timetable that defines the default check-out times for this administration. It can be overridden for each rentable type. - `data` object - … - `interactive_map` object - `data` object - … - `payment_handlers` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - DiscountAction: Represents a fixed or percentage discount that may be applied to a Reservation. DiscountActions can apply to specific Channels and/or RentableTypes. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `discount_percentage` number, double: Applied discount percentage (if set) - `fixed_discount` object: Applied fixed discount (if set) - `currency` string - `value` string - `minimum_number_of_nights` integer - `maximum_number_of_nights` integer - `days_in_advance_mode` 'none' | 'early_bird' | 'last_minute': Specifies if the discount action is an early bird or last minute discount - `number_of_days_in_advance` integer: The minimum days in advance for bookings of early bird discounts, or the maximum days in advance for bookings of last minute discounts. - `coupon_codes` string[]: Applies when one of the specified coupon codes is used - `archived` boolean - `created_at` string, date-time - `updated_at` string, date-time - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `book_period` array[]: Applies to reservations that were booked in the given periods - string[] - `stay_period` array[]: Applies to reservations with stay overlapping with the given periods - string[] - `relationships` object: Relationships - `administration` object - `data` object - … - `discount_campaign` object: DEPRECATED use promotion instead - `data` object - … - `promotion` object - `data` object - … - `book_period` object: Applies to reservations that were booked in the given period - `data` object - … - `stay_period` object: Applies to reservations with stay overlapping with the given period - `data` object - … - `guest_group_limits` object: Applies to reservations that satisfy **all** of the given guest group limits. - `data` object[] - … - `rentable_types` object: Applies to reservations for one of the associated rentable types. This relationship will not be returned when the discount action applies to **all** associated rentable types. - `data` object[] - … - `channels` object: Applies to reservations made through one of the associated channels. This relationship will not be returned when the discount action applies to **all** associated channels. - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - OrderItem: Defines a Cost, grouped bundle of Costs or Extra that is ordered and applies to the associated Reservation. The price of an OrderItem is the total price for the Cost, grouped bundle of Costs or the Extra. They should be used to render a preview of the Order to the end user. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `type` 'cost_down' | 'cost' | 'deposit' | 'provision': An OrderItem can have four different types: * `cost_down` - To be paid as downpayment * `cost`- To be paid on arrival (hidden costs) * `deposit` - Deposit * `provision` - Commission items - `quantity` number, double - `quantity_type` 'per_person' | 'per_person_per_day' | 'per_pet' | 'per_pet_per_day' | 'fixed' | 'per_day' | 'per_piece' | 'per_piece_per_day' | 'percentage_over_default_costs' | 'percentage_over_total' | 'percentage_over_base_rent' | 'percentage_over_default_rent' | 'percentage_over_default_rent_per_person' | 'percentage_over_rent' - `product_name` string: Yields the non-localized item name - `sku` string: Internal code (SKU) - `invoiced_to` 'customer' | 'tour_operator': Returns to whom this item is invoiced - `is_rent` boolean: Whether this item is counted as rent for settlement - `in_advertised_price` boolean: Returns if this item is part of the calculated all-in price - `price` object - `currency` string - `value` string - `price_without_vat` object - `currency` string - `value` string - `sub_items` object[]: For grouped items, this may return the items that are part of this grouped item, which can be shown to the customer. - `name` object - … - `quantity` integer - `relationships` object: Relationships - `extra` object: Returns the Extra to which this item belongs (if any) - `data` object - … - `costs` object: Returns the Costs to which this item belongs (if any) - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - MainOrderItem: Persists that a default (required) Cost has been ordered with a given quantity. The price of a MainOrderItem is the total price based on the unit price and quantity. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `is_rent` boolean: Whether this item is counted as rent for settlement - `is_discount` boolean: Whether this item is a discount item - `is_deferred` boolean: Whether this item is deferred, meaning it should be paid on arrival - `vat_rate` number, double - `sku` string: Internal code (SKU) - `price` object - `currency` string - `value` string - `price_without_vat` object - `currency` string - `value` string - `position` integer - `quantity` number, double - `quantity_type` 'per_person' | 'per_person_per_day' | 'per_pet' | 'per_pet_per_day' | 'fixed' | 'per_day' | 'per_piece' | 'per_piece_per_day' | 'percentage_over_default_costs' | 'percentage_over_total' | 'percentage_over_base_rent' | 'percentage_over_default_rent' | 'percentage_over_default_rent_per_person' | 'percentage_over_rent' - `unit_price` object - `currency` string - `value` string - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `cost` object: Cost to which this item belongs (if any) - `data` object - … - `extra` object: Extra belonging to this order item. This may happen when an Extra is part of a PrimaryPackage - `data` object - … - `discount_action` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - DiscountCard: Discount cards (for example the ASCI camping card) implicitly represent a package, usually with a custom price per night or a discount depending on the time of stay. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `logo` object - `original` string - `thumb` string - `square_128` string - `square_256` string - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - PrimaryPackage: In contrast to ExtraPackages, primary packages can be applied only once to a Reservation. They usually provide a fixed price for a stay that is combined with several special costs and/or extras. For example: a Sauna package which includes "Towels", "Sauna tickets" and "Bathrobes" can be bought together as one package that is normally cheaper than buying all the same extras individually. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `short_description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - `tr` string - `en` string - `da` string - `description` object - `cs` string - `da-DK` string - `de` string - `de-AT` string - `de-CH` string - `en-US` string - `en-GB` string - `es` string - `fr` string - `fr-BE` string - `fr-LU` string - `it` string - `nb` string - `nl` string - `nl-BE` string - `pl` string - `pt` string - … truncated; see the full OpenAPI document linked below ## Other responses - `429`: Error - `default`: Error ## Changes - **2026-11-03** `ff81bc4fefa9`: 9 warning, 274 info - added the new `da-DK` enum value to the `data/attributes/locale` response property for the response status `200` - added the new `da-DK` enum value to the `included/items/anyOf[#/components/schemas/Booking]/attributes/locale` response property for the response status `200` - added the new `da-DK` enum value to the `included/items/anyOf[#/components/schemas/Order]/attributes/locale` response property for the response status `200` - added the new `en-GB` enum value to the `data/attributes/locale` response property for the response status `200` - …279 more [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/channels/:channel_id/reservations/post.md) --- [API](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3.md) - [All operations](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/llms.txt) - [OpenAPI document](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/revisions/ff81bc4fefa9?raw)