Altegio
Documentation Powered by Redocly

Altegio REST API (2.0.0)

This is an official document describing the interaction with the Altegio online booking service. API allows third-party developers to perform most operations with the Altegio platform. When designing methods, we tried to adhere to the REST architecture.

  • All interaction with protocol are transpire by TLS encryption (from 1.2 version)
  • Limits are 200 requests per minute or 5 requests per second per IP address
  • URL API: https://api.alteg.io/api/v1
  • Questions, inquiries, error messages can be sent to support@alteg.io

Integration cases with Altegio

  • Data exchange with programs for automation and accounting
  • Integration of online booking in third-party sites and mobile applications (company catalogs, company apps, etc.)

General description of data exchange with Altegio

The API for integration with Altegio contains two groups of methods:

  • Methods requiring user authorization and partner authorization
  • Methods that do not require user authorization, but requiring partner authorization

API Request Authorization

Accessing both the first and second groups of methods requires partner authorization. I.e. passing the partner's unique hash key. API requests are authorized in accordance with RFC 6749 "Resource Owner Password Credentials Grant". When making API requests the HTTP authorization header must include the access key in the following format:

Authorization: Bearer <partner token>

To get this key, please contact us at support@alteg.io and specify:

  • Your company ID
  • Your contacts for communication
  • For what purposes do you plan to use the API.

To get the user API key, use the auth method. The key itself must also be sent in the request header (after the partner key, separated by a comma):

Authorization: Bearer <partner token>, User <user token>

Whether the user needs authorization to work with certain entities should be seen in the descriptions of the data format and sample queries.

Date and time

All dates in the API are presented as strings in ISO 8601 format:

"2014-09-21T23:00:00.000+03:00"

Durations of services and other entities are transferred in seconds. For example, if the service lasts 15 minutes, then the data format is as follows:

{ "length": 900 }

Altegio API Concepts

The API allows you to work with the main entities of the platform:

  • Company

  • User Users can manage companies, they have access rights to certain company. Not all users have access to all settings. In order, to change certain settings, you must first obtain a user API-key with the appropriate privileges.

  • Service category All company services are grouped into a service category.

  • Service As a rule, an appointment is made for a specific service that a particular employee provides in a particular company. The service has a cost range and some other parameters.

  • Employee As a rule, booking is made to a specific employee or resource (for example, a lift or quest room).

  • Employee Schedule Each employee has a work schedule - time intervals during which the employee works with clients.

  • Employee free time Time for which you can make an appointment with an employee, i.e. time intervals in which it is free.

  • Appointment The time interval at which a particular employee provides services to a specific client. The employee is busy during an appointment.

  • Customer The person who booked the service from the company.

Altegio API Data Model

There are four main structures used for working with data:

  • Entity One of the entities listed above, which has unique properties and parameters. Entities can be retrieved, modified, and deleted.

  • Entity Collection A set of entities. For example, a list of companies or a list of services provided by companies. Entities can be added to a collection of entities.

  • Communication entity For example, the relationship of an employee and service determines that a particular employee provides a specific service. Communication may have its properties, for example, the individual price of service for a particular employee

  • Collection of entity relationships For example, a list of services provided by an employee and their properties. You can add links to the collection

Users

User management, in particular working with roles and permissions.

Getting a list of user roles

Returns a list of user roles along with permissions for each role.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

query Parameters
include
Array of strings
Items Value: "user_permissions"

Requested set of an included models.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

Array of objects (Model object "User role")
meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": { }
}

Getting a list of user roles in the context of a company user

Returns a list of user roles along with permissions for each role. Allows to get the editable status for each permission of a company user (is_editable field). This status depends on the current user's permissions.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

user_id
required
number
Example: 123

ID of a user.

query Parameters
include
Array of strings
Items Value: "user_permissions"

Requested set of an included models.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

Array of objects (Model object "User role")
meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": { }
}

Getting permission values and user role

Return user role and list of permissions values.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

user_id
required
number
Example: 123

User id.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Model object "Permissions and user role")

Data on the permissions and user role

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Updating permission values and user role

Updates the role and permissions of the user, as well as the employee who is attached to this user.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

user_id
required
number
Example: 123

User id.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
user_role
string
Enum: "worker" "administrator" "accountant" "manager" "owner"

Name of role

Array of items

List of user permissions values

staff_id
number

Employee ID attached to user

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Model object "Permissions and user role")

Data on the permissions and user role

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "user_role": "worker",
  • "user_permissions": [
    ],
  • "staff_id": 0
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Copy a user to companies

Copies an active user with permissions to several companies at once. Adds the user to company as active if the user has not existed in the company yet. If the user has been already invited to the company, only permissions will be updated, the user still has to accept the invitation.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

user_id
required
number
Example: 123

User id.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
required
Array of objects non-empty unique

List of companies to copy the user to

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "user_company_links": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Removing a user from companies

Removes an active user from several companies at once.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

user_id
required
number
Example: 123

User id.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
required
Array of objects non-empty unique

List of companies to remove the user from

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "user_company_links": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Schedules of records/activities

You can easily manage schedules of records (currently not supported) and activities via this feature.
It is possible to set up several schedule series for each of the days of the week and adjust its settings for specific needs.
You can set up different staff, datetimes, labels, resource instances etc. for different schedule series.

Search a schedule by event

Searches for a schedule by a record or activity linked to it or by record or activity based on.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

entity_type
required
string
Enum: "record" "activity"
Example: activity

Type of an entity schedule is searched by:
record - individual record, currently not supported;
activity - group activity.

entity_id
required
number
Example: 123

ID of an entity schedule is searched by.

query Parameters
include
Array of strings
Items Enum: "days" "days.events_master" "days.events_labels" "days.events_resource_instances"

Requested set of an included models.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Schedule")

Data for an existing schedule in a company.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Create a schedule

Creates a schedule of records or activities based on original entity.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

query Parameters
include
Array of strings
Items Value: "days"

Requested set of an included models.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
original_entity_type
required
string
Enum: "record" "activity"

Type of entity the schedule will be based on:
record - individual record, currently not supported;
activity - group activity.

original_entity_id
required
number

ID of entity the schedule will be based on.

date_end
required
string <date>

Date of the schedule end.

required
Array of objects [ 1 .. 7 ] items

Schedule series settings, min of 1 series, max of 7 series (each series corresponds to one day of week).

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Schedule")

Data for an existing schedule in a company.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "original_entity_type": "activity",
  • "original_entity_id": 123,
  • "date_end": "2022-02-01",
  • "days": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Update a schedule

Updates a schedule of records or activities settings.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

schedule_id
required
number
Example: 123

ID of a schedule.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
date_end
string <date>

Date of the schedule end.

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Schedule")

Data for an existing schedule in a company.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "date_end": "2022-02-01"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Delete a schedule

Deletes a schedule completely with all series and records or activities linked to it.

path Parameters
company_id
required
number
Example: 123

ID of a company.

schedule_id
required
number
Example: 123

ID of a schedule.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Create a schedule series

Adds a new series to an existing schedule of records or activities.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

schedule_id
required
number
Example: 123

ID of a schedule.

query Parameters
include
Array of strings
Items Enum: "events_master" "events_labels" "events_resource_instances" "events"

Requested set of an included models.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
day_of_week
required
string
Enum: "mon" "tue" "wed" "thu" "fri" "sat" "sun"

Day of week of the schedule series.

events_master_id
required
number

ID of staff for the events in the schedule series.

events_time
required
string

Time of beginning of the events in the schedule series (as HH:MM:SS).

events_duration
required
number

Duration of the events in the schedule series (as seconds).

events_capacity
required
number

Activities capacity in the schedule series (should be equal to 1 for records).

labels_ids
Array of numbers

IDs of labels for the events in the schedule series.

resource_instances_ids
Array of numbers

IDs of resource instances for the events in the schedule series.

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Schedule Series")

Data for an existing schedule series in a company.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "day_of_week": "mon",
  • "events_master_id": 123,
  • "events_time": "14:00:00",
  • "events_duration": 3600,
  • "events_capacity": 4,
  • "labels_ids": [
    ],
  • "resource_instances_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Update a schedule series

Updates a schedule of records or activities series settings.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

schedule_id
required
number
Example: 123

ID of a schedule.

day_id
required
number
Example: 123

ID of a schedule series.

query Parameters
include
Array of strings
Items Enum: "events_master" "events_labels" "events_resource_instances" "events"

Requested set of an included models.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
force
required
boolean

Flag for force override of manual changes in scheduled records/activities.

events_master_id
number

ID of staff for the events in the schedule series.

events_time
string

Time of beginning of the events in the schedule series (as HH:MM:SS).

events_duration
number

Duration of the events in the schedule series (as seconds).

events_capacity
number

Activities capacity in the schedule series (should be equal to 1 for records).

labels_ids
Array of numbers

IDs of labels for the events in the schedule series.

resource_instances_ids
Array of numbers

IDs of resource instances for the events in the schedule series.

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Schedule Series")

Data for an existing schedule series in a company.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "force": false,
  • "events_master_id": 123,
  • "events_time": "14:00:00",
  • "events_duration": 3600,
  • "events_capacity": 4,
  • "labels_ids": [
    ],
  • "resource_instances_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Delete a schedule series

Deletes a schedule series and all records or activities linked to it.

path Parameters
company_id
required
number
Example: 123

ID of a company.

schedule_id
required
number
Example: 123

ID of a schedule.

day_id
required
number
Example: 123

ID of a schedule series.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Get a list of events of scheduled records/activities

Prints a list of events of scheduled records/activities.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

schedule_id
required
number
Example: 123

ID of a schedule.

day_id
required
number
Example: 123

ID of a schedule series.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

Array of objects (Object of model "Event of record/activity in a Schedule")
object (Meta object with response results count)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Create a client schedule

Creates a client schedule including a bunch of records for activities based on existing schedule.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

schedule_id
required
number
Example: 123

ID of a schedule.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
client_id
required
number

ID of client for creating a client schedule.

comer_id
number

