Changelog 2023

Changelog 2023

19th December 2023

• Extended Add export with Customer and Company entity types.
• Added Twint payment type option to Add external payment request.

12th December 2023

• Extended Product with Names, ExternalNames, ShortNames and Descriptions.
• Deprecated properties in Product
  • Name. Use Names instead.
  • ExternalName. Use ExternalNames instead.
  • ShortName. Use ShortNames instead.
  • Description. Use Descriptions instead.

8th December 2023

• Extended Add export with Payment and Reservation entity types.

5th December 2023

• Deprecated EditableHistoryInterval property in Get configuration and Get all enterprises. Use AccountingEditableHistoryInterval and OperationalEditableHistoryInterval instead.
• Extended Availability adjustment with UpdatedUtc property.

29th November 2023

• Extended Get all resource blocks response with Name and Notes parameters.

28th November 2023

• Added operation Delete addresses.

22nd November 2023

• Extended Update reservations with Options parameter.

21st November 2023

• Extended Bill with AssociatedAccountIds and AssociatedAccountData.
• Deprecated properties in Bill
  • CompanyId. Use AssociatedAccountIds instead.
  • CompanyDetails. Use AssociatedAccountData instead.
• Extended Close bill parameters with AssociatedAccountData and AccountAddress.
• Deprecated properties in Close bill
  • TaxIdentifier. Use AccountTaxIdentifier or AssociatedAccountData instead.
  • CompanyTaxIdentifier. Use AssociatedAccountData instead.
  • Address. Use AccountAddress or AssociatedAccountData instead.
  • CompanyAddress. Use AssociatedAccountData instead.

20th November 2023

• Extended Order item type with TaxCorrection.

2nd November 2023

• Added DepositWireTransfer payment type option to Add external payment request.
• Extended Get all order items response with ServiceId parameter.

1st November 2023

• Added operations:

  • Get all resource category assignments
  • Get all resource category image assignments
  • Get all resource features
  • Get all resource feature assignments

• Deprecated operation extents

  • ResourceCategoryAssignments in Get all resources. Use Get all resource category assignments instead.
  • ResourceCategoryImageAssignments in Get all resources. Use Get all resource category image assignments instead.
  • ResourceFeatures in Get all resources. Use Get all resource features instead.
  • ResourceFeaturesAssignments in Get all resources. Use Get all resource feature assignments instead.

• Extended Add rate with ExternalIdentifier parameter.

31st October 2023

• Added new use case Data export

26th October 2023

• Enabled Portfolio Access Tokens for the Add order operation.
• Added Exports operations, currently in beta-testing:
  • Get all exports
  • Add export

25th October 2023

• Extended Customer Classification with Student classification.

23rd October 2023

• Extended Voucher with new property Type

• Added operations:

  • Add vouchers
  • Update vouchers
  • Delete vouchers
  • Get all voucher codes
  • Add voucher codes
  • Delete voucher codes

• Deprecated operation extent VoucherCodes and Companies in Get all vouchers. Get all voucher codes and Get all companies should be used instead.

• Added new parameter field UpdatedUtc in Get all vouchers.

• Added UpdatedUtc filter for following operations:

  • Get all routing rules
  • Get all payment requests
  • Get all resource access tokens
  • Get all services
  • Get all rules
  • Get all counters
  • Get all company contracts
  • Get all products
  • Get all credit cards
  • Get all departments
  • Get all business segments
  • Get all age categories
  • Get all cashiers
  • Get all accounting categories
  • Get all enterprises

• Extended following responses with new properties CreatedUtc and UpdatedUtc:

  • Routing rule
  • Payment request
  • Resource access token
  • Service
  • Rule
  • Counter
  • Travel agency contract
  • Product
  • Department
  • Business segment
  • Age category
  • Cashier
  • Accouting category

• Extended following responses with new property UpdatedUtc:

  • Credit card
  • Enterprise
  • Configuration enterprise

20th October 2023

