API Operations
This section describes all operations supported by the API, organised here by theme.
Operation or Endpoint | Description |
Merges two or more accounts of the same account type together. | |
Returns all addresses associated with the specified accounts within the enterprise | |
Adds a new address to the system and assigns it to a specified account | |
Updates an existing address in the system assigned to a specified account |
Operation or Endpoint | Description |
Returns configuration of the enterprise and the client | |
Returns all countries supported by the API | |
Returns all currencies supported by the API | |
Returns all tax environments supported by the API | |
Returns all taxations supported in tax environments | |
Returns all languages supported by the API | |
Returns translations of texts in the specified languages | |
Returns URLs of the specified images |
Operation or Endpoint | Description |
Returns all customers filtered by identifiers, emails, names and other filters | |
Searches for customers that are active at the moment in the enterprise, e.g. companions of checked-in reservations or paymasters | |
Returns all open items for the specified customers, i.e. all unpaid items and all deposited payments | |
Adds a new customer to the system and returns details of the added customer | |
Updates personal information of a customer | |
Attaches the specified file to the customer profile |
Operation or Endpoint | Description |
Returns all devices in the enterprise | |
Returns all commands the are still active from the client application point of view | |
Returns all commands by their identifiers | |
Adds a new printer command representing printing of the specified document on a printer | |
Adds a new key cutter command representing cutting of a key for the specified reservation | |
Updates state of a command |
Operation or Endpoint | Description |
Returns all company profiles of the enterprise, possibly filtered by identifiers, names or other filters | |
Adds a new company to the enterprise | |
Updates information of the company | |
Returns all contracts between the enterprise and other companies | |
Adds new company contracts to the enterprise | |
Updates selected company contracts | |
Deletes selected company contracts | |
Returns all departments of an enterprise associated with the connector integration | |
Returns all counters of an enterprise associated with the connector integration | |
Returns all outlets of an enterprise associated with the connector integration | |
Returns all resources of an enterprise associated with the connector integration | |
Updates details of the resources | |
Returns all resource blocks (out of order blocks or internal use blocks) | |
Adds a new resource block to the specified resource for a defined period of time | |
Removes specified resource blocks from the resources | |
Adds a new task to the enterprise, optionally to a specified department | |
Returns all tasks of the enterprise, filtered by identifiers or other filters |
Operation or Endpoint | Description |
Returns all available exchange rates among currencies of the enterprise | |
Returns all cashiers in the enterprise | |
Returns all cashier transactions created within the specified interval | |
Returns all accounting categories of the enterprise associated with the connector integration | |
Returns all accounting items of the enterprise that were consumed (posted) or will be consumed within the specified interval | |
Updates specified accounting item | |
Returns all bills, possibly filtered by customers, identifiers and other filters | |
Creates new empty bill assigned to specified account | |
Removes selected bills | |
Closes a bill so no further modification to it is possibles | |
Creates a PDF version of the specified bill | |
Returns all outlet items of the enterprise that were consumed (posted) or will be consumed within the specified interval | |
Returns all credit cards, possibly filtered by identifiers, customers or other filters | |
Creates payment for specified customer credit card and charges the credit card via a gateway | |
Adds a new tokenized credit card to the specified customer | |
Returns all preauthorizations of specified customers | |
Adds a new credit card payment to a bill of the specified customer | |
Adds a new external payment to a bill of the specified customer | |
Adds a new alternative payment to a specified customer | |
Adds new outlet bills with their items |
Operation or Endpoint | Description |
Returns all loyalty programs of the enterprise | |
Adds new loyalty programs | |
Updates selected loyalty programs | |
Deletes selected loyalty programs | |
Returns all loyalty memberships of the enterprise | |
Adds new loyalty memberships | |
Updates selected loyalty memberships | |
Deletes selected loyalty memberships |
Operation or Endpoint | Description |
Get all message threads that you have created | |
Creates a new message thread on behalf of the specified customer | |
Get all messages belonging to the specified message threads | |
Add the specified messages to the specified message threads |
Operation or Endpoint | Description |
Returns all reservations specified by any identifier, customer or other filter | |
Returns all revenue items associated with the specified reservations | |
Returns prices of reservations with the specified parameters | |
Adds the specified reservations as a single group | |
Updates information about the specified reservations | |
Marks all specified reservations as Confirmed | |
Marks a reservation as Started (checked in) | |
Marks a reservation as Processed (checked out) | |
Cancels all reservation with specified identifiers | |
Updates customer of a reservation | |
Updates reservation interval (start, end or both) | |
Adds a customer as a companion to the reservation | |
Removes customer companionship from the reservation | |
Adds a new product order of the specified product to the reservation | |
Returns all sources associated with a reservation group | |
Returns all possible reservation sources |
Operation or Endpoint | Description |
Returns all routing rules of the enterprise | |
Adds new routing rules | |
Updates selected routing rules | |
Deletes selected routing rules |
Operation or Endpoint | Description |
Returns all notes associated with the given service orders. Service orders can be reservations or product orders. |
Operation or Endpoint | Description |
Returns all services offered by the enterprise | |
Returns availability of a bookable service in the specified interval | |
Updates the number of available resources in the specified resource category by a certain amount | |
Returns all availability blocks filtered by services, unique identifiers and other filter | |
Adds availability blocks which are used to group related availability updates | |
Updates information about the specified availability block | |
Delete availability blocks | |
Returns all rules applied with the reservations | |
Returns all business segments of the default service provided by the enterprise | |
Returns all rates (pricing setups) and rate groups (condition settings) of the default service provided by the enterprise | |
Returns prices of a rate in the specified interval | |
Updates price of a rate in the specified intervals | |
Returns all restrictions of the default service provided by the enterprise | |
Adds new restrictions with the specified conditions | |
Removes restrictions from the service | |
Creates a new order with the specified products and items | |
Returns all companionships based on customers, reservations or reservation groups | |
Returns all resource access tokens based on resource access tokens, reservations or interval | |
Adds new resource access tokens with the specified data | |
Updates resource access token validity intervals and permissions | |
Delete specified resource access tokens | |
Returns all rate vouchers filtered by service, voucher code or voucher identifier | |
Returns all age categories filtered by service |
Last modified 4d ago