--- title: "POST todo" method: POST path: "/v3/administrations/{administration_id}/todos" tags: ["Todos"] --- # POST todo `POST /v3/administrations/{administration_id}/todos` ## Request - Base URL: `https://api.bookingexperts.com` - URL: `https://api.bookingexperts.com/v3/administrations/{administration_id}/todos` - 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 todo ## Path parameters - `administration_id` string, required ## Query parameters - `fields[todo]` string - `include` string ## Headers - `Accept-Language` string ## Request body - object - `data` object: A todo is a task that needs to be done before a given deadline. It has an optional relationship to a Reservation or TodoList. - `type` string: Type - `attributes` object: Attributes - `deadline` string, date - `quantity` integer - `name` string, required - `description` string - `details` string - `blocker` boolean: Yields whether this todo blocks check-in - `checkable` boolean: Yields whether this todo should be checked after being finished - `taxable` boolean: Yields whether this todo is taxable after being checked - `urgent` boolean: This will notify the executor of the todo via SMS - `checked_at` string, date-time - `finished_at` string, date-time - `relationships` object: Relationships - `executor` object - `data` object - `id` string: executor 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. - `facility` object - `data` object - `id` string: facility 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. - `todo_list` object - `data` object - `id` string: todo_list 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` object - `data` object - `id` string: reservation 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 - Executor: An executor represents a user that executes a Todo, for example a cleaner, gardener or technical service employee. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `email` string - `name` string - `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 executor. Is used for communication. - `timezone` string: The timezone of the administration, for example: Amsterdam - `relationships` object: Relationships - `user` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Facility: A facility is anything that cannot be rented, for example a swimming pool or sanitary block. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `archived` boolean: Returns whether this facility has been archived - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `self` string: Link to self - `relationships` object: Relationships - `administration` 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. - TodoList: Todo lists are used to categorize Todos. For example: * Cleaning * Animation Executors can be assigned to todo lists to ensure unfinished todos are assigned properly. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `title` string - `archived` boolean - `relationships` object: Relationships - `administration` object - `data` object - … - `task_cost_for_hours` 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. ## Response `200` TodoResponse - object - `data` Todo: A todo is a task that needs to be done before a given deadline. It has an optional relationship to a Reservation or TodoList. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `deadline` string, date - `quantity` integer - `name` string, required - `description` string - `details` string - `blocker` boolean: Yields whether this todo blocks check-in - `checkable` boolean: Yields whether this todo should be checked after being finished - `taxable` boolean: Yields whether this todo is taxable after being checked - `urgent` boolean: This will notify the executor of the todo via SMS - `checked_at` string, date-time - `finished_at` string, date-time - `timesheet_hours` number, double: Total time written in hours - `automatically_generated` boolean: Returns whether the todo was generated by an Automatic todo. - `memo` string: An optional note - `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 - `executor` object - `data` object - `id` string: executor 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. - `facility` object - `data` object - `id` string: facility 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. - `todo_list` object - `data` object - `id` string: todo_list 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` object - `data` object - `id` string: reservation 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. - `creator` object - `data` object - `id` string: creator 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. - `invoice` object - `data` object - `id` string: 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. - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - `included` union[] - union - Executor: An executor represents a user that executes a Todo, for example a cleaner, gardener or technical service employee. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `email` string - `name` string - `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 executor. Is used for communication. - `timezone` string: The timezone of the administration, for example: Amsterdam - `relationships` object: Relationships - `user` object - `data` object - … - `meta` object: Metadata - `temp_id` string: UUID for internal resource linking. Should be omitted when the relationship ID is known. - Facility: A facility is anything that cannot be rented, for example a swimming pool or sanitary block. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `archived` boolean: Returns whether this facility has been archived - `created_at` string, date-time - `updated_at` string, date-time - `links` object: Links - `self` string: Link to self - `relationships` object: Relationships - `administration` 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. - TodoList: Todo lists are used to categorize Todos. For example: * Cleaning * Animation Executors can be assigned to todo lists to ensure unfinished todos are assigned properly. - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `title` string - `archived` boolean - `relationships` object: Relationships - `administration` object - `data` object - … - `task_cost_for_hours` 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. - 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. - User - `id` string: ID - `type` string: Type - `attributes` object: Attributes - `name` string - `email` string - `mobile_phone` string - `locale` string: One of: ["nl", "en-US", "en-GB", "de", "fr", "da-DK", "cs", "es", "tr", "pt", "it", "nb", "pl", "en", "da"] - `timezone` string: The timezone of the administration, for example: Amsterdam - `avatar` object - `original` string - `thumb` string - `normal` string - `created_at` string, date-time - `updated_at` string, date-time - `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. ## Other responses - `429`: Error - `default`: Error ## Changes - **2026-11-03** `ff81bc4fefa9`: 6 warning, 35 info - added the new `da-DK` enum value to the `included/items/anyOf[#/components/schemas/Executor]/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` - added the new `en-GB` enum value to the `included/items/anyOf[#/components/schemas/Executor]/attributes/locale` response property for the response status `200` - added the new `en-GB` enum value to the `included/items/anyOf[#/components/schemas/Reservation]/attributes/locale` response property for the response status `200` - …37 more [Operation history](https://skmtc.dev/bookingexperts/apis/booking-experts-api-v3/changes/v3/administrations/:administration_id/todos/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)