--- title: "GET bookings" method: GET path: "/v3/channels/{channel_id}/bookings" tags: ["Channel Bookings"] --- # GET bookings `GET /v3/channels/{channel_id}/bookings` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/channels/{channel_id}/bookings` - 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) Returns all bookings belonging to the channel ## Path parameters - `channel_id` string, required ## Query parameters - `page[number]` integer - `page[size]` integer - `sort` string - `fields[booking]` string - `include` string - `filter[id]` string - `filter[booker_desires_downpayment]` string - `filter[after_payment_return_url]` string - `filter[option_validity]` string - `filter[remote_booking_nr]` string - `filter[reference_nr]` string - `filter[locale]` string - `filter[memo]` string - `filter[cancel_date]` string - `filter[cancel_reason]` string - `filter[state]` string - `filter[token]` string - `filter[confirmed_at]` string - `filter[booking_nr]` string - `filter[created_at]` string - `filter[updated_at]` string - `filter[customer]` string - `filter[owner]` string - `filter[traffic_source]` string - `filter[credit_cards]` string - `filter[security_deposits]` string - `filter[administration]` string - `filter[channel]` string - `filter[guest_invoice]` string - `filter[customer_invoice]` string - `filter[channel_invoice]` string - `filter[reservations]` string ## Headers - `Accept-Language` string ## Response `200` BookingCollectionResponse - object - `data` Booking[] - `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 - `currency` string - `value` string - `paid_amount` object - `currency` string - `value` string - `payment_deadlines_with_deposit` object[] - `date` string, date - `open_amount` object - `currency` string - `value` string - `paid_amount` object - `currency` string - `value` string - `included_security_deposits` object[] - `pay_on_arrival` boolean - `amount` object - `currency` string - `value` string - `pending_vouchers` object[] - `code` string - `balance` object - `currency` string - `value` string - `amount` object - `currency` 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 - `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 - `id` string: customer 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. - `owner` object: Returns the Owner if this is a booking for an owner. - `data` object - `id` string: owner 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. - `traffic_source` object - `data` object - `id` string: traffic_source 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. - `conversation` object: Optionally create a conversation linked to this booking - `data` object - `id` string: conversation 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. - `credit_cards` object - `data` object[] - `id` string: credit_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. - `security_deposits` object - `data` object[] - `id` string: security_deposits 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. - `channel` object - `data` object - `id` string: channel 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. - `guest_invoice` object: DEPRECATED use customer_invoice instead - `data` object - `id` string: guest_invoice 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. - `customer_invoice` object - `data` object - `id` string: customer_invoice 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. - `channel_invoice` object - `data` object - `id` string: channel_invoice 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. - `reservations` object - `data` object[] - `id` string: reservations 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. - `payments` object - `data` object[] - `id` string: payments 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 - Customer: A Customer is a guest that created one or multiple Bookings. Note that a Customer of a particular Booking may have custom IBAN or BIC details. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `receive_newsletter` boolean - `title` 'mr' | 'ms' | 'family' | 'mrs' | 'miss' | 'mx' | 'dr' | 'prof' | 'rev' | 'sir' | 'dame' | 'lord' | 'lady': The title by which the customer should be addressed. May be left blank. - `first_name` string - `last_name` string - `phone` string - `email` string - `is_company` boolean - `company` string - `vat_nr` string - `business_registration_number` string - `date_of_birth` string, date - `gender` 'male' | 'female' | 'other' | 'prefer_not_to_say' - `address` string - `number` string - `postalcode` string - `city` 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' - `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. - `debtor_code` string: DEPRECATED Use the debtor_codes instead - `debtor_codes` string[]: The Debtor Codes this customer has within the organization. - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `labels` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Owner: An Owner is typically a private person that invests in holiday homes (InventoryObject) on a holiday park (Administration). Incoming reservation rent is paid out minus commission. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `license_plate_number` string - `memo` string: An optional note - `pays_vat` boolean - `pay_in_advance` boolean - `invoice_from` string, date - `contract_ends_at` string, date - `active` boolean: DEPRECATED: returns whether active agreement exists - `psp_recurring_enabled_at` string, date-time - `promotion_token` string - `title` 'mr' | 'ms' | 'family' | 'mrs' | 'miss' | 'mx' | 'dr' | 'prof' | 'rev' | 'sir' | 'dame' | 'lord' | 'lady': The title by which the owner should be addressed - `first_name` string - `last_name` string - `phone` string - `mobile_phone` string - `nationality` string - `gender` 'male' | 'female' | 'other' | 'prefer_not_to_say' - `email` string: Email address of the primary linked user of this owner (if present). Returns the first linked user (if present) if no primary linked user is set. - `linked_emails` string[]: Email addresses of all linked users of this owner (if present), in order of creation. Primary linked user comes first, if present. - `is_company` boolean - `company` string - `vat_nr` string - `tin` string - `business_registration_number` string - `date_of_birth` string, date - `receive_newsletter` boolean - `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 owner. Is used for communication. - `address` string: Combined address (line 1 and line 2 separated by comma) - `address_line_1` string: Street name without house number - `address_line_2` string: Additional address line (e.g., apartment, suite) - `number` string: House number extracted from address - `postalcode` string - `city` string - `country_code` string - `iban` string - `bic` string - `debtor_code` string: A system wide unique identifier for this debtor - `relationships` object: Relationships - `primary_contact` object - `data` object - … - `contacts` object - `data` object[] - … - `administration` object - `data` object - … - `active_inventory_objects` object - `data` object[] - … - `owner_guests` object - `data` object[] - … - `active_rentable_identities` object: DEPRECATED use active_inventory_objects instead - `data` object - … - `labels` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - TrafficSource: A traffic source represent the medium through which a Reservation has been created. For example: * Internet * Phone - `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 - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Conversation: Conversations is a collection of messages between administration and guest. They're in the context of a booking. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `rid` string, required: The identifier that is used by the external system to track the message - `is_open` boolean: Indicates whether the conversation is open or closed. - `relationships` object: Relationships - `booking` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - CreditCard: A CreditCard belongs to a Booking. As BEX is not PCI-compliant, it only accepts tokenized credit cards. Tokenization should happen by a PCI compliant proxy, which should also be responsible for detokenization. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `token` string: Tokenized creditcard number. Do not set real credit card numbers here - `csc_token` string: Tokenized creditcard security code. Do not set real credit card security codes here - `amount` object: The total value of this credit card - `currency` string - `value` string - `card_holder` string: Card holder name - `effective_date` string, date: Sets on which date this card can be charged - `expiry_date` string, date: Sets on which date this card cannot be cahrged anymore - `issuer_code` 'AX' | 'BC' | 'BL' | 'CB' | 'UP' | 'DN' | 'DS' | 'EC' | 'JC' | 'MA' | 'MC' | 'SO' | 'CU' | 'TP' | 'VE' | 'VI' | 'XX': Card issuer - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `booking` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - SecurityDeposit: Security deposits are collected before check-in and can be claimed, waived or released after check-out. They can be specified per Reservation, but will be collected using payments on the associated Booking or guest Invoice. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` object: Name of the deposit - `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 - `state` 'required' | 'secured' | 'waived' | 'released': Current state of the deposit - `pay_on_arrival` string: Whether the deposit is payable on arrival - `payment_deadline` string, date: The due date for the security deposit payment - `amount` object - `currency` string - `value` string - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `reservation` object - `data` object - … - `customer_invoice` object - `data` object - … - `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. - Channel: Every Reservation originates from a channel. This can be a tour operator, the backoffice, the website and so on. Administrations can customize the following aspects for each Channel: * Extras * Costs * Availability * Rent prices * Invoicing - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string: Name of the channel. This name is also shown in the back-office. - `email` string: Contact email address of the channel. This email address is also shown in the back-office. - `kind` 'reseller' | 'tour_operator': Channel kind. - `available_currencies` string[]: Lists the currencies that are available for this channel. One or more of: EUR, USD, CHF, CZK, TRY, CVE, XCG, GBP, NOK, DKK, ZAR. - `pricing_type` string: Type of pricing that applies to this channel. One of: night_prices, complex_prices. Is replaced by requires_night_prices. - `requires_night_prices` boolean: Whether this channel can only handle night prices. - `archivable` boolean: Whether the channel can be archived or not. - `front_office` boolean: Whether reservations made through this channel should be listed as front office reservations on the planboard or not. - `synchronizes_costs` boolean: Whether the channel synchronizes costs or not. - `allows_costs_with_multiple_price_periods` boolean: Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false. - `allows_costs_with_negative_amounts` boolean: Whether the channel allows costs with negative prices or percentages. Ignored when synchronizes_costs is false. - `allows_deposit_costs_that_are_not_fixed_or_per_piece_or_percentual` boolean: Whether the channel allows deposit costs that are not fixed, per piece or percentual. Ignored when synchronizes_costs is false. - `allow_confirmation_without_payment` boolean: Whether the channel allows confirmation without direct payment. - `determines_price` boolean: Whether the channel determines the price or not. - `skip_price_deviation_check` boolean: Whether price deviation checks must be performed. By default, when the passed price for a booking deviates more than 5% from the expected booking price, we notify the administration of this. - `rent_invoiced_to` 'guest' | 'channel': Whether the channel invoices rent to the guest or the channel. - `costs_invoiced_to` 'guest' | 'channel': Whether the channel invoices costs to the guest or the channel. - `use_costs_invoiced_to` boolean: Whether the channel should use the costs_invoiced_to setting to determine invoicing or not. Setting this to false allows overriding the invoicing for individual costs. - `extras_invoiced_to` 'guest' | 'channel': Whether the channel invoices extras to the guest or the channel. - `use_extras_invoiced_to` boolean: Whether the channel should use the extras_invoiced_to setting to determine invoicing or not. Setting this to false allows overriding the invoicing for individual extras. - `behave_as_own_site` boolean: Whether the channel behaves as the own site channel or not. Must be false when kind is set to tour_operator. - `supports_group_details` boolean: Whether the channel supports specifying detailed group compositions. - `confirm_reservations` boolean: Whether the channel automatically confirms reservations or not - `auto_deliver_invoices` boolean: Whether the channel automatically delivers invoices to the specified email or not - `confirm_by_email` boolean: Deprecated: use auto_deliver_invoices instead. Whether the channel automatically delivers invoices to the specified email or not - `customer_invoice_payable_on_park` boolean: Whether the guest invoice can be paid on arrival or not - `fixed_attributes` string[]: Lists the attributes of the channel that cannot be freely edited in the back-office. One or more of: name, requires_night_prices, kind, rent_invoiced_to, costs_invoiced_to, use_costs_invoiced_to, confirm_reservations, auto_deliver_invoices, customer_invoice_payable_on_park, available_currencies, email. - `can_be_set_as_default_channel` boolean: Whether the channel can be set as the default channel for new back office reservations etc. or not. Can only be specified on creation. - `requires_cancellation_originator` boolean: Whether the channel requires the originator of reservation cancellations to be known or not. Can only be specified on creation. - `requires_restitution_after_cancellation` boolean: Whether the channel requires mandatory restitution after a reservation cancellation or not. Can only be specified on creation. - `requires_confirmation_or_cancellation_within_24_hours` boolean: Whether the channel requires confirmation or cancellation of a reservation within 24 hours after creation of the reservation. " \ "Can only be specified on creation. - `uses_remote_reservation_key` boolean: Whether the channel uses a remote reservation key or not. Can only be specified on creation. - `only_allow_movement_by_channel` boolean: Whether the channel only allows movements of reservations (in time, or to different inventory objects) by the channel itself or not. - `archived` boolean: Whether this channel has been archived or not. - `debtor_code` string: A system wide unique identifier for this debtor - `temporary_booking_validity_in_hours` string: Time in hours after which unconfirmed reservations are cancelled. - `price_factor` number, double: The final rent price (base rent price minus discount) is multiplied by this value. For example, if the factor is 1.1, 10% is added to the final rent price. Values below 1.0 are also possible. - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `url` string: Link to url - `relationships` object: Relationships - `administration` object - `data` object - … - `application` object - `data` object - … - `brand` object - `data` object - … - `contact` object - `data` object - … - `guest_payment_policy` object - `data` object - … - `channel_payment_policy` object - `data` object - … - `excluded_costs` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Invoice: Invoices can be created for Orders, Channels and Owners. An Invoice will be in concept until it is sent, after which it becomes immutable. Changes to an Order will be invoiced by crediting the current Invoice and generating a new Invoice. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `date` string, date: The date of the invoice - `type` 'CancellationInvoice' | 'ChannelInvoice' | 'CreditInvoice' | 'MeasurementInvoice' | 'OneOffOwnerInvoice' | 'OwnerPeriodicInvoice' | 'RentSettlementInvoice' | 'ReservationInvoice' | 'ReservationMeasurementInvoice' | 'TodoInvoice' | 'UtilitiesAdvanceInvoice' - `invoice_nr` string: The invoice number, which is unique within the administration - `sent` boolean: Returns whether this invoice has been sent - `currency` string: An ISO 4217 currency code - `reference_nr` string: Reference number from the associated booking (if any) - `company` string: The company name of the billed to party (if any) - `country_code` string: The country code of the billed to party (if any) - `city` string: The city of the billed to party (if any) - `address` string: Combined address of the billed to party (if any) - `address_line_1` string: Address line 1 of the billed to party (if any) - `address_line_2` string: Address line 2 of the billed to party (if any) - `postalcode` string: The postal code of the billed to party (if any) - `address_subdivision` string: The subdivision (state/province/region) of the billed to party (if any) - `debtor_code` string - `memo` string: Returns the current content of the memo. For booking invoices, this returns the memo of the booking. - `recurring_payment` boolean: Yields whether this invoice should be paid with recurring payment - `period_start_date` string, date: The start date of the period this invoice applies to (if any) - `period_end_date` string, date: The end date of the period this invoice applies to (if any) - `payment_deadlines` object[]: Deadlines for payment of the invoice, with the due date, open and paid amounts, and the current status. Status can have the following values: first_reminder, second_reminder, final_notice - `date` string, date - `status` string - `open_amount` object - … - `paid_amount` object - … - `total` object - `currency` string - `value` string - `total_open` object - `currency` string - `value` string - `pdf_url` string - `last_sent` string, date-time: Returns the last time this invoice was sent to the Customer. - `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_short_url` string: A short URL to the payment portal for this invoice - `relationships` object: Relationships - `owner` object - `data` object - … - `invoice_items` object - `data` object[] - … - `debtor` object - `data` object - … - `links` object - … - `administration` object - `data` object - … - `links` object - … - `reservation` object: DEPRECATED use booking instead - `data` object - … - `links` object - … - `booking` object - `data` object - … - `links` object - … - `inventory_objects` object - `data` object[] - … - `credited_invoice` object: The invoice that was credited, if any - `data` object - … - `previous_invoice` object: For a mutation invoice, this yields the previous (credited) invoice - `data` object - … - `payments` object - `data` object[] - … - `security_deposits` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Invoice: Invoices can be created for Orders, Channels and Owners. An Invoice will be in concept until it is sent, after which it becomes immutable. Changes to an Order will be invoiced by crediting the current Invoice and generating a new Invoice. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `date` string, date: The date of the invoice - `type` 'CancellationInvoice' | 'ChannelInvoice' | 'CreditInvoice' | 'MeasurementInvoice' | 'OneOffOwnerInvoice' | 'OwnerPeriodicInvoice' | 'RentSettlementInvoice' | 'ReservationInvoice' | 'ReservationMeasurementInvoice' | 'TodoInvoice' | 'UtilitiesAdvanceInvoice' - `invoice_nr` string: The invoice number, which is unique within the administration - `sent` boolean: Returns whether this invoice has been sent - `currency` string: An ISO 4217 currency code - `reference_nr` string: Reference number from the associated booking (if any) - `company` string: The company name of the billed to party (if any) - `country_code` string: The country code of the billed to party (if any) - `city` string: The city of the billed to party (if any) - `address` string: Combined address of the billed to party (if any) - `address_line_1` string: Address line 1 of the billed to party (if any) - `address_line_2` string: Address line 2 of the billed to party (if any) - `postalcode` string: The postal code of the billed to party (if any) - `address_subdivision` string: The subdivision (state/province/region) of the billed to party (if any) - `debtor_code` string - `memo` string: Returns the current content of the memo. For booking invoices, this returns the memo of the booking. - `recurring_payment` boolean: Yields whether this invoice should be paid with recurring payment - `period_start_date` string, date: The start date of the period this invoice applies to (if any) - `period_end_date` string, date: The end date of the period this invoice applies to (if any) - `payment_deadlines` object[]: Deadlines for payment of the invoice, with the due date, open and paid amounts, and the current status. Status can have the following values: first_reminder, second_reminder, final_notice - `date` string, date - `status` string - `open_amount` object - … - `paid_amount` object - … - `total` object - `currency` string - `value` string - `total_open` object - `currency` string - `value` string - `pdf_url` string - `last_sent` string, date-time: Returns the last time this invoice was sent to the Customer. - `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_short_url` string: A short URL to the payment portal for this invoice - `relationships` object: Relationships - `owner` object - `data` object - … - `invoice_items` object - `data` object[] - … - `debtor` object - `data` object - … - `links` object - … - `administration` object - `data` object - … - `links` object - … - `reservation` object: DEPRECATED use booking instead - `data` object - … - `links` object - … - `booking` object - `data` object - … - `links` object - … - `inventory_objects` object - `data` object[] - … - `credited_invoice` object: The invoice that was credited, if any - `data` object - … - `previous_invoice` object: For a mutation invoice, this yields the previous (credited) invoice - `data` object - … - `payments` object - `data` object[] - … - `security_deposits` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Invoice: Invoices can be created for Orders, Channels and Owners. An Invoice will be in concept until it is sent, after which it becomes immutable. Changes to an Order will be invoiced by crediting the current Invoice and generating a new Invoice. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `date` string, date: The date of the invoice - `type` 'CancellationInvoice' | 'ChannelInvoice' | 'CreditInvoice' | 'MeasurementInvoice' | 'OneOffOwnerInvoice' | 'OwnerPeriodicInvoice' | 'RentSettlementInvoice' | 'ReservationInvoice' | 'ReservationMeasurementInvoice' | 'TodoInvoice' | 'UtilitiesAdvanceInvoice' - `invoice_nr` string: The invoice number, which is unique within the administration - `sent` boolean: Returns whether this invoice has been sent - `currency` string: An ISO 4217 currency code - `reference_nr` string: Reference number from the associated booking (if any) - `company` string: The company name of the billed to party (if any) - `country_code` string: The country code of the billed to party (if any) - `city` string: The city of the billed to party (if any) - `address` string: Combined address of the billed to party (if any) - `address_line_1` string: Address line 1 of the billed to party (if any) - `address_line_2` string: Address line 2 of the billed to party (if any) - `postalcode` string: The postal code of the billed to party (if any) - `address_subdivision` string: The subdivision (state/province/region) of the billed to party (if any) - `debtor_code` string - `memo` string: Returns the current content of the memo. For booking invoices, this returns the memo of the booking. - `recurring_payment` boolean: Yields whether this invoice should be paid with recurring payment - `period_start_date` string, date: The start date of the period this invoice applies to (if any) - `period_end_date` string, date: The end date of the period this invoice applies to (if any) - `payment_deadlines` object[]: Deadlines for payment of the invoice, with the due date, open and paid amounts, and the current status. Status can have the following values: first_reminder, second_reminder, final_notice - `date` string, date - `status` string - `open_amount` object - … - `paid_amount` object - … - `total` object - `currency` string - `value` string - `total_open` object - `currency` string - `value` string - `pdf_url` string - `last_sent` string, date-time: Returns the last time this invoice was sent to the Customer. - `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_short_url` string: A short URL to the payment portal for this invoice - `relationships` object: Relationships - `owner` object - `data` object - … - `invoice_items` object - `data` object[] - … - `debtor` object - `data` object - … - `links` object - … - `administration` object - `data` object - … - `links` object - … - `reservation` object: DEPRECATED use booking instead - `data` object - … - `links` object - … - `booking` object - `data` object - … - `links` object - … - `inventory_objects` object - `data` object[] - … - `credited_invoice` object: The invoice that was credited, if any - `data` object - … - `previous_invoice` object: For a mutation invoice, this yields the previous (credited) invoice - `data` object - … - `payments` object - `data` object[] - … - `security_deposits` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - 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 - … - `price` object - … - `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 - … - `rentable_type` object - `data` object - … - `rentable_identity` object: DEPRECATED use inventory_object instead - `data` object - … - `inventory_object` object - `data` object - … - `booking` object: Returns the booking of the reservation. This relationship can be managed via sideposting. - `data` object - … - `links` object - … - `order` object: DEPRECATED use booking instead - `data` object - … - `links` object - … - `discount_card` object - `data` object - … - `primary_package` object - `data` object - … - `extra_packages` object - `data` object[] - … - `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[] - … - `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[] - … - `reservation_amenities` object - `data` object[] - … - `available_optional_amenities` object: Returns a list of the optional amenities of the rentables that are available for this reservation. - `data` object[] - … - `labels` object - `data` object[] - … - `administration` object - `data` object - … - `links` object - … - `discount_action` object - `data` object - … - `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[] - … - `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[] - … - `available_discount_cards` object - `data` object[] - … - `available_primary_packages` object - `data` object[] - … - `available_extra_packages` object - `data` object[] - … - `available_extras` object - `data` object[] - … - `question_answers` object - `data` object[] - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Payment: Represents a payment. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `paid_at` string, date: Local payment date - `amount` object: Paid amount - `currency` string - `value` string - `payment_type` 'cash' | 'pos' | 'psp' | 'batch' | 'transfer' | 'transfered_from_invoice' | 'transfered_to_invoice' | 'credited' | 'credit' | 'voucher' | 'transfered_to_voucher' | 'imported': Payment type. On create, this must be one of: cash, pin, psp, batch, transfer - `memo` string: An optional note - `terminal_identifier` string: An optional terminal identifier for POS payments - `description` string: A short description of this payment - `created_at` string, date-time - `updated_at` string, date-time - `relationships` object: Relationships - `payment_method` object - `data` object - … - `booking` object - `data` object - … - `invoice` object - `data` object - … - `register` object: Register is required when linked with a payment_method (through payment_type) that has pos_enabled, like cash or pin payments. - `data` object - … - `administration` object - `data` object - … - `receipt` object - `data` object - … - `settled_with` object: Yields the payment on the settled invoice or receipt (if any) - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `meta` object - `pagination` object - `total_records` integer - `page` integer - `size` integer ## Other responses - `429`: Error - `default`: Error ## Changes - **2026-11-03** `ff81bc4fefa9`: 12 warning, 25 info - added the new `da-DK` enum value to the `data/items/attributes/locale` response property for the response status `200` - added the new `da-DK` enum value to the `included/items/anyOf[#/components/schemas/Customer]/attributes/locale` response property for the response status `200` - added the new `da-DK` enum value to the `included/items/anyOf[#/components/schemas/Owner]/attributes/locale` response property for the response status `200` - added the new `da-DK` enum value to the `included/items/anyOf[#/components/schemas/Reservation]/attributes/locale` response property for the response status `200` - …33 more [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/channels/:channel_id/bookings/get.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)