Connector API
Search…
Introduction
Use cases
Guidelines
Operations
Accounting categories
Accounting items
Age categories
Availability blocks
Bills
Business segments
Cashiers
Cashier transactions
Commands
Companies
Companionships
Company contracts
Configuration
Counters
Countries
Credit cards
Currencies
Customers
Departments
Devices
Exchange rates
Images
Languages
Messages
Message threads
Orders
Outlet bills
Outlet items
Outlets
Payments
Preauthorizations
Products
Rates
Reservations
Resource access tokens
Resource blocks
Resources
Restrictions
Rules
Services
Tasks
Tax environments
Taxations
Vouchers
Webhooks
WebSockets
Deprecations
Changelog
Powered By
GitBook
Operations
This section describes all operations supported by the API, organised here by theme.
Configuration
Operation or Endpoint
Description
​
Get configuration
​
Returns configuration of the enterprise and the client
​
Get all countries
​
Returns all countries supported by the API
​
Get all currencies
​
Returns all currencies supported by the API
​
Get all tax environments
​
Returns all tax environments supported by the API
​
Get all taxations
​
Returns all taxations supported in tax environments
​
Get all languages
​
Returns all languages supported by the API
​
Get language texts
​
Returns translations of texts in the specified languages
​
Get image URLs
​
Returns URLs of the specified images
Customers (guests)
Operation or Endpoint
Description
​
Get all customers
​
Returns all customers filtered by identifiers, emails, names and other filters
​
Search customers
​
Searches for customers that are active at the moment in the enterprise, e.g. companions of checked-in reservations or paymasters
​
Get customers open items
​
Returns all open items for the specified customers, i.e. all unpaid items and all deposited payments
​
Add customer
​
Adds a new customer to the system and returns details of the added customer
​
Update customer
​
Updates personal information of a customer
​
Merge customers
​
Merges one customer to another
​
Add customer file
​
Attaches the specified file to the customer profile
Device integrations
Operation or Endpoint
Description
​
Get all devices
​
Returns all devices in the enterprise
​
Get all commands
​
Returns all commands the are still active from the client application point of view
​
Get all commands by ids
​
Returns all commands by their identifiers
​
Add printer command
​
Adds a new printer command representing printing of the specified document on a printer
​
Add key cutter command
​
Adds a new key cutter command representing cutting of a key for the specified reservation
​
Update command
​
Updates state of a command
Enterprises
Operation or Endpoint
Description
​
Get all companies
​
Returns all company profiles of the enterprise, possibly filtered by identifiers, names or other filters
​
Add company
​
Adds a new company to the enterprise
​
Update company
​
Updates information of the company
​
Get all company contracts
​
Returns all contracts between the enterprise and other companies
​
Get all departments
​
Returns all departments of an enterprise associated with the connector integration
​
Get all counters
​
Returns all counters of an enterprise associated with the connector integration
​
Get all outlets
​
Returns all outlets of an enterprise associated with the connector integration
​
Get all resources
​
Returns all resources of an enterprise associated with the connector integration
​
Update resources
​
Updates details of the resources
​
Get all resource blocks
​
Returns all resource blocks (out of order blocks or internal use blocks)
​
Add resource block
​
Adds a new resource block to the specified resource for a defined period of time
​
Delete resource blocks
​
Removes specified resource blocks from the resources
​
Add task
​
Adds a new task to the enterprise, optionally to a specified department
​
Get all tasks
​
Returns all tasks of the enterprise, filtered by identifiers or other filters
Finance
Operation or Endpoint
Description
​
Get all exchange rates
​
Returns all available exchange rates among currencies of the enterprise
​
Get all cashiers
​
Returns all cashiers in the enterprise
​
Get all cashier transactions
​
Returns all cashier transactions created within the specified interval
​
Get all accounting categories
​
Returns all accounting categories of the enterprise associated with the connector integration
​
Get all accounting items
​
Returns all accounting items of the enterprise that were consumed (posted) or will be consumed within the specified interval
​
Update accounting items
​
Updates specified accounting item
​
Get all bills
​
Returns all bills, possibly filtered by customers, identifiers and other filters
​
Add bill
​
Creates new empty bill assigned to specified account
​
Delete bill
​
Removes selected bills
​
Close bill
​
Closes a bill so no further modification to it is possibles
​
Get bill PDF
​
Creates a PDF version of the specified bill
​
Get all outlet items
​
Returns all outlet items of the enterprise that were consumed (posted) or will be consumed within the specified interval
​
Get all credit cards
​
Returns all credit cards, possibly filtered by identifiers, customers or other filters
​
Charge credit card
​
Creates payment for specified customer credit card and charges the credit card via a gateway
​
Add tokenized credit card
​
Adds a new tokenized credit card to the specified customer
​
Get all preauthorizations by customers
​
Returns all preauthorizations of specified customers
​
Add credit card payment
​
Adds a new credit card payment to a bill of the specified customer
​
Add external payment
​
Adds a new external payment to a bill of the specified customer
​
Add alternative payment
​
Adds a new alternative payment to a specified customer
Messages
Operation or Endpoint
Description
​
Get all message threads
​
Get all message threads that you have created
​
Add message thread
​
Creates a new message thread on behalf of the specified customer
​
Get all messages
​
Get all messages belonging to the specified message threads
​
Add messages
​
Add the specified messages to the specified message threads
Reservations
Operation or Endpoint
Description
​
Get all reservations
​
Returns all reservations specified by any identifier, customer or other filter
​
Get all reservation items
​
Returns all revenue items associated with the specified reservations
​
Price reservations
​
Returns prices of reservations with the specified parameters
​
Add reservations
​
Adds the specified reservations as a single group
​
Update reservations
​
Updates information about the specified reservations
​
Confirm reservations
​
Marks all specified reservations as
Confirmed
​
Start reservation
​
Marks a reservation as
Started
(checked in)
​
Process reservation
​
Marks a reservation as
Processed
(checked out)
​
Cancel reservation
​
Cancels all reservation with specified identifiers
​
Update reservation customer
​
Updates customer of a reservation
​
Update reservation interval
​
Updates reservation interval (start, end or both)
​
Add reservation companion
​
Adds a customer as a companion to the reservation
​
Delete reservation companion
​
Removes customer companionship from the reservation
​
Add reservation product
​
Adds a new product order of the specified product to the reservation
Services
Operation or Endpoint
Description
​
Get all services
​
Returns all services offered by the enterprise
​
Get service availability
​
Returns availability of a bookable service in the specified interval
​
Update service availability
​
Updates the number of available resources in the specified resource category by a certain amount
​
Get all availability blocks
​
Returns all availability blocks filtered by services, unique identifiers and other filter
​
Add availability blocks
​
Adds availability blocks which are used to group related availability updates
​
Update availability blocks
​
Updates information about the specified availability block
​
Delete availability blocks
​
Delete availability blocks
​
Get all rules
​
Returns all rules applied with the reservations
​
Get all business segments
​
Returns all business segments of the default service provided by the enterprise
​
Get all rates
​
Returns all rates (pricing setups) and rate groups (condition settings) of the default service provided by the enterprise
​
Get rate pricing
​
Returns prices of a rate in the specified interval
​
Update rate price
​
Updates price of a rate in the specified intervals
​
Get all restrictions
​
Returns all restrictions of the default service provided by the enterprise
​
Add restrictions
​
Adds new restrictions with the specified conditions
​
Delete restrictions
​
Removes restrictions from the service
​
Add order
​
Creates a new order with the specified products and items
​
Get all companionships
​
Returns all companionships based on customers, reservations or reservation groups
​
Get all resource access tokens
​
Returns all resource access tokens based on resource access tokens, reservations or interval
​
Add resource access tokens
​
Adds new resource access tokens with the specified data
Previous
Taxation
Next
Accounting categories
Last modified
30d ago
Copy link
Contents
Configuration
Customers (guests)
Device integrations
Enterprises
Finance
Messages
Reservations
Services