• Deprecated operation Extent in Get all bills. Get all payments and Get all order items should be used instead.

6th October 2023

• Updated Pagination documentation

14th September 2023

• Added operation Add rates
• Extended Rate with new properties Type and Descriptions

12th September 2023

• Removed AccountingCounter from Counter Type Discriminator since it is never used.

6th September 2023

• Added operation Delete products.
• Updated Get all product service orders documentation:
  • Removed StartUtc and EndUtc properties which were never exposed.
  • Added documentation for CommanderOrigin property.
• In Get all reservations (ver 2023-06-06) response:
  • Clarified behavior of StartUtc property, which is either the reservation’s scheduled time, or the actual customer check-in time, whichever is earlier.
  • Added new properties ScheduledStartUtc and ActualStartUtc, intended ultimately to replace StartUtc.
  • Deprecated StartUtc, but no discontinuation date has been set for now.

31st August 2023

• Enabled Portfolio Access Tokens for the following operations:
  • Get all message threads
  • Get all messages

29th August 2023

• Enabled Portfolio Access Tokens for the following operations:

  • Add availability blocks
  • Update availability blocks
  • Delete availability blocks

• Extended the following operations by adding EnterpriseId to the request parameters:

  • Add availability blocks
  • Update availability blocks
  • Delete availability blocks

25th August 2023

• Enabled Portfolio Access Tokens for the following operations:

  • Update reservation customer
  • Update reservation interval
  • Price reservations

• Extended the following operations by adding EnterpriseId to the request parameters:

  • Update reservation customer
  • Update reservation interval
  • Price reservations

24th August 2023

• Extended Get all reservations response with CommanderOrigin.

17th August 2023

• Extended Customer Classification with InRoom and WaitingForRoom classifications.

7th August 2023

• Re-write of Kiosk use case, including clarification of payment options

3rd August 2023

• Enabled Portfolio Access Tokens for the following operations:

  • Add customer file

• Extended the following operations by adding ChainId to the request parameters:

  • Add customer file

• Extended the following operation by adding ReservationGroupIds to the request parameters:

  • Get all reservations

2nd August 2023

• Added operation Refund payment.
• Extended Get all payments response with Kind parameter.

28th July 2023

• Enabled Portfolio Access Tokens for the following operations:

  • Close bill
  • Delete bill
  • Add keycutter command
  • Add printer command

• Extended the following operations by adding EnterpriseId to the request parameters:

  • Close bill
  • Delete bill
  • Add keycutter command
  • Add printer command

27th July 2023

• Extended operation Get all restrictions:
  • Added filtering by restriction origin
  • Added restriction origin property to the response

25th July 2023

• Added operation Get all account notes to retrieve account notes.
• Added operation Add account notes to add account notes.
• Added operation Update account notes to update account notes.
• Added operation Delete account notes to delete account notes.
• Extended behavior of operations Set restrictions and Clear restrictions. These operations now only affect restrictions created by 3rd-party integrations.

11th July 2023

• Enabled Portfolio Access Tokens for the following operations:

  • Add loyalty programs
  • Update loyalty programs
  • Add loyalty memberships
  • Update loyalty memberships
  • Add loyalty tiers
  • Add addresses
  • Update addresses
  • Add external payment
  • Update reservations
  • Start reservation
  • Process reservation
  • Cancel reservation
  • Update accounting items
  • Add bill
  • Add payment requests
  • Add customer
  • Update customer
  • Add company
  • Update company

• Extended the following operations by adding ChainId to the request parameters:

  • Add loyalty programs
  • Update loyalty programs
  • Add loyalty memberships
  • Update loyalty memberships
  • Add loyalty tiers
  • Add addresses
  • Update addresses
  • Add customer
  • Update customer
  • Add company
  • Update company

• Extended the following operations by adding EnterpriseId to the request parameters:

  • Add external payment
  • Update reservations
  • Start reservation
  • Process reservation
  • Cancel reservation
  • Update accounting items
  • Add bill
  • Add payment requests

