Glossary
| Name | Definition |
|---|---|
| Administration | Property within an organization. An organization can have multiple properties. A property can be a hotel, a holiday park, a camping, etc. |
| AdministrationAmenity | An AdministrationAmenity is a relationship between an Administration and an Amenity. When the linked Amenity is a numerical or multiple choice Amenity, the value of this AdministrationAmenity denotes the numerical value or the AmenityOption ID (as integer), respectively. |
| AdministrationSubscription | A link between a Subscription and an Administration, chosen by the user when the app is installed. An AdministrationSubscription has an optional link to a Channel for manual assignment, which can be used by online tour operators to fetch availability, prices and make reservations. |
| Agency | This agency can be used for backwards compatibility with the V2 API. |
| AgendaPeriod | A blocking event on the calendar of a Rentable. This includes Reservations and maintenance events. |
| AggregatedJournalTransaction | Aggregation of transactions between ledger accounts |
| Agreement | An agreement with an Owner for a given RentableIdentity |
| Amenity | Amenities are for external and internal use. They can be used to signify amenities of a RentableType or Rentable that are important to the guest. For example: * With sauna * Free wi-fi An Amenity can optionally be numerical or multiple choice. When an Amenity is numerical, the values of linked amenities (RentableTypeAmenity, RentableAmenity, ReservationAmenity and RoomAmenity) denote the numerical value belonging to the amenity. When an Amenity is multiple choice, the values of linked amenities denote the ID of the AmenityOption that applies. |
| AmenityGroup | Provides a way for Organizations to categorize Amenities. |
| AmenityOption | Represents an option of an Amenity with type Amenities::MultipleChoiceAmenity. |
| Application | A representation of your BEX App |
| AreaType | Represents an area such as "ground floor" or "first floor". |
| Availability | Availabilities represent a stay in or at a Rentable (mostly a holiday house, room or campsite). It includes an exact (all-in) price for the supplied guest group and other filters. For example, the search can give you a list of availabilities for 2 adults, 2 children, 1 pet, scoped on The Netherlands and Belgium with preference for a Rentable with sea view for a specific price range including all-in prices. This allows the guest to really compare Rentables because there will be no fees that are added during the reservation process. *Note: Users can explicitly exclude costs from the all-in price. This is not standard behaviour.* |
| Booking | A Booking consists of one or more reservations. It should be considered a shopping cart. The Booking defines the total amount that needs to be paid. |
| CancellationRule | Defines the percentage of the total price & administrative costs to be paid for Reservation cancellation. |
| ChangeRequest | Defines a reservation change that has to be approved by an Administration. This is very useful for online tour operators when a reservation change cannot be applied automatically. |
| 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 |
| Chargeback | An amount to be paid back to the customer. |
| CheckoutPortalBooking | A CheckoutPortal::Booking consists of one or more checkout_portal_reservations. It should be considered a shopping cart. A CheckoutPortal::Booking is not yet confirmed and does not block availability. Used for further processing through CheckoutPortal. Succesfully finishing CheckoutPortal proces will result in a blocking Booking. |
| CheckoutPortalReservation | A CheckoutPortal::Reservation can be considered a shopping cart item. Part of a CheckoutPortal::Booking and used for processing through CheckoutPortal. |
| City | Represents a city of a Region in a country. |
| CommissionAgreement | A commission agreement of an Administration |
| ComplexPrice | Yields a complex price for a given date of a master price list. |
| Contact | A person that opted in to receive a newsletter. Usually a Customer or Owner. |
| Cost | A cost is a surcharge that may apply to a certain Reservation. |
| CurrencyConversion | A currency conversion defines the exchange rate from an administration's native currency to a certain other currency. |
| Customer | Encapsulates the Customer details of a Booking. |
| 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. |
| Debtor | A Debtor represents someone who is billed. This might be a Channel, Reservation or Owner. |
| DeprecatedAccommodationType | Segment that an accommodation belongs to. For example, "Holiday houses" or "Campsites". |
| DiscountAction | Represents a fixed or percentage discount that may be applied to a Reservation. DiscountActions can apply to specific Channels and/or RentableTypes. |
| DiscountCampaign | Discount campaigns are used to advertise DiscountActions on rent prices for one or more RentableTypes. Discounts can be a percentage or a fixed amount. |
| DiscountCard | Discount cards (for example the ASCI camping card) implicitly represent a package, usually with a custom price per night or a discount depending on the time of stay. |
| Domain | A domain represents a top level domain name like "example.com". |
| Executor | An executor represents a user that executes a Todo, for example a cleaner, gardener or technical service employee. |
| Extra | An Extra is an option that can be added to a reservation, for example a child chair, tickets etc. They can have prices that change over time. Will yield a price when returned within the context of a Reservation. |
| ExtraOrderItem | Persists that an Extra has been ordered with a given quantity. The price of an ExtraOrderItem is the total price based on the unit price and quantity. |
| ExtraPackage | An ExtraPackage is a Package that can be user selected. They can have prices that change over time. Will yield a price when returned within the context of a Reservation. |
| Facility | A facility is anything that cannot be rented, for example a swimming pool or sanitary block. |
| FirstTermOffset | A first term offset is part of a payment policy. |
| Guest | A guest on the guest list of a Reservation. These details are often used for reporting guest list information to authorities. |
| GuestGroupLimit | RentableTypes, Packages and DiscountActions may only apply to specific guest groups or are calculated differently based on the guest group. These guest groups can be defined using one or more GuestGroupLimits. |
| Image | Represents an image with multiple versions. |
| InternalMessage | Internal messages are notifications that can be sent to an administration when needed. |
| 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. |
| InvoiceItem | Defines a line on an Invoice. |
| JournalTransaction | A transaction between ledger accounts |
| Label | A label provides a way to categorize RentableIdentities, Owners and Reservations. These categorizations are created by backoffice users. **Important: A label is for internal use only and should never be exposed outside the Organization itself. This can for example be used to flag Customers that have been known for making a mess.** |
| LedgerAccount | Financial ledger accounts for journal transactions |
| Logo | Represents a logo of a payment method |
| LosPrice | Yields the price for a given arrival date and length of stay (LOS). |
| MainOrderItem | Persists that a default (required) Cost has been ordered with a given quantity. The price of a MainOrderItem is the total price based on the unit price and quantity. |
| MasterPriceList | Contains a list of valid arrival or checkout dates. |
| Measurement | Represents a meter_reading of a utility |
| Memo | A memo is a small note that can be added to a Reservation, which will be shown on the details page of a Reservation. It supports simple HTML formatting and links. |
| Message | Represents a message that needs to be sent to the main guest of a Reservation. |
| MeterType | A meter type of an administration. |
| NightPrice | Yields the night price for a given date. |
| OrderItem | Defines a Cost, grouped bundle of Costs or Extra that is ordered and applies to the associated Reservation. The price of an OrderItem is the total price for the Cost, grouped bundle of Costs or the Extra. They should be used to render a preview of the Order to the end user. |
| Organization | Represents an organizational structure. It can have one or more Administrations (mostly holiday parks & campings). |
| Owner | An Owner is typically a private person that invests in holiday homes (RentableIdentity) on a holiday park (Administration). Incoming reservation rent is paid out minus commission. |
| PackageEntry | Represents a Cost or Extra of a Package with a specific price as part of the Package. |
| Payment | Represents a payment. |
| PaymentMethod | Payment methods that are available for processing payments. The actual payments are handled by a third party payment service provider. |
| PaymentPolicy | A payment policy determines when the debtor should pay which amoubt, based on te underlying first term offsets and payment terms. |
| PaymentRequest | An amount to be paid by a Customer |
| PaymentResult | A status update of a payment attempt |
| PaymentTerm | A payment term is part of a payment policy |
| Period | Periods are sets of date ranges. They can be used to define the validity of: * Costs * DiscountActions (when they can be booked and when the stay period is valid) * Packages (when they can be booked and when the stay period is valid) |
| PeriodEntry | Represents a date range as part of a Period. |
| PrimaryPackage | In contrast to ExtraPackages, primary packages can be applied only once to a Reservation. They usually provide a fixed price for a stay that is combined with several special costs and/or extras. For example: a Sauna package which includes "Towels", "Sauna tickets" and "Bathrobes" can be bought together as one package that is normally cheaper than buying all the same extras individually. |
| QuestionAnswer | As part of a Reservation, a QuestionAnswer is an answer of a Customer to a question predefined by an Administration. |
| Receipt | A receipt is a document acknowledging that an Administration has received a Payment following a sale or other transfer of products. |
| ReceiptItem | Represents a line as part of a Receipt. |
| RefundRequest | An amount to be refunded to the Customer |
| RefundResult | A status update of a refund attempt |
| Region | Represents a region of a country. For example: * Overijssel * Calabria * Tirol |
| Register | A POS register of an administration. |
| Rentable | A rentable is a period during which a RentableIdentity can be rented. A RentableIdentity can have multiple rentables, each representing different configurations (type, tags, pet policy, for rent, etc...) of the same physical accommodation. This exists because it's typical for holiday parks to upgrade accommodations. A RentableIdentity cannot have more than one active Rentable for a given date. |
| RentableAmenity | A RentableAmenity is a relationship between a Rentable and an Amenity. When the linked Amenity is a numerical or multiple choice Amenity, the value of this RentableAmenity denotes the numerical value or the AmenityOption ID (as integer), respectively. |
| RentableIdentity | An accommodation that can be booked as part of a Reservation |
| RentableSegment | Segment that a RentableType belongs to. For example, "Holiday houses" or "Berths". |
| RentableType | A RentableType represents a type and thus can have multiple underlying Rentables. The specific Rentables are not advertised to the guest. The exact Rentable is hidden from the guest so that the organization is flexible in assigning guests to different accommodations. |
| RentableTypeAmenity | A RentableTypeAmenity is a relationship between a RentableType and an Amenity. When the linked Amenity is a numerical or multiple choice Amenity, the value of this RentableTypeAmenity denotes the numerical value or the AmenityOption ID (as integer), respectively. |
| RentableTypeAvailability | Defines the availability of a RentableType on a given date. |
| RentableTypeGroup | Used by administrations to group RentableTypes that have something in common with each other. |
| Reservation | Request serializer for updating a Reservation outside of the channel namespace. |
| Reservation | A reservation of a single accommodation (RentableIdentity) as part of a Booking. Each Reservation in a Booking may have multiple order items. The total price of a Booking is the sum of all order items belonging to its reservations. |
| ReservationAmenity | A ReservationAmenity is a relationship between a Reservation and an Amenity. |
| Review | A Review is a collection of ReviewAnswers given by a Customer of a Reservation. It contains the average score of all answers given and provides details on the stay period. These reviews may be shared on a website. |
| ReviewAnswer | Represents an answer to a review question given by the Customer of a Reservation. |
| ReviewForm | A review form is a collection of ReviewQuestions that apply to given RentableSegments. |
| ReviewQuestion | A review question is part of a ReviewForm. It provides a multilingual representation of the question, specifies the kind of question and the type of answer that is expected to be given by a customer. |
| Room | Definition of a Room of a RentableType. |
| RoomAmenity | A RoomAmenity is a relationship between a Room and an Amenity. When the linked Amenity is a numerical or multiple choice Amenity, the value of this RoomAmenity denotes the numerical value or the AmenityOption ID (as integer), respectively. |
| RoomType | Definition of a room type that is available in one or more types (RentableType) of an Organization. |
| Signature | A signature of a Receipt, obtained by having a Receipt signed by an external financial party, for example to meet Registrierkassensicherheitsverordnung (RKSV) regulations in Austria. |
| SimplePrice | Yields a simple price for a given date of a master price list. |
| Subdomain | A subdomain represents a full domain name like "www.example.com" or "book.example.com". |
| Subscription | A subscription is created for an Organization when your app is installed. It has zero or more AdministrationSubscriptions, which define which Administrations of the Organization your app has access to. |
| SupportedPaymentMethod | Translated names and images for a supported payment method |
| Terms | General terms and conditions to which a guest has to agree to when making a Reservation. |
| 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. |
| TodoImage | An image that has been uploaded as part of a Todo. |
| 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. |
| TrafficSource | A traffic source represent the medium through which a Reservation has been created. For example: * Internet * Phone |
| User | A user that has a vertain role in the given Organization |
| ValidArrivalOrCheckoutDate | Defines whether arrival or checkout is possible on a given date. Part of an ArrivalCheckoutDate. |
| VATCode | A representation of a VAT type, eg Low/High VAT |
| VATTariff | A rate of a VATCode for a given timeframe |