Terminology and Definitions

• Management Company User ID: The management company user id refers to the unique identification of the User whose inventory you are referencing in the API. It helps identify the specific Management Company (MC) or Property Manager (PM) associated with the inventory.
• UnitID: The UnitID is synonymous with PropertyID and represents a unique identifier for a property or unit within the system.
• Inventory: Inventory refers to the collection of units that are available for the API user and feature a Property or Unit ID to uniquely identify each inventory item. These units represent properties or accommodations that can be managed and booked through the API and are associated to a Management Company (MC) as the source.
• Property Manager (PM): The terms Property Manager (PM), Management Company (MC), and Supplier are used interchangeably to represent the entity responsible for managing and providing rental properties.
• Reservation: A Reservation may also be referred to as a Booking, indicating a confirmed arrangement for a guest to stay at a specific property during a particular period.
• Property: The term Property is equivalent to Unit, representing an individual accommodation available for rental.
• AOA Property: An AOA Property is a Property object that represents a specific type or category of unit. An AOA Property Object Instance refers to a group of inventory from that particular type/category.
  • AOA Properties Usage: If you are using AOA properties, kindly reach out to your CiiRUS technical point of contact for further information and guidance.
• Agent (API User): The Agent, also known as the API User, is a Channel Partner who utilizes the Partner-API to access and interact with the inventory of the Management Company or Property Manager.
• Merchant of Record (MOR): The Agent, also known as the API User, is a Channel Partner who utilizes the API to access and interact with the inventory of the Management Company or Property Manager.
  • The Merchant of Record is the organization held financially liable by the acquiring bank (i.e., the financial institution processing customer credit and/or debit card payments) for full and partial returns to the customer's card, as well as any chargebacks initiated by the customer.

❗️

Required:

Any element or object marked as "Required" must be provided in the API request. It is mandatory for the successful processing of the request.