4th July 2023

• Extended Get all reservations 2023-06-06 and Get all product service orders response with StartUtc, EndUtc and AccountType.
• Extended Get all payments with SettlementUtc filter.
• Extended Get all payments response with SettlementUtc and AccountType parameter.
• Extended Get all enterprises with LinkedUtc filter and response with LinkedUtc field.

29th June 2023

• Documentation-only changes to add clarity around endpoint versioning. The deprecated version of Get all reservations is now called Get all reservations (ver 2017-04-12) and the new version is called Get all reservations (ver 2023-06-06). All relevant links have been updated.
• Extended Add bill with Name request parameter to name the newly created bill.

26th June 2023

• Enabled Portfolio Access Tokens for the following operations:
  • Get all reservations 2023-06-06.
  • Get all product service orders.
• Enabled Portfolio Access Tokens for Get rate pricing.

23rd June 2023

• Added operation Get all reservations 2023-06-06.
• Added operation Get all product service orders.
• Deprecated operation Get all reservations. Operation Get all reservations 2023-06-06 should be used instead.
• Deprecated operation Get all reservation items. Operation Get all order items should be used instead.

21st June 2023

• Added operation Get all product categories to retrieve product categories.

• Enabled Portfolio Access Tokens for the following operations:

  • Get all accounting categories.
  • Get all addresses.
  • Get all age categories.
  • Get all availability adjustments.
  • Get all availability blocks.
  • Get all business segments.
  • Get all cancellation policies.
  • Get all cashiers.
  • Get all cashier transactions.
  • Get all companies.
  • Get all companionships.
  • Get all company contracts.
  • Get all counters.
  • Get all credit cards.
  • Get all customers.
  • Get all departments.
  • Get all loyalty memberships.
  • Get all loyalty programs.
  • Get all loyalty tiers.
  • Get all outlet items.
  • Get all payment requests.
  • Get all product categories.
  • Get all rates.
  • Get all reservation groups.
  • Get all resource access tokens.
  • Get all resource blocks.
  • Get all restrictions.
  • Get all resources.
  • Get all routing rules.
  • Get all rules.
  • Get all services.

• Added pagination to the following operations:

  • Get all accounting categories.
  • Get all addresses.
  • Get all age categories.
  • Get all availability adjustments.
  • Get all availability blocks
  • Get all business segments.
  • Get all cashiers.
  • Get all cashier transactions.
  • Get all companionships.
  • Get all counters.
  • Get all credit cards.
  • Get all departments.
  • Get all rates.
  • Get all resource blocks.
  • Get all restrictions.
  • Get all resources.
  • Get all rules.
  • Get all services.

• Extended response objects with EnterpriseId for following:

  • Accounting category.
  • Age category.
  • Cashier.
  • Cashier transaction.
  • Counter.
  • Credit card.
  • Department.
  • Outlet item.
  • Payment request.
  • Reservation group.
  • Resource access token.
  • Resource block.
  • Resource.
  • Routing rule.
  • Service.

• Extended response objects with ChainId for following:

  • Address.
  • Company.
  • Customer.
  • Loyalty membership.
  • Loyalty program.
  • Loyalty tier.

