Operations

This section describes all operations supported by the API:

• ​Configuration - operations related to configuration of the client, enterprise or API.

  • ​Get configuration - returns configuration of the client and enterprise.

  • ​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 languages - returns all languages supported by the API.

  • ​Get language texts - returns translations of texts to a specified language.

  • ​Get image URLs - returns URLs of specified images.

• ​Enterprises - operations related to the enterprise and its settings.

  • ​Get all companies - returns company profiles of the enterprise.

  • ​Get all companies by name - returns company profiles by their name.

  • ​Get all company contracts - returns contracts of the enterprise with companies.

  • ​Get all departments - returns all departments of the enterprise.

  • ​Get all outlets - returns all outlets of the enterprise.

  • ​Get all spaces - returns spaces in the enterprise together with their configuration.

  • ​Get all space blocks - returns space blocks in an interval.

  • ​Update space state - updates state of a space.

  • ​Add task - adds a task to the enterprise.

  • ​Add company - adds a new company to the enterprise.

  • ​Update company - updates a company.

  • ​Add space block - adds a new space block to the room.

• ​Services - operations related to offered services, availability and prices.

  • ​Get all services - returns all services offered by the enterprise.

  • ​Get service availability - returns availability of a service in an interval.

  • ​Get all products - returns all products offered together with services.

  • ​Get all business segments - returns all business segments of a service.

  • ​Get all rates - returns all rates of a service.

  • ​Get all companionships - returns all companionships by filter.

  • ​Get rate pricing - returns prices of a rate in an interval.

  • ​Update rate price - updates prices of a rate.

  • ​Get all restrictions - returns all restrictions of a service.

  • ​Add restrictions - adds new restrictions.

  • ​Delete restrictions - removes restrictions.

  • ​Add order - adds a new service order.

• ​Reservations - operations for retrieval and modifications of reservations.

  • ​Get all reservations - returns all reservations in an interval.

  • ​Get all reservations by ids - returns all reservations by their identifiers.

  • ​Get all reservations by customers - returns all reservations by the customers that own them.

  • ​Get all reservations by numbers - returns all reservations by numbers.

  • ​Get all reservation items - returns all accounting items of reservations.

  • ​Price reservations - returns prices of specified reservations.

  • ​Add reservations - adds a new group of reservations.

  • ​Update reservation - updates a reservation.

  • ​Confirm reservation - confirms a reservation.

  • ​Start reservation - starts (checks in) a reservation.

  • ​Process reservation - processes (checks out) a reservation.

  • ​Cancel reservation - cancels a reservation.

  • ​Update reservation customer - updates customer of a reservation.

  • ​Update reservation interval - updates start (arrival) and end (departure) of a reservation.

  • ​Update reservation space - updates assignment of a reservation to another space.

  • ​Update reservation requested category - updates requested space category of a reservation.

  • ​Add reservation companion - adds a new companion to a reservation.

  • ​Delete reservation companion - deletes a companion from a reservation.

  • ​Add reservation product - adds a new product to the reservation.

• ​Customers - operations for retrieval and modifications of customers.

  • ​Get all customers - returns all customers in an interval.

  • ​Get all customers by ids - returns all customers by their identifiers.

  • ​Get all customers by emails - returns all customers by their emails.

  • ​Get all customers by name - returns all customers by their name.

  • ​Search customers - searches among active customers.

  • ​Get customers open items - returns open items of customers.

  • ​Add customer - adds a new customer.

  • ​Update customer - updates personal/internal information of a customer.

  • ​Merge customers - merges two customers into one.

  • ​Add customer file - adds a new file to a customer.

• ​Finance - operations related to financial settings, bills and payments.

  • ​Get all exchange rates - returns all exchange rates of the enterprise.

  • ​Get all cashiers - returns all cashiers of the enterprise.

  • ​Get all cashier transactions - returns all cashier transactions in an interval.

  • ​Get all accounting categories - returns all accounting categories of the enterprise.

  • ​Get all accounting items - returns all accounting items in an interval.

  • ​Get all bills - returns all bills by filters.

  • ​Get all outlet items - returns all outlet items in an interval.

  • ​Get all credit cards by ids - returns all credit cards by their identifiers.

  • ​Get all credit cards by customers - returns all credit cards of the specified customers.

  • ​Charge credit card - charges specified customer credit card.

  • ​Get all preauthorizations by customers - returns all preauthorizations of the specified customers.

  • ​Add credit card payment - adds a new credit card payment.

  • ​Add tokenized credit card - adds a new tokenized credit card.

  • ​Add external payment - adds a new external payment.

  • ​Add outlet bills - adds new outlet bills with items.

• ​Integrations - operations related to integrations, devices and commands to them.

  • ​Get all devices - returns all physical devices defined in the enterprise.

  • ​Get all commands - returns all active commands issued for the client.

  • ​Get all commands by ids - returns all commands by their identifiers.

  • ​Add printer command - adds a new command for a printer to print a document.

  • ​Add key cutter command - adds a new command for key cutter to cut keys.

  • ​Update command - updates a command for a device.