ID of client`s comer for creating a client schedule.

schedule_days_ids
required
Array of numbers [ 1 .. 7 ] items

IDs of schedule series, min of 1 series, max of 7 series.

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Client schedule")

Data for an existing client schedule in a company.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "client_id": 123,
  • "comer_id": 123,
  • "schedule_days_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Update a client schedule

Updates client schedule with attaching or detaching of schedule series, causing client records for future schedule activities being created or deleted.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

schedule_id
required
number
Example: 123

ID of a schedule.

client_schedule_id
required
number
Example: 123

ID of a client schedule.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
schedule_days_ids
required
Array of numbers [ 1 .. 7 ] items

IDs of schedule series, min of 1 series, max of 7 series.

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Client schedule")

Data for an existing client schedule in a company.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "schedule_days_ids": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Delete a client schedule

Deletes a client schedule with deletion of all records for future schedule activities.

path Parameters
company_id
required
number
Example: 123

ID of a company.

schedule_id
required
number
Example: 123

ID of a schedule.

client_schedule_id
required
number
Example: 123

ID of a client schedule.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Marketplace

Setting up notifications in the wizard inside the notification showcase takes place in several stages

  • The partner company must provide all the necessary information for the technical implementation of the integration: domain, address for user registration, address for receiving event callbacks.
  • Altegio user confirms acceptance of the terms of integration, a redirect to the registration page in the partner's service takes place. We add the salon_id GET parameter to the route, which stores the ID of the branch that requested registration.
  • After registration, you must send the user back to Altegio by redirecting to the corresponding route.
  • Upon successful payment for the service, you must notify Altegio by sending a ping to the corresponding route.

Address for redirecting a user after registering with a partner service

The user must be redirected to this address in the browser after registration with the data required by the partner service

Authorizations:
bearer
Request Body schema: application/json
salon_id
required
number

Branch ID.

application_id
required
number

Application ID.

api_key
number

API-key for messaging module.

webhook_urls
Array of strings

Webhooks array

Responses

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "api_key": "2f181e2a-5c22-4ae7-9d9b-07104f312c28",
  • "webhook_urls": []
}

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Application installation for branch

The integration settings of the partner service must be sent to this address, after which the application will be configured and installed in the branch

Authorizations:
bearer
Request Body schema: application/json
salon_id
required
number

Branch ID.

application_id
required
number

Application ID.

api_key
number

API-key for messaging module.

webhook_urls
Array of strings

Webhooks array

Responses

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "api_key": "2f181e2a-5c22-4ae7-9d9b-07104f312c28",
  • "webhook_urls": []
}

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Notification to Altegio of successful payment

It is necessary to send a webhook notification to this address about successful payment for services on the side of the service partner

Authorizations:
bearer
Request Body schema: application/json
salon_id
required
number

Branch ID.

application_id
required
number

Application ID.

currency_iso
required
string

Currency ISO (e.g.: USD, EUR, BYN)

payment_sum
required
number

Payment amount.

payment_date
required
string

Date and time of payment.

period_from
required
string

Date from which the paid period begins (inclusive).

period_to
required
string

Date from which the paid period ends (inclusive).

Responses

Response Schema: application/json
success
boolean (Status.)

Status.

object

Data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "currency_iso": "EUR",
  • "payment_sum": 990.99,
  • "payment_date": "2022-01-01 10:10:00",
  • "period_from": "2022-01-01 10:10:00",
  • "period_to": "2022-02-01 10:10:00"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Notifying Altegio of available SMS sender names

This address is intended for sending to Altegio user-accessible SMS sender names. The user will be able to select any available from the transmitted.

Authorizations:
bearer
Request Body schema: application/json
salon_id
required
number

Branch ID.

application_id
required
number

Application ID

short_names
required
Array of strings

Array of SMS names

Responses

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "short_names": [
    ]
}

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Chargeback Notice

Chargeback Notice

Authorizations:
bearer
path Parameters
payment_id
required
number
Example: 123

Payment ID.

Responses

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Response samples

Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}

Webhook FROM Altegio about application events

This is not a valid endpoint. This describes how to send webhooks from Altegio when certain events occur during the application-to-saloon life cycle. Currently available events to receive:

  • uninstall - the event is sent when the application is disabled on the Altegio side.
  • freeze - the event is sent when the integration is frozen due to expiration.

You can set the address for receiving webhooks in the personal account of the Altegio developer.

Request Body schema: application/json
salon_id
required
number

Branch ID.

application_id
required
number

Application ID.

event
required
string
Enum: "uninstall" "freeze"

Event Slug.

partner_token
required
string

Bearer token of the developer's company (to verify the origin of the webhook)

Responses

Request samples

Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "event": "uninstall",
  • "partner_token": "yasdfkjah2328aj"
}

Application status data in any branch

This endpoint is designed to receive information about the installation of the application in a particular branch.

Authorizations:
bearer
path Parameters
salon_id
required
number

Branch ID

application_id
required
number

Application ID

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object
meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Application uninstall

This endpoint is designed to uninstall the application from partner's side.

Authorizations:
bearer
path Parameters
salon_id
required
number

Branch ID

application_id
required
number

Application ID

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Data about the salons that connected the application

This endpoint is designed to get a list of salons that have connected a certain application, with detailed information about them

Authorizations:
bearer
path Parameters
application_id
required
number

Application ID

query Parameters
page
required
number

Page number

count
required
number <= 1000

Number of elements per page

Responses

Response Schema: application/json
success
boolean

Success status (true)

Array of objects

Array of objects

meta
Array of objects

Metadata (empty array)

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": { }
}

Sending SMS through operators

To send an SMS, the operator must provide the address (url_operator) to which requests mentioned further will be sent. Authorization of API requests is performed in accordance with the RFC 6749 “Resource Owner Password Credentials Grant”. When making requests to the API, the HTTP header Authorization must include an access key in the following format: The authorization key (partner_token) must be specified in the settings of the company’s notification module.

Sending SMS

Send SMS

In case of an error, its HTTP code is returned. In some cases, a textual description of the error is also returned. All API methods can return the following error codes:

error code Http status code Title Description
5 400 ENTITY_VALIDATION_ERROR The request body did not pass validation
10 400 FIELD_VALIDATION_ERROR Parameter not validated
32 200 FIELD_VALIDATION_ERROR Not enough funds
15 403 ACCESS_FORBIDDEN The action is not available, the application does not have the required permissions.
20 401 INVALID_PARTNER_TOKEN partner_token missing or invalid
30 404 RESOURCE_NOT_FOUND The resource at the requested path does not exist
Authorizations:
bearer
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: */*
destination_params
required
object

an object containing the send ID and phone number parameters

from
required
string

Sender name

text
required
string

departure text

type
required
string

sending type (sms, viber)

dispatch_type
required
string

mailing type (service - service, adds - advertising)

delivery_callback_url
required
string

url to which message statuses are sent

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Getting message statuses

Get message statuses

Number Title
1 Delivered
2 Not delivered
4 Sent to phone
8 Transferred to the operator
16 Rejected by operator
52 Not enough funds

In case of an error, its HTTP code is returned. In some cases, a textual description of the error is also returned. All API methods can return the following error codes:

error code Http status code Title Description
5 400 ENTITY_VALIDATION_ERROR The request body did not pass validation
10 400 FIELD_VALIDATION_ERROR Parameter not validated
15 403 ACCESS_FORBIDDEN The action is not available, the application does not have the required permissions.
20 401 INVALID_PARTNER_TOKEN partner_token missing or invalid
30 404 RESOURCE_NOT_FOUND The resource at the requested path does not exist

When sending SMS, the delivery_callback_url attribute is passed in the request - this is the url to which message statuses should be sent.

Use it to send message statuses. Url to which message statuses should be sent - https://app.alteg.io/smsprovider/status/callback/{partner_token}

Authorizations:
bearer
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
Array
id
string

Identifier

status
number

Message status

payment_sum
number

Full message cost

currency_iso
string

Currency ISO

parts_amount
number

Amount of message's parts

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "success": true
}

Authorization

Authorize user

When a user changes their password, their API key will change and a new authorization will be required

Attribute Type Description
login string The user's phone number in the format 79161234567 or his Email
password string User password
Authorizations:
bearer
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
login
required
string

Phone number or Email

password
required
string

Password

Responses

Response Schema: application/json
id
integer <int32>

User ID

user_token
string

User_token of the user

name
string

Username

phone
string

User phone

login
string

User login

email
string

User mailing address

avatar
string

Path to the user's avatar file

is_approved
boolean

Is the user verified in the system

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Authorize Online Recording User

When a user of an online account changes their password, their API key will change and a new authorization will be required

Attribute Type Description
login string The visitor's phone number in the format 79161234567 or his Email
password string Visitor password
Authorizations:
bearer
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
login
required
string

Phone number or Email

password
required
string

Password

Responses

Response Schema: application/json
id
integer <int32>

User ID

user_token
string

User_token of the user

name
string

Username

phone
string

User phone

login
string

User login

email
string

User mailing address

avatar
string

Path to the user's avatar file

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Online appointment

Get booking form settings

Each client of the Altegio service can create an unlimited number of online registration forms with different designs and for different recording scenarios.

Usually, the id of the booking form is stored in a subdomain, for example: https://b123.alteg.io, where 123 is the id of the booking form. Using this parameter, you can get all the other parameters necessary for the implementation of online registration, understand whether the registration will take place in a specific company or in a chain of companies.

For the chain widget, you will additionally need to call the [GET] /companies method with the company_id filter and get a list of companies to write to.

The object containing the booking form settings has the following fields:

Field Type Description
steps Array of objects Booking form steps with custom settings
style object Booking form design settings
group_id number Company chain ID (0 - if the entry form is for a non-chain company)
company_id number Company ID (always returned, used to get additional settings)
phone_confirmation boolean Do I need to confirm the phone by SMS (if groupid = 0 (not a group form), otherwise look in the settings of each company separately)
language string Booking form language (code from langs array)
langs array of object List of widget languages
comment_required boolean Whether the field with a comment on the entry is required
metric_counter_id string Yandex.Metrica ID
google_analytics_id string Google Analytics ID
facebook_pixel_id string Facebook Pixel ID
vkontakte_pixel_id string Vkontakte pixel ID
app_metric_id string Yandex AppMetrika ID
sms_enabled boolean Is sending SMS available?
comment_input_name string (optional) Title for the field with a comment to the entry (if not set, the default value is used)
booking_notify_text string (optional) The text of the notification that is displayed (if set) at the step of entering contact data
is_show_privacy_policy boolean Whether it is necessary to display the text of the agreement on the personal data processing policy to the user
specialization_display_mode number Display the specialization or position of the employee. 0 - Specialization, 1 - Position

The steps array consists of objects that have the following fields:

Field Type Description For what steps is specified
step string Step city/company/service/master/datetime/contact/confirm For everyone
title string Name of the step to display in the interface For everyone
number number What number should this step be displayed on (starting from 1) For everyone
default string or number The default value for this step, if set For all but datetime
hidden boolean Hide this step when booking or not For everyone
date_hidden boolean Hide this step when booking or not For datetime
time_hidden boolean Hide this step when booking or not For datetime
date_default string The default value for this step, if set For datetime
time_default number The default value for this step, if set For datetime

The style object has the following fields:

Field Type Description
show header boolean Show header and menu or not
logo string Path to logo image
header_background string Path to subtitle background image
menu_background string Path to menu background image
primaryPalette string The main color of the form (all colors from the list: red, pink, purple, deep-purple, indigo, blue, light-blue, cyan, teal, green, light-green, lime, yellow, amber, orange, deep-orange, brown , grey, blue-grey, white, black)
accentPalette string Form secondary color (subtitle semi-transparent cover)
warnPalette string Color entry form buttons
backgroundPalette string Entry form background color
Authorizations:
bearer
path Parameters
id
required
number
Example: 1

booking form id

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get internationalization options

Translation is available in one of the languages:

  • Latvian - 'lv-LV'
  • English - 'en-US'
  • Estonian - 'ee-EE'
  • Lithuanian - 'lt-LT'
  • German - 'de-DE'
  • Ukrainian - 'uk-UK'
Authorizations:
bearer
path Parameters
langCode
required
string
Example: en-US

Language code. One of the set 'lv-LV', 'en-US', 'ee-EE', 'lt-LT', 'de-DE', 'uk-UK'

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
object
object
object
object
object
and
string
terms-of-agreement
string
data-processing
string
license-agreement
string
personal-data
string
buy-for
string
object
object
object
object
back
string
backCity
string
backFilials
string
backRecordType
string
filials
string
my_profile
string
about_us
string
object
at
string
on
string
h
string
m
string
from
string
dist_m
string
dist_km
string
yesterday
string
today
string
tomorrow
string
Close
string
Yes
string
No
string
refresh
string
online_record_disabled
string
online_record_disabled_long_text
string
object
object
object
object
object
save
string
proceed
string
object
object
object
object
object
object
object
object
object
object
object
object
object
object
object
Jan
string
Feb
string
March
string
Mar
string
Apr
string
May
string
Jun
string
Jul
string
Aug
string
Sep
string
Oct
string
Nov
string
Dec
string
object
object
landscape
string

Response samples

Content type
application/json
{
  • "404": {
    },
  • "action": {
    },
  • "tips": {
    },
  • "payment-status": {
    },
  • "user-data-form": {
    },
  • "and": "and",
  • "terms-of-agreement": "Terms of agreement",
  • "data-processing": "Data processing",
  • "license-agreement": "License agreement",
  • "personal-data": "Your data",
  • "buy-for": "Buy for",
  • "group_booking": {
    },
  • "geo": {
    },
  • "tooltips": {
    },
  • "prepaid": {
    },
  • "back": "Back",
  • "backCity": "Cities",
  • "backFilials": "Branches",
  • "backRecordType": "Record Type",
  • "filials": "Branches",
  • "my_profile": "Cabinet",
  • "about_us": "About Us",
  • "record": {
    },
  • "at": "v",
  • "on": "on the",
  • "h": "h.",
  • "m": "min.",
  • "from": "from",
  • "dist_m": "m",
  • "dist_km": "km",
  • "yesterday": "yesterday",
  • "today": "today",
  • "tomorrow": "tomorrow",
  • "Close": "close",
  • "Yes": "Yes",
  • "No": "Not",
  • "refresh": "Refresh",
  • "online_record_disabled": "Online registration is disabled. <br> We apologize for the inconvenience caused.",
  • "online_record_disabled_long_text": "Online registration is temporarily unavailable. You can still manage your online records in your account, transfer them and delete them.",
  • "address": {
    },
  • "common": {
    },
  • "notification": {
    },
  • "header": {
    },
  • "loyalty": {
    },
  • "save": "Save",
  • "proceed": "Continue",
  • "profile": {
    },
  • "registration": {
    },
  • "menu": {
    },
  • "footer": {
    },
  • "city": {
    },
  • "company": {
    },
  • "steps": {
    },
  • "master": {
    },
  • "cart": {
    },
  • "reviews": {
    },
  • "date": {
    },
  • "time": {
    },
  • "service": {
    },
  • "confirm": {
    },
  • "login": {
    },
  • "Jan": "January",
  • "Feb": "February",
  • "March": "Martha",
  • "Mar": "Martha",
  • "Apr": "April",
  • "May": "May",
  • "Jun": "June",
  • "Jul": "July",
  • "Aug": "august",
  • "Sep": "September",
  • "Oct": "October",
  • "Nov": "november",
  • "Dec": "December",
  • "activity": {
    },
  • "button": {
    },
  • "landscape": "It will be more convenient if you turn the device vertically"
}

Send SMS verification code for phone number

  • Request body
    • phone (required, string, '79991234567') - phone to which the code will be sent
    • fullname (option, sring, James) - Client name
Authorizations:
bearer
path Parameters
company_id
required
number
Example: 4564

Company ID

header Parameters
Accept
required
string

application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
phone
string

Customer phone number

fulname
string

Client name

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

metadata

Request samples

Content type
application/json
{
  • "phone": "+1-315-555-0175",
  • "fulname": "James Smith"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Check recording options

After generating the parameters of the record(s), you can check them for the possibility of creating records.

JSON-Object containing online recording parameters has the following fields:

Field Type Mandatory Description
appointments Array of objects YES Recording options (services, specialists...)

The appointments array consists of objects that have the following fields:

Field Type Mandatory Description
id number Yes Record ID for post-save feedback (see response to request).
services array of numbers NO Array of IDs of the services the client wants to sign up for
staff_id number YES ID of the specialist the client wants to book with (0 if any master is selected)
datetime datetime YES Session date and time in ISO8601 format (passed for each session in the book_times resource)

In response to the parameter check request, an empty response with the code 201 will be returned if the record parameters are in order and records can be created:

If the response is JSON with an HTTP code other than 201, then the record parameters are out of order, and records cannot be created.

Errors that the server may return:

  1. The selected time of one of the entries is already taken. In this case, the response comes with http code 422 and error code 433, as well as the record identifier from the appointments array in the id field

  2. There are no employees available for recording (if the default master was selected). In this case, the response comes with http code 422 and error code 436

  3. The selected time of one of the records intersects with the time of the record created by the same query. In this case, the response comes with http code 422 and error code 437, as well as the record identifier from the appointments array in the id field

  4. There is no record for the specified service. (The company has already removed the selected services) In this case, the response comes with http code 422 and error code 438

Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
appointments
required
Array of objects

Recording options (services, specialists...)

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

metadata

Response Schema: application/json
success
boolean

Execution success status (true)

object

metadata

Request samples

Content type
application/json
{
  • "appointments": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Create a session entry

JSON-Object containing online recording parameters has the following fields:

Field Type Mandatory Description
phone string YES Client's phone number (eg 79161502239)
full name string YES Client name
email string NO Postal address of the client
appointments Array of objects YES Recording options (services, specialists...)
code string NO Phone number confirmation code sent via SMS (only needed if you need to confirm the number)
notify_by_sms number NO How many hours in advance to send an SMS reminder about the appointment (0 if you do not need to be reminded)
notify_by_email number NO How many hours in advance to send an email reminder about the appointment (0 if you do not need to be reminded)
comment string NO Post Comment
api_id string NO External Record ID

The appointments array consists of objects that have the following fields:

Field Type Mandatory Description
id number Yes Record ID for post-save feedback (see response to request).
services array of numbers NO Array of IDs of the services the client wants to sign up for
staff_id number YES ID of the specialist the client wants to book with (0 if any master is selected)
datetime datetime YES Session date and time in ISO8601 format (passed for each session in the book_times resource)
custom_fields key-value object NO Additional entry field values that are returned with the entry

Additional fields in the appointments array

When creating additional record fields (see the "Additional fields" section), it becomes possible to pass your own values for the fields. Additional fields are unique for each company. After creating additional fields, their values for a particular record can be passed in the optional field custom_fields as key-value pairs where key is the "code" field of the additional field. Example:

  • Created an additional record field with code="my_custom_field" type="number", and a second field code="some_another_field" type="list"
  • When creating a record, another attribute was passed in the appointments array element: "" appointments: [{ ... }, { ... custom_fields: { "my_custom_field": 123, "some_another_field": ["first value", "second value"] } }]"
  • When this record is received by the GET method later, the same value of additional fields will be returned in the response

In response to the request to create an appointment, an array of objects will come (the number of objects is equal to the number of objects in the appointments array) with the following fields:

Field Type Description
id number The record ID passed in the appointments array
record_id number Identifier of the entry created in the system
record_hash string Record ID to delete immediately after creation

Errors to be handled:

  1. The entered SMS number verification code is incorrect. In this case, the response comes with http code 422 and error code 432

  2. The selected time of one of the entries is already taken. In this case, the response comes with http code 422 and error code 433, as well as the record identifier from the appointments array in the id field

  3. The user with the specified phone number is blacklisted and cannot be recorded. In this case, the response comes with http-code 403 and error code 434

  4. The user's phone number is in the wrong format. In this case, the response comes with http code 422 and error code 431

  5. The client's name was not specified. In this case, the response comes with http code 422 and error code 435

  6. There are no employees available for recording (if the default master was selected). In this case, the response comes with http code 422 and error code 436

  7. The selected time of one of the records intersects with the time of the record created by the same query. In this case, the response comes with http code 422 and error code 437, as well as the record identifier from the appointments array in the id field

Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
phone
required
string

Customer phone

fullname
required
string

Client name

email
string

Postal address of the client

code
number

Phone confirmation code sent via SMS (mandatory if the company has set phone_conformation = true)

comment
string

Commentary on the post

type
string

Recording source

notify_by_sms
number

How many hours before the visit should send an SMS reminder to the client (0 - if not needed)

notify_by_email
number

How many hours before the visit should an email reminder be sent to the client (0 - if not needed)

api_id
number

Record ID from external system

Array of objects

Recording options (session, services, master)

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Data (array of objects)

meta
Array of objects

Metadata (empty array)

Request samples

Content type
application/json
{
  • "phone": "+1-315-555-0175",
  • "fullname": "James Smith",
  • "email": "[email protected]",
  • "code": "38829",
  • "comment": "test entry!",
  • "type": "mobile",
  • "notify_by_sms": 6,
  • "notify_by_email": 24,
  • "api_id": "777",
  • "appointments": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Move recording to session

Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

record_id
required
number

ID of the record to be migrated

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
datetime
string <date-time>

Date and time to which we want to move the record

comment
string

Post comment

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Data (object)

Request samples

Content type
application/json
{
  • "datetime": 1463754600,
  • "comment": "DODO!"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get an appointment for a session

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

record_id
required
number
Example: 22123

Post ID (enough to view the post if the user is logged in)

record_hash
required
string
Example: 'dawd4fs09rhf0s9fafef0'

HASH records (required to view the record if the user is not authorized)

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
id
number

Record ID

Array of objects

Service ID List

object

Company parameters

object

Employee parameters

clients_count
integer <int32>
date
string <date-time>

04-02T12:00:00Z' (required, string) - Session date

datetime
string <date-time>

Session date in ISO

create_date
string <date-time>

04-02T12:00:00Z' (required, string) - Record creation date

comment
string

Post comment

deleted
boolean

Whether the entry was made (true if removed)

attendance
number

2 - The user confirmed the entry, 1 - The user came, the services were provided, 0 - the user is waiting, -1 - the user did not come to visit

length
number

Session duration

notify_by_sms
number

How many hours in advance to send an SMS reminder about the appointment (0 if you do not need to be reminded)

notify_by_email
number

How many hours in advance to send an email reminder about the appointment (0 if you do not need to be reminded)

master_requested
boolean

Whether a specific specialist was specified when recording (false if "doesn't matter" was specified)

online
boolean

Whether the entry is online or not (false if the entry was made by an administrator)

api_id
string

External entry ID

last_change_date
string <date-time>

The date the entry was last edited

prepaid
boolean

Is online payment available for enrollment

prepaid_confirmed
boolean

Online payment status

activity_id
number

group entry ID

Response samples

Content type
application/json
{
  • "id": 13132699,
  • "services": [
    ],
  • "company": {
    },
  • "staff": {
    },
  • "clients_count": 1,
  • "date": 1508866200,
  • "datetime": "2017-10-24T17:30:00+0000",
  • "create_date": "2017-10-20T21:40:24+0000",
  • "comment": "",
  • "deleted": true,
  • "attendance": 0,
  • "length": 1800,
  • "notify_by_sms": 0,
  • "notify_by_email": 0,
  • "master_requested": false,
  • "online": true,
  • "api_id": "",
  • "last_change_date": "2017-10-24T23:54:02+0000",
  • "prepaid": false,
  • "prepaid_confirmed": false,
  • "activity_id": 0
}

Create an entry in a group event

Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

activity_id
required
number

Group Event ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Request Body schema: */*
fullname
required
string

Client name

phone
required
string

Customer phone (for example 79161502239)

email
string

Postal address of the client

code
number

Phone confirmation code sent via SMS (mandatory if the company has set phone_conformation = true)

comment
string

Post comment

notify_by_sms
integer <int32>

How many hours in advance to send an SMS reminder about the appointment (0 if you do not need to be reminded)

notify_by_email
integer <int32>

How many hours in advance to send an email reminder about the appointment (0 if you do not need to be reminded)

type
string

Recording source

api_id
number

Record ID from external system

clients_count
number

number of seats

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get a list of dates available for booking

The dates available for booking object has the following fields:

Field Type Description
working_days array of working days grouped by month Working days of an employee/organization
working_dates array of dates An array of dates when the employee/organization works
booking_days array of days when there are free sessions Array of days that are available for booking for the specified services
booking_dates array of dates An array of dates when there are free sessions for the service to the selected employee/organization

working days and booking_days have the same format: month:[array of days in this month]

For example, this booking_days: "9": [ "4", "5"] "10": [ "14", "25"] Means that on September 4 and 5, and on October 14 and 25 there are free sessions for booking

The following filters are available:

  • service_ids: Array of service IDs. If you need dates when you can book the specified services
  • staff_id: Employee ID. If you need dates when you can book the specified specialist
  • date: Date within a month, if you need dates for a specific month
Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

query Parameters
service_ids[]
string

Service ID. Filter by the list of service identifiers

staff_id
number
Example: staff_id=0

Employee ID. Filter by employee ID Default: 0

date
string
Example: date=2015-09-01

date in iso8601 format. Filter by month of booking.

date_from
string
Example: date_from=2015-09-01

date in iso8601 format. Start of dates to search. Must be used together with the "date_to" param and overrides the "date" param.

date_to
string
Example: date_to=2015-09-30

date in iso8601 format. End of dates to search. Must be used together with the "date_from" param and overrides the "date" param.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Data (object)

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get a list of services available for booking

The object of services available for booking has the following fields:

Field Type Description
categories array of objects Array of service categories (you can't book a category)
services array of objects Services available for booking by category

An object from the categories array, has the following fields:

Field Type Description
id number Category ID
title string Category name
sex number Category belonging to gender (1 - male, 2 - female, 0 - not specified)
weight number Category weight. Categories are sorted by weight, heavier ones first
api_id string External Category ID

An object from the services array, has the following fields:

Field Type Description
id number Service ID
title string Service name
category_id number Identifier of the category to which the service belongs
weight number Category weight. Services are sorted by weight, heavier ones first
price_min number The minimum cost of the service
price_max number Maximum cost of the service
discount number Service discount
comment string Comment on the service
active number Is the service active
prepaid string Online payment status
sex number Gender for which the service is provided
session_length number Service duration in seconds (only if filter by employee is set)
image string Image services

If you need to get the services provided by a specific specialist, then you need to use the filter by specialist. The following filters are available:

  • staff_id: Employee ID. If you need services that only the selected employee provides
  • datetime: date (in iso8601 format). If you need services that can be booked from the master for a certain time
  • service_ids: Array of service IDs. If a master is already selected, the time and service(s) are within that entry, and another service must be selected.
Authorizations:
bearer
path Parameters
company_id
required
number
Example: 4564

Company ID

query Parameters
staff_id
number
Example: staff_id=0

Employee ID. Filter by employee ID Default: 0

datetime
number
Example: datetime=``

date (in iso8601 format). Filter by service booking date (for example '2005-09-09T18:30') Default: ''

service_ids[]
Array of numbers

Service ID. Filter by the list of identifiers of already selected (within one record) services. It makes sense if a filter by master and date is set.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get a list of the nearest available sessions

The employee's nearest sessions object has the following fields:

Field Type Description
session_date string Next date with available sessions
sessions array List of available sessions

The following filters are available:

  • service_ids: Array of service IDs. If you need sessions, when can you book these services
  • datetime: date (in iso8601 format) for which you want to get the next sessions
Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

staff_id
required
number

Employee ID

query Parameters
service_ids[]
Array of numbers

Service ID. Filter by the list of service identifiers

datetime
number

date in iso8601 format. Filter by date

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get a list of employees available for booking

Each object from the array of employees available for booking has the following fields:

Field Type Description
id number Employee ID
name string Employee name
specialization string Employee specialization
position object Employee position
bookable boolean Does the employee have sessions available for booking
weight number Employee weight. When withdrawing, employees are sorted by weight, heavier first
show_rating number Whether to show employee's rating (1 - show, 0 - don't show)
rating number Employee rating
votes_count number Number of votes rated employee
comments_count number Number of comments to an employee
avatar string Path to employee avatar file
information string Additional information about the employee (HTML format)
session_date string Date of the next day that there are available sessions (only for bookable = true)

The following filters are available:

  • service_ids: Array of service IDs. If you need employees who provide only the selected service
  • datetime: date (in iso8601 format). If you need employees who have sessions for the specified service at the specified time
Authorizations:
bearer
path Parameters
company_id
required
number
Example: 4564

Company ID

query Parameters
service_ids[]
Array of numbers

Service ID. Filter by the list of service identifiers

datetime
number

date in iso8601 format. Filter by service booking date (for example '2005-09-09T18:30')

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects with data

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Get a list of sessions available for booking

The sessions available for booking object has the following fields:

Field Type Description
time string Session time (17:30 for example)
session_length number Session duration in seconds
datetime datetime Date and time of the session in ISO8601 format (must be passed when creating the entry)

The following filters are available:

  • service_ids: Array of service IDs. If you need sessions, when can you book these services
Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

date
required
string

date in iso8601 format. Filter by booking date (eg '2015-09-30')

staff_id
required
number
Example: 0

Employee ID. Filter by employee ID Default: 0

query Parameters
service_ids[]
string

Service ID. Filter by the list of service identifiers

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects with data

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

User entries

Log in with phone number and code

To access their online and offline (made by phone) records, the user must log in by confirming his phone number. To do this, he needs to send a confirmation code to his phone number using the resource "SMS phone number verification code

Authorizations:
bearer
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
login
required
string

Phone number or Email

password
required
string

Password

Responses

Response Schema: application/json
user_token
string

User_token of the user

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "user_token": "wec23fh8cDfFV4432fc352456"
}

Delete user entry

Authorizations:
(beareruser)
path Parameters
record_id
required
number
Example: 22123

Record ID (enough to delete the record if the user is authorized)

record_hash
required
string
Example: 'dawd4fs09rhf0s9fafef0'

HASH records (required to delete the record if the user is not authorized)

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Online Recording Users

Authorize Online Recording User

When a user of an online account changes their password, their API key will change and a new authorization will be required

Attribute Type Description
login string The visitor's phone number in the format 79161234567 or his Email
password string Visitor password
Authorizations:
bearer
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
login
required
string

Phone number or Email

password
required
string

Password

Responses

Response Schema: application/json
id
integer <int32>

User ID

user_token
string

User_token of the user

name
string

Username

phone
string

User phone

login
string

User login

email
string

User mailing address

avatar
string

Path to the user's avatar file

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Send SMS verification code for phone number to change data

The request must contain one of two parameters: company_id or group_id

Authorizations:
(beareruser)
query Parameters
company_id
required
integer

Company ID

group_id
required
integer

Chain ID

phone
required
string

Phone number

header Parameters
Accept
required
string

application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Online Recording User Password Update

Updating the password of an online recording user.

The response comes with a new user token.

Authorizations:
(beareruser)
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
old_password
string

Current Password

new_password
string

New password

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Request samples

Content type
application/json
{
  • "old_password": "qwerty123",
  • "new_password": "example!"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Updating user data online record

Updating the master data of the user of the online record.

When updating a phone number, you need to send the confirmation_code field with the code you need to receive from the resource SMS confirmation code of the phone number to change data

Authorizations:
(beareruser)
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
name
string

Name

email
string

mail

phone
string

Phone number

confirmation_code
string

SMS confirmation code (when changing phone number)

Responses

Request samples

Content type
application/json
{
  • "name": "James Smith",
  • "email": "[email protected]",
  • "phone": "+1-315-555-0175",
  • "confirmation_code": "1234"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Retrieving Online Enrollment User Data

Retrieve online record user data.

Authorizations:
(beareruser)
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
0
string

User Token

id
integer <int32>

User ID

user_token
string

User Token

name
string

Username

phone
string

User phone

login
string

User login

email
string

User mail

avatar
string

User avatar

Response samples

Content type
application/json
{}

Companies

Get a list of companies

Get a list of companies with data

Authorizations:
bearer
query Parameters
id
number
Example: id=4564

Filter by company ID

group_id
number
Example: group_id=83

Filter by company chain ID Default: 83

my
number
Example: my=1

For authorized user only. If you need companies that the user has rights to manage

active
number
Example: active=1

If you need to get only companies with an active license and an available booking

moderated
number
Example: moderated=1

If you need to get only moderated companies, whose content is checked for publication

forBooking
number
Example: forBooking=1

Include date and time of the next free session in the company (ISO8601)

show_groups
number
Example: show_groups=1

Include in the company object a list of chains that this company belongs to

city_id
number
Example: city_id=2

Filter by city ID (cities getting method)

showBookforms
number
Example: showBookforms=1

Include in the company object a list of company online booking forms

vk_api_id
number
Example: vk_api_id=2

Search online booking form by vk_api_id. Works with showBookforms=1

min_id
number
Example: min_id=1000

Filter by minimum company ID

show_deleted
number
Example: show_deleted=1

Include deleted companies

hide_record_type_single
number
Example: hide_record_type_single=1

Hide companies with individual booking

hide_record_type_activity
number
Example: hide_record_type_activity=1

Hide companies with group booking

hide_record_type_mixed
number
Example: hide_record_type_mixed=1

Hide companies with mixed booking

business_group_id
number
Example: business_group_id=1

Filter by business group ID

business_type_id
number
Example: business_type_id=1

Filter by business type ID

yandex
number
Example: yandex=1

Filter by company data synchronization with partner sites activated

include
Array of strings
Items Enum: "staff" "positions" "accounts" "storages" "expenses"
Example: include=staff&include=positions

Include additional data in the company object

count
number

Number of companies per page

page
number

Page number

header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Success status (true)

Array of objects

Array of objects

meta
Array of objects

Metadata (empty array)

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": { }
}

Create a company

Create new company

Authorizations:
(beareruser)
header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
title
string

Company name

country_id
number

ID of the country in which the company is located (method to get a list of countries)

city_id
number

Identifier of the city in which the company is located (method to get a list of cities)

address
string

Company address

site
string

Company website

coordinate_lat
number <float>

Latitude

coordinate_lot
number <float>

Longitude

business_type_id
number

Business type

short_descr
string

Company category

Responses

Response Schema: application/json
success
boolean

Success status (true)

object

data object

meta
Array of objects

Metadata (empty array)

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Request samples

Content type
application/json
{
  • "title": "James Smith LLC",
  • "country_id": 1,
  • "city_id": 2,
  • "address": "New York, 787 Jackson Drive",
  • "site": "james-smith-company.com",
  • "coordinate_lat": "40.730610",
  • "coordinate_lot": "-73.935242",
  • "business_type_id": 1,
  • "short_descr": "Beauty salon"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Get company

Getting information about the company.

Authorizations:
(beareruser)
path Parameters
id
required
number
Example: 37532

The ID of the company to get information about.

query Parameters
my
number
Example: my=1

For authorized user only. If you need additional data for the company that the user has rights to manage

forBooking
number
Example: forBooking=1

Date and time of the next free session in the company (ISO8601).

show_groups
number
Example: show_groups=1

Include in the company object a list of chains that this company belongs to

showBookforms
number
Example: showBookforms=1

Show company online booking forms (widgets)

bookform_id
number
Example: bookform_id=19203

Show url of online booking form with specified ID

header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Response Schema: application/json
object (Response error message)

Additional response data.

object (Response error message)

Additional response data.

Response Schema: application/json
object (Response error message)

Additional response data.

object (Response error message)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Change company

Change company data

Authorizations:
(beareruser)
path Parameters
id
required
number
Example: 37532

Company ID

header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
title
string

Company name

country_id
number

Country ID (has higher priority then country)

country
string

Country

city_id
number

City ID (has higher priority then city)

city
string

City

address
string

Company address

zip
string

Zip code

phones
Array of strings

Company phone numbers

object

Company social media

site
string

Company website

coordinate_lat
number <float>

Latitude

coordinate_lon
number <float>

Longitude

description
string <html>

Description

business_type_id
number <int32>

Business type

short_descr
string

Business category

Responses

Response Schema: application/json
id
number

Company ID

title
string

Company name

country_id
number

Country ID

country
string

Country name

city_id
number

City ID

city
string

City name

timezone_name
string

Timezone name

address
string

Company address

zip
number

Zip code

object

Company social media

site
string

Company website

coordinate_lat
number <float>

Latitude

coordinate_lon
number <float>

Longitude

description
string <html>

Description

business_type_id
number <int32>

Business type

short_descr
string

Business category

phone_confirmation
boolean

Do I need to confirm my phone number via SMS when booking?

group_priority
integer <int32>

The higher the priority, the higher the company when displayed in the list of chain branches

push_notification_phone_confirm
boolean

Confirm client number to send push notifications

access
object

Access rights list

Response Schema: application/json
object (Response error message)

Additional response data.

object (Response error message)

Additional response data.

Response Schema: application/json
object (Response error message)

Additional response data.

object (Response error message)

Additional response data.

Request samples

Content type
application/json
{
  • "title": "James Smith LLC",
  • "country": "United States",
  • "city": "New York",
  • "address": "New York, 787 Jackson Drive",
  • "zip": 11435,
  • "phones": [
    ],
  • "social": {
    },
  • "site": "james-smith-company.com",
  • "coordinate_lat": "40.730610",
  • "coordinate_lon": "-73.935242",
  • "description": "The <strong>James Smith</strong> company",
  • "business_type_id": 1,
  • "short_descr": "Beauty salon"
}

Response samples

Content type
application/json
{
  • "id": 37532,
  • "title": "James Smith LLC",
  • "country_id": 7,
  • "country": "United States",
  • "city_id": 181,
  • "city": "New York",
  • "timezone_name": "Europe/Moscow",
  • "address": "New York, 787 Jackson Drive",
  • "zip": 11435,
  • "coordinate_lat": "40.730610",
  • "coordinate_lon": "-73.935242",
  • "short_descr": "Beauty salon",
  • "social": {
    },
  • "site": "james-smith-company.com",
  • "business_type_id": 1,
  • "description": "The <strong>James Smith</strong> company",
  • "phone_confirmation": true,
  • "group_priority": 900,
  • "push_notification_phone_confirm": 1,
  • "access": { }
}

Delete company

Delete a company.

Authorizations:
(beareruser)
path Parameters
id
required
number
Example: 37532

Company ID

header Parameters
Accept
required
string

Must be application/vnd.api.v2+json

Content-Type
required
string

Must be application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
object (Response error message)

Additional response data.

object (Response error message)

Additional response data.

Response Schema: application/json
object (Response error message)

Additional response data.

object (Response error message)

Additional response data.

Response samples

Content type
application/json
{
  • "errors": {
    },
  • "meta": {
    }
}

Service category

Create a service category

Authorizations:
(beareruser)
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
title
string

Service category name

api_id
string

External Category ID

weight
number

Category weight (used to sort categories when displayed)

staff
Array of numbers

List of IDs of employees providing services from the category

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Request samples

Content type
application/json
{
  • "title": "Haircut very feminine",
  • "api_id": "adw322",
  • "weight": 111,
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get service category

Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

id
required
number

Service Category ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects

object

Metadata (number of categories)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Change service category

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

id
required
number

Service Category ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
title
string

Service category name

api_id
string

External Category ID

weight
number

Category weight (used to sort categories when displayed)

staff
Array of numbers

List of IDs of employees providing services from the category

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects

object

Metadata (number of categories)

Request samples

Content type
application/json
{
  • "title": "Haircut very feminine",
  • "api_id": "adw322",
  • "weight": 111,
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Delete service category

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

id
required
number

Service Category ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Conetnt-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Get a list of chain service categories

Authorizations:
(beareruser)
path Parameters
chain_id
required
integer

Chain ID

query Parameters
include
string
Value: "services"

Include additional resources in response

header Parameters
Accept
required
string

application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
Array
id
integer <int32>

Service Category ID

title
string

Service category name

Array of objects (Root Type for ServiceTitle)

Services in the category (on request)

Response samples

Content type
application/json
[
  • {
    }
]

Get a list of service categories

  • Options
    • company_id (required, number) - company ID
    • id (optional, number) - service category ID (to work with a specific category)
    • staff_id (optional, number) - employee ID (to get categories associated with an employee)
Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

id
required
number

Service Category ID

query Parameters
staff_id
number

Employee ID (to get categories associated with an employee)

header Parameters
Accept
required
string

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects

object

Metadata (number of categories)

Response Schema: application/json
success
boolean

Execution success status (true)

data
string

is null

object

Metadata (error message)

Response Schema: application/json
success
boolean

Execution success status (true)

data
string

is null

object

Metadata (contains possible error messages)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Deprecated. Get a list of service categories Deprecated

Get a list of service categories

Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

id
required
number

Service category identifier

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects

object

Metadata (number of categories)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Services

Create a service

Method to create a service

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorizarion
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
title
string

Service name

category_id
number

Service Category ID

price_min
number <float>

The minimum cost of the service

price_max
number <float>

Maximum cost of the service

duration
number <float>

Service duration, default is 3600 seconds

discount
number <float>

Service discount

comment
string

Comment on the service

weight
number

Service weight (used to sort services when displayed)

active
number

Is the service available for online registration? 1 - available, 0 not available.

api_id
string

External Service ID

Array of objects

Employees providing the service and the duration of the service by each of them

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Request samples

Content type
application/json
{
  • "title": "Men's haircut",
  • "category_id": 83167,
  • "price_min": 1300,
  • "price_max": 1300,
  • "duration": 3600,
  • "discount": 0,
  • "comment": "",
  • "weight": 6,
  • "active": 1,
  • "api_id": "00000000042",
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get a list of services / specific service

  • Parameter
    • company_id (required, number, 1) - company ID
    • service_id (optional, number, 1) - service ID
Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

service_id
required
number

Service ID, if you need to work with a specific service.

query Parameters
staff_id
number

Employee ID, if you want to filter by employee

category_id
number

Category ID, if you want to filter by category

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects with data

object

Metadata (contains the number of services found)

Response Schema: application/json
success
boolean

Execution success status (true)

data
string

is null

object

Metadata (error message)

Response Schema: application/json
success
boolean

Execution success status (true)

data
string

is null

object

Metadata (contains possible error messages)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Change service

Method to change the service

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

service_id
required
number

Service ID

header Parameters
Accept
required
string
Example: application/vnd.yclients.v2+json

e.g. application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
title
required
string

Service name

booking_title
required
string

Service name for booking

category_id
required
number

ID service category

price_min
required
number <float>

Minimum cost of the service

price_max
required
number <float>

Maximum cost of the service

duration
required
number

Service duration, default value is 3600

discount
number <float>

Service discount

comment
string

Comment on the service

is_multi
required
boolean

false - Appointment, true - Event

tax_variant
required
number

Bill ID

vat_id
required
number

VAT ID

is_need_limit_date
required
boolean

The service is available for a limited time

seance_search_start
required
number

Start of period is the booking available, in seconds

seance_search_finish
required
number

End of period is the booking available, in seconds

step
required
number

Display interval of slots, in seconds

seance_search_step
required
number

Search interval of slots, in seconds

weight
number

Service weight (used to sort services when displayed)

active
number

1 - available for online recording, 0 - not available

api_id
string

External Service ID

Array of objects

List of employees providing the service and session duration

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object
meta
Array of objects

Metadata (empty array)

Request samples

Content type
application/json
{
  • "title": "Men's haircut",
  • "booking_title": "Men's haircut",
  • "category_id": 83167,
  • "price_min": 1300,
  • "price_max": 1300,
  • "duration": 3600,
  • "discount": 0,
  • "tax_variant": 1,
  • "vat_id": 3,
  • "is_multi": false,
  • "is_need_limit_date": true,
  • "date_from": "2022-09-19",
  • "date_to": "2022-09-30",
  • "seance_search_start": 36000,
  • "seance_search_finish": 84600,
  • "step": 300,
  • "seance_search_step": 900,
  • "comment": "",
  • "weight": 6,
  • "active": 1,
  • "api_id": "00000000042",
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Deprecated. Get a list of services / specific service Deprecated

Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

service_id
required
number

Service ID, if you need to work with a specific service.

query Parameters
staff_id
number

Employee ID, if you want to filter by employee

category_id
number

Category ID, if you want to filter by category

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects with data

object

Metadata (contains the number of services found)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}

Deprecated. Change service Deprecated

Deprecated. Method to change the service

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

service_id
required
number

Service ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
title
string

Service name

category_id
number

Service Category ID

price_min
number <float>

The minimum cost of the service

price_max
number <float>

Maximum cost of the service

duration
number <float>

Service duration, default is 3600 seconds

discount
number <float>

Service discount

comment
string

Comment on the service

weight
number

Service weight (used to sort services when displayed)

active
number

Is the service available for online registration? 1 - available, 0 not available.

api_id
string

External Service ID

Array of objects

Employees providing the service and the duration of the service by each of them

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Request samples

Content type
application/json
{
  • "title": "Men's haircut",
  • "category_id": 83167,
  • "price_min": 1300,
  • "price_max": 1300,
  • "duration": 3600,
  • "discount": 0,
  • "comment": "",
  • "weight": 6,
  • "active": 1,
  • "api_id": "00000000042",
  • "staff": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Delete a service

Method to remove a service

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

service_id
required
number

Service ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Linking employee providing a service

Creates an employee service link with provided duration and technological card.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

service_id
required
number
Example: 123

ID of service.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
master_id
required
number

ID of an employee who provides the service.

seance_length
required
number

Duration of service provision by the specified employee in seconds,
minimum 300 seconds (5 minutes), maximum 86100 seconds (23 hours 55 minutes).

technological_card_id
required
number or null

ID of technological card used while provisioning the service.

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Service Staff")
meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "master_id": 123,
  • "seance_length": 3600,
  • "technological_card_id": 123
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Updating employee service link settings

Updates an employee service link with provided duration and technological card.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

service_id
required
number
Example: 123

ID of service.

master_id
required
number
Example: 123

ID of staff.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
seance_length
required
number

Duration of service provision by the specified employee in seconds,
minimum 300 seconds (5 minutes), maximum 86100 seconds (23 hours 55 minutes).

technological_card_id
required
number or null

ID of technological card used while provisioning the service.

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Service Staff")
meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "seance_length": 3600,
  • "technological_card_id": 123
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Deleting employee service link

Deletes an employee service link.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

service_id
required
number
Example: 123

ID of service.

master_id
required
number
Example: 123

ID of staff.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

User

Get a list of rights

  • Parameter
    • company_id (required, number, 1) - company ID
Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with access rights categories

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Create and send an invitation

An invitation to manage a branch involves sending a link by e-mail or phone. By clicking on this link, the user, after registration, gets access to the management of the branch in accordance with the assigned rights. Assignment of rights is carried out after sending an invitation in a separate request.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
required
Array of objects

Array of invites

Responses

Response Schema: application/json
success
boolean

Send success status (true)

data
string

Is null

object

Metadata (contains a message that the data has been saved)

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "invites": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Clients

Get a list of clients

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

header Parameters
Accept
required
string

application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
page
number

Page number

page_size
number

The number of output lines per page. Maximum 200. (Default 25)

fields
Array of strings

Fields to be returned in the response

order_by
string
Enum: "id" "name" "phone" "email" "discount" "first_visit_date" "last_visit_date" "sold_amount" "visit_count"

What field to sort by

order_by_direction
string
Enum: "ASC" "DESC"

How to sort (ascending / descending)

operation
string
Enum: "AND" "OR"

Type of transaction

Array of objects

Filters for searching by customers

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects with data

object

Metadata (contains the number of clients found)

Response Schema: application/json
success
boolean

Execution success status (false)

data
string

Contains null

object

Metadata (contains an error message)

Response Schema: application/json
success
boolean

Execution success status (false)

data
string

Contains null

object

Metadata (contains an error message)

Response Schema: application/json
success
boolean

Execution success status (false)

object

Metadata (contains an error message)

Request samples

Content type
application/json
{
  • "page": 1,
  • "page_size": 3,
  • "fields": [
    ],
  • "order_by": "name",
  • "order_by_direction": "desc",
  • "operation": "AND",
  • "filters": [
    ]
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Deprecated. Get a list of clients Deprecated

  • Parameter
    • company_id (required, number, 1) - company ID
    • page (number, 1) - Page number
    • count (number, 20) - Number of clients per page

Client filtering

  • fullname:Joh (optional, string) - Name (part of name) to filter clients
  • phone:7916 (optional, string) - Phone (part of the number) for filtering clients
  • email:test@ (optional, string) - Email (part) for client filtering
  • card:5663rt (optional, string) - Card (part) for filtering customers by loyalty card number
  • paid_min:100 (optional, number) - Minimum paid to the cashier, to filter customers by the amount of payments
  • paid_max:0 (optional, number) - Maximum paid to the cashier, to filter customers by the amount of payments
  • paid_max:0 (optional, number) - Maximum paid to the cashier, to filter customers by the amount of payments
  • id:66 (optional, number) - ID of one client for filtering clients
  • id[]: 66 (optional, array) - IDs of multiple clients to filter
  • changed_after: '2000-01-01T00:00:00' (optional, string) - Filtering clients changed/created since a specific date and time
  • changed_before: '2020-12-31T23:59:59' (optional, string) - Filtering clients changed/created before a specific date and time
Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

query Parameters
fullname
string
Example: fullname=Joh

Name (part of the name) for client filtering

phone
string
Example: phone=7916

Phone (part of the number) for customer filtering

email
string
Example: email=test@

Email (part) for customer filtering

paid_min
number
Example: paid_min=1

Minimum paid to the cashier, to filter customers by the amount of payments

paid_max
number
Example: paid_max=1

Maximum paid to the cashier, to filter customers by the amount of payments

page
number
Example: page=1

Page number

count
number
Example: count=20

Number of customers per page

id
number
Example: id=66

ID of one or more clients to filter clients

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects with data

object

Metadata (contains the page number and number of clients per page)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Add client

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
name
required
string

Client name

surname
string

Client surname

patronymic
string

Client patronymic

phone
required
string

Customer phone

email
string

Client Email

sex_id
number

Gender of the client (1 - male, 2 - female, 0 - unknown)

importance_id
number

Client importance class (0 - none, 1 - bronze, 2 - silver, 3 - gold)

discount
number

Customer Discount

card
string

Client card number

birth_date
string

Date of birth of the client in the format yyyy-mm-dd

comment
string

A comment

spent
number

How much money spent in the company at the time of adding

balance
number

Client balance

sms_check
number

1 - Happy Birthday by SMS, 0 - do not congratulate

sms_not
number

1 - Exclude the client from SMS mailings, 0 - do not exclude

categories
object

Array of customer category IDs

custom_fields
object

Array of additional client fields as "api-key": "value" pairs

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Bulk adding clients

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
name
required
string

Client name

surname
string

Client surname

patronymic
string

Client patronymic

phone
required
string

Customer phone

email
string

Client Email

sex_id
number

Gender of the client (1 - male, 2 - female, 0 - unknown)

importance_id
number

Client importance class (0 - none, 1 - bronze, 2 - silver, 3 - gold)

discount
number

Customer Discount

card
string

Client card number

birth_date
string

Date of birth of the client in the format yyyy-mm-dd

comment
string

A comment

spent
number

How much money spent in the company at the time of adding

balance
number

Client balance

sms_check
number

1 - Happy Birthday by SMS, 0 - do not congratulate

sms_not
number

1 - Exclude the client from SMS mailings, 0 - do not exclude

categories
object

Array of customer category IDs

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Sample request to get a list of client files

A list of downloaded customer files can be obtained by querying the branch ID and the client ID for which the list is to be obtained. The client ID can be retrieved from a collection of clients.

The list is an array of client files.

The client file has the following structure:

| Field | Type | Description | | -----------------| ------- | -------------------------------------------------- ------------------------ | | id | number | File ID | | client_id | number | Client ID | | name | string | Filename with extension | | description | string | File description | | extension | string | File name extension | | mime | string | MIME file type | | link | string | File download link | | date_create | string | File upload date in ISO8601 format | | size | string | Formatted file size string | | username | string | The name of the user who uploaded the file | | user_avatar | string | Avatar of the user who uploaded the file | | can_edit | boolean | Is there a right to change and delete the file? true - there is a right, false - there is no right |

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

client_id
required
number

Client ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects with data

object

Metadata (contains the number of files)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Delete request example

Authorizations:
bearer
path Parameters
company_id
required
number

Company ID

client_id
required
number

Client ID

file_id
required
number

File ID

header Parameters
Accept
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}

Search by customer history

Displays records from the client's browsing history by his ID or phone number. The response includes records and product sales aggregated by visits, filtered by visit status and paid visit status. Result sorted by date and paginated by 25 items (or more if the date of the last entry is the same as next entry date). The client is identified by the input parameter client_id or by client_phone. The rest of the parameters can be empty.
To get data on the next page, you need to execute a request with from and to parameters, received as a result of the current request in the meta field.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
client_id
required
number or null

Client ID.

client_phone
required
string or null

Customer phone number.

from
required
string or null <date>

Period start date.

to
required
string or null <date>

Period end date.

payment_statuses
required
Array of strings
Items Enum: "not_paid" "paid_not_full" "paid_full" "paid_over"

Visit payment status:
not_paid - the visit is not paid, no payments were made for the visit;
paid_not_full - the visit is partially paid;
paid_full - the visit is paid in full, there is no overpayment;
paid_over - there is an overpayment for the visit.
If the filter by payment status is not required, then an empty array [] must be passed.

attendance
required
number or null
Enum: -1 0 1 2

Visit status:
-1: - the client did not come;
0: - waiting for the client;
1: - the client has arrived;
2: - the client has confirmed the entry.

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Customer History Model Object)

Data on customer visits, including records and product sales.

object (An object of date-based pagination information.)

Page navigation information containing information about the current, next, and previous pages. The data is sorted and paginated by date in descending order.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "client_id": 123,
  • "client_phone": "79998887766",
  • "from": "2022-01-31",
  • "to": "2022-02-01",
  • "payment_statuses": [
    ],
  • "attendance": -1
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}

List of a comments for a client

Returns a list of a comments for a client and a files in a client details uploads history.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

client_id
required
number
Example: 123

ID of a company client.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

Array of objects (Object of model "Comment for a client")
object (Meta object with response results count)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Add a comment for a client

Creates a new text comment for a client.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

client_id
required
number
Example: 123

ID of a company client.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Request Body schema: application/json
text
required
string

Text of a comment for a client.

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

object (Object of model "Comment for a client")

Data for an existing comment for a client.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Request validation error message)

Additional response data.

Request samples

Content type
application/json
{
  • "text": "Comment for a client"
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}

Delete a comment for a client

Deletes a comment for a client; does not delete files uploaded that triggered creation of a comment.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

ID of a company.

client_id
required
number
Example: 123

ID of a company client.

comment_id
required
number
Example: 123

ID of a comment for client.

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

Should be equal to application/vnd.api.v2+json

Content-Type
required
string
Example: application/json

Should be equal to application/json

Responses

Response Schema: application/json
success
boolean (Successful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

object (Response error message)

Additional response data.

Response Schema: application/json
success
boolean (Unsuccessful response status)

Response status.

data
object or null (No data in response)

Response data.

meta
object (Empty meta object)

Additional response data.

Response samples

Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": { }
}

Get a client

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

id
required
number

Client ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Edit client

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

id
required
number

Client ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
name
required
string

Client name

surname
string

Client surname

patronymic
string

Client patronymic

phone
required
string

Customer phone

email
string

Client Email

sex_id
number

Gender of the client (1 - male, 2 - female, 0 - unknown)

importance_id
number

Client importance class (0 - none, 1 - bronze, 2 - silver, 3 - gold)

discount
number

Customer Discount

card
string

Client card number

birth_date
string

Date of birth of the client in the format yyyy-mm-dd

comment
string

A comment

spent
number

How much money spent in the company at the time of adding

balance
number

Client balance

sms_check
number

1 - Happy Birthday by SMS, 0 - do not congratulate

sms_not
number

1 - Exclude the client from SMS mailings, 0 - do not exclude

labels
object

Array of customer category IDs

custom_fields
object

Array of additional client fields as "api-key": "value" pairs

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Delete client

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

id
required
number

Client ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Entries

Get list of records

Filtering records

  • staff_id: Employee ID. If you need records for a specific employee

  • client_id: Client ID. If you need specific customer records

  • created_user_id: ID of the user who created the entry. If you need entries created by a specific user

  • start_date: Session date starting from (filter by session date). If you need appointments for a session starting from a specific date

  • end_date: Date of the session until. If you need appointments for a session before a specific date

  • c_start_date: Record creation date starting from (filter by record creation date). If you need records created since a specific date

  • c_end_date: Post creation date by (filter by post creation date).

  • changed_after: The date the entry was modified/created. If you need records created/modified starting from a specific date and time

  • changed_before: The date the entry was modified/created. If you need records created/modified before a specific date and time

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

query Parameters
page
number
Example: page=1

Page number

count
number
Example: count=50

Number of entries per page

staff_id
number
Example: staff_id=7572

Employee ID, if you only need records for a specific employee

client_id
number
Example: client_id=572

Client ID. If you need records for a specific client

created_user_id
number
Example: created_user_id=7572

The ID of the user who created the entry. If you need entries created by a specific user

start_date
string
Example: start_date=1456185600

Session date starting at (filter by session date). If you need appointments for a session starting from a specific date

end_date
string
Example: end_date=1456185600

Session date to. If you need appointments for a session before a specific date

c_start_date
string
Example: c_start_date=1456185600

Record creation date starting from(filter by record creation date). If you need records created since a specific date

c_end_date
string
Example: c_end_date=1456185600

Record creation date by (filter by record creation date).

changed_after
string
Example: changed_after=1456228800

The date the entry was modified/created. If you need records created/modified starting from a specific date and time

changed_before
string
Example: changed_before=1456228800

The date the entry was modified/created. If you need records created/modified before a specific date and time

include_consumables
number
Example: include_consumables=0

Flag for including a list of consumables by records in the response

include_finance_transactions
number
Example: include_finance_transactions=0

flag to include in the response financial transactions by records

with_deleted
boolean

Include deleted records in output (with_deleted=1 will return deleted records as well)

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects with data

object

Metadata (contains the page number and the number of entries per page)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Create a new entry

For group events When creating an entry in a group event, the activity_id parameter becomes mandatory, staff_id, services, datetime, session_length parameters become optional.

Additional fields When creating additional record fields (see the "Additional fields" section), it becomes possible to pass your own values for the fields. Additional fields are unique for each company. After creating additional fields, their values for a particular record can be passed in the optional custom_fields field as key-value pairs where key is the "code" field of the additional field. Example:

  • Created an additional record field with code="my_custom_field" type="number", and a second field code="some_another_field" type="list"

  • Passed another attribute when creating the record: custom_fields: { "my_custom_field": 123, "some_another_field": ["first value", "second value"] }

  • When this record is received by the GET method later, the same value of additional fields will be returned in the response

Authorizations:
(beareruser)
path Parameters
company_id
required
number
Example: 24699

Company ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
staff_id
number

Employee ID

Array of objects

Service parameters (id, cost, discount)

object

Client parameters (phone, name, email)

save_if_busy
boolean

Whether to keep the record if the time is busy or non-working, or give an error

datetime
string <date-time>

Date and time of recording

seance_length
number

Recording duration in seconds

send_sms
boolean

Whether to send SMS with the details of the appointment to the client

comment
string

Post comment

sms_remain_hours
number

How many hours before the visit should send an SMS reminder to the client (0 - if not needed)

email_remain_hours
number

How many hours before the visit should an email reminder be sent to the client (0 - if not needed)

attendance
number

Entry status (2 - User confirmed the entry, 1 - User came, services provided, 0 - user waiting, -1 - user did not come to visit)

api_id
string

External system ID

custom_color
string

Record color

record_labels
Array of strings

Array of post category IDs

object

Additional record fields

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

Array of objects

Array of objects with data

object

Metadata (contains the page number and the number of entries per page)

Request samples

Content type
application/json
{
  • "staff_id": 8886,
  • "services": [
    ],
  • "client": {},
  • "save_if_busy": false,
  • "datetime": 1449907200,
  • "seance_length": 3600,
  • "send_sms": true,
  • "comment": "test entry!",
  • "sms_remain_hours": 6,
  • "email_remain_hours": 24,
  • "attendance": 1,
  • "api_id": "777",
  • "custom_color": "f44336",
  • "record_labels": [
    ],
  • "custom_fields": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Get a list of partner records

Filtering records

  • salon_id: Branch ID

  • start_date: Visit date starting from (filter by visit date). If you need entries starting from a specific visit date

  • end_date: Visit date by (filter by visit date)

  • created_start_date: Record creation date starting from (filter by record creation date). If you need records created since a specific date

  • created_end_date: Post creation date by (filter by post creation date)

  • user_id: user ID

Authorizations:
(beareruser)
query Parameters
page
number
Example: page=1

Page number

editable_length
number
Example: editable_length=50

Number of entries per page, maximum 100

salon_id
number
Example: salon_id=1

Branch ID

start_date
string
Example: start_date='17.01.2018'

Filter by visit date from

end_date
string
Example: end_date='17.01.2018'

Filter by visit date by

created_start_date
string
Example: created_start_date='17.01.2018'

Filter by record creation date from

created_end_date
string
Example: created_end_date='17.01.2018'

Filter by record creation date by

user_id
number
Example: user_id=1

User ID

header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}

Get an entry

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

record_id
required
number

Record ID

query Parameters
include_consumables
number
Example: include_consumables=0
include_finance_transactions
number
Example: include_finance_transactions=0
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Edit Entry

When an entry is changed in a group event, the activity_id parameter becomes required, staff_id, services, datetime, session_length parameters become optional

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

record_id
required
number

Record ID

query Parameters
include_consumables
number
Example: include_consumables=0
include_finance_transactions
number
Example: include_finance_transactions=0
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
staff_id
number

Employee ID

Array of objects

Service parameters (id, cost, discount)

object

Client parameters (phone, name, email)

save_if_busy
boolean

Whether to keep the record if the time is busy or non-working, or give an error

datetime
string <date-time>

Date and time of recording

seance_length
number

Recording duration in seconds

send_sms
boolean

Whether to send SMS with the details of the appointment to the client

comment
string

Post comment

sms_remain_hours
number

How many hours before the visit should send an SMS reminder to the client (0 - if not needed)

email_remain_hours
number

How many hours before the visit should an email reminder be sent to the client (0 - if not needed)

attendance
number

Entry status (2 - User confirmed the entry, 1 - User came, services provided, 0 - user waiting, -1 - user did not come to visit)

api_id
string

External system ID

custom_color
string

Record color

record_labels
Array of strings

Array of post category IDs

object

Additional record fields

Responses

Response Schema: application/json
success
boolean

Success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Request samples

Content type
application/json
{
  • "staff_id": 8886,
  • "services": [
    ],
  • "client": {},
  • "save_if_busy": false,
  • "datetime": 1449907200,
  • "seance_length": 3600,
  • "send_sms": true,
  • "comment": "test entry!",
  • "sms_remain_hours": 6,
  • "email_remain_hours": 24,
  • "attendance": 1,
  • "api_id": "777",
  • "custom_color": "f44336",
  • "record_labels": [
    ],
  • "custom_fields": {
    }
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Delete entry

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Company ID

record_id
required
number

Record ID

query Parameters
include_consumables
number
Example: include_consumables=0
include_finance_transactions
number
Example: include_finance_transactions=0
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Visits

Get a visit

Authorizations:
(beareruser)
path Parameters
visit_id
required
number
Example: Visit ID
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Get visit details

Block "kkm_transaction_details_container"

Flag "last_operation_type"

Meaning Description
0 Print return receipt
1 Print sales receipt

Types of all transactions with cash register

Meaning Description
0 Sales operation (active for a document with the "Visit" type)
1 Sale return operation (active for a document with the "Visit" type)
2 Correction operation
4 Shift opening operation
5 Shift closing operation
9 The operation of obtaining the status of KKM
11 The operation of obtaining the status of the KKM team
12 Correction operation
13 Print X-report
6 Cash deposit
7 Withdrawal of cash

Statuses of all operations with KKM

Meaning Description
0 Connection error with KKM
1 Successfully
2 Sent for printing
3 Runtime error
4 Status check error
5 Waiting for KKM readiness

Document types

Meaning Description
1 Sale of goods
2 Provision of services
3 Arrival of goods
4 Goods write-off
5 Movement of goods
6 Inventory
7 Visit
8 Write-off of consumables
Authorizations:
(beareruser)
path Parameters
salon_id
required
number
Example: Branch ID
record_id
required
number
Example: Record ID
visit_id
required
number
Example: Visit ID
header Parameters
Accept
required
string

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer access_token, User user_token

Responses

Response Schema: application/json
success
boolean

Execution success status (true)

object

Object with data

meta
Array of objects

Metadata (empty array)

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}

Edit visit

Authorizations:
(beareruser)
path Parameters
visit_id
required
number
Example: Visit ID
record_id
required
number
Example: ID entry
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
attendance
required
number

Visit status (2 - The user confirmed the entry, 1 - The user came, the services were provided, 0 - the user is waiting, -1 - the user did not come to the visit)

comment
required
string

A comment

Array of objects

Array of objects of new commodity transactions

deleted_transaction_ids
Array of objects

Array of instance IDs

Array of objects

Array of commodity transactions objects

Array of objects

Array of objects with services

fast_payment
number

Quick payment 1 - cash, 2 - cashless, 129 - cash and print, 130 - cashless and print

Responses

Check PDF for the visit

Authorizations:
(beareruser)
path Parameters
visit_id
required
number
Example: Visit ID
header Parameters
Accept
required
string
Example: application/vnd.api.v2+json

e.g. application/vnd.api.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/pdf
Group events
Create a group event 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
date
required
string <date-time> 
 
date and time


service_id
required
number
 
Service ID


staff_id
required
number
 
Employee ID


capacity
required
number
 
Capacity


resource_instance_ids
Array of numbers
 
Array of resource instance IDs


force
required
boolean
 
Ignore errors (busy master/resources, etc.)


length
number
 
Event duration in seconds


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "date": "2017-10-10 15:30",
  • "service_id": 1185299,
  • "staff_id": 26427,
  • "length": 3600,
  • "capacity": 9,
  • "resource_instance_ids": [
    ],
  • "force": false
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Reading a group event 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


activity_id
required
number
 
group entry ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Group event update 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


activity_id
required
number
 
Group Event ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
date
required
string <date-time> 
 
date and time


service_id
required
number
 
Service ID


staff_id
required
number
 
Employee ID


capacity
required
number
 
Capacity


resource_instance_ids
Array of numbers
 
Array of resource instance IDs


force
required
boolean
 
Ignore errors (busy master/resources, etc.)


length
number
 
Event duration in seconds


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "date": "2017-10-10 15:30",
  • "service_id": 1185299,
  • "staff_id": 26427,
  • "length": 3600,
  • "capacity": 9,
  • "resource_instance_ids": [
    ],
  • "force": false
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Deleting a group event 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


activity_id
required
number
 
group entry ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Group events search filters 
Authorizations:
BearerPartner
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


query Parameters
service_ids
Array of integers
 
 Example:  service_ids=123
Filter by services IDs.


staff_ids
Array of integers
 
 Example:  staff_ids=456
Filter by staff IDs.


resource_ids
Array of integers
 
 Example:  resource_ids=789
Filter by resources IDs.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


Array of objects (Object "Group events search filter") 
 
object (Meta object with response results count) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Finding dates range for group events 
Authorizations:
BearerPartner
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


query Parameters
service_ids
Array of integers
 
 Example:  service_ids=123
Filter by services IDs.


staff_ids
Array of integers
 
 Example:  staff_ids=456
Filter by staff IDs.


resource_ids
Array of integers
 
 Example:  resource_ids=789
Filter by resources IDs.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Object "Dates range for group events search") 
 
Dates range for group events search.


meta
object (Empty meta object) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Finding dates for group events 
Authorizations:
BearerPartner
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


query Parameters
from
required
string
 
 Example:  from=2023-06-01
Search start date (YYYY-MM-DD format).


till
required
string
 
 Example:  till=2023-07-15
Search end date (YYYY-MM-DD format).


service_ids
Array of integers
 
 Example:  service_ids=123
Filter by services IDs.


staff_ids
Array of integers
 
 Example:  staff_ids=456
Filter by staff IDs.


resource_ids
Array of integers
 
 Example:  resource_ids=789
Filter by resources IDs.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Group Event Search 
Authorizations:
BearerPartner
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


query Parameters
from
required
string
 
 Example:  from=2023-06-01
Search start date (YYYY-MM-DD format).


till
required
string
 
 Example:  till=2023-07-15
Search end date (YYYY-MM-DD format).


service_ids
Array of integers
 
 Example:  service_ids=123
Filter by services IDs.


staff_ids
Array of integers
 
 Example:  staff_ids=456
Filter by staff IDs.


resource_ids
Array of integers
 
 Example:  resource_ids=789
Filter by resources IDs.


page
number
 
 Example:  page=1
Page number (default 1).


count
number
 
 Example:  count=25
Page size (default 25).


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of events found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Search for group services 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
 Example:  4564
Company ID


query Parameters
staff_id
number
 
Employee ID to filter


term
string
 
Search by name or part of the service name


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
staff_id
number
 
Employee ID to filter


term
string
 
Search by name or part of the service name


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of services found)


 Request samples 
Content type
application/json
{
  • "staff_id": 1,
  • "term": "test"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Getting duplication strategies for group events 
Duplication of events occurs based on a set of parameters combined in the "duplication strategy" entity






Field
Type
Description





title
string
Strategy name




repeat_mode_id
integer
Repeat mode




days
integer[]
List of days of the week: 0 Sun, 6 Fri




interval
integer
Break in searching for dates, in units of type




content_type
integer
Duplicate records? 1 - no, 2 - yes





The repeat mode can take the values






Meaning
Description
Break unit





1
Daily
Day




2
Weekdays
-




3
Mon Wed Fri
-




4
Tue Thu
-




5
Every week
Week




6
Every month
Month




7
Every year
Year





The days field is relevant only for mode 5 - week, for specifying specific days of repetition
If you specify repeat_mode = 5, days = [1,4], interval = 2, then the event will be
repeat every 3rd week on mon and thurs


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
 Example:  4564
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Create a duplicate group event template 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
title
required
string
 
Name


days
Array of objects
 
Recurrence Days for Weekly Mode


repeat_mode_id
required
number
 
Repeat Mode


interval
number
 
Break in searching for dates


content_type
number
 
Duplicate records? 1 - no, 2 - yes


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Group Event Duplicate Template Update 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
 Example:  4564
Company ID


strategy_id
required
number
 
 Example:  3
Replication strategy ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
title
required
string
 
Name


days
Array of objects
 
Recurrence Days for Weekly Mode


repeat_mode_id
required
number
 
Repeat Mode


interval
number
 
Break in searching for dates


content_type
number
 
Duplicate records? 1 - no, 2 - yes


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Group Event Duplicate Request 
A request for duplication can be made in 3 ways:


    

  • Specifying a list of dates and times to duplicate
    

    • 

  • Specifying the id of the repetition strategy
    

    • 

  • By specifying all repetition parameters
    

    • 



Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
 Example:  1
activity_id
required
number
 
 Example:  2
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
object
 
Responses
 Request samples 
Content type
application/json
{ }
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Dates for the magazine
Get a list of dates for a log 
The dates for the log are an array of dates. (for example, ["2015-10-26", "2015-10-30"]). To get the dates, you need to pass the date relative to which the list of working dates of the salon/employee will be received.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


date
required
string
 
date in iso8601 format.
Filter by booking date (eg '2015-09-30')


query Parameters
staff_id
number
 
Employee ID.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Comments
Get comments 
The comment object has the following fields:






Field
Type
Description





id
number
Comment ID




salon_id
number
Company ID




type
number
1 - comment to the master, 0 - to the salon




master_id
number
Master ID if type = 1




text
string
Comment text




date
string
Date when the comment was left




rating
number
Rating (from 1 to 5)




user_id
number
Id of the user who left the comment




username
string
Name of the user who left the comment




user_avatar
string
Avatar of the user who left the comment




record_id
number
ID of the post after which the review was left (the value will be non-zero if the review was left through a link asking for a review after the visit)





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
start_date
string
 
date in iso8601 format.
Filter by date since (for example '2015-09-30')


end_date
string
 
date in iso8601 format.
Filter by date by (for example '2015-09-30')


staff_id
number
 
Employee ID


rating
number
 
Rating score. Filter by reviews with a specific rating.


page
number
 
Page number


count
number
 
Number of reviews per page


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Leave a comment 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


staff_id
required
number
 
Employee ID, specify when creating a review for an employee


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
mark
required
number
 
Rating from 1 to 5


text
required
string
 
Feedback text


name
required
string
 
Username to be displayed on the testimonials page


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "mark": "4",
  • "text": "Everything is very bad!",
  • "name": "Victor"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Company users
Deprecated. Get company users  Deprecated 
Company User object


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get company users 
The method allows you to get users of the company.
 Company User object:






Attribute
Type
Description





id
number
User ID




name
string
User name




phone
string
User phone




email
string
User email




information
string
User information




is_approved
boolean
Whether the user accepted the invitation to manage the company




is_non_deletable
boolean
Whether the user is non-deletable





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
filter[is_approved]
number
 
 Example:  filter[is_approved]=1
Whether the user accepted the invitation to manage the company. 1 - accepted, 0 - not accepted


header Parameters
Accept
required
string
 
 Example:  application/vnd.yclients.v2+json
e.g. application/vnd.yclients.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Response status.


Array of objects
 
Response data.


object
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Remove the user from the company 
Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


user_id
required
number
 
User ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": false,
  • "data": null,
  • "meta": {
    }
}
Checkout
Get company cash registers 
The company checkout object has the following fields:






Field
Type
Description





id
number
Checkout ID




title
string
Title




type
number
1 - for non-cash payments, 0 for cash




comment
string
Description to the checkout





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Warehouses
Get company warehouses 
The company warehouse object has the following fields:






Field
Type
Description





id
number
Warehouse ID




title
string
Title




for_services
number
1 - if used for automatic write-off of consumables




for_sale
number
1 - if the default warehouse for selling goods




comment
string
Description of the warehouse





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
SMS mailing
Send SMS to the list of clients 
The object for creating SMS mailing has the following fields:






Field
Type
Description





client_ids
array of numbers
Array of client IDs




text
string
SMS text message





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
client_ids
Array of numbers
 
Array of client IDs


text
string
 
SMS text message


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


data
string
 
Is null


object
 
An object containing a 201 status code message


 Request samples 
Content type
application/json
{
  • "client_ids": [
    ],
  • "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Send SMS campaigns to customers matching the filters 
The object for creating SMS mailing has the following fields:






Field
Type
Description





text
string
SMS text message





Client filtering


    

  • fullname:'Joh' (optional, string) - Name (part of name) to filter clients
    • 

  • phone:'7916' (optional, string) - Phone (part of the number) to filter clients
    • 

  • email:'test@' (optional, string) - Email (part) for client filtering
    • 

  • card:'5663rt' (optional, string) - Card (part) to filter customers by loyalty card number
    • 



Attention: If there are no filters, SMS mailing will go to the entire database!


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
fullname
string
 
 Example:  fullname='Joh'
Name (part of the name) for client filtering


phone
string
 
 Example:  phone='7916'
Phone (part of the number) for customer filtering


email
string
 
 Example:  email='test@'
Email (part) for customer filtering


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
text
string
 
SMS text message


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


data
string
 
Is null


object
 
An object containing a 201 status code message


 Request samples 
Content type
application/json
{
  • "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Email newsletter
Send Email newsletter according to the list of clients 
The object for creating an Email campaign has the following fields:






Field
Type
Description





client_ids
array of numbers
Array of client IDs




text
string
Text Email Message




subject
string
Email Subject





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
client_ids
required
Array of numbers
 
Array of client IDs


subject
required
string
 
Email Subject


text
required
string
 
Email text


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


data
string
 
Is null


object
 
An object containing a 201 status code message


 Request samples 
Content type
application/json
{
  • "client_ids": [
    ],
  • "subject": "Important!",
  • "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Send email campaigns for clients matching the filters 
The object for creating an Email campaign has the following fields:






Field
Type
Description





text
string
Text Email Message




subject
string
Email Subject





Client filtering


    

  • fullname:'Joh' (optional, string) - Name (part of name) to filter clients
    • 

  • phone:'7916' (optional, string) - Phone (part of the number) to filter clients
    • 

  • email:'test@' (optional, string) - Email (part) for client filtering
    • 

  • card:'5663rt' (optional, string) - Card (part) to filter customers by loyalty card number
    • 



Attention: If there are no filters, email distribution will go to the entire database!


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
fullname
string
 
 Example:  fullname='Joh'
Name (part of the name) for client filtering


phone
string
 
 Example:  phone='7916'
Phone (part of the number) for customer filtering


email
string
 
 Example:  email='test@'
Email (part) for customer filtering


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
subject
required
string
 
Email Subject


text
required
string
 
Email text


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


data
string
 
Is null


object
 
An object containing a 201 status code message


 Request samples 
Content type
application/json
{
  • "subject": "Important!",
  • "text": "Dear clients, we congratulate you on being our clients! You are very lucky!"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Financial transactions
Get transactions 
Transaction filtering


    

  • page: Page number
    

    • 

  • count: Number of customers per page
    

    • 

  • account_id: Checkout ID
    

    • 

  • supplier_id: Counterparty ID
    

    • 

  • client_id: Client ID
    

    • 

  • user_id: user ID
    

    • 

  • master_id: Employee ID
    

    • 

  • type: transaction type
    

    • 

  • real_money: real money transaction
    

    • 

  • deleted: whether the transaction was deleted
    

    • 

  • start_date: start date of the period
    

    • 

  • end_date: end date of the period
    

    • 

  • balance_is: 0 - any balance, 1 - positive, 2 - negative
    

    • 

  • document_id: document ID
    

    • 



Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
page
number
 
 Example:  page=1
Page number


count
number
 
 Example:  count=50
Number of customers per page


account_id
number
 
 Example:  account_id=0
Checkout ID


supplier_id
number
 
 Example:  supplier_id=0
Counterparty ID


client_id
number
 
 Example:  client_id=0
Client ID


user_id
number
 
 Example:  user_id=0
User ID


master_id
number
 
 Example:  master_id=0
Employee ID


type
number
 
 Example:  type=0
transaction type


real_money
number
 
 Example:  real_money=0
real money transaction


deleted
number
 
 Example:  deleted=0
whether the transaction was deleted


start_date
number
 
 Example:  start_date=''
period start date


end_date
number
 
 Example:  end_date=''
period end date


balance_is
number
 
 Example:  balance_is=0
0 - any balance, 1 - positive, 2 - negative


document_id
number
 
 Example:  document_id=0
document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Getting transactions by visit or record ID 
Transaction filtering


    

  • record_id: record ID
    

    • 

  • visit_id: ID of the visit
    

    • 



Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
record_id
number
 
 Example:  record_id=0
Record ID


visit_id
number
 
 Example:  visit_id=0
Visit ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Creating a financial transaction 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
expense_id
number
 
Payment item


amount
number <float> 
 
Transaction amount


account_id
number
 
Checkout ID


client_id
number
 
Client ID


supplier_id
number
 
Counterparty ID


master_id
number
 
Employee ID


comment
number
 
A comment


date
string <date-time> 
 
Transaction creation date


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "expense_id": 2640,
  • "amount": 100,
  • "account_id": 39105,
  • "client_id": 4240788,
  • "supplier_id": 0,
  • "master_id": 0,
  • "comment": "Transaction comment",
  • "date": 1491336000
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Receiving a financial transaction 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Financial Transaction Update 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
expense_id
number
 
Payment item


amount
number <float> 
 
Transaction amount


account_id
number
 
Checkout ID


client_id
number
 
Client ID


supplier_id
number
 
Counterparty ID


master_id
number
 
Employee ID


comment
number
 
A comment


date
string <date-time> 
 
Transaction creation date


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Deleting a transaction 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Loyalty cards
Get a list of card types available at the branch 
Returns a list of card types that are valid for the given branch.


Attributes and their descriptions correspond to the "Collection of card types available to the client" method described above.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
 Example:  12345
Company ID


Responses
Response Schema: application/json
 Array 
id
integer <int32> 
 
Card type identifier


title
string
 
Map type name


salon_group_id
integer <int32> 
 
ID of the chain where the map type was created


object
 
An object that contains the "id" and "title" fields: the identifier of the chain where the map type was created and the name of this chain


 Response samples 
Content type
application/json
[
  • {
    },
  • {
    }
]
Get a list of customer cards by phone number 
Returns a list of customer cards with programs that are active in this salon


| Attribute | Type | Description|
|----------------|--------|----------------------- -------------------------------------------------- --------------------------------------------|
| id | int | Loyalty card ID |
| balance | decimal| Loyalty card balance |
| paid_amount | decimal| Amount "Paid" |
| sold_amount | decimal| Amount "Sold" |
| visits_count | int | Number of visits |
| number | string | Card number |
| type_id | int | Loyalty card type identifier |
| salon_group_id | int | ID of the chain where the map was created |
| type | object | An object that contains the "id" and "title" fields: map type identifier and map type name, respectively
| salon_group | object | An object that contains the "id" and "title" fields: identifier of the chain where the map type was created and the name of this chain |
| programs | array | An array with information about promotions linked to a loyalty card |
| rules | array | An array with information about the rules configured in the action |


The programs array consists of objects with the following fields:


| Attribute | Type | Description |
|-----------------|--------|---------------------- ----------------|
| id | int | Promotion ID |
| title | string | Action name |
| loyalty_type_id | int | Promotion type ID |
| item_type_id | int | Is cashback accrued from goods |
| value_unit_id | int | Bonus field. Discount % or Fixed. amount |
| group_id | int | ID of the chain where the action was created |
| loyalty_type | object | Object with information about the action |


The rules array consists of objects with the following fields:


| Attribute | Type | Description |
|--------------------|--------|------------------- -------------------------------|
| id | int | Rule ID |
| loyalty_program_id | int | Identifier of the stock to which the rule is attached |
| loyalty_type_id | int | Promotion type ID |
| value | decimal| Value from which the rule will work |


Authorizations:
(beareruser) 
path Parameters
phone
required
string
 
Customer phone number in the format 70001234567


group_id
required
number
 
Chain ID


company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
id
integer <int32> 
 
Loyalty card ID


balance
number <float> 
 
Loyalty card balance


points
integer <int32> 
 
paid_amount
number <float> 
 
Amount Paid


sold_amount
number <float> 
 
Amount "Sold"


visits_count
integer <int32> 
 
Number of visits


number
string
 
Card number


type_id
integer <int32> 
 
Loyalty card type identifier


salon_group_id
integer <int32> 
 
ID of the chain where the map was created


object
 
An object that contains the "id" and "title" fields: map type identifier and map type name, respectively


object
 
An object that contains the "id" and "title" fields: the identifier of the chain where the map type was created and the name of this chain


Array of objects
 
An array with information about promotions linked to a loyalty card


 Response samples 
Content type
application/json
{
  • "id": 9210520,
  • "balance": 100,
  • "points": 0,
  • "paid_amount": 1000,
  • "sold_amount": 1000,
  • "visits_count": 1,
  • "number": 14507109210520,
  • "type_id": 10992,
  • "salon_group_id": 145071,
  • "type": {
    },
  • "salon_group": {
    },
  • "programs": [
    ]
}
Get a list of customer cards by ID 
Returns a list of customer cards with programs that are active in this salon


The attributes in the response to the request completely match the "Get a list of issued cards by phone number" method described above


Authorizations:
(beareruser) 
path Parameters
client_id
required
number
 
Client ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
id
integer <int32> 
 
Loyalty card ID


balance
number <float> 
 
Loyalty card balance


points
integer <int32> 
 
paid_amount
number <float> 
 
Amount Paid


sold_amount
number <float> 
 
Amount "Sold"


visits_count
integer <int32> 
 
Number of visits


number
string
 
Card number


type_id
integer <int32> 
 
Loyalty card type identifier


salon_group_id
integer <int32> 
 
ID of the chain where the map was created


object
 
An object that contains the "id" and "title" fields: map type identifier and map type name, respectively


object
 
An object that contains the "id" and "title" fields: the identifier of the chain where the map type was created and the name of this chain


Array of objects
 
An array with information about promotions linked to a loyalty card


 Response samples 
Content type
application/json
{
  • "id": 9210520,
  • "balance": 100,
  • "points": 0,
  • "paid_amount": 1000,
  • "sold_amount": 1000,
  • "visits_count": 1,
  • "number": 14507109210520,
  • "type_id": 10992,
  • "salon_group_id": 145071,
  • "type": {
    },
  • "salon_group": {
    },
  • "programs": [
    ]
}
Get user loyalty cards 
Returns a list of cards of an authorized user with programs, filtering cards by salon chain / salon


Authorizations:
(beareruser) 
path Parameters
group_id
required
number
 
Chain ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
id
integer <int32> 
 
Loyalty card ID


balance
number <float> 
 
Loyalty card balance


points
integer <int32> 
 
paid_amount
number <float> 
 
Amount Paid


sold_amount
number <float> 
 
Amount "Sold"


visits_count
integer <int32> 
 
Number of visits


number
string
 
Card number


type_id
integer <int32> 
 
Loyalty card type identifier


salon_group_id
integer <int32> 
 
ID of the chain where the map was created


object
 
An object that contains the "id" and "title" fields: map type identifier and map type name, respectively


object
 
An object that contains the "id" and "title" fields: the identifier of the chain where the map type was created and the name of this chain


Array of objects
 
An array with information about promotions linked to a loyalty card


 Response samples 
Content type
application/json
{
  • "id": 9210520,
  • "balance": 100,
  • "points": 0,
  • "paid_amount": 1000,
  • "sold_amount": 1000,
  • "visits_count": 1,
  • "number": 14507109210520,
  • "type_id": 10992,
  • "salon_group_id": 145071,
  • "type": {
    },
  • "salon_group": {
    },
  • "programs": [
    ]
}
Issue a loyalty card 
| Attribute | Type | Description |
|----------------------|--------|----------------- ------------------------------|
| loyalty_card_number | number | Loyalty card number |
| loyalty_card_type_id | number | Loyalty card type identifier |
| phone | number | Customer phone number in the format 70001234567 |


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
loyalty_card_number
string
 
Loyalty card number


loyalty_card_type_id
string
 
Loyalty card type identifier


phone
number
 
Customer phone number in the format 70001234567


Responses
Response Schema: application/json
id
integer <int32> 
 
Loyalty card ID


balance
number <float> 
 
Loyalty card balance


points
integer <int32> 
 
paid_amount
number <float> 
 
Amount Paid


sold_amount
number <float> 
 
Amount "Sold"


visits_count
integer <int32> 
 
Number of visits


number
string
 
Card number


type_id
integer <int32> 
 
Loyalty card type identifier


salon_group_id
integer <int32> 
 
ID of the chain where the map was created


object
 
An object that contains the "id" and "title" fields: map type identifier and map type name, respectively


object
 
An object that contains the "id" and "title" fields: the identifier of the chain where the map type was created and the name of this chain


Array of objects
 
An array with information about promotions linked to a loyalty card


 Request samples 
Content type
application/json
{
  • "loyalty_card_number": 9090909,
  • "loyalty_card_type_id": "8230",
  • "phone": 79091552422
}
 Response samples 
Content type
application/json
{
  • "id": 9250498,
  • "balance": 0,
  • "points": 0,
  • "paid_amount": 16300,
  • "sold_amount": 19320,
  • "visits_count": 5,
  • "number": "01010101",
  • "type_id": 8230,
  • "salon_group_id": 145071,
  • "type": {
    },
  • "salon_group": {
    },
  • "programs": [
    ]
}
Remove loyalty card 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


card_id
required
number
 
loyalty card ID


Responses
Manual withdraw/deposit to loyalty card in chain 
Manual withdraw/deposit to loyalty card in chain


Authorizations:
BearerPartnerUser
path Parameters
chain_id
required
number
 
 Example:  123
ID of a chain.


card_id
required
number
 
Loyalty card ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
amount
required
number
 
Withdraw/deposit amount. Positive for deposit, negative for withdraw.


title
string
 
Optional comment


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (loyalty_card) 
 
Loyalty card


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


 Request samples 
Content type
application/json
{
  • "amount": 100.5,
  • "title": "string"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Get a list of map types available on the chain 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
 Array 
id
integer <int32> 
 
Card type identifier


title
string
 
Map type name


 Response samples 
Content type
application/json
[
  • {
    }
]
Manual withdraw/deposit to loyalty card in company 
Manual withdraw/deposit to loyalty card in company


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


card_id
required
number
 
Loyalty card ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
amount
required
number
 
Withdraw/deposit amount. Positive for deposit, negative for withdraw.


title
string
 
Optional comment


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (loyalty_card) 
 
Loyalty card


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


 Request samples 
Content type
application/json
{
  • "amount": 100.5,
  • "title": "string"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Get a list of card types available for issuance to the client 
Returns a list of card types that are available for issuance to a salon client.


| Attribute | Type | Description |
|----------------|--------|----------------------- -------------------------------------------------- --------------------------------------------|
| id | int | Card type identifier |
| title | string | Map type name |
| salon_group_id | int | ID of the chain where the map type was created |
| salon_group | object | An object that contains the "id" and "title" fields: identifier of the chain where the map type was created and the name of this chain |


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
 Example:  12345
Company ID


phone
required
number
 
 Example:  70001234567
Customer phone number


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
 Array 
id
integer <int32> 
 
Card type identifier


title
string
 
Map type name


salon_group_id
integer <int32> 
 
ID of the chain where the map type was created


object
 
An object that contains the "id" and "title" fields: the identifier of the chain where the map type was created and the name of this chain


 Response samples 
Content type
application/json
[
  • {
    },
  • {
    }
]
Application of loyalty in a visit
Apply a discount promotion in a visit 
Applying a promotion to a visit, it only makes sense if there is a visit


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


card_id
required
number
 
Client card ID


program_id
required
number
 
ID of the promotion linked to the card


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
record_id
required
number
 
Record ID


visit_id
required
number
 
Visit ID


Responses
Response Schema: application/json
payment_transactions
Array of objects
 
Array with information about the financial transactions of the record


Array of objects
 
An array with information about applied loyalty transactions in a visit


object
 
Object with information about KKM write transactions


Array of objects
 
Array with information about goods and services of the record


 Request samples 
Content type
application/json
{
  • "record_id": 0,
  • "visit_id": 0
}
 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [
    ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Cancel the application of the discount promotion in the visit 
Cancellation of the promotion applied to the visit.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


card_id
required
number
 
Client card ID


program_id
required
number
 
ID of the promotion linked to the card


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
record_id
required
number
 
Record ID


visit_id
required
number
 
Visit ID


Responses
Response Schema: application/json
payment_transactions
Array of objects
 
Array with information about the financial transactions of the record


loyalty_transactions
Array of objects
 
An array with information about applied loyalty transactions in a visit


object
 
Object with information about KKM write transactions


Array of objects
 
Array with information about goods and services of the record


 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [ ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Apply deduction from the loyalty card in the visit 
Write-off of bonuses from the card The amount will not exceed the balance for payment If 0, then there will be no transaction


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


card_id
required
number
 
Client card ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
record_id
required
number
 
Record ID


visit_id
required
number
 
Visit ID


amount
required
number
 
Number of points to redeem


Responses
Response Schema: application/json
payment_transactions
Array of objects
 
Array with information about the financial transactions of the record


Array of objects
 
An array with information about applied loyalty transactions in a visit


object
 
Object with information about KKM write transactions


Array of objects
 
Array with information about goods and services of the record


 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [
    ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Cancel withdrawal from the loyalty card during the visit 
Cancellation of write-off from the loyalty card.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


card_id
required
number
 
Client card ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
record_id
required
number
 
Record ID


visit_id
required
number
 
Visit ID


Responses
Response Schema: application/json
payment_transactions
Array of objects
 
Array with information about the financial transactions of the record


loyalty_transactions
Array of objects
 
An array with information about applied loyalty transactions in a visit


object
 
Object with information about KKM write transactions


Array of objects
 
Array with information about goods and services of the record


 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [ ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Apply referral program on post 
Applying a referral program to a visit


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


group_id
required
number
 
ID of the chain where the referral program is configured


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
record_id
required
number
 
Record ID


visit_id
required
number
 
Visit ID


referrer_phone
required
number
 
Phone number of the inviter


Responses
Response Schema: application/json
payment_transactions
Array of objects
 
Array with information about the financial transactions of the record


Array of objects
 
An array with information about applied loyalty transactions in a visit


object
 
Object with information about KKM write transactions


Array of objects
 
Array with information about goods and services of the record


 Response samples 
Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [
    ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}
Get loyalty transactions by visit 
List of transactions for loyalty promotions for this visit


Authorizations:
(beareruser) 
path Parameters
visit_id
required
number
 
Visit ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
 Array 
id
integer <int32> 
 
Loyalty transaction ID


status_id
integer <int32> 
 
Status ID


amount
number <float> 
 
Transaction amount


type_id
integer <int32> 
 
Transaction type identifier


program_id
integer <int32> 
 
Loyalty program ID


card_id
integer <int32> 
 
Loyalty card ID


salon_group_id
integer <int32> 
 
ID of the chain to which the loyalty belongs


item_id
integer <int32> 
 
Identifier of the product/service to which the promotion applies


item_type_id
integer <int32> 
 
Operation type identifier


item_record_id
integer <int32> 
 
Identifier of the record to which the service/product belongs


goods_transaction_id
integer <int32> 
 
Commodity transaction ID


is_discount
boolean
 
Is a discount


is_loyalty_withdraw
boolean
 
Is the application of loyalty canceled


object
 
Loyalty type


object
 
Promotion Information


 Response samples 
Content type
application/json
[
  • {
    },
  • {
    }
]
Webhook event notifications
Get event notification settings 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Change event notification settings 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
urls
required
Array of arrays
 
List of addresses to send notifications to


active
required
number
 
1 - notifications are active, 0 - not active


salon
number
 
1 - send events by company entity, 0 - no send


service_category
number
 
1 - send events by service category entity, 0 - do not send


service
number
 
1 - send events by service entity, 0 - do not send


good
number
 
1 - send events by product entity, 0 - don't send


master
number
 
1 - send events by employee entity, 0 - don't send


client
number
 
1 - send events by client entity, 0 - don't send


record
number
 
1 - send events by record entity, 0 - do not send


goods_operations_sale
number
 
1 - send events by the item sale entity, 0 - do not send


goods_operations_receipt
number
 
1 - send events by the entity arrival of goods, 0 - do not send


goods_operations_consumable
number
 
1 - send events by the consumable write-off entity, 0 - do not send


goods_operations_stolen
number
 
1 - send events by the item write-off entity, 0 - do not send


goods_operations_move
number
 
1 - send events by the item movement entity, 0 - no send


finances_operation
number
 
1 - send events by entity financial operation, 0 - no send


self_sending
number
 
1 - the webhook creator receives events that are initiated by him, 0 - does not receive


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "urls": [],
  • "active": 0,
  • "salon": 1,
  • "service_category": 0,
  • "service": 1,
  • "good": 1,
  • "master": 1,
  • "client": 1,
  • "record": 1,
  • "goods_operations_sale": 1,
  • "goods_operations_receipt": 1,
  • "goods_operations_consumable": 1,
  • "goods_operations_stolen": 1,
  • "goods_operations_move": 1,
  • "finances_operation": 1,
  • "self_sending": 0
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Reference books
Get business types by group 
Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of business types found)


 Response samples 
Content type
application/json
{}
Categories
Get company categories 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


entity
required
number
 
Category object (0 - general tags, 1 - customer tags, 2 - post tags)


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
 Array 
id
number
 
Category ID


salon_id
number
 
Branch ID


title
string
 
name of category


color
string
 
Label color in #RRGGBB format


icon
string
 
Icon name


entity
number
 
Category object (1 - category for customers, 2 - category for records)


deleted
number
 
Delete mark


not_editable
number
 
Whether category changes are allowed (1 - allowed, 0 - not allowed)


 Response samples 
Content type
application/json
[
  • {
    },
  • {
    }
]
Create a client company category 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
title
string
 
name of category


color
string
 
Label color in #RRGGBB format


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


Response Schema: application/json
success
boolean
 
Execution success status (false)


data
string
 
Contains null


object
 
Metadata (contains an error message)


Response Schema: application/json
success
boolean
 
Execution success status (false)


data
string
 
Contains null


object
 
Contains an array with possible error messages


Response Schema: application/json
success
boolean
 
Execution success status (false)


data
string
 
Contains null


object
 
Contains an array of possible error messages


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Create category 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
title
required
string
 
name of category


color
required
string
 
Label color in #RRGGBB format


entity
number
 
Category object (0 - general tags, 1 - customer tags, 2 - post tags)


icon
string
 
Icon name


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update Category 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


label_id
required
number
 
Tag ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
title
string
 
name of category


color
string
 
Label color in #RRGGBB format


entity
number
 
Category object (1 - category for customers, 2 - category for records)


icon
string
 
Icon name


Responses
 Request samples 
Content type
application/json
{
  • "title": "Testway2",
  • "color": "#aa11ff",
  • "entity": 2,
  • "icon": "Test"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Delete company category 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


label_id
required
number
 
Tag ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Product categories
List request example 
List of products and product categories


A list of products and product categories can be obtained by requesting a branch ID.
The list can be filtered by the name or article of the product category, by the name, article or barcode of the product by passing the search_term parameter.
The number of results is limited by the max_count parameter.


If search_term is not given, a list of root categories of the branch is output, ignoring max_count. If search_term is passed, search by category is performed first, then (if less than max_count is found) by product


The list is an array of goods tree elements.



Product tree element has the following structure:


| Field | Type | Description |
| -------------| ------- | -------------------------------------------------- ----------------------------------------- |
| parent_id | number | Parent element ID (0 for root elements) |
| item_id | number | Item ID (0 if item is a category) |
| category_id | number | Product category ID (0 if the item is a product) |
| title | string | Product name or product category |
| is_chain | boolean | Is the element chain-bound? true - the element is connected to the chain, false - not connected |
| is_category | boolean | Is the element a category? true - category, false - product |
| is_item | boolean | Is the item a product? true - product, false - category |


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
search_term
string
 
Search query by name, article number or barcode


max_count
number
 
The number of output lines per page. Maximum 100


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array with data objects


object
 
Metadata (contains the number of categories found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Example of a request to get the composition of a category 
##№ Composition of the product category


Information on a product category and its descendants can be obtained by making a request specifying the branch ID and product category.
Pagination is supported, specified by the page and count parameters.


Composition of a product category has the following structure:


| Field | Type | Description |
| ----------------| ------- | -------------------------------------------------- ------------------------------------------------- |
| parent_id | number | Parent element ID (0 for root elements) |
| item_id | number | Item ID (always 0) |
| category_id | number | Product category ID |
| title | string | Product category name |
| is_chain | boolean | Is the element chain-bound? true - the element is connected to the chain, false - not connected |
| is_category | boolean | Is the element a category? always true |
| is_item | boolean | Is the item a product? always false |
| children | Array of objects(Product tree element) | Child elements of a product category |
| children_count | number | Total number of child products and categories (no recursion) |


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


category_id
required
number
 
Product Category ID


query Parameters
page
number
 
Page number


count
number
 
The number of products displayed on the page. Maximum 1000


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    }
}
Get a list of product categories  Deprecated 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


parent_category_id
required
number
 
ID of the parent product category. Default 0 - top-level categories are displayed (optional)


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get a list of product categories by ID 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
id
number
 
Product category ID (you can specify several additional parameters &ids[]={id}


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Example of a request to get categories 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


parent_category_id
required
number
 
ID of the parent product category


query Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Create product category 
The method allows you to create a product category.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
title
required
string
 
Product category name


parent_category_id
integer <int32> 
 
Parent category ID (optional, but can be 0 or null if you don't need to specify the parent category)


article
string
 
vendor code


comment
string
 
A comment


Responses
Response Schema: application/json
success
boolean
 
Execution success status


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "title": "Manicure",
  • "parent_category_id": 123456,
  • "article": "123article",
  • "comment": "Category of products for manicure"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Edit product category 
The method allows you to edit the product category


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


category_id
required
number
 
Product category ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
title
required
string
 
Product category name


parent_category_id
integer <int32> 
 
Parent category ID (optional, but can be 0 or null if you don't need to specify the parent category)


article
string
 
vendor code


comment
string
 
A comment


Responses
Response Schema: application/json
success
boolean
 
Execution success status


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "title": "Manicure",
  • "parent_category_id": 123456,
  • "article": "123article",
  • "comment": "Category of products for manicure"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Delete product category 
The method allows you to delete a product category


Authorizations:
(userbearer) 
path Parameters
company_id
required
number
 
Branch ID


category_id
required
number
 
Product category ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Technological cards and consumables
Get a list of those cards 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


query Parameters
search
string
 
 Example:  search='test'
parameter for searching by the name of those maps


page
number
 
 Example:  page=1
page number


count
number
 
 Example:  count=20
number of those cards per page


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of data objects


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get a tech card to contact an employee service 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


staffId
required
number
 
Employee ID


serviceId
required
number
 
Service ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of data objects


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get a list of those cards and consumables 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


record_id
required
number
 
Record ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Delete process record-service from association 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


record_id
required
number
 
Record ID


service_id
required
number
 
Service ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
delete_consumables
number
 
Whether to remove consumables along with deleting those cards. Default 0


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array with object


object
 
Metadata (empty array0)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Delete process record-service from association 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


record_id
required
number
 
Record ID


service_id
required
number
 
Service ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
delete_consumables
number
 
Whether to remove consumables along with deleting those cards. Default 0


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array with object


object
 
Metadata (empty array0)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Change the list of consumables for the record-service connection 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


record_id
required
number
 
Record ID


service_id
required
number
 
Service ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
goods_transaction_id
required
number
 
commodity transaction id


record_id
required
number
 
post id


service_id
required
number
 
service id


storage_id
required
number
 
warehouse id,


good_id
required
number
 
product id,


price
required
number
 
the cost of the consumable in the record,


amount
required
number
 
the number of consumables in the record,


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "goods_transaction_id": 0,
  • "record_id": 0,
  • "service_id": 0,
  • "storage_id": 0,
  • "good_id": 0,
  • "price": 0,
  • "amount": 0
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Commodity transactions
Search for commodity transactions 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
page
number
 
 Example:  page=1
page number


count
number
 
 Example:  count=20
number of transactions per page


start_date
string
 
 Example:  start_date=''
period start date


end_date
string
 
 Example:  end_date=''
period end date


document_id
string
 
Document ID


changed_after
string
 
Filtering commodity transactions modified/created since a specific date and time


changed_before
string
 
Filtering commodity transactions modified/created before a specific date and time


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Create transaction 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
document_id
required
number <float> 
 
Document ID


good_id
required
number
 
Item ID


amount
required
number
 
Quantity


cost_per_unit
required
number <float> 
 
Unit cost


discount
required
number
 
Discount in %


cost
required
number <float> 
 
Total transaction amount


operation_unit_type
required
number
 
unit type: 1 - for sale, 2 - for write-off


master_id
number
 
ID of the artist who sold the item


client_id
number
 
ID of the customer who bought the item


supplier_id
number
 
Vendor ID


comment
string
 
A comment


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "document_id": 22254960,
  • "good_id": 232674,
  • "amount": 1,
  • "cost_per_unit": 100,
  • "discount": 10,
  • "cost": 90,
  • "operation_unit_type": 1,
  • "master_id": 26781,
  • "client_id": 0,
  • "supplier_id": 0,
  • "comment": "Transaction comment"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Receiving a transaction 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Transaction update 
Authorizations:
(beareruser) 
path Parameters
transaction_id
required
number
 
transaction ID


company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
document_id
required
number <float> 
 
Document ID


good_id
required
number
 
Item ID


amount
required
number
 
Quantity


cost_per_unit
required
number <float> 
 
Unit cost


discount
required
number
 
Discount in %


cost
required
number <float> 
 
Total transaction amount


operation_unit_type
required
number
 
unit type: 1 - for sale, 2 - for write-off


master_id
number
 
ID of the artist who sold the item


client_id
number
 
ID of the customer who bought the item


supplier_id
number
 
Vendor ID


comment
string
 
A comment


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Deleting a transaction 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


transaction_id
required
number
 
transaction ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Warehouse operations
Create a warehouse operation 
Creating a warehouse operation involves creating a document and several commodity transactions within a single API request. When specifying the sign of payment, the necessary financial transactions are created


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
type_id
required
number
 
Document type (sale 1, receipt 3, write-off 4, transfer 5)


comment
string
 
A comment


create_date
required
string <date-time> 
 
Document creation date


master_id
number
 
Master ID


storage_id
required
number
 
Warehouse ID


goods_transactions
required
Array of objects
 
An array of objects containing transaction parameters, similar to a request to create a commodity transaction


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Warehouse operations documents
Create document 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
type_id
required
number
 
Document type (sale 1, receipt 3, write-off 7)


comment
string
 
A comment


storage_id
required
number
 
Warehouse ID


create_date
required
string <date-time> 
 
Date of the warehouse transaction


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "type_id": 1,
  • "comment": "Document comment",
  • "storage_id": 36539,
  • "create_date": 1493064000
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get document 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update Document 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
type_id
required
number
 
Document type (sale 1, receipt 3, write-off 7)


comment
string
 
A comment


storage_id
required
number
 
Warehouse ID


create_date
required
string <date-time> 
 
Date of the warehouse transaction


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Delete document 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Get document financial transactions 
Authorizations:
(beareruser) 
path Parameters
document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get commodity transactions of a document 
Authorizations:
(beareruser) 
path Parameters
document_id
required
number
 
Document ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (number of transactions found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Personal accounts
Creation of a personal account replenishment operation 
Creating a transaction with a personal account involves creating a document, a transaction with a personal account, and a financial transaction within a single API request.


Authorizations:
(beareruser) 
path Parameters
salon_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
client_id
required
number
 
ID of the client, the owner of the personal account


deposit_id
required
number
 
personal account ID


amount
required
number
 
replenishment amount


master_id
number
 
Employee ID


account_id
required
number
 
Checkout ID for payment


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Getting a list of personal accounts by branch and client 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


client_id
required
number
 
Client ID


header Parameters
Accept
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Getting a list of personal accounts by chain and a set of filters 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
Chain ID


query Parameters
balance_from
number
 
Minimum balance for filtering


balance_to
number
 
Maximum balance for filtering


page
number
 
Page number


limit
number
 
Number of items per page


header Parameters
Accept
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Getting a list of personal accounts by chain and customer phone number 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
Chain ID


phone
required
number
 
Customer phone number


header Parameters
Accept
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Country
Get a list of countries 
Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Salon chains
Obtaining chains available to the user 
The store chain object has the following fields:






Field
Type
Description





id
number
Salon chain ID




title
string
Salon chain name




companies
array
List of chain salons




access
object
Object with access rights for chain management





Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}
Z-Report
Get Z-Report data 
    

  • start_date: Report date
    

    • 

  • master_id: Employee ID
    

    • 



Authorizations:
(beareruser) 
path Parameters
company_id
required
integer
 
Company ID


query Parameters
start_date
string
 
 Example:  start_date=''
period start date


master_id
integer
 
 Example:  master_id=0
Employee ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Additional fields
Getting a collection of branch fields 
Authorizations:
(beareruser) 
path Parameters
field_category
required
string
 
 Example:  record
Field category.


    

  • For records - record
    

    • 

  • For clients - client 
    

    • 



company_id
required
integer
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Adding an additional field 
To add the field, the user must be added to the Chain associated with the location, and have access rights in the section: 
Settings - Access to the Additional Fields section - Creating add. fields


Authorizations:
(beareruser) 
path Parameters
field_category
required
string
 
 Example:  record
Field category.


    

  • For records - record
    

    • 

  • For clients - client 
    

    • 



company_id
required
integer
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
type
required
string
 
Field type


code
required
string
 
Field ID


title
required
string
 
Field name


user_can_edit
required
boolean
 
Can the user edit the field


show_in_ui
required
boolean
 
Whether to show the field in the interface


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "type": "text",
  • "code": "my_text_field",
  • "title": "test field",
  • "user_can_edit": true,
  • "show_in_ui": true
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update an additional field 
To update the field, the user must be added to the Chain associated with the location, and have access rights in the section: 
Settings - Access to the Additional Fields section - Modify add. fields


Authorizations:
(beareruser) 
path Parameters
field_category
required
string
 
 Example:  record
Field category.


    

  • For records - record
    

    • 

  • For clients - client 
    

    • 



company_id
required
integer
 
Company ID


field_id
required
integer
 
field ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
type
required
string
 
Field type


code
required
string
 
Field ID


title
required
string
 
Field name


user_can_edit
required
boolean
 
Can the user edit the field


show_in_ui
required
boolean
 
Whether to show the field in the interface


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "type": "text",
  • "code": "my_text_field",
  • "title": "test field",
  • "user_can_edit": true,
  • "show_in_ui": true
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": {
    }
}
Removing an additional field from a branch 
To remove the field, the user must be added to the Chain associated with the location, and have access rights in the section: 
Settings - Access to the Additional Fields section - Remove add. fields


Authorizations:
(beareruser) 
path Parameters
field_category
required
string
 
 Example:  record
Field category.


    

  • For records - record
    

    • 

  • For clients - client 
    

    • 



company_id
required
integer
 
Company ID


field_id
required
integer
 
field ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": null,
  • "meta": {
    }
}
Rules for the processing of personal data
Obtaining information about the rules for processing personal data of the company 
Authorizations:
bearer
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Data Validation
Phone number format check 
The transferred phone number is checked for compliance with Altegio rules.


Authorizations:
(beareruser) 
path Parameters
phone
required
string
 
Checked phone number


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Fiscalization of checks
Example of a request for fiscalization of a document 
Authorizations:
bearer
header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Request Body schema: application/json
id
string
 
Unique ID of the sales document


date
string <date-time> 
 
Date and time the document was sent for printing (in ISO-8601 format)


document_id
integer <int32> 
 
Internal document identifier in the Altegio system


type
string
 Enum: "sale" "return" 
 
Document type (list of possible values)


print_receipt
boolean
 
Whether to print a paper check at the checkout during fiscalization


object
 
Client entity


Array of objects
 
List of positions in the check


Array of objects
 
List of fees applied per check


tax
string
 
Type of taxation system (slug from the list of taxation systems)


object
 
The Essence of a Cashier


object
 
Options for the connected POS terminal


callback_url
string
 
Link to update fiscal status


custom_text
string
 
Arbitrary text for printing on a receipt


Responses
 Request samples 
Content type
application/json
{
  • "id": "d72fece5-6825-4895-9395-0133195612a4",
  • "date": 1596190296,
  • "document_id": 239083104,
  • "type": "sale",
  • "print_receipt": true,
  • "customer": {},
  • "positions": [
    ],
  • "payments": [
    ],
  • "tax": "ru_osn",
  • "cashier": {
    },
  • "pos": {
    },
  • "callback_url": "https://app.alteg.io/api/v1/integration/kkm/callback/",
  • "custom_text": "some custom text"
}
 Response samples 
Content type
application/json
{
  • "id": "d72fece5-6825-4895-9395-0133195612a4",
  • "status": "success",
  • "code": 0,
  • "message": "OK"
}
List request example 
A list of tax systems and VAT available for a country can be obtained by requesting the country ID for which the list is to be obtained.
The country ID can be obtained from list of countries.


The list is an array of tax systems with a nested VAT array for each tax system.


The taxation system has the following structure:






Field
Type
Description





title
string
Name of taxation system




slug
string
Code name for the taxation system




vats
Array of objects(Vat[])
List of available VAT for the taxation system






VAT has the following structure:






Field
Type
Description





title
string
Title VAT




slug
string
Code name VAT





Authorizations:
bearer
path Parameters
countryId
required
number
 
 Example:  1
Country ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of taxation systems found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Example of a request in case of successful fiscalization or in case of an error 
Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Conetnt-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Request Body schema: application/json
object
 
Responses
 Request samples 
Content type
application/json
{ }
Loyalty
Get a list of loyalty notification templates 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
 Array 
id
integer <int32> 
 
Template ID


type
string
 Enum: "big" "mid" "small" "custom" 
 
Template option


body
string
 
Template text


message_type
string
 Enum: "loyalty_discount_expiration" "loyalty_cashback_expiration" "loyalty_discount_increased" "loyalty_discount_decreased" "loyalty_card_created" "loyalty_card_withdraw" "loyalty_withdraw_cancelled" "loyalty_card_manual" "loyalty_card_manual_withdraw" "loyalty_card_cashback" "loyalty_card_cashback_cancelled" "loyalty_card_income" "loyalty_discount_changed" "loyalty_cashback_changed" "loyalty_settings_abonement_notification" 
 
Message type


 Response samples 
Content type
application/json
[
  • {
    }
]
Create an online promotion 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


query Parameters
include
string
 Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template" 
 
Include additional resources in the answer


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
applization/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
title
required
string
 
Share name


type
required
string
 Enum: "discount_static" "discount_accumulative_visits" "discount_accumulative_sold" "discount_accumulative_paid" "cashback_static_sold" "cashback_static_paid" "cashback_accumulative_paid" "cashback_accumulative_sold" "cashback_accumulative_paid_visits" "cashback_accumulative_sold_visits" "cashback_sold_visits" "cashback_paid_visits" "package_discount" 
 
Promotion type


service_item_type
required
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to services


good_item_type
required
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to goods


value_unit
required
string
 Enum: "percent" "amount" 
 
Bonus or discount measurement unit (percentage, fixed amount)


usage_limit
integer <int32> 
 
Limit on the number of applications (only for cashback)


visit_multiplicity
integer <int32> 
 
Multiplicity of application by visits (only for cashback)


sold_items_multiplicity
integer <int32> 
 
How many services you need to pay to get a discount on promotional services (only for the promotion type "Discount by condition")


expiration_timeout
integer <int32> 
 
Expiration date of bonuses or discounts


expiration_timeout_unit
string
 Enum: "day" "week" "month" "year" 
 
The unit of measurement for the expiration date of bonuses or discounts


expiration_notification_timeout
integer <int32> 
 
How many days before the bonus or discount expires, a notification must be sent to the client


params_source_type
string
 Enum: "loyalty_card" "active_companies" "chain" 
 
Where to get the client's history to calculate the size of the bonus or discount (for accumulation promotions or conditional discounts)


history_start_date
string <date> 
 
From what date to take into account the client's history to calculate the size of the bonus or discount (for accumulative promotions or conditional discounts)


loyalty_card_type_ids
Array of integers <int32> [ items <int32 > ]
 
Identifiers of types of cards for which the promotion is valid


object (Root Type for LoyaltyNotificationMessageTemplateRequest) 
 
Body of the request to bind the loyalty notification template


object (Root Type for LoyaltyNotificationMessageTemplateRequest) 
 
Body of the request to bind the loyalty notification template


required
Array of objects (Root Type for LoyaltyProgramRuleRequest) 
 
Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions)


company_ids
required
Array of integers <int32> [ items <int32 > ]
 
Identifiers of branches where the promotion is valid


allowed_service_ids
Array of integers <int32> [ items <int32 > ]
 
Service and service category identifiers (if application type is set for some services)


allowed_good_ids
Array of integers <int32> [ items <int32 > ]
 
Item IDs (if application type is set for some items)


allowed_good_category_ids
Array of integers <int32> [ items <int32 > ]
 
Product category identifiers (if application type is set for some products)


Responses
Response Schema: application/json
id
integer <int32> 
 
Stock ID


title
string
 
Share name


type
string
 Enum: "discount_static" "discount_accumulative_visits" "discount_accumulative_sold" "discount_accumulative_paid" "cashback_static_sold" "cashback_static_paid" "cashback_accumulative_paid" "cashback_accumulative_sold" "cashback_accumulative_paid_visits" "cashback_accumulative_sold_visits" "cashback_sold_visits" "cashback_paid_visits" "package_discount" 
 
Promotion type


service_item_type
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to services


good_item_type
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to goods


value_unit
string
 Enum: "percent" "amount" 
 
Bonus or discount measurement unit (percentage, fixed amount)


usage_limit
integer <int32> 
 
Limit on the number of applications (only for cashback)


visit_multiplicity
integer <int32> 
 
Multiplicity of application by visits (only for cashback)


sold_items_multiplicity
integer <int32> 
 
How many services you need to pay to get a discount on promotional services (only for the type of promotion "Discount by condition")


expiration_timeout
integer <int32> 
 
Expiration date of bonuses or discounts


expiration_timeout_unit
string
 Enum: "day" "week" "month" "year" 
 
The unit of measurement for the expiration date of bonuses or discounts


expiration_notification_timeout
integer <int32> 
 
How many days before the bonus or discount expires, a notification must be sent to the client


params_source_type
string
 Enum: "loyalty_card" "active_companies" "chain" 
 
Where to get the client's history to calculate the size of the bonus or discount (for accumulation promotions or conditional discounts)


history_start_date
string <date> 
 
From what date to take into account the client's history to calculate the size of the bonus or discount (for accumulative promotions or conditional discounts)


on_changed_notification_template_id
integer <int32> 
 
Notification template ID when changing bonus or discount


on_expiration_notification_template_id
integer <int32> 
 
Identifier of the notification template when a bonus or discount burns


Array of objects (Root Type for LoyaltyCardType) 
 
Type of cards for which the promotion is valid (on request)


object (Root Type for LoyaltyNotificationMessageTemplate) 
 
Loyalty notification template


object (Root Type for LoyaltyNotificationMessageTemplate) 
 
Loyalty notification template


Array of objects (Root Type for LoyaltyProgramRule) 
 
Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions) (on request)


Array of objects (Company) 
 
Branches where the promotion is valid (on request)


Array of objects (Root Type for LoyaltyEntityAttendanceItem) 
 
Related entities for selective application of the promotion (on request)


 Request samples 
Content type
application/json
{
  • "title": "Cumulative discount for some services and not for goods",
  • "type": "discount_accumulative_paid",
  • "service_item_type": "custom_allowed",
  • "good_item_type": "not_allowed",
  • "allowed_service_ids": [
    ],
  • "allowed_good_ids": { },
  • "allowed_good_category_ids": { },
  • "value_unit": "percent",
  • "usage_limit": 0,
  • "visit_multiplicity": 0,
  • "sold_items_multiplicity": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "params_source_type": "chain",
  • "history_start_date": 1516147200,
  • "loyalty_card_type_ids": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "company_ids": [
    ]
}
 Response samples 
Content type
application/json
{
  • "id": 34,
  • "title": "Cumulative discount for some services and not for goods",
  • "type": "discount_accumulative_paid",
  • "service_item_type": "custom_allowed",
  • "good_item_type": "not_allowed",
  • "value_unit": "percent",
  • "usage_limit": 0,
  • "visit_multiplicity": 0,
  • "sold_items_multiplicity": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "params_source_type": "chain",
  • "history_start_date": 1516147200,
  • "on_changed_notification_template_id": 55,
  • "on_expiration_notification_template_id": 84,
  • "loyalty_card_types": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "companies": [
    ],
  • "applicable_items": [
    ]
}
Get a share online 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


loyalty_program_id
required
integer
 
Promotion ID


query Parameters
include
string
 Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template" 
 
Include additional resources in the answer


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
id
integer <int32> 
 
Stock ID


title
string
 
Share name


type
string
 Enum: "discount_static" "discount_accumulative_visits" "discount_accumulative_sold" "discount_accumulative_paid" "cashback_static_sold" "cashback_static_paid" "cashback_accumulative_paid" "cashback_accumulative_sold" "cashback_accumulative_paid_visits" "cashback_accumulative_sold_visits" "cashback_sold_visits" "cashback_paid_visits" "package_discount" 
 
Promotion type


service_item_type
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to services


good_item_type
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to goods


value_unit
string
 Enum: "percent" "amount" 
 
Bonus or discount measurement unit (percentage, fixed amount)


usage_limit
integer <int32> 
 
Limit on the number of applications (only for cashback)


visit_multiplicity
integer <int32> 
 
Multiplicity of application by visits (only for cashback)


sold_items_multiplicity
integer <int32> 
 
How many services you need to pay to get a discount on promotional services (only for the type of promotion "Discount by condition")


expiration_timeout
integer <int32> 
 
Expiration date of bonuses or discounts


expiration_timeout_unit
string
 Enum: "day" "week" "month" "year" 
 
The unit of measurement for the expiration date of bonuses or discounts


expiration_notification_timeout
integer <int32> 
 
How many days before the bonus or discount expires, a notification must be sent to the client


params_source_type
string
 Enum: "loyalty_card" "active_companies" "chain" 
 
Where to get the client's history to calculate the size of the bonus or discount (for accumulation promotions or conditional discounts)


history_start_date
string <date> 
 
From what date to take into account the client's history to calculate the size of the bonus or discount (for accumulative promotions or conditional discounts)


on_changed_notification_template_id
integer <int32> 
 
Notification template ID when changing bonus or discount


on_expiration_notification_template_id
integer <int32> 
 
Identifier of the notification template when a bonus or discount burns


Array of objects (Root Type for LoyaltyCardType) 
 
Type of cards for which the promotion is valid (on request)


object (Root Type for LoyaltyNotificationMessageTemplate) 
 
Loyalty notification template


object (Root Type for LoyaltyNotificationMessageTemplate) 
 
Loyalty notification template


Array of objects (Root Type for LoyaltyProgramRule) 
 
Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions) (on request)


Array of objects (Company) 
 
Branches where the promotion is valid (on request)


Array of objects (Root Type for LoyaltyEntityAttendanceItem) 
 
Related entities for selective application of the promotion (on request)


 Response samples 
Content type
application/json
{
  • "id": 34,
  • "title": "Cumulative discount for some services and not for goods",
  • "type": "discount_accumulative_paid",
  • "service_item_type": "custom_allowed",
  • "good_item_type": "not_allowed",
  • "value_unit": "percent",
  • "usage_limit": 0,
  • "visit_multiplicity": 0,
  • "sold_items_multiplicity": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "params_source_type": "chain",
  • "history_start_date": 1516147200,
  • "on_changed_notification_template_id": 55,
  • "on_expiration_notification_template_id": 84,
  • "loyalty_card_types": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "companies": [
    ],
  • "applicable_items": [
    ]
}
Edit promotion online 
Authorizations:
bearer
path Parameters
chain_id
required
integer
 
Chain ID


loyalty_program_id
required
integer
 
Promotion ID


query Parameters
include
string
 Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template" 
 
Include additional resources in the answer


Request Body schema: application/json
title
string
 
Share name


usage_limit
integer <int32> 
 
Limit on the number of applications (only for cashback)


expiration_timeout
integer <int32> 
 
Expiration date of bonuses or discounts


expiration_timeout_unit
string
 Enum: "day" "week" "month" "year" 
 
The unit of measurement for the expiration date of bonuses or discounts


expiration_notification_timeout
integer <int32> 
 
How many days before the bonus or discount expires, a notification must be sent to the client


loyalty_card_type_ids
Array of integers <int32> [ items <int32 > ]
 
Identifiers of types of cards for which the promotion is valid


object (Root Type for LoyaltyNotificationMessageTemplateRequest) 
 
Body of the request to bind the loyalty notification template


object (Root Type for LoyaltyNotificationMessageTemplateRequest) 
 
Body of the request to bind the loyalty notification template


Array of objects (Root Type for LoyaltyProgramRuleRequest) 
 
Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions)


company_ids
Array of integers <int32> [ items <int32 > ]
 
Identifiers of branches where the promotion is valid


allowed_service_ids
Array of integers <int32> [ items <int32 > ]
 
Service and service category identifiers (if application type is set for some services)


allowed_good_ids
Array of integers <int32> [ items <int32 > ]
 
Item IDs (if application type is set for some items)


allowed_good_category_ids
Array of integers <int32> [ items <int32 > ]
 
Product category identifiers (if application type is set for some products)


Responses
Response Schema: application/json
id
integer <int32> 
 
Stock ID


title
string
 
Share name


type
string
 Enum: "discount_static" "discount_accumulative_visits" "discount_accumulative_sold" "discount_accumulative_paid" "cashback_static_sold" "cashback_static_paid" "cashback_accumulative_paid" "cashback_accumulative_sold" "cashback_accumulative_paid_visits" "cashback_accumulative_sold_visits" "cashback_sold_visits" "cashback_paid_visits" "package_discount" 
 
Promotion type


service_item_type
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to services


good_item_type
string
 Enum: "any_allowed" "not_allowed" "custom_allowed" 
 
Type of application to goods


value_unit
string
 Enum: "percent" "amount" 
 
Bonus or discount measurement unit (percentage, fixed amount)


usage_limit
integer <int32> 
 
Limit on the number of applications (only for cashback)


visit_multiplicity
integer <int32> 
 
Multiplicity of application by visits (only for cashback)


sold_items_multiplicity
integer <int32> 
 
How many services you need to pay to get a discount on promotional services (only for the type of promotion "Discount by condition")


expiration_timeout
integer <int32> 
 
Expiration date of bonuses or discounts


expiration_timeout_unit
string
 Enum: "day" "week" "month" "year" 
 
The unit of measurement for the expiration date of bonuses or discounts


expiration_notification_timeout
integer <int32> 
 
How many days before the bonus or discount expires, a notification must be sent to the client


params_source_type
string
 Enum: "loyalty_card" "active_companies" "chain" 
 
Where to get the client's history to calculate the size of the bonus or discount (for accumulation promotions or conditional discounts)


history_start_date
string <date> 
 
From what date to take into account the client's history to calculate the size of the bonus or discount (for accumulative promotions or conditional discounts)


on_changed_notification_template_id
integer <int32> 
 
Notification template ID when changing bonus or discount


on_expiration_notification_template_id
integer <int32> 
 
Identifier of the notification template when a bonus or discount burns


Array of objects (Root Type for LoyaltyCardType) 
 
Type of cards for which the promotion is valid (on request)


object (Root Type for LoyaltyNotificationMessageTemplate) 
 
Loyalty notification template


object (Root Type for LoyaltyNotificationMessageTemplate) 
 
Loyalty notification template


Array of objects (Root Type for LoyaltyProgramRule) 
 
Rules for determining the value of the bonus or discount (only one rule is allowed for fixed promotions) (on request)


Array of objects (Company) 
 
Branches where the promotion is valid (on request)


Array of objects (Root Type for LoyaltyEntityAttendanceItem) 
 
Related entities for selective application of the promotion (on request)


 Request samples 
Content type
application/json
{
  • "title": "Cumulative discount for some services and not for goods",
  • "allowed_service_ids": [
    ],
  • "allowed_good_ids": { },
  • "allowed_good_category_ids": { },
  • "usage_limit": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "loyalty_card_type_ids": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "company_ids": [
    ]
}
 Response samples 
Content type
application/json
{
  • "id": 34,
  • "title": "Cumulative discount for some services and not for goods",
  • "type": "discount_accumulative_paid",
  • "service_item_type": "custom_allowed",
  • "good_item_type": "not_allowed",
  • "value_unit": "percent",
  • "usage_limit": 0,
  • "visit_multiplicity": 0,
  • "sold_items_multiplicity": 0,
  • "expiration_timeout": 6,
  • "expiration_timeout_unit": "month",
  • "expiration_notification_timeout": 7,
  • "params_source_type": "chain",
  • "history_start_date": 1516147200,
  • "on_changed_notification_template_id": 55,
  • "on_expiration_notification_template_id": 84,
  • "loyalty_card_types": [
    ],
  • "on_changed_notification_template": {
    },
  • "on_expiration_notification_template": {
    },
  • "rules": [
    ],
  • "companies": [
    ],
  • "applicable_items": [
    ]
}
Delete stock online 
Authorizations:
bearer
path Parameters
chain_id
required
integer
 
Chain ID


loyalty_program_id
required
integer
 
Promotion ID


query Parameters
include
string
 Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template" 
 
Include additional resources in the answer


Responses
Get a list of online loyalty transactions 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
integer
 
Chain ID


query Parameters
created_after
required
string <date> 
 
Sample start date in Y-m-d format


created_before
required
string <date> 
 
Sample end date in Y-m-d format


types
Array of strings
Items Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11" 
 
Types of loyalty transactions included in the selection: 1 - Promotion discount, 2 - Loyalty program accrual, 3 - Loyalty card withdrawal, 4 - Referral program accrual, 5 - Manual replenishment, 6 - Manual withdrawal, 7 - Overdue points withdrawal , 8 - Withdrawal from the certificate, 9 - Use of the subscription, 10 - Recalculation of the cost of the subscription, 11 - Withdrawal from the personal account


company_ids
Array of integers
 
Loyalty transaction affiliate IDs included in the sample


visit_ids
Array of integers
 
Loyalty transaction visit IDs included in the sample


page
integer
 
Selection page


count
integer
 
Number of results per selection page


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of items in the response)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Certificate/subscription code generation 
    

  • Options
      

    • salonId (required, number, 1) - salon ID
      • 

    • goodId (required, number, 1) - product ID (certificate/subscription)
      • 

    

    • 



Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


good_Id
required
number
 
Item ID (subscription/certificate)


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
object (LoyaltyGenerateCode200Option) 
 
required
object (LoyaltyGenerateCode200DataOption) 
 
meta
required
Array of objects
 
success
required
boolean
 
Response Schema: application/json
object (LoyaltyGenerateCodeErrorOption) 
 
required
object (LoyaltyGenerateCodeErrorMetaOption) 
 
success
required
boolean
 
Response Schema: application/json
object (LoyaltyGenerateCodeErrorOption) 
 
required
object (LoyaltyGenerateCodeErrorMetaOption) 
 
success
required
boolean
 
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get a list of available subscription types 
A list of subscription types available at a branch can be obtained by requesting the branch ID.
The list can be filtered by subscription type name by passing the title parameter.
Pagination is supported, specified by the page and page_size parameters.


The list is an array of subscription types.



Subscription type has the following structure:


| Field | Type | Description |
| -------------------------------| ------- | -------------------------------------------------- -------------------------------------------------- ---------------------------------- |
| id | number | Subscription type identifier |
| title | string | Subscription type name |
| allow_freeze | boolean | Is it possible to freeze memberships? true - allowed, false - not allowed |
| freeze limit | number | Maximum total freezing period (days) |
| salon_group_id | number | Identifier of the chain in which the subscription type is valid |
| period | number | Subscription expiration date (0 if not set) |
| period_unit_id | number | Subscription expiration unit (list of possible values, if not set - 0) |
| is_allow_empty_code | boolean | Allow the sale of a subscription without a code? true - allow, false - do not allow |
| is_united_balance | boolean | Total or separate subscription balance: true - total, false - separate |
| united_balance_services_count | number | Number of visits for total balance |



Measurement units of subscription type validity period






Meaning
Description





1
Day




2
Week




3
Month




4
Year





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
title
string
 
Subscription type name


page
number
 
Page number


page_size
number
 
The number of output lines per page. Maximum 100


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Conetnt-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array with data objects


object
 
Metadata (contains the number of subscription types found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a list of subscription types by ID 
A list of subscription types available at a branch can be obtained by querying the branch ID and subscription type IDs.


The list is an array of subscription types.


Get a list of subscription types by ID


    

  • Parameters
      

    • company_id (required, number) - company ID
      • 

    • id: 1 (optional, number) - subscription type ID (you can specify several additional parameters &ids[]={id}
      • 

    

    • 



Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
ids[]
number
 
Subscription type ID (you can specify several additional parameters &ids[]={id}


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array with data objects


object
 
Metadata (contains the number of subscription types found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a list of available certificate types 
A list of certificate types available at a branch can be obtained by querying the branch ID.
The list can be filtered by the name of the certificate type by passing the title parameter.
Pagination is supported, specified by the page and page_size parameters.


The list is an array of certificate types.



Certificate type has the following structure:


| Field | Type | Description |
| ----------------------| ------- | -------------------------------------------------- -------------------------------------------------- ------------------------------------------------- |
| id | number | Certificate type identifier |
| title | string | Certificate type name |
| balance | number | Certificate denomination |
| is_multi | boolean | Write-off type: true - multiple write-off, false - single write-off |
| company_group_id | number | ID of the chain where the certificate type is valid |
| item_type_id | number | Application Constraint (list of possible values) |
| expiration_type_id | number | Expiration limit (list of possible values) |
| expiration_date | string | Fixed burn date in ISO8601 format (null if not set) |
| expiration_timeout | number | Certificate validity period from the date of sale (0 if not set) |
| expiration_timeout_unit_id | number | The unit of measurement of the validity period of the certificate from the moment of sale (list of possible values, if not set - 0) |
| is_allow_empty_code | boolean | Allow sale of certificate without code? true - allow, false - do not allow |



Certificate Type Restriction






Meaning
Description





0
Unlimited




1
Any services without goods




2
Any goods without services




3
Some services without goods




4
Some services and any goods






Certificate Type Expiration Limit






Meaning
Description





0
No expiration date




1
Fixed date for all instances




2
Fixed period of validity from the date of sale






Units of certificate type validity period






Meaning
Description





1
Day




2
Week




3
Month




4
Year





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
title
string
 
Certificate type name


page
number
 
Page number


page_size
number
 
The number of output lines per page. Maximum 100


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
integer
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of certificate types found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a list of certificate types by ID 
A list of certificate types available at the branch can be obtained by querying the branch ID and certificate type IDs.


The list is an array of certificate types.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of certificate types found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get a list of promotions active in the branch 
The method allows you to get a list of promotions that are active for the specified branch.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
include
string
 
The first_transaction_date value adds the date of the first stock transaction to the response.


type
string
 Enum: "discount_static" "discount_accumulative_visits" "discount_accumulative_sold" "discount_accumulative_paid" "cashback_static_sold" "cashback_static_paid" "cashback_accumulative_paid" "cashback_accumulative_sold" "cashback_accumulative_paid_visits" "cashback_accumulative_sold_visits" "cashback_sold_visits" "cashback_paid_visits" "package_discount" 
 
Promotion type


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status.


Array of objects
 
An array of data objects.


object
 
Metadata (contains the number of objects found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get customer statistics 
The method allows you to get statistics on returning, new and lost customers


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
date_to
required
string
 
Period end date


date_from
required
string
 
Period start date


loyalty_program_id
required
string
 
Promotion ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get revenue statistics 
The method allows you to get statistics on revenue.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
date_to
required
string
 
Period end date


date_from
required
string
 
Period start date


loyalty_program_id
required
string
 
Promotion ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get employee return 
The method allows you to get the return statistics for an employee


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
date_to
required
string
 
Period end date


date_from
required
string
 
Period start date


loyalty_program_id
required
string
 
Promotion ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status


Array of objects
 
Array with data objects


object
 
Metadata (contains the number of objects found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
User records
Get user records 
The JSON Object containing the user record parameters has the following fields:






Field
Type
Mandatory
Description





id
number
YES
Record ID




services
array of numbers
YES
List of ID service records




company
object
YES
Company parameters




staff
object
YES
Parameters of the specialist who was booked




clients_count
int
YES
Number of clients




date
string
YES
Session date




datetime
string
YES
Session date in ISO




create_date
string
YES
Record creation date




length
number
YES
Session duration




deleted
boolean
YES
Has the entry been made (true if deleted)




notify_by_sms
number
NO
How many hours in advance to send an SMS reminder about the appointment (0 if you do not need to be reminded)




notify_by_email
number
NO
How many hours in advance to send an email reminder about the appointment (0 if you do not need to be reminded)




comment
string
YES
Post Comment




master_requested
boolean
YES
Whether a specific specialist was specified when recording (false if "doesn't matter" was specified)




online
boolean
YES
Whether the entry is online or not (false if the entry was made by an administrator)




visit_attendance
number
YES
2 - The user confirmed the entry, 1 - The user came, the services were provided, 0 - the user was waiting, -1 - the user did not come to visit




api_id
string
NO
External Record ID




last_change_date
string
NO
Date of the last edit of the record




prepaid
boolean
NO
Is online payment available for registration




prepaid_confirmed
boolean
NO
Online payment status




last_change_date
string
NO
Date of the last edit of the record




activity_id
int
NO
ID bringing group entry





Each object in the services array has the following fields:






Field
Type
Description





id
number
Service ID




title
string
Service name




cost
float
Service cost




price_min
float
Minimum price of the service




price_max
float
Maximum service price




discount
float
Discount




amount
int
Number of ordered services




session_length
int
Service duration in seconds (only if filter by employee is set)





The company object has the following fields:






Field
Type
Description





id
number
Company ID




title
string
Company name




country_id
number
Identifier of the country in which the company is located




country
string
Company name




city_id
number
Identifier of the city where the company is located)




city
string
Company city name




time zone
string
timezone companies




address
string
Address where the company is located




phone
string
Company's main phone number




phones
array of strings
All phone numbers of the company




coordinate_lat
float
Latitude where the company is located




coordinate lng
float
Longitude




allow_delete_record
boolean
Is it possible to delete an entry




allow_change_record
boolean
Is it possible to transfer the entry




site
string
Company website




currency_short_title
string
Currency symbol




allow_change_record_delay_step
int
Time after which you can transfer the record




allow_delete_record_delay_step
int
Time after which you can delete a record





The staff object has the following fields:






Field
Type
Description





id
number
Employee ID




name
string
Employee name




specialization
string
Employee specialization




position
object
Employee position




show_rating
number
Whether to show employee's rating (1 - show, 0 - don't show)




rating
number
Employee rating




votes_count
number
Number of votes rated employee




comments_count
number
Number of comments to an employee




avatar
string
Path to employee avatar file





Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Employees
Quick create an employee 
Creates a new employee with a minimal set of parameters.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
name
required
string
 
Name of an employee.


specialization
required
string
 
Specialization of an employee.


position_id
required
number or null
 
ID of a position that should be linked to an employee.


phone_number
required
string or null
 
Phone number of a user that should be linked to an employee (without "+", 9 to 15 digits).


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Object of model "Employee with Position") 
 
meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Request validation error message) 
 
Additional response data.


 Request samples 
Content type
application/json
{
  • "name": "John Johnson",
  • "specialization": "Master",
  • "position_id": 123,
  • "phone_number": "11234567890"
}
 Response samples 
Content type
application/json
{}
Deprecated. Add new employee  Deprecated 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
name
string
 
Employee name


specialization
string
 
Employee specialization


weight
number
 
Employee weight. Employees are sorted by weight on exit, heavier first


information
string
 
Employee information (HTML format)


api_id
string
 
External employee ID


hidden
number
 
Display status in online entry, 1 - hidden, 0 - not hidden


fired
number
 
The employee's dismissal status, 1 - dismissed, 0 - not dismissed


user_id
number
 
Linked user ID, 0 - unlink user


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of employees found)


 Request samples 
Content type
application/json
{
  • "name": "Basil",
  • "specialization": "the hairdresser",
  • "weight": 10,
  • "information": "Trimming with three hands",
  • "api_id": "42",
  • "hidden": 0,
  • "fired": 0,
  • "user_id": 123
}
 Response samples 
Content type
application/json
{}
Get a list of employees / specific employee 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


staff_id
required
number
 
Employee ID, if you need to work with a specific employee.


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of employees found)


Response Schema: application/json
success
boolean
 
Execution success status (false)


data
string
 
Contains null


object
 
Metadata (contains an error message)


Response Schema: application/json
success
boolean
 
Execution success status (false)


object
 
Metadata (contains an error message)


 Response samples 
Content type
application/json
{}
Deprecated. Get a list of employees / specific employee  Deprecated 
Authorizations:
bearer
path Parameters
company_id
required
number
 
Company ID


staff_id
required
number
 
Employee ID, if you need to work with a specific employee.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{}
Change employee 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


staff_id
required
number
 
Employee ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
name
string
 
Employee name


specialization
string
 
Employee specialization


weight
number
 
Employee weight. Employees are sorted by weight on exit, heavier first


information
string
 
Employee information (HTML format)


api_id
string
 
External employee ID


hidden
number
 
Display status in online entry, 1 - hidden, 0 - not hidden


fired
number
 
The employee's dismissal status, 1 - dismissed, 0 - not dismissed


user_id
number
 
Linked user ID, 0 - unlink user


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of employees found)


 Response samples 
Content type
application/json
{}
Delete employee 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


staff_id
required
number
 
Employee ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Chain clients
Get a chain client by phone number. 
    

  • Parameter
      

    • group_id (required, number, 43877) - Id of the salon chain
      • 

    

    • 



Client filtering


    

  • phone:'70001234567' (optional, string) - Phone to filter clients
    • 



Authorizations:
(beareruser) 
path Parameters
group_id
required
number
 
Salon chain ID


query Parameters
phone
required
string
 
 Example:  phone='79264037640'
Phone to filter clients, required parameter


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token.User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


Response Schema: application/json
success
boolean
 
Execution success status


data
string
 
Contains null


object
 
Object with error message


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Resources
Getting Resources at a Branch 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array with data objects


object
 
Metadata (contains the number of resources found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Employee work schedule
Get an employee's schedule 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


staff_id
required
number
 
Employee ID.


start_date
required
number
 
 Example:  ''
Period start date


end_date
required
number
 
 Example:  ''
Period end date


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
date
required
string
 
date in iso8601 format.


is_working
required
boolean
 
Free time or not.


slots
Array of objects
 
An array of (from, to) working time intervals.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Change an employee's work schedule 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


staff_id
required
number
 
Employee ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: */*
date
required
string
 
date


is_working
required
boolean
 
Working date or not


slots
required
object
 
Array of (from, to) working hours


Responses
Sessions for the magazine
Get a list of sessions for a log 
The sessions object for the log has the following fields:






Field
Type
Description





time
string
Session time (17:30 for example)




free
boolean
Free time or busy





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


date
required
string
 
date in iso8601 format.
Filter by booking date (eg '2015-09-30')


staff_id
required
number
 
Employee ID.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
time
required
string
 
Session time


is_free
required
boolean
 
free time or not


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
KKM transactions
Get transactions 
Filters






Parameter
Description





page
Page number




editable_length
Number of clients per page




type
Operation type




status
Operation status




start_date
Period start date




end_date
Period end date






Types of all transactions with cash register






Meaning
Description





0
Sales operation (active for a document with the "Visit" type)




1
Sale return operation (active for a document with the "Visit" type)




2
Correction operation




4
Shift opening operation




5
Shift closing operation




9
The operation of obtaining the status of KKM




11
The operation of obtaining the status of the KKM team




12
Correction operation




13
Print X-report




6
Cash deposit




7
Withdrawal of cash





Statuses of all operations with KKM






Meaning
Description





0
Connection error with KKM




1
Successfully




2
Sent for printing




3
Runtime error




4
Status check error




5
Waiting for KKM readiness





Document types






Meaning
Description





1
Sale of goods




2
Provision of services




3
Arrival of goods




4
Goods write-off




5
Movement of goods




6
Inventory




7
Visit




8
Write-off of consumables




9
Deposit replenishment





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
page
number
 
 Example:  page=1
Page number


editable_length
number
 
 Example:  editable_length=25
Number of customers per page


type
number
 
 Example:  type=20
Type of transaction


status
number
 
 Example:  status=6
Operation status


start_date
number
 
 Example:  start_date=''
Period start date


end_date
number
 
 Example:  end_date=''
Period end date


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer access_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of transactions found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Print receipt 
Types of all transactions with cash register






Meaning
Description





0
Sale operation (active for documents with types "Visit" and "Deposit replenishment")




1
Sale return operation (active for documents with types "Visit" and "Deposit replenishment")




2
Correction operation




4
Shift opening operation




5
Shift closing operation




9
The operation of obtaining the status of KKM




11
The operation of obtaining the status of the KKM team




12
Correction operation




13
Print X-report




6
Cash deposit




7
Withdrawal of cash





Document types






Meaning
Description





1
Sale of goods




2
Provision of services




3
Arrival of goods




4
Goods write-off




5
Movement of goods




6
Inventory




7
Visit




8
Write-off of consumables




9
Deposit replenishment





Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


Request Body schema: */*
document_id
required
number
 
Document ID


type
required
number
 
type of operation with cash register (see table of types of all operations)


is_pos_enabled
boolean
 
enable POS terminal (default false)


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Sale operation
Receipt of a Sales Transaction 
Authorizations:
(beareruser) 
path Parameters
document_id
required
integer
 
Sales Document ID


company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Deleting a cashier payment transaction 
As a response, information about the Sale operation is returned


Authorizations:
(beareruser) 
path Parameters
document_id
required
integer
 
Sales Document ID


payment_transaction_id
required
integer
 
transaction ID


company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Deleting a loyalty payment transaction 
As a response, information about the Sale operation is returned


Authorizations:
(beareruser) 
path Parameters
document_id
required
integer
 
Sales Document ID


payment_transaction_id
required
integer
 
transaction ID


company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Payment at the cash desk and loyalty (various methods) 
As a response, information about the Sale operation is returned


Authorizations:
(beareruser) 
path Parameters
document_id
required
number
 
Document ID


company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
    

  1. In the case of payment by a certificate, if the user does not have the "Pay by certificate and subscription without code" right, the "number" (string) parameter containing the certificate code must also be passed in the request body.
    2. 

  2. In the case of payment by subscription, if the user does not have the "Pay by certificate and subscription without code" right, the "number" (string) parameter containing the subscription code must also be passed in the request body.
    3. 



 Any of 
object
 
Object containing the payment method


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
Example
{
  • "payment": {
    }
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Integration with chain telephony
Telephony events 
Enable integration


To use the api and activate access to the settings in the user interface, you need to activate the integration by sending the "Enable integration" request. After a successful connection, access to the section with routing settings will be opened in the chain user interface.


Disable integration


To disable the integration, you can use the "Disable integration" method. After the integration is disabled, access to the user interface settings section is closed, the requests "Call notification" and "Call information saving" are not processed.


Call notification


To display notifications about an incoming call, the "Call notification" method is used, the call type ("incoming", "outgoing", "internal") is specified in the parameters, but currently notifications are displayed only for the "incoming" value. Notifications are displayed for users defined based on routing settings. When specifying the "user" and "diversion" parameters at the same time, "user" is the priority when searching for routes.


Saving call information


The information about the call is automatically saved to the chain history and to the history of chain companies in accordance with the call routing settings.


Authorizations:
bearer
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Request Body schema: application/json
Request bodies


 Any of 
command
required
string
 
Slug of operation 'setup'


type
required
string
 
Operation type, in this case 'enable'


crm_token
required
string
 
CRM-token from the Telephony-Integration in the client's chain section


Responses
Response Schema: application/json
success
boolean
 
Success status (true)


data
string
 
Contains null


object
 
Metadata (contain an "Accepted" message)


 Request samples 
Content type
application/json
Example
{
  • "command": "setup",
  • "type": "enable",
  • "crm_token": "7cf262d6-1656-43f9-86ac-2826bdc125d2"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "meta": {
    }
}
Get branch's call list 
This endpoint is designed to get a list of calls in a branch, taking into account filters and pagination


Authorizations:
BearerPartnerUser
Request Body schema: application/json
salon_id
required
number
 
Branch ID.


date_from
required
string
 
Sample start date.


date_to
required
string
 
Sample start end.


phone
string
 
Phone number.


types
Array of strings
Items Enum: "incoming" "outgoing" "internal" 
 
Call types list


statuses
Array of strings
Items Enum: "success" "missed" "cancel" "busy" "notallowed" "notavailable" "notfound" 
 
Call statuses list


page
number
 
Page number


limit
number  <= 1000 
 
Amount of elements on page


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


Array of objects
 
Calls list


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


 Request samples 
Content type
application/json
{
  • "salon_id": 615243,
  • "date_from": "2023-01-01",
  • "date_to": "2023-02-01",
  • "phone": "79111234567",
  • "types": [
    ],
  • "statuses": [
    ],
  • "page": 1,
  • "limit": 25
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}
Subscriptions
Freeze subscription 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
 Example:  123
Chain ID.


abonementId
required
number
 
 Example:  123
Subscription ID.


Request Body schema: application/json
freeze_till
required
string
 
The date until which the subscription will be frozen.


Responses
 Request samples 
Content type
application/json
{
  • "freeze_till": "string"
}
 Response samples 
Content type
application/json
[
  • {
    }
]
Unfreeze subscription 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
 Example:  123
Chain ID.


abonementId
required
number
 
 Example:  123
Subscription ID.


Responses
 Response samples 
Content type
application/json
[
  • {
    }
]
Change subscription duration 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
 Example:  123
Chain ID.


abonementId
required
number
 
 Example:  123
Subscription ID.


Request Body schema: application/json
period
required
number
 
Period duration


period_unit_id
required
number
 
Period type (1 - day, 2 - week, 3 - month, 4 - year)


Responses
 Request samples 
Content type
application/json
{
  • "period": 0,
  • "period_unit_id": 0
}
 Response samples 
Content type
application/json
[
  • {
    }
]
Change the number of times a subscription has been used 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
 Example:  123
Chain ID.


abonementId
required
number
 
 Example:  123
Subscription ID.


Request Body schema: application/json
united_balance_services_count
required
number
 
Number of services for a subscription with a pooled balance


required
Array of objects
 
Transfer service-amount for a subscription with a separate balance


Responses
 Request samples 
Content type
application/json
{
  • "united_balance_services_count": 0,
  • "services_balance_count": [
    ]
}
 Response samples 
Content type
application/json
[
  • {
    }
]
Get a list of subscriptions by filter 
Authorizations:
(beareruser) 
path Parameters
chain_id
required
number
 
 Example:  123
Chain ID.


query Parameters
created_after
string
 
 Example:  created_after=1630454400
Creation date from (filter by creation date).


created_before
string
 
 Example:  created_before=1630454400
Creation date by (filter by creation date).


abonements_ids
Array of numbers
 
List of identifiers for the filter.


page
number
 
 Example:  page=1
Page number.


count
number
 
 Example:  count=25
The number of entries per page.


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
 Response samples 
Content type
application/json
[
  • {
    }
]
Get customer subscriptions 
Returns a list of customer's subscriptions by phone


Authorizations:
(beareruser) 
query Parameters
company_id
required
number
 
Branch ID


phone
required
number
 
Customer phone number


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of subscriptions found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get User Subscriptions 
Returns a list of subscriptions of an authorized user


Authorizations:
(beareruser) 
query Parameters
company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of subscriptions found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Certificates
Get client certificates 
Returns a list of client certificates by phone


| Attribute | Type | Description |
|-----------------|-----------|------------------- ---------------------------------|
| id | int | Certificate ID |
| number | string | Certificate code |
| balance | decimal | Current balance |
| default_balance | decimal | Initial balance |
| type_id | int | Certificate type identifier |
| status_id | int | Status ID |
| created_date | timestamp | Date of sale |
| expiration_date | datetime | Burn date |
| type | object | Object with certificate type information |
| status | object | An object with information about the current certificate status |


The type array contains the following objects:


| Attribute | Type | Description |
|----------------------|---------|---------- -------------------------------------------------- -------------------------------------------------- ----------------------------------------|
| id | int | Certificate type identifier |
| title | string | Type name |
| balance | decimal | Certificate denomination |
| is_multi | boolean | Is it available for multiple debits |
| company_group_id | int | ID of the chain where the certificate type was created |
| item_type_id | int | Restriction on the use of redemption points. 0 - no limit, 1 - services only, 2 - some services + all products, 3 - some services, 4 - products only |
| expiration_type_id | int | The ID of the expiration limit. 0 - unlimited, 1 - fixed date, 2 - fixed term |
| expiration_date |timestamp| Burn date of all certificates. Populated with expiration_type_id = 1 |
| expiration_timeout | int | Validity period of certificates. Populated with expiration_type_id = 2 |
| expiration_timeout_unit_id | int | Time units. 1 - Day, 2 - Week, 3 - Month, 4 - Year |
| is_allow_empty_code | boolean | Sale without code |
| item_type | object | Object with item_type_id and its name


Authorizations:
(beareruser) 
query Parameters
copmany_id
required
number
 
Branch ID


phone
required
number
 
Customer phone number


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of certificates found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get user certificates 
Returns a list of authorized user certificates


Authorizations:
(beareruser) 
query Parameters
company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of certificates found)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Cities
Get a list of cities 
Authorizations:
bearer
query Parameters
country_id
number
 
Country ID to get cities from


company_id
number
 
Branch ID. If passed, the city of the branch will also be returned, regardless of whether it belongs to the specified country or not


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Images
Image upload 
The response object has the following fields:






Field
Type
Description





image_binded
boolean
Status of linking images to an entity




image_group
object
Image group object





Authorizations:
(beareruser) 
path Parameters
entity
required
string
 
 Example:  "master"
entity name (master/service)


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
form-data


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: multipart/form-data
company_id
number
 
Salon ID for image binding (for entity=service)


service_id
number
 
Service ID for image binding (for entity=service)


master_id
number
 
Employee ID for image binding (for entity=master)


image
required
string
 
transferred image (image/jpeg, image/png)


Responses
Response Schema: application/json
object (ImageGroup) 
 
required
object (ImageGroup) 
 
 Response samples 
Content type
application/json
{}
Deleting images 
The response object has the following fields:






Field
Type
Description





success
boolean
Deletion result





Authorizations:
(beareruser) 
path Parameters
entity
required
string
 
entity name (master/service)


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
form-data


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: multipart/form-data
image_group_id
required
number
 
Image group ID to delete


Responses
Licenses
Obtaining company license information 
Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
object (LicenseOption) 
 
active
required
number
 
Is the license active


deactivation_date
required
string
 
License expiration date


id
required
number
 
License ID


name
required
string
 
License name


options
required
Array of objects
 
License options


salon_id
required
number
 
Company ID


staff_limit
required
number
 
Employee limit


start_date
required
string
 
License start date


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Reviews and tips
Get feedback form status 
Authorizations:
bearer
path Parameters
recordToken
required
string
 
Short entry token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{}
Submitting a feedback form 
Authorizations:
(beareruser) 
path Parameters
recordToken
required
string
 
Short entry token


Request Body schema: application/json
rating
required
integer <int32> 
 
Rating for the review (number of stars from 1 to 5)


text
string
 
Feedback text


tips_amount
number <double> 
 
Tip amount


redirect_prefix
string
 
The prefix part of the url that will be redirected to after returning from the payment form


Responses
 Request samples 
Content type
application/json
{}
 Response samples 
Content type
application/json
{}
Tips
Get a list of salon masters with their tip settings 
Authorizations:
(beareruser) 
path Parameters
company_id
required
integer
 
salon id


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of found masters)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ]
}
Enable tips at the master 
Authorizations:
(beareruser) 
path Parameters
master_tips_settings_id
required
integer
 
tip settings id


company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of found masters)


 Response samples 
Content type
application/json
{}
Disable tips from the master 
Authorizations:
(beareruser) 
path Parameters
company_id
required
integer
 
salon id


master_tips_settings_id
required
integer
 
tip settings id


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array of objects with data


object
 
Metadata (contains the number of found masters)


 Response samples 
Content type
application/json
{}
Payroll
Search payroll calculations of an employee 
The method allows company owner to search payroll calculations for the period for an employee.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


Array of objects (Mutual settlements) 
 
object (Meta object with response results count) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Request validation error message) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get payroll calculation details of an employee 
The method allows company owner to get details of a specific payroll calculation.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


calculation_id
required
number
 
 Example:  789
ID of a salary calculation.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Salary calculation object with details) 
 
meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Obtaining payroll schemes count for an employee 
The method allows you to get salary calculation schemes count for an employee before trying to obtain calculation data.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Salary schemes count) 
 
meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Receipt of mutual settlements of an employee 
The method allows company owner to get mutual settlements of an employee.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Mutual settlements) 
 
Mutual settlements.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Request validation error message) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Receipt of mutual settlements of an employee grouped by date 
The method allows company owner to get mutual settlements of an employee grouped by date.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Mutual settlements grouped by date) 
 
Mutual settlements grouped by date.


object (Meta object with response results count) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Request validation error message) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}
Getting payroll for a period for an employee 
The method allows company owner to get the calculation for the period for an employee.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Mutual settlements) 
 
Mutual settlements.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Request validation error message) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Getting payroll for a period for an employee grouped by date 
The method allows company owner to get the calculation for the period for an employee grouped by date.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Payroll for a period for an employee grouped by date) 
 
Payroll for a period for a specific employee grouped by date.


object (Meta object with response results count) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Request validation error message) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": {
    }
}
Receipt of own mutual settlements of a specific employee 
The method allows you to get own mutual settlements of a specific employee. In the user's access rights, the checkbox "Access to payroll only for a specific employee" must be specified.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Mutual settlements) 
 
Mutual settlements.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Request validation error message) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Obtaining own payroll schemes for a specific employee 
The method allows you to get own salary calculation schemes for a specific employee.
In the user's access rights, the checkbox "Access to payroll only for a specific employee" must be specified.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


Array of objects (Salary scheme object) 
 
object (Meta object with response results count) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Getting own payroll for a period for a specific employee 
The method allows you to get the calculation for the period for a specific employee.
In the user's access rights, the checkbox "Access to payroll only for a specific employee" must be checked.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


staff_id
required
number
 
 Example:  123
ID of an employee.


query Parameters
date_from
required
string
 
 Example:  date_from=2023-03-01
Start from date.


date_to
required
string
 
 Example:  date_to=2023-03-31
End to date.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Payroll for a period for an employee) 
 
Payroll for a period for a specific employee.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Request validation error message) 
 
Additional response data.


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Notifications
Get notification settings in a branch 
The method allows you to get notification settings in a branch.


Authorizations:
(userbearer) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, USer user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status


Array of objects
 
Array of objects


object
 
Metadata (contains the number of objects)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": {
    }
}
Get user notification settings 
The method allows you to get notification settings for a particular branch user.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


user_id
required
number
 
User ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Change User Push Notification Settings 
The method allows you to change the user's PUSH notification settings.
The type of notification to be changed (record_create_online_staff or record_create_online_admin, etc.) should be selected based on the type of notification specified by the user (mode: admin or mode: staff)


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


user_id
required
number
 
User ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer bearer_token, User user_token


Request Body schema: application/json
Array of objects
 
Array of objects


Responses
Response Schema: application/json
success
boolean
 
Execution success status


object
 
Object with data


meta
Array of objects
 
Metadata (empty array)


 Request samples 
Content type
application/json
{
  • "notification_types": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Products
Create product 
The method allows you to create a product


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
title
required
string
 
Product Name


print_title
string
 
Title to be printed on receipt


article
string
 
vendor code


barcode
string
 
Barcode


category_id
required
integer
 
Product category ID


cost
number <float> 
 
Selling price


actual_cost
number <float> 
 
Cost price


sale_unit_id
required
integer
 
Sales unit


service_unit_id
required
integer
 
Write-off unit


unit_equals
number <float> 
 
The ratio of the unit of measure for sale to the unit of measure for write-off


critical_amount
number <float> 
 
critical residue


desired_amount
number <float> 
 
Desired balance


netto
number <float> 
 
Net weight


brutto
number <float> 
 
Gross weight


comment
string
 
A comment


tax_variant
integer
 
Taxation system


vat_id
integer
 
VAT


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array with data objects


meta
Array of objects
 
Metadata (empty array)


Response Schema: application/json
success
boolean
 
Execution success status


data
string
 
Contains null


object
 
Contains an error message


 Request samples 
Content type
application/json
{
  • "title": "Shampoo",
  • "print_title": "Shampoo",
  • "article": "123",
  • "barcode": "123",
  • "category_id": 289632,
  • "cost": 1000,
  • "actual_cost": 500,
  • "sale_unit_id": 216762,
  • "service_unit_id": 216762,
  • "unit_equals": 100,
  • "critical_amount": 1,
  • "desired_amount": 1,
  • "netto": 200,
  • "brutto": 250,
  • "comment": "Test comment 123",
  • "tax_variant": 0,
  • "vat_id": 3
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Get goods 
    

  • term: Name, article or barcode
    

    • 

  • page (number, 1) - Page number (not used if good_id is passed)
    

    • 

  • count (number, 25) - Number of products on the page (not used if good_id is passed)
    

    • 

  • category_id (number, 777) - Id of the product category (not used if good_id is passed)
    

    • 

  • changed_after (string) - filtering products changed/created since a specific date and time (not used if good_id is passed)
    

    • 

  • changed_before (string) - filtering products changed/created before a specific date and time (not used if good_id is passed)
    

    • 



Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


good_id
required
number
 
Product ID (if you need to get a specific product)


query Parameters
term
string
 
name, article number or barcode


page
number
 
 Example:  page=1
page number


count
number
 
 Example:  count=25
number of products per page


category_id
number
 
Product category ID


changed_after
string
 
 Example:  changed_after=1483272000
filtering products modified/created since a specific date and time


changed_before
string
 
 Example:  changed_before=2017-01-01T12:00:00+0400
filtering products modified/created before a specific date and time


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
e.g. application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array with data objects


meta
Array of objects
 
Metadata (empty array)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Edit product 
The method allows you to change the product parameters.
When editing units of measure for an item that already has warehouse operations, you must add an array of rules for recalculating units of measure - correction_rules. Otherwise, the array is optional.


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


good_id
required
number
 
Item ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Request Body schema: application/json
title
required
string
 
Product Name


print_title
string
 
Title to be printed on receipt


article
string
 
vendor code


barcode
string
 
Barcode


category_id
required
integer
 
Product category ID


cost
number <float> 
 
Selling price


actual_cost
number <float> 
 
Cost price


sale_unit_id
required
integer
 
Sales unit


service_unit_id
required
integer
 
Write-off unit


unit_equals
number <float> 
 
The ratio of the unit of measure for sale to the unit of measure for write-off


critical_amount
number <float> 
 
critical residue


desired_amount
number <float> 
 
Desired balance


netto
number <float> 
 
Net weight


brutto
number <float> 
 
Gross weight


comment
string
 
A comment


tax_variant
integer
 
Taxation system


vat_id
integer
 
VAT


Array of objects
 
An array of rules for converting units of measurement (required if there are warehouse operations for the product)


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


Array of objects
 
Array with data objects


meta
Array of objects
 
Metadata (empty array)


Response Schema: application/json
success
boolean
 
Execution success status


data
string
 
Contains null


object
 
Object with error message


Response Schema: application/json
success
boolean
 
Execution success status


data
string
 
Contains null


object
 
Contains an error message


 Request samples 
Content type
application/json
{
  • "title": "Shampoo",
  • "print_title": "Shampoo",
  • "article": "123",
  • "barcode": "123",
  • "category_id": 289632,
  • "cost": 1000,
  • "actual_cost": 500,
  • "sale_unit_id": 216762,
  • "service_unit_id": 216762,
  • "unit_equals": 100,
  • "critical_amount": 1,
  • "desired_amount": 1,
  • "netto": 200,
  • "brutto": 250,
  • "comment": "Test comment 123",
  • "tax_variant": 0,
  • "vat_id": 3,
  • "correction_rules": [
    ]
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Delete item 
The method allows you to remove the product


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Branch ID


good_id
required
number
 
Item ID


header Parameters
Accept
required
string
 
application/vnd.api.v2+json


Content-Type
required
string
 
application/json


Authorization
required
string
 
Bearer partner_token, User user_token


Responses
Online recording settings
Getting Online Recording Settings 
Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object (Root Type for company_get_online_settings_response_data_field_data_types) 
 
meta
Array of objects
 
metadata


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update Online Recording Settings 
Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Request Body schema: application/json
confirm_number
required
boolean
 
Confirm customer number via SMS


any_master
required
boolean
 
"Any employee" mode


seance_delay_step
required
integer  [ 0 .. 1380 ] 
 
Delay to the next session, in minutes from 0 to 23 hours (inclusive) in increments of 30 minutes


activity_online_record_clients_count_max
required
integer  [ 1 .. 255 ] 
 
Maximum number of seats in one event record


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object (Root Type for company_get_online_settings_response_data_field_data_types) 
 
meta
Array of objects
 
metadata


 Request samples 
Content type
application/json
{
  • "confirm_number": false,
  • "any_master": true,
  • "seance_delay_step": 90,
  • "activity_online_record_clients_count_max": 1
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Recording log settings
Retrieving Recording Log Settings 
Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object (Root Type for company_get_timetable_settings_response_data_field_data_types) 
 
meta
Array of objects
 
metadata


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Update log settings 
Authorizations:
(beareruser) 
header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Request Body schema: application/json
record_type
required
integer  [ 0 .. 2 ] 
 
Default record type: 0 - Mixed record, 1 - Individual record, 2 - Group record


activity_record_clients_count_max
required
integer  [ 1 .. 255 ] 
 
Maximum number of seats in one event record


Responses
Response Schema: application/json
success
boolean
 
Execution success status (true)


object (Root Type for company_get_timetable_settings_response_data_field_data_types) 
 
meta
Array of objects
 
metadata


 Request samples 
Content type
application/json
{
  • "record_type": 0,
  • "activity_record_clients_count_max": 1
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Letterform settings
Get a list of letters 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Responses
Response Schema: application/json
required
Array of objects (Root Type BookformSettingsResponse) 
 
Array of data


meta
required
Array of objects
 
Metadata (contains the total count of bookforms)


success
required
boolean
 
Success status (true)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "meta": [ ]
}
Create a letterform 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Request Body schema: application/json
title
required
string
 
Name of the letterform


description
string
 Default:  ""
 
Letter description


is_default
boolean
 Default:  false
 
Default letterform flag


without_menu
boolean
 Default:  false
 
Step mode flag


service_step_default
number
 
Service ID


service_step_hide
boolean
 Default:  false
 
Service Hiding Flag


master_step_default
number
 
Master ID


master_step_hide
boolean
 Default:  false
 
Master hide flag


service_step_num
number
 
Service step sequence number


master_step_num
number
 
Sequence number of the wizard step


datetime_step_num
number
 
Sequence number of the date and time step


show_button
boolean
 Default:  true
 
Button visibility flag


button_position
string
 Default:  "bottom right"
 Enum: "bottom right" "bottom left" "top right" "top left " 
 
Button location on the page


form_position
string
 Default:  "right"
 Enum: "right" "left" 
 
Panel position on the page


button_color
string
 Default:  "#1c84c6"
 
Button color


button_animation
boolean
 Default:  true
 
Button animation enable flag


Responses
Response Schema: application/json
required
object (Root Type BookformSettingsResponse) 
 
Letterform settings


meta
required
Array of objects
 
Metadata


success
required
boolean
 
Success status (true)


 Request samples 
Content type
application/json
{
  • "title": "string",
  • "description": "",
  • "is_default": false,
  • "without_menu": false,
  • "service_step_default": 0,
  • "service_step_hide": false,
  • "master_step_default": 0,
  • "master_step_hide": false,
  • "service_step_num": 0,
  • "master_step_num": 0,
  • "datetime_step_num": 0,
  • "show_button": true,
  • "button_position": "bottom right",
  • "form_position": "right",
  • "button_color": "#1c84c6",
  • "button_animation": true
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Get a letterform 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


form_id
required
number
 
Letterform ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Responses
Response Schema: application/json
required
object (Root Type BookformSettingsResponse) 
 
Letterform settings


meta
required
Array of objects
 
Metadata


success
required
boolean
 
Success status (true)


 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Delete letterform 
path Parameters
company_id
required
number
 
Company ID


form_id
required
number
 
Letterform ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Responses
Change letterform 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


form_id
required
number
 
Letterform ID


header Parameters
Accept
required
string
 
e.g. application/vnd.api.v2+json


Authorization
required
string
 
Bearer partner_token, User user_token


Content-Type
required
string
 
application/json


Request Body schema: application/json
title
required
string
 
Name of the letterform


description
required
string
 
Letter description


is_default
required
boolean
 
Default letterform flag


without_menu
required
boolean
 
Step mode flag


service_step_default
required
number
 
Service ID


service_step_hide
required
boolean
 
Service Hiding Flag


master_step_default
required
number
 
Master ID


master_step_hide
required
boolean
 
Master hide flag


service_step_num
required
number
 
Service step sequence number


master_step_num
required
number
 
Sequence number of the wizard step


datetime_step_num
required
number
 
Sequence number of the date and time step


show_button
required
boolean
 
Button Visibility Step


button_position
required
string
 Enum: "bottom right" "bottom left" "top right" "top left" 
 
Button location on the page


form_position
required
string
 Enum: "right" "left" 
 
Panel position on the page


button_color
required
string
 
Button color


button_animation
required
boolean
 
Button animation enable flag


Responses
Response Schema: application/json
required
object (Root Type BookformSettingsResponse) 
 
Letterform settings


meta
required
Array of objects
 
Metadata


success
required
boolean
 
Success status (true)


 Request samples 
Content type
application/json
{
  • "title": "string",
  • "description": "string",
  • "is_default": true,
  • "without_menu": true,
  • "service_step_default": 0,
  • "service_step_hide": true,
  • "master_step_default": 0,
  • "master_step_hide": true,
  • "service_step_num": 0,
  • "master_step_num": 0,
  • "datetime_step_num": 0,
  • "show_button": true,
  • "button_position": "bottom right",
  • "form_position": "right",
  • "button_color": "string",
  • "button_animation": true
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": [ ]
}
Positions
Get a list of company positions 
The method allows you to get a list of current positions in the company


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


Responses
Response Schema: application/json
required
Array of objects (StaffPosition) 
 
Array of objects with data


meta
required
Array of objects
 
Metadata (contains the number of posts found)


success
required
boolean
 
Execution success status (true)


 Response samples 
Content type
application/json
{
  • "data": [
    ],
  • "meta": [
    ],
  • "success": true
}
Quick create a position 
Creates a new position in a company; position is created as a chain entity and at the same time linked to a company initiated its creation.


Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
 
 Example:  123
ID of a company.


header Parameters
Accept
required
string
 
 Example:  application/vnd.api.v2+json
Should be equal to application/vnd.api.v2+json


Content-Type
required
string
 
 Example:  application/json
Should be equal to application/json


Request Body schema: application/json
title
required
string
 
Title of a position.


Responses
Response Schema: application/json
success
boolean (Successful response status) 
 
Response status.


object (Object of model "Position") 
 
Data for an existing position in a chain.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Response error message) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


meta
object (Empty meta object) 
 
Additional response data.


Response Schema: application/json
success
boolean (Unsuccessful response status) 
 
Response status.


data
object or null (No data in response) 
 
Response data.


object (Request validation error message) 
 
Additional response data.


 Request samples 
Content type
application/json
{
  • "title": "Position"
}
 Response samples 
Content type
application/json
{
  • "success": true,
  • "data": {
    },
  • "meta": { }
}
Analytics
Get key company metrics 
The method allows you to get the main indicators of the company for the selected period and compare with the previous period of the same duration


Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


staff_id
integer
 
ID of the company employee whose work needs to be analyzed


position_id
integer
 
Company position ID to analyze the work of all employees belonging to the same position


user_id
integer
 
The user ID of the company whose work you want to analyze


Responses
Response Schema: application/json
required
object (AnalyticsReportOverallStats) 
 
Summary indicators


meta
required
Array of objects
 
metadata


success
required
boolean
 
Execution success status (true)


 Response samples 
Content type
application/json
{
  • "data": {
    },
  • "meta": [
    ],
  • "success": true
}
Get data on revenue by day 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


staff_id
integer
 
ID of the company employee whose work needs to be analyzed


position_id
integer
 
Company position ID to analyze the work of all employees belonging to the same position


user_id
integer
 
The user ID of the company whose work you want to analyze


Responses
Response Schema: application/json
 Array 
label
string
 
Name of data series


data
Array of integers (AnalyticsReportOverallChartDailyRowItem) [ items <int32 >[ items <int32 > ] ]
 
Data for each day. Each day is an array of two numbers. The first number is the timestamp of the beginning of the day in the UTC zone, the second number is the value of the indicator on that day.


 Response samples 
Content type
application/json
[
  • {
    }
]
Get data on the number of entries by day 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


staff_id
integer
 
ID of the company employee whose work needs to be analyzed


user_id
integer
 
User ID of the company whose work you want to analyze


Responses
Response Schema: application/json
 Array 
label
string
 
Name of data series


data
Array of integers (AnalyticsReportOverallChartDailyRowItem) [ items <int32 >[ items <int32 > ] ]
 
Data for each day. Each day is an array of two numbers. The first number is the timestamp of the beginning of the day in the UTC zone, the second number is the value of the indicator on that day.


 Response samples 
Content type
application/json
[
  • {
    },
  • {
    },
  • {
    }
]
Get occupancy data by day 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


staff_id
integer
 
ID of the company employee whose work needs to be analyzed


user_id
integer
 
The user ID of the company whose work you want to analyze


Responses
Response Schema: application/json
 Array 
label
string
 
Name of data series


data
Array of integers (AnalyticsReportOverallChartDailyRowItem) [ items <int32 >[ items <int32 > ] ]
 
Data for each day. Each day is an array of two numbers. The first number is the timestamp of the beginning of the day in the UTC zone, the second number is the value of the indicator on that day.


 Response samples 
Content type
application/json
[
  • {
    }
]
Get the structure of records by source 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


staff_id
integer
 
ID of the company employee whose work needs to be analyzed


user_id
integer
 
The user ID of the company whose work you want to analyze


Responses
Response Schema: application/json
 Array 
label
string
 
Name of indicator


data
integer
 
Indicator value


 Response samples 
Content type
application/json
[
  • {
    },
  • {
    }
]
Get the structure of records by visit status 
Authorizations:
(beareruser) 
path Parameters
company_id
required
number
 
Company ID


query Parameters
date_from
required
string <date> 
 
Start date of the analyzed period


date_to
required
string <date> 
 
End date of the analyzed period (included in the report)


staff_id
integer
 
ID of the company employee whose work needs to be analyzed


user_id
integer
 
The user ID of the company whose work you want to analyze


Responses
Response Schema: application/json
 Array 
label
string
 
Name of indicator


data
integer
 
Indicator value


 Response samples 
Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]