• Extended requests for following endpoints:

  • Get all accounting categories request with EnterpriseIds, AccountingCategoryIds, ActivityStates parameters.
  • Get all addresses request with ChainIds, ActivityStates parameters.
  • Get all age categories request with EnterpriseIds, ActivityStates parameters.
  • Get all availability adjustments request with EnterpriseIds, ActivityStates parameters.
  • Get all availability blocks request with EnterpriseIds parameter.
  • Get all business segments request with EnterpriseIds, Ids, ActivityStates parameters.
  • Get all cancellation policies request with EnterpriseIds parameter.
  • Get all cashiers request with EnterpriseIds, Ids, ActivityStates parameters.
  • Get all cashier transactions request with EnterpriseIds, CashierTransactionIds, ActivityStates parameters.
  • Get all companies request with ChainIds parameter.
  • Get all companionships request with EnterpriseIds, CompanionshipIds parameters.
  • Get all counters request with EnterpriseIds, Type parameters.
  • Get all credit cards request with EnterpriseIds parameter.
  • Get all customers request with EnterpriseIds parameter.
  • Get all departments request with EnterpriseIds, DepartmentIds parameters.
  • Get all loyalty memberships request with ChainIds parameter.
  • Get all loyalty programs request with ChainIds parameter.
  • Get all loyalty tiers request with ChainIds parameter.
  • Get all outlet items request with EnterpriseIds parameter.
  • Get all payment requests request with EnterpriseIds, PaymentRequestIds parameters.
  • Get all rates request with EnterpriseIds parameter.
  • Get all reservation groups request with EnterpriseIds parameter.
  • Get all resource access tokens request with EnterpriseIds parameter.
  • Get all resource blocks request with EnterpriseIds parameter.
  • Get all resources request with EnterpriseIds, ResourceIds parameters.
  • Get all routing rules request with EnterpriseIds parameters.
  • Get all services request with EnterpriseIds, ServiceIds parameters.
  • Get all restrictions request with EnterpriseIds parameter.

• Deprecated BillCounters, ProformaCounters, BillPreviewCounters, ServiceOrderCounters, RegistrationCardCounters in Get all counters. Use Counters instead.

20th June 2023

• Added new page Multi-property for multi-property operation with Portfolio Access Tokens.
• Updated Requests page to add explanation of authentication with Portfolio Access Tokens.

19th June 2023

• Extended Order item with AccountType parameter.

9th June 2023

• Extended Add order with BillId parameter.

7th June 2023

• Extended Loyalty memberships with State.
• Extended Loyalty memberships with CreatorProfile and UpdaterProfile.

24th May 2023

• Extended Add external payment with AccountId property to support Company accounts. CustomerId property was deprecated.
• Extended Add order with AccountId property to support Company accounts. CustomerId property was deprecated.
• AccountId in Bill parameters is allowed to be an Id of a Company.
• Deprecated CustomerId in Bill. Use AccountId instead.

23rd May 2023

• Added operation Get all loyalty tiers to retrieve loyalty tiers.
• Added operation Add loyalty tiers to add loyalty tiers.
• Added operation Update loyalty tiers to update loyalty tiers.
• Added operation Delete loyalty tiers to delete loyalty tiers.
• Added operation Get all resource categories.
• Deprecated operation extent ResourceCategories in Get all resources. Get all resource categories should be used instead.

22nd May 2023

• Extended Loyalty memberships with LoyaltyTierId.

16th May 2023

• Added operation Get all cancellation policies.

11th May 2023

• Added operation Get all reservation groups.

28th April 2023

• Added missing property descriptions to Get all order items

25th April 2023

• Added clarification to values for Reservation origin.

21st April 2023

• Extended loyalty programs with Type and Subscription parameters.
• Added operation Add service order notes.
• Added operation Update service order notes.
• Added operation Delete service order notes.

20th April 2023

• Extended Get all order items with EnterpriseIds filter and Order item with EnterpriseId.
• Extended Get all payments with EnterpriseIds filter and Payment with EnterpriseId.

19th April 2023

• Deprecated operation Get all accounting items . Operation Get all payments and Get all order items should be used instead.

17th April 2023

• Extended Get configuration request with EnterpriseId parameter.
• Deprecated Address in Enterprise and replaced with AddressId.
• Added new page Enterprises with operation Get all enterprises.

12th April 2023

• Added operation Get all order items.

11th April 2023

• Extended Get all accounting items response with OriginalAmount in Order item and Payment item.
• Deprecated AmountDefault in Payment item.

9th April 2023

• Extended Get all rules response with TravelAgencyId in Rule conditions.

6th April 2023

• Updated definitions for external identifiers throughout the API
• Added new page for common object definitions used throughout the API

4th April 2023

• Fixed name of parameter PostCancellationFee in Reservation cancel.
• Added operation Get all payments.

3rd April 2023

• Added operation Clear restrictions.

27th March 2023

• Updated loyalty programs and loyalty memberships operations as restricted.
• Re-wrote the Datetimes section to better explain how date-times are used in the API.
• Updated descriptions for startUtc and endUtc in Restriction Conditions and Restriction set data.
• Other minor improvements to documentation in the Restrictions page.
• Corrected small errors in Set restrictions - removed Identifier and ExternalIdentifier, and updated sample JSON

22nd March 2023

• Added new page Best practices

17th March 2023

• Added operation Set restrictions.

16th March 2023

• Extended Enterprise with AccountingConfiguration in Get configuration.

15th March 2023

• Extended Get all sources with UpdatedUtc and SourceIds filter.
• Extended Get all sources response with UpdatedUtc in Source.
• Extended Get all outlet items with UpdatedUtc filter.
• Extended Get all outlet items response with UpdatedUtc in Outlet bill and Outlet item.

3rd March 2023

• Added new parameter field UpdatedUtc in Get all companionships
• Added new parameter field UpdatedUtc in Get all accountingItems
• Extended Get all source assignments with UpdatedUtc filter.

28th February 2023

• Added new parameter field UpdatedUtc in Get all bills
• Added new response field UpdatedUtc in Get all bills

23rd February 2023

• Extended Get all rates with AvailabilityBlockAssignments extent.
• Extended Get all availability blocks with ReleasedUtc filter.
• Added new page Payment requests with operations:
  • Get all payment requests.
  • Add payment requests.
  • Cancel payment requests.
• Added new page Availability adjustments with operation Get all availability adjustments.

20th February 2023

• Added new use case Mews Payment Terminals
• Added new restricted operation Add payment command.
• Deprecated AssigneeData in Get all bills response and replaced with OwnerData.
• Extended Bill customer data with CustomerID, LegalIdentifiers, BillingCode, LastName, FirstName, SecondLastName, TitlePrefix and with Bill address fields.
• Extended Bill company data with Owner Data LegalIdentifiers, BillingCode, Name, FiscalIdentifier, AdditionalTaxIdentifier and with Bill address fields.
• Extended Payment Items with AmountDefault.
• Deprecated ItalianFiscalCode and ItalianLotteryCode in Bill customer data.

1st February 2023

• Some changes to documentation structure to improve readability and navigability; documentation only, no functional changes to the API

27th January 2023

• Extended Add companies and Update companies with ExternalIdentifier.

26th January 2023

• Extended Add company with ReferenceIdentifierand WebsiteUrl fields.
• Extended Update company with ReferenceIdentifierand WebsiteUrl fields.
• Added ReferenceIdentifierand WebsiteUrl fields in Company.
• Extended Close bill with PurchaseOrderNumber field.
• Extended Bill with PurchaseOrderNumber field.

20th January 2023

• Added ExternalIdentifier to each of the following entities.
  • Product
  • Company
  • Service
  • Rate
  • Rate group
  • Resource category
  • Voucher
  • Enterprise

18th January 2023

• Added pagination to Get all companies
• Added new filter ExternalIdentifiers to Get all companies
• Deprecated Address in Company and replaced with AddressId
• Added new page Service orders [corrected to Service order notes 21st April 2023].
• Added operation Get all service order notes.
• Deprecated BasePrices and replaced it with BaseAmountPrices in the response to Get rate pricing; BaseAmountPrices includes information about the tax breakdown.
• Deprecated Prices and replaced it with AmountPrices in the response to Get rate pricing; AmountPrices includes information about the tax breakdown.
• Extended Get rate pricing response with AmountPrices and AmountPrices in Resource category pricing.

13th January 2023

• Extended Get all addresses with filter parameter UpdatedUtc.

6th January 2023

• Extended Get all rates with filtering parameters RateIds and UpdatedUtc.

Next
Changelog 2022