--- title: "Get all reservations (ver 2017-04-12)" method: POST path: "/api/connector/v1/reservations/getAll" tags: ["Reservations"] deprecated: true --- # Get all reservations (ver 2017-04-12) `POST /api/connector/v1/reservations/getAll` > **Deprecated.** Use [Get all reservations (ver 2023-06-06)](https://mews-systems.gitbook.io/connector-api/operations/reservations#get-all-reservations-ver-2023-06-06). ## Request body - ReservationFilterParameters - `ClientToken` string, required — Token identifying the client application. - `AccessToken` string, required — Access token of the client application. - `Client` string, required — Name and version of the client application. - `ServiceIds` string[], required — Unique identifiers of the [Services](https://mews-systems.gitbook.io/connector-api/operations/services/#service) from which the reservations are requested. - `ServiceId` string, uuid, nullable - `GroupIds` string[], nullable — Unique identifiers of the requested [Reservation groups](https://mews-systems.gitbook.io/connector-api/operations/#reservation-group). - `ReservationIds` string[], nullable — Unique identifiers of the requested [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2017-04-12). - `CustomerIds` string[], nullable — Unique identifiers of the [Customers](https://mews-systems.gitbook.io/connector-api/operations/customers/#customer) which own the reservations. - `AssignedResourceIds` string[], nullable — Unique identifiers of [Resources](https://mews-systems.gitbook.io/connector-api/operations/resources/#resource) assigned to the reservations. - `RateIds` string[], nullable — Unique identifiers of [Rates](https://mews-systems.gitbook.io/connector-api/operations/rates/#rate) assigned to the reservations. - `BusinessSegmentIds` string[], nullable — Unique identifiers of [Business segments](https://mews-systems.gitbook.io/connector-api/operations/businesssegments/#business-segment) assigned to the reservations. - `ChannelNumbers` string[], nullable — Set of numbers or references used by the Channel (i.e. OTA, GDS, CRS, etc.) in case the reservation group originates there, e.g. Booking.com confirmation numbers. - `Numbers` string[], nullable — Confirmation numbers of [Reservations](https://mews-systems.gitbook.io/connector-api/operations/#reservation-ver-2017-04-12). - `StartUtc` string, date-time, nullable — Start of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter. - `EndUtc` string, date-time, nullable — End of the interval in UTC timezone in ISO 8601 format. Required when used in conjunction with the TimeFilter or States search parameter. - `TimeFilter` 'Colliding' | 'Created' | 'Updated' | 'Start' | 'End' | 'Overlapping' | 'Canceled' - `Currency` string, currency, nullable — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency) the item costs should be converted to. - `States` ServiceOrderStateOld[], nullable — States the reservations should be in. If not specified, reservations in Confirmed, Started or Processed states or reservations specified by ReservationIds regardless of state are returned. - `Extent` ReservationExtent, required — Extent of data to be returned. E.g. it is possible to specify that together with the reservations, customers, groups and rates should be also returned. - `Reservations` boolean, nullable — Whether the response should contain reservations. - `ReservationGroups` boolean, nullable — Whether the response should contain groups of the reservations. - `Customers` boolean, nullable — Whether the response should contain customers of the reservations. - `CustomerAdresses` boolean, nullable — Whether the response should contain addresses of the customers. - `CustomerIdentityDocuments` boolean, nullable — Whether the response should contain identity documents of the customers. - `Services` boolean, nullable — Whether the response should contain services reserved by the reservations. - `Products` boolean, nullable — Whether the response should contain products orderable with the reservations. - `BusinessSegments` boolean, nullable — Whether the response should contain business segmentation. - `Resources` boolean, nullable — Whether the response should contain resources. - `ResourceCategories` boolean, nullable — Whether the response should contain resource categories. - `ResourceCategoryAssignments` boolean, nullable — Whether the response should contain assignments of the resources to categories. - `Rates` boolean, nullable — Whether the response should contain rates and rate groups. - `Items` boolean, nullable — Whether the response should contain accounting items. - `OrderItems` boolean, nullable — Whether the response should contain reservation items. - `Notes` boolean, nullable — Whether the response should contain notes. - `QrCodeData` boolean, nullable — Whether the response should contain QR code data. - `Companies` boolean, nullable — Whether the response should contain companies. - `AccountingStates` AccountingState[], nullable — States the items should be in. If not specified, items in `Open` or `Closed` states are returned. - `Limitation` Limitation, required — Limitation on the quantity of data returned. - `Count` integer, required - `Cursor` string, uuid, nullable ## Response `200` OK - ReservationResult - `Reservations` ReservationOld[], nullable — The reservations that collide with the specified interval. - `Id` string, uuid, required — Unique identifier of the reservation. - `ServiceId` string, uuid, required — Unique identifier of the Service that is reserved. - `GroupId` string, uuid, required — Unique identifier of the Reservation group. - `Number` string, required — Confirmation number of the reservation in Mews. - `ChannelNumber` string, nullable — Number of the reservation within the Channel (i.e. OTA, GDS, CRS, etc) in case the reservation group originates there (e.g. Booking.com confirmation number). - `ChannelManagerNumber` string, nullable — Unique number of the reservation within the reservation group. - `ChannelManagerGroupNumber` string, nullable — Number of the reservation group within a Channel manager that transferred the reservation from Channel to Mews. - `ChannelManager` string, nullable — Name of the Channel manager (e.g. AvailPro, SiteMinder, TravelClick, etc). - `State` 'Enquired' | 'Confirmed' | 'Started' | 'Processed' | 'Canceled' | 'Optional' | 'Requested', required - `Origin` 'Distributor' | 'ChannelManager' | 'Import' | 'Connector' | 'Navigator' | 'CommanderInPerson' | 'CommanderChannel' | 'CommanderPhone' | 'CommanderEmail' | 'CommanderWebsite' | 'CommanderMessage' | 'CommanderCallCenter' | 'CommanderRoomingList', required - `OriginDetails` string, nullable — Details about the reservation origin. - `Purpose` 'Leisure' | 'Business' | 'Student' - `CreatedUtc` string, required — Creation date and time of the reservation in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, required — Last update date and time of the reservation in UTC timezone in ISO 8601 format. - `CancelledUtc` string, nullable — Cancellation date and time in UTC timezone in ISO 8601 format. - `StartUtc` string, required — Start of the reservation in UTC timezone in ISO 8601 format. This is either the scheduled reservation start time, or the actual customer check-in time if this is earlier than the scheduled start time. - `EndUtc` string, required — End of the reservation (departure) in UTC timezone in ISO 8601 format. - `ReleasedUtc` string, nullable — Date when the optional reservation is released in UTC timezone in ISO 8601 format. - `RequestedCategoryId` string, uuid, required — Identifier of the requested Resource category. - `AssignedSpaceId` string, uuid, nullable — Identifier of the assigned Space. - `AssignedSpaceLocked` boolean — Whether the reservation is locked to the assigned Space and cannot be moved. - `AssignedResourceId` string, uuid, nullable — Identifier of the assigned Resource. - `AssignedResourceLocked` boolean, required — Whether the reservation is locked to the assigned Resource and cannot be moved. - `BusinessSegmentId` string, uuid, nullable — Identifier of the reservation Business segment. - `CompanyId` string, uuid, nullable — Identifier of the Company on behalf of which the reservation was made. - `TravelAgencyId` string, uuid, nullable — Identifier of the Company that mediated the reservation. - `AvailabilityBlockId` string, uuid, nullable — Unique identifier of the Availability block the reservation is assigned to. - `RateId` string, uuid, required — Identifier of the reservation Rate. - `VoucherId` string, uuid, nullable — Unique identifier of the Voucher that has been used to create reservation. - `CreditCardId` string, uuid, nullable — Unique identifier of the Credit card. - `CancellationReason` 'Other' | 'ConfirmationMissed' | 'BookedElsewhere' | 'ForceMajeure' | 'GuestComplaint' | 'NoShow' | 'PriceTooHigh' | 'ServiceNotAvailable' | 'InputError' | 'InvalidPayment' | 'TravelAgency' | 'RequestedByGuest' | 'Update' | 'BookingAbandoned' | 'RequestedByBooker' - `AdultCount` integer — Count of adults the reservation was booked for. - `ChildCount` integer — Count of children the reservation was booked for. - `PersonCounts` ReservationPersonCount[], required — Number of people per age category the reservation was booked for. - `AgeCategoryId` string, uuid, required — Unique identifier of the [Age category](https://mews-systems.gitbook.io/connector-api/operations/agecategories#age-category). - `Count` integer, required — Number of people of a given age category. Only positive value is accepted. - `OwnerId` string, uuid, required — Unique identifier of the Customer or Company who owns the reservation. - `CustomerId` string, uuid, required — Unique identifier of the Customer who owns the reservation. - `BookerId` string, uuid, nullable — Unique identifier of the Customer on whose behalf the reservation was made. - `CompanionIds` string[], required — Unique identifiers of the `Customer`s that will use the resource. - `ChannelManagerId` string, nullable — Channel Manager number. - `Options` ReservationOptions, required - `OwnerCheckedIn` boolean, required — Owner of the reservation checked in. - `AllCompanionsCheckedIn` boolean, required — All companions of the reservation checked in. - `AnyCompanionCheckedIn` boolean, required — Any companion of the reservation checked in. - `ReservationGroups` ReservationGroupOld[], nullable — Reservation groups that the reservations are members of. - `Id` string, uuid — Unique identifier of the reservation group. - `Name` string, nullable — Name of the reservation group. - `Customers` Customer[], nullable — Customers that are members of the reservations. - `Id` string, uuid, required — Unique identifier of the customer. - `ChainId` string, uuid, required — Unique identifier of the chain. - `Number` string, required — Unique number of the customer (max 19 digits). - `Title` 'Mister' | 'Miss' | 'Misses' — Type of the title prefix of the customer. Note that the value should not be used as-is, but localized. For example, the value `Misses` should be displayed as `Mrs.` in English and `Fr.` in German. Mister (Mr.) Miss (Ms.) Misses (Mrs.) - `Sex` 'Male' | 'Female' — Male Female - `FirstName` string, nullable — First name of the customer. - `LastName` string, required — Last name of the customer. - `SecondLastName` string, nullable — Second last name of the customer. - `NationalityCode` string, nullable — ISO 3166-1 code of the [Country](https://mews-systems.gitbook.io/connector-api/operations/countries/#country). - `PreferredLanguageCode` string, nullable — Language and culture code of the customer's preferred language, according to their profile. For example: `en-GB`, `fr-CA`. - `LanguageCode` string, nullable — Language and culture code of the customer's language, based on multiple sources. These sources include the preferred language specified in internal data based on previous bookings, and the preferred language of the customer specified in their profile. If neither of these sources are present, we use the native language based on the customer's nationality. The format is, for example, `en-US` or `fr-FR`. - `BirthDate` string, nullable — Date of birth in ISO 8601 format. - `BirthCountryCode` string, nullable — ISO 3166-1 alpha-2 code of the birth country. - `BirthCountrySubdivisionCode` string, nullable — ISO 3166-2 code of the administrative division, e.g. ES-C. - `BirthPlace` string, nullable — Place of birth. - `Occupation` string, nullable — Occupation of the customer. - `Email` string, nullable — Email address of the customer. - `HasOtaEmail` boolean — Whether the customer's email address is a temporary email address from an OTA. For more details, see the [product documentation](https://help.mews.com/s/article/how-to-maintain-ota-guest-profiles-with-verified-email-addresses-obtained-from-the-guest-portal). - `Phone` string, nullable — Phone number of the customer (possibly mobile). - `TaxIdentificationNumber` string, nullable — Tax identification number of the customer. - `LoyaltyCode` string, nullable — Loyalty code of the customer. - `AccountingCode` string, nullable — Accounting code of the customer. - `BillingCode` string, nullable — Billing code of the customer. - `Notes` string, nullable — Internal notes about the customer. - `CarRegistrationNumber` string, nullable — Registration number of the customer's car. - `DietaryRequirements` string, nullable — Customer's dietary requirements, e.g. Vegan, Halal. - `CreatedUtc` string, date-time, required — Creation date and time of the customer in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the customer in UTC timezone in ISO 8601 format. - `Passport` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `IdentityCard` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `Visa` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `DriversLicense` IdentityDocument - `Id` string, uuid — Unique identifier of the document. - `CustomerId` string, uuid — Identifier of the `Customer`. - `Type` 'IdentityCard' | 'Passport' | 'Visa' | 'DriversLicense' — IdentityCard Passport Visa DriversLicense - `Number` string, nullable — Number of the document (e.g. passport number). - `Expiration` string, date, nullable — Expiration date in ISO 8601 format. - `Issuance` string, date, nullable — Date of issuance in ISO 8601 format. - `IssuingCountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `IssuingCountrySubdivisionCode` string, nullable — Identifier of the country subdivision where the document was issued (province, state or region). - `IssuingCity` string, nullable — City where the document was issued. - `IdentityDocumentSupportNumber` string, nullable — Identity document support number. Only required for Spanish identity cards in Spanish hotels. - `Address` OldAddress - `Id` string, uuid — Unique identifier of the address. - `Line1` string, nullable — First line of the address. - `Line2` string, nullable — Second line of the address. - `City` string, nullable — The city. - `PostalCode` string, nullable — Postal code. - `CountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `CountrySubdivisionCode` string, nullable — ISO 3166-2 code of the administrative division, e.g. `DE-BW`. - `Latitude` number, double, nullable — The latitude. - `Longitude` number, double, nullable — The longitude. - `AddressId` string, uuid, nullable — Unique identifier of the `Address` of the customer. - `Classifications` CustomerClassificationEnum[], required — Classifications of the customer. - `Options` CustomerOptionsEnum[], required — Options of the customer. - `ItalianDestinationCode` string, nullable — Value of Italian destination code. - `ItalianFiscalCode` string, nullable — Value of Italian fiscal code. - `ItalianLotteryCode` string, nullable — Italian lottery code. - `CompanyId` string, uuid, nullable — Unique identifier of [Company](https://mews-systems.gitbook.io/connector-api/operations/companies/#company) the customer is associated with. - `MergeTargetId` string, uuid, nullable — Unique identifier of the account ([Customer](https://mews-systems.gitbook.io/connector-api/operations/#customer)) to which this customer is linked. - `ActivityState` string, nullable — [Activity State](https://mews-systems.gitbook.io/connector-api/operations/#activity-state) of customer record, i.e. whether active or deleted. - `IsActive` boolean, required — Whether the customer record is still active. - `PreferredSpaceFeatures` ResourceFeatureClassification[], required — A list of room preferences, such as view type, bed type, and amenities. - `CreatorProfileId` string, uuid, required — Unique identifier of the user who created the customer. - `UpdaterProfileId` string, uuid, required — Unique identifier of the user who last updated the customer. - `Services` Service[], nullable — Services that have been reserved. - `Id` string, uuid, required — Unique identifier of the service. - `EnterpriseId` string, uuid, required — Unique identifier of the [Enterprise](https://mews-systems.gitbook.io/connector-api/operations/enterprises/#enterprise). - `IsActive` boolean, required — Whether the service is still active. - `Name` string, required — Name of the service. - `Names` object, required — All translations of the name. - `StartTime` string, nullable - `EndTime` string, nullable - `Options` ServiceOptions, required — Options of the service. - `BillAsPackage` boolean, required — Products should be displayed as a single package instead of individual items. - `Promotions` Promotions - `BeforeCheckIn` boolean, required — Whether it can be promoted before check-in. - `AfterCheckIn` boolean, required — Whether it can be promoted after check-in. - `DuringStay` boolean, required — Whether it can be promoted during stay. - `BeforeCheckOut` boolean, required — Whether it can be promoted before check-out. - `AfterCheckOut` boolean, required — Whether it can be promoted after check-out. - `DuringCheckOut` boolean, required — Whether it can be promoted during check-out. - `Type` string, nullable - `Ordering` integer, required — Order value for presentation purposes. - `Data` object, required — Additional information about the specific service. - `Discriminator` 'Bookable' | 'Additional' - `Value` union - BookableServiceData - `StartOffset` string, required — Offset from the start of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the default start of the service; expressed in ISO 8601 duration format. - `EndOffset` string, required — Offset from the end of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the default end of the service; expressed in ISO 8601 duration format. - `OccupancyStartOffset` string, required — Offset from the start of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the occupancy start of the service; expressed in ISO 8601 duration format. 'Occupancy start' is used for availability and reporting purposes, it implies the time at which the booked resource is considered occupied. - `OccupancyEndOffset` string, required — Offset from the end of the [time unit](https://mews-systems.gitbook.io/connector-api/concepts/time-units/) which defines the occupancy end of the service; expressed in ISO 8601 duration format. 'Occupancy end' is used for availability and reporting purposes, it implies the time at which the booked resource is no longer considered occupied. - `TimeUnit` 'Day' | 'Month' | 'Hour', required — Day Month Hour - `TimeUnitPeriod` 'Day' | 'Month' | 'Hour', required — Day Month Hour - AdditionalServiceData - `Promotions` Promotions, required - `BeforeCheckIn` boolean, required — Whether it can be promoted before check-in. - `AfterCheckIn` boolean, required — Whether it can be promoted after check-in. - `DuringStay` boolean, required — Whether it can be promoted during stay. - `BeforeCheckOut` boolean, required — Whether it can be promoted before check-out. - `AfterCheckOut` boolean, required — Whether it can be promoted after check-out. - `DuringCheckOut` boolean, required — Whether it can be promoted during check-out. - `ExternalIdentifier` string, nullable — Identifier of the service from external system. - `CreatedUtc` string, date-time, required — Creation date and time of the service in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the service in UTC timezone in ISO 8601 format. - `Products` Product[], nullable — Products orderable with reservations. - `Id` string, uuid, required — Unique identifier of the product. - `ServiceId` string, uuid, required — Unique identifier of the [Service](https://mews-systems.gitbook.io/connector-api/operations/services/#service). - `CategoryId` string, uuid, nullable — Unique identifier of the Product category. - `AccountingCategoryId` string, uuid, nullable — Unique identifier of [Accounting Category](https://mews-systems.gitbook.io/connector-api/operations/accountingcategories/#accounting-category). - `IsActive` boolean, required — Whether the product is still active. - `IsDefault` boolean - `Name` string, nullable — Name of the product. **Deprecated!** Please use Names - `Names` object, required — All translations of the name. - `ExternalName` string, nullable — Name of the product meant to be displayed to customer. **Deprecated!** Please use ExternalNames - `ExternalNames` object, required — All translations of external name. - `ShortName` string, nullable — Short name of the product. **Deprecated!** Please use ShortNames - `ShortNames` object, required — All translations of short name. - `Description` string, nullable — Description of the product. **Deprecated!** Please use Descriptions - `Descriptions` object, nullable — All translations of descriptions. - `Charging` 'Once' | 'PerTimeUnit' | 'PerPersonPerTimeUnit' | 'PerPerson' — Once PerTimeUnit PerPersonPerTimeUnit PerPerson - `ChargingMode` 'Once' | 'PerTimeUnit' | 'PerPersonPerTimeUnit' | 'PerPerson', required — Once PerTimeUnit PerPersonPerTimeUnit PerPerson - `Posting` 'Once' | 'Daily' — Once Daily - `PostingMode` 'Once' | 'PerTimeUnit', required — Once PerTimeUnit - `Options` ProductOptions, required - `BillAsPackage` boolean, required — Product should be displayed as part of a package. - `ExcludePriceFromOffer` boolean, required — Product's price should not be displayed separately on the offer. - `Promotions` Promotions, required - `BeforeCheckIn` boolean, required — Whether it can be promoted before check-in. - `AfterCheckIn` boolean, required — Whether it can be promoted after check-in. - `DuringStay` boolean, required — Whether it can be promoted during stay. - `BeforeCheckOut` boolean, required — Whether it can be promoted before check-out. - `AfterCheckOut` boolean, required — Whether it can be promoted after check-out. - `DuringCheckOut` boolean, required — Whether it can be promoted during check-out. - `Classifications` ProductClassifications, required - `Food` boolean — Product is classified as food. - `Beverage` boolean — Product is classified as beverage. - `Wellness` boolean — Product is classified as wellness. - `CityTax` boolean — Product is classified as city tax. - `Fee` boolean — Product is classified as fee. - `Price` ExtendedAmount, required - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - `Pricing` object, required - `Discriminator` 'Absolute' | 'Relative' - `Value` union - ExtendedAmount - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - … - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - RelativeProductPrice - `Multiplier` number, double - `Target` string, nullable - `TaxRateCodes` string[], nullable - `ProductIds` string[], nullable - `ImageIds` string[], nullable — Unique identifier of the product image. - `Ordering` integer, required — Order value for presentation purposes. - `ExternalIdentifier` string, nullable — Identifier of the product from external system. - `TaxExemptionReason` 'Unknown' | 'IT_N1' | 'IT_N2_1' | 'IT_N2_2' | 'IT_N3_4' | 'IT_N3_5' | 'IT_N4' | 'IT_N5' | 'PL_ZW' | 'PL_NP' | 'DE_NATO' | 'FR_261_7' | 'FR_262_00_BIS' | 'FR_293_B' — Unknown (Unknown tax exemption reason) IT_N1 (N1 - Escluse ex art.15) IT_N2_1 (N2.1 - Non soggette ad IVA ai sensi degli artt. da 7 a 7-septies del d.P.R. n. 633/72) IT_N2_2 (N2.2 - Non soggette – altri casi) IT_N3_4 (N3.4 - Non imponibili – operazioni assimilate alle cessioni all’esportazione) IT_N3_5 (N3.5 - Non imponibili – a seguito di dichiarazioni d’intento) IT_N4 (N4 - Esenti) IT_N5 (N5 - Regime del margine / IVA non esposta in fattura) PL_ZW (ZW - Zwolniony) PL_NP (NP - Nie podlega) DE_NATO (NATO-ZAbk - Umsatzsteuerbefreiung gemäß Artikel 67(3) NATO-Zusatzabkommen) FR_261_7 (Exonération de TVA, article 261, 7 du CGI) FR_262_00_BIS (Exonération de TVA, article 262-00 bis du CGI) FR_293_B (TVA non applicable, article 293 B du CGI) - `TaxExemptionLegalReference` string, nullable — Legal reference that states why this product is exempt from tax. - `CreatedUtc` string, date-time, required — Creation date and time of the product in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the product in UTC timezone in ISO 8601 format. - `ConsumptionMoment` 'ServiceOrderEnd' | 'ServiceOrderStart' | 'PostingTimeUnit' | 'NextTimeUnit', required — ServiceOrderEnd ServiceOrderStart PostingTimeUnit NextTimeUnit - `Resources` Resource[], nullable — Assigned resources of the reservations. - `Id` string, uuid, required — Unique identifier of the resource. - `EnterpriseId` string, uuid, required — Unique identifier of the `Enterprise`. - `IsActive` boolean, required — Whether the resource is still active. - `ParentResourceId` string, uuid, nullable — Identifier of the parent `Resource` (e.g. room of a bed). - `Name` string, required — Name of the resource (e.g. room number). - `State` 'Dirty' | 'Clean' | 'Inspected' | 'OutOfService' | 'OutOfOrder', required — State of the resource. Dirty Clean Inspected OutOfService OutOfOrder - `Descriptions` object, required — All translations of the description. - `CreatedUtc` string, required — Creation date and time of the resource in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, required — Last update date and time of the resource in UTC timezone in ISO 8601 format. - `Data` object, required — Additional data of the resource. - `Discriminator` 'Space' | 'Object' | 'Person' — Whether the resource is space, object, or person. - `Value` union — Based on `Discriminator`. Currently present only for `Space` resources with [Space resource data](https://mews-systems.gitbook.io/connector-api/operations/resources#space-resource-data). - SpaceData - `FloorNumber` string, required — Number of the floor the space is on. - `LocationNotes` string, nullable — Location notes for the space. It can be, for example, Building number the space is located in or the Parking area the particular parking space is at. - object - object - `ExternalNames` object, required — All translations of external name. - `Directions` object, required — All translations of direction. - `ResourceCategories` ResourceCategory[], nullable — Resource categories of the resources. - `Id` string, uuid, required — Unique identifier of the category. - `EnterpriseId` string, uuid, required — Unique identifier of the `Enterprise`. - `ServiceId` string, uuid, required — Unique identifier of the `Service` of the resource category. - `IsActive` boolean, required — Whether the category is still active. - `Type` 'Room' | 'Bed' | 'Dorm' | 'Apartment' | 'Suite' | 'Villa' | 'Site' | 'Office' | 'MeetingRoom' | 'ParkingSpot' | 'Desk' | 'TeamArea' | 'Membership' | 'Tent' | 'CaravanOrRV' | 'UnequippedCampsite' | 'Bike' | 'ExtraBed' | 'Cot' | 'Crib' | 'ConferenceRoom' | 'Rooftop' | 'Garden' | 'Restaurant' | 'Amphitheater' | 'PrivateSpaces', required — Type of the category. - `Classification` 'StandardSingle' | 'StandardDouble' | 'SuperiorTwin' | 'SuperiorDouble' | 'JuniorSuite' | 'SharedOrDorm' | 'Other' | 'SuperiorSingle' | 'Triple' | 'Family' | 'StandardTwin' | 'Studio' | 'SuperiorTripleRoom' | 'OneBedroomApartment' | 'ThreeBedroomsApartment' | 'TwoBedroomsApartment', required — Classification of the resource category. - `Names` object, required — All translations of the name. - `ShortNames` object, required — All translations of the short name. - `Descriptions` object, required — All translations of the description. - `Ordering` integer, required — Ordering of the category, lower number corresponds to lower category (note that neither uniqueness nor continuous sequence is guaranteed). - `Capacity` integer, required — Capacity that can be served (e.g. bed count). - `ExtraCapacity` integer, required — Extra capacity that can be served (e.g. extra bed count). - `ExternalIdentifier` string, nullable — Identifier of the resource category from external system. - `AccountingCategoryId` string, uuid, nullable — Unique identifier of the accounting category. - `ResourceCategoryAssignments` ResourceCategoryAssignment[], nullable — Assignments of the resources to categories. - `Id` string, uuid, required — Unique identifier of the assignment. - `IsActive` boolean, required — Whether the assignment is still active. - `ResourceId` string, uuid, required — Unique identifier of the [Resource](https://mews-systems.gitbook.io/connector-api/operations/#resource) assigned to the Resource category. - `CategoryId` string, uuid, required — Unique identifier of the [Resource category](https://mews-systems.gitbook.io/connector-api/operations/#resource-category). - `CreatedUtc` string, date-time, required — Creation date and time of the assignment in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the assignment in UTC timezone in ISO 8601 format. - `BusinessSegments` BusinessSegment[], nullable — Business segments of the reservations. - `Id` string, uuid, required — Unique identifier of the business segment. - `ServiceId` string, uuid, required — Unique identifier of the `Service`. - `IsActive` boolean, required — Whether the business segment is still active. - `Name` string, required — Name of the business segment. - `CreatedUtc` string, date-time, required — Creation date and time of the business segment in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the business segment in UTC timezone in ISO 8601 format. - `Rates` RateForExtent[], nullable — Rates of the reservations. - `Id` string, uuid, required — Unique identifier of the rate. - `GroupId` string, uuid, required — Unique identifier of `Rate Group` where the rate belongs. - `ServiceId` string, uuid, required — Unique identifier of the `Service`. - `BaseRateId` string, uuid, nullable — Unique identifier of the base `Rate`. - `IsBaseRate` boolean, required — Whether the rate is a base rate. - `BusinessSegmentId` string, uuid, nullable — Unique identifier of the `Business Segment`. - `IsActive` boolean, required — Whether the rate is still active. - `IsEnabled` boolean, required — Whether the rate is currently available to customers. - `IsPublic` boolean, required — Whether the rate is publicly available. - `Type` 'Public' | 'Private' | 'AvailabilityBlock', required — Public Private AvailabilityBlock - `Name` string, nullable — Name of the rate (in the default language). - `Names` object, required — All translations of the name. - `ShortName` string, nullable — Short name of the rate (in the default language). - `UpdatedUtc` string, date-time, required — Interval in which the rates were updated. - `ExternalNames` object, nullable — All translations of the external name of the rate. - `Description` object, nullable — All translations of the description of the rate. - `ExternalIdentifier` string, nullable — Identifier of the rate from external system. - `RateGroups` RateGroupOld[], nullable — Rate groups of the reservation rates. - `Id` string, uuid — Unique identifier of the rate group. - `ServiceId` string, uuid — Unique identifier of the Service that the rate group belongs to. - `IsActive` boolean — Whether the rate group is still active. - `Name` string, nullable — Name of the rate group. - `ExternalIdentifier` string, nullable — External identifier of the rate group. - `Items` AccountingItem[], nullable — Accounting items that are part of the reservations. - `Id` string, uuid - `AccountId` string, uuid - `CustomerId` string, uuid, nullable - `OrderId` string, uuid, nullable - `ServiceId` string, uuid, nullable - `ProductId` string, uuid, nullable - `BillId` string, uuid, nullable - `InvoiceId` string, uuid, nullable - `AccountingCategoryId` string, uuid, nullable - `CreditCardId` string, uuid, nullable - `Type` string, nullable - `SubType` string, nullable - `Name` string, nullable - `Notes` string, nullable - `ConsumptionUtc` string, nullable - `ClosedUtc` string, nullable - `State` string, nullable - `SubState` string, nullable - `Amount` ExtendedAmount - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - `TaxExemptionReasonCode` string, nullable — Code of tax exemption reason. **Restricted!** This property is currently intended for Mews' internal usage and may be subject to change. - `OrderItems` OrderItemOld[], nullable — Revenue items of the reservations. - `Id` string, uuid, required — Unique identifier of the item. - `AccountId` string, uuid, required — Unique identifier of the account (for example `Customer`) the item belongs to. - `OrderId` string, uuid, required — Unique identifier of the order (or `Reservation` which is a special type of order) the item belongs to. - `BillId` string, uuid, nullable — Unique identifier of the `Bill` the item is assigned to. - `AccountingCategoryId` string, uuid, nullable — Unique identifier of the `AccountingCategory` the item belongs to. - `UnitCount` integer — Unit count of item, i.e. the number of sub-items or units, if applicable. - `UnitAmount` Amount, required - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `Amount` ExtendedAmount, required - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - `OriginalAmount` ExtendedAmount, required - `Currency` string, currency, required — ISO-4217 code of the [Currency](https://mews-systems.gitbook.io/connector-api/operations/currencies/#currency). - `NetValue` number, double, required — Net value without taxes. - `GrossValue` number, double, required — Gross value including all taxes. - `TaxValues` TaxValue[], required — The tax values applied. - `Code` string, nullable — Code corresponding to tax type. - `Value` number, double, required — Amount of tax applied. - `Breakdown` TaxBreakdown, required - `Items` TaxBreakdownItem[], required — Tax breakdown items per each tax rate applied. - `TaxRateCode` string, nullable — Tax rate code for the item. `null` for untaxed amounts. - `NetValue` number, double, required — The net value that the tax is calculated from. - `TaxValue` number, double, required — The value of the tax. - `Value` number, double, nullable - `Net` number, double, nullable - `Tax` number, double, nullable - `TaxRate` number, double, nullable - `RevenueType` string, required — Revenue type of the item. - `CreatorProfileId` string, uuid, required — Unique identifier of the user who created the item. - `UpdaterProfileId` string, uuid, required — Unique identifier of the user who updated the item. - `CreatedUtc` string, date, required — Creation date and time of the item in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date, required — Last update date and time of the item in UTC timezone in ISO 8601 format. - `ConsumedUtc` string, date, nullable — Date and time of the item consumption in UTC timezone in ISO 8601 format. - `CanceledUtc` string, date, nullable — Cancellation date and time of the item in UTC timezone in ISO 8601 format. - `ClosedUtc` string, date, nullable — Date and time of the item bill closure in UTC timezone in ISO 8601 format. - `StartUtc` string, date, nullable — Start date and time of the item in UTC timezone in ISO 8601 format. - `AccountingState` string, required — Accounting state of the item. - `Data` object, required — Additional data specific to particular order item. - `Discriminator` 'CancellationFee' | 'Rebate' | 'Deposit' | 'ExchangeRateDifference' | 'CustomItem' | 'Surcharge' | 'SurchargeDiscount' | 'SpaceOrder' | 'ProductOrder' | 'Other' | 'TaxCorrection' | 'ResourceUpgradeFee' | 'InvoiceFee' - `Value` union — Based on order item discriminator or `null` for types without any additional data. - RebateOrderItemData - `RebatedItemId` string, uuid, required — Unique identifier of `OrderItem` which has been rebated by current item. - ProductOrderItemData - `ProductId` string, uuid, required — Unique identifier of the `Product`. - `AgeCategoryId` string, uuid, nullable — Unique identifier of the `AgeCategory`. - `Notes` OrderNote[], nullable — Notes of the reservations. - `Id` string, uuid — Unique identifier of the service order note. - `OrderId` string, uuid — Unique identifier of the `Service order` to which the Service Order Note belongs. - `Text` string, nullable — Content of the service order note. - `Type` 'General' | 'ChannelManager' | 'SpecialRequest' — General ChannelManager SpecialRequest - `CreatedUtc` string, date-time, nullable — Creation date and time of the service order note in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, nullable — Last update date and time of the service order note in UTC timezone in ISO 8601 format. - `QrCodeData` ReservationQrCodeData[], nullable — QR code data of the reservations. - `ReservationId` string, uuid — Unique identifier of the reservation. - `Data` string, nullable — Reservation data for QR code generation. - `Companies` Company[], nullable — Companies related to the reservations. - `Id` string, uuid, required — Unique identifier of the company. - `ChainId` string, uuid, required — Unique identifier of the chain. - `Name` string, required — Name of the company. - `MotherCompanyId` string, uuid, nullable — Unique identifier of mother company. - `InvoicingEmail` string, email, nullable — Email for issuing invoices to the company. - `WebsiteUrl` string, uri, nullable — The website url of the company. - `InvoiceDueInterval` string, nullable — The maximum time, when the invoice has to be be paid in ISO 8601 duration format. - `Options` CompanyOptions, required — Options of the company. - `Invoiceable` boolean — Whether the company is invoiceable or not. - `AddFeesToInvoices` boolean — Whether the company has an additional fee applied for invoicing or not. - `AddTaxDeductedPaymentToInvoices` boolean — Whether tax-deducted payments should be automatically added to invoices. - `CreditRating` CreditRating, required — Credit rating to define creditworthiness of the company. - `Basic` 'CreditOk' | 'PaymentRequiredUpfront' | 'LocalDecisionRequired' — CreditOk (Company can book services.) PaymentRequiredUpfront (Company must pay upfront.) LocalDecisionRequired (Requires local approval.) - `Department` string, nullable — The internal segmentation of a company, e.g. sales department. - `DunsNumber` string, nullable — The Dun & Bradstreet unique 9-digit DUNS number. - `ReferenceIdentifier` string, nullable — External system identifier - custom identifier used by an external system such as an external database. - `AccountingCode` string, nullable — Accounting code of the company. - `AdditionalTaxIdentifier` string, nullable — Additional tax identifier of the company. - `BillingCode` string, nullable — Billing code of the company. - `Contact` string, nullable — Other contact details, such as telephone, email or similar. - `ContactPerson` string, nullable — Contact person of the company. - `ElectronicInvoiceIdentifier` string, nullable — Electronic invoice identifier of the company. - `Identifier` string, nullable — Fiscal or legal identifier of the company. - `Iata` string, nullable — Iata of the company. - `IsActive` boolean, required — Whether the company is still active. - `Notes` string, nullable — Additional notes. - `Number` integer, required — Unique number of the company (max 19 digits). - `TaxIdentifier` string, nullable — Tax identification number of the company. - `Telephone` string, tel, nullable — Contact telephone number. - `CreatedUtc` string, date-time, nullable — Date of [Company](https://mews-systems.gitbook.io/connector-api/operations/#company) creation date and time. - `UpdatedUtc` string, date-time, nullable — Date of [Company](https://mews-systems.gitbook.io/connector-api/operations/#company) last update date and time. - `Address` OldAddress - `Id` string, uuid — Unique identifier of the address. - `Line1` string, nullable — First line of the address. - `Line2` string, nullable — Second line of the address. - `City` string, nullable — The city. - `PostalCode` string, nullable — Postal code. - `CountryCode` string, nullable — ISO 3166-1 code of the `Country`. - `CountrySubdivisionCode` string, nullable — ISO 3166-2 code of the administrative division, e.g. `DE-BW`. - `Latitude` number, double, nullable — The latitude. - `Longitude` number, double, nullable — The longitude. - `AddressId` string, uuid, nullable — Unique identifier of the company [Address](https://mews-systems.gitbook.io/connector-api/operations/addresses/#account-address). - `MergeTargetId` string, uuid, nullable — Unique identifier of the account (Customer) to which this company is linked. - `TaxIdentificationNumber` string, nullable - `ExternalIdentifier` string, nullable — Identifier of company from external system. - `ResourceAccessTokens` ResourceAccessToken[], nullable — Resource access tokens for the reservations. - `Id` string, uuid, required — Unique identifier of the resource access token. - `EnterpriseId` string, uuid, required — Unique identifier of the `Enterprise`. - `ServiceOrderId` string, uuid, required — Unique identifier of `Reservation`. - `CompanionshipId` string, uuid, nullable — Unique identifier of `Companionship`. - `ResourceId` string, uuid, nullable — Unique identifier of `Resource`. - `Type` 'PinCode' | 'RfidTag', required — Type of stored value. - `Value` string, required — Value of the resource access token. - `SerialNumber` string, nullable — Serial number of the resource access token. - `ValidityStartUtc` string, date-time, required — Marks the start of interval in which the resource access token can be used. - `ValidityEndUtc` string, date-time, required — Marks the end of interval in which the resource access token can be used. - `Permissions` ResourceAccessTokenPermissions, required - `Bed` boolean — Specify whether the resource access token grants permission to access bed. - `Room` boolean — Specify whether the resource access token grants permission to access room. - `Floor` boolean — Specify whether the resource access token grants permission to access floor. - `Building` boolean — Specify whether the resource access token grants permission to access building. - `CreatedUtc` string, date-time, required — Creation date and time of the resource access token in UTC timezone in ISO 8601 format. - `UpdatedUtc` string, date-time, required — Last update date and time of the resource access token in UTC timezone in ISO 8601 format. - `IsActive` boolean, required — Whether the resource access token is still active. - `Cursor` string, uuid, nullable — Unique identifier of the last and hence oldest reservation returned. This can be used in [Limitation](https://mews-systems.gitbook.io/connector-api/guidelines/pagination/#limitation) in a subsequent request to fetch the next batch of older reservations. ## Other responses - `204` — Server has successfully fulfilled the request and there is no additional information to send back. - `400` — Error caused by the client app, e.g. in case of malformed request or invalid identifier of a resource. In most cases, such an error signifies a bug in the client app (consumer of the API). - `401` — Error caused by usage of invalid ClientToken, AccessToken, or you may not have the necessary permission to use the endpoint. - `403` — Server error that should be reported to the end user of the client app. Happens for example when the server-side validation fails or when a business-logic check is violated. - `408` — Error caused by heavy request that takes too long to process (typically tens of seconds). To get around this, request data in smaller batches. For more information, see [Request timeouts](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-timeouts) - `429` — Error caused by too many requests sent in a given amount of time. Response contains `Retry-After` header indicating how long the user agent should wait before making a follow-up request. For more information, see [Request limits](https://mews-systems.gitbook.io/connector-api/guidelines/requests#request-limits). - `500` — Unexpected error on the Mews side. This may be due to a software fault. If such a situation occurs, the error will be logged and the development team notified, however you can raise an issue through GitHub on our [documentation repository](https://github.com/MewsSystems/gitbook-connector-api). --- [API](https://skmtc.net/mews/apis/connector-api.md) · [All operations](https://skmtc.net/mews/apis/connector-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mews/connector-api/revisions/81933a8ff730/schema)