YCLIENTS REST API

Это официальный документ, описывающий взаимодействие с сервисом онлайн-бронирования YCLIENTS.

При проектировании методов, мы старались придерживаться архитектуры REST

Все обращения к протоколу осуществляются с использованием SSL-шифрования.

Лимиты 200 запросов в минуту, или 5 запросов в секунду на один IP-адрес.

URL API: https://api.yclients.com

Вопросы, пожелания, сообщения об ошибках можно направлять по адресу support@yclients.com

API позволяет сторонним разработчикам выполнять большинство операций с платформой YCLIENTS.

Внимание! Большинство обращений в техническую поддержку связаны с тем, что разработчики не читают документацию. Обязательно прочтите раздел INTRODUCTION полностью и внимательно ознакомьтесь с информацией на других ресурсах, на которые мы ссылаемся. Для тестирования запросов мы рекомендуем использовать сервис Postman, при обращении в службу поддержки используйте скриншоты из Postman.

SDK

Ниже приведены ссылки на SDK сторонних разработчиков. В ближайшее время мы планируем подключиться к их улучшению и развитию. И всегда привествуем Opensource инициативы, если у вас есть возможности и желание развивать одну из предложенных библиотек это принесет общую пользу. Если решите создать свою - сообщите нам о ней, мы примем участие в развитии и разместим ссылку на нее здесь.

PHP: https://github.com/SlowProg/yclients-api

Кейсы интеграции с YCLIENTS

  1. Обмен данными с программой для автоматизации и учета.

  2. Интеграция онлайн-записи со стронними сайтами и мобильными приложениями (каталоги компаний, приложения компаний и т.п.)

Общее описание обмена данными с YCLIENTS

API для интеграции с YCLEINTS содержит две группы методов:

  1. Методы требующие авторизацию пользователя и авторизацию партнера
  2. Методы не требующие авторизации пользователя, но требующие авторизацию партнера

Авторизация запросов API

Для обращений и к первой и ко второй группе методов требуется авторизация партнера. Т.е. передача уникального hash-ключа партнера.

Авторизация запросов к API производится в соответствии с RFC 6749 "Resource Owner Password Credentials Grant". При запросах к API в HTTP заголовок Authorization должен быть включен ключ доступа в следущем формате:

Authorization: Bearer <partner token>

Для того, чтобы получить этот ключ нужно зарегистрироваться в маркетплейсе интеграций, а потом скопировать API-ключ в разделе «Настройки аккаунта».

Для получения API-ключа пользователя используйте метод auth. Передавать сам ключ нужно также в заголовке запроса (после ключа партнера через запятую):

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

Нужна ли авторизация пользователя для работы с теми или иными сущностями нужно смотреть в описаниях формата данных и примерах запросов.

Версионирование API

Текущая версия формата ответа 2.0, в нем всегда присутствуют секции "success", "data", "meta".

Указать версию необходимо с помощью заголовка

Accept: application/vnd.yclients.v2+json

Дата и время

Все даты в API представлены в виде строк в формате ISO 8601:

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

Длительности услуг и других сущностей передаются в секундах. Например, если услуга длиться 15 минут, то формат данных следующий:

{ "length": 900 }

Концепты YCLIENTS API

API позволяет работать с основными сущностями платформы:

  • Компания

  • Пользователь Пользователи могут управлять компаниями, они имеют права доступа к определенным настройкам компании. Не все пользователи имеют доступ ко всем настройкам. Для того, чтобы изменять те или иные настройки нужно сначала получить API-ключ пользователя с соответсвующими правами.

  • Категория услуг Все услуги компании группируются в рамках категории услуг .

  • Услуга Как правило, запись производится на определенную услугу, которую оказывает определенный сотрудник в определенной компании. Услуга имеет диапазон стоимости и некоторые другие параметры.

  • Сотрудник Как правило, запись производится, к определенному сотруднику или ресурсу (например, подъемник или квест-комната).

  • Расписание сотрудника У каждого сотрудника есть график работы - итервалы времени, в которое сотрудник работает с клиентами.

  • Свободное время сотрудника Время на которое можно записаться к сотруднику, т.е. интервалы времени, в которые он свободен.

  • Запись Интервал времени, в которое конкретный сотрудник оказывает конкретному клиенту услуги. Во время записи сотрудник занят.

  • Клиент Человек, который записывался на услугу в компанию.

Модель данных YCLIENTS API

Для работы с данными используется четыре основных структуры:

  1. Сущность Одна из перечисленных выше сущностей, обладающая своими уникальными свойствами и параметрами. Сущности можно получать, изменять и удалять

  2. Коллекция сущностей Набор сущностей. Например, список компаний или список услуг, оказываемых компаний. В коллекции сущностей можно добавлять сущности.

  3. Связь сущностей Например, связь сотрудника и услуги определяет, что конкретный сотрудник оказывает конкретную услугу. У связи могут быть свои свойства, например, индивидуальная цена услуги для конкретного сотрудника

  4. Коллекция связей сущностей Например, список услуг, оказываемых сотрудником и их свойсва. В коллекции можно добавлять связи

Авторизация

Для вызова многих методов требуется получить API-ключ пользователя, который будет использоваться для доступа к закрытым данным.

Авторизовать пользователя

При смене пароля пользователем его API-ключ изменится и потребуется новая авторизация

Атрибут Тип Описание
login string В качестве логина может быть использован номер телефона пользователя в формате 79161234567 или его Email
password string Пароль пользователя
Authorizations:
bearer
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

Request Body schema: application/json
login
required
string

Номер телефона или Email

password
required
string

Пароль

Responses

Response Schema: application/json
id
integer <int32>

Идентификатор пользователя

user_token
string

User_token пользователя

name
string

Имя пользователя

phone
string

Телефон пользователя

login
string

Логин пользователя

email
string

Почтовый адрес пользователя

avatar
string

Путь к файлу аватарки пользователя

is_approved
boolean

Подтвержден ли пользователь в системе

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Авторизовать пользователя онлайн-записи

При смене пароля пользователем онлайн-записи его API-ключ изменится и потребуется новая авторизация

Атрибут Тип Описание
login string В качестве логина может быть использован номер телефона посетителя в формате 79161234567 или его Email
password string Пароль посетителя
Authorizations:
bearer
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

Request Body schema: application/json
login
required
string

Номер телефона или Email

password
required
string

Пароль

Responses

Response Schema: application/json
id
integer <int32>

Идентификатор пользователя

user_token
string

User_token пользователя

name
string

Имя пользователя

phone
string

Телефон пользователя

login
string

Логин пользователя

email
string

Почтовый адрес пользователя

avatar
string

Путь к файлу аватарки пользователя

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Онлайн-запись

Для реализации клиентской части онлайн-записи используется следующий набор методов. Они адаптированы для пользовательских сценариев онлайн-записи, в отличии от других REST-методов, которые лучше использовать для интеграциионных целей.

Получить настройки формы бронирования

Каждый клиент сервиса YCLIENTS, может создать неограниченное количество форм онлайн-записи с разным дизайном и для разных сценариев записи.

Обычно, id формы бронирования хранится в поддомене, например: https://w123.yclients.com, где 123 - id формы записи. С помощью этого параметра можно получить все остальные необходимые для реализации онлайн-записи параметры, понять, будет происходить запись в конкретную компанию или в сеть компаний.

Для сетевого виджета необходимо будет дополнительно обратится к методу [GET] /companies с фильтром company_id и получить список копаний, в которые будет производиться запись.

Объект содержащий настройки формы бронирование имеет следующие поля:

Поле Тип Описание
steps Массив объектов Шаги формы бронирования со своими настройками
style Object Настройки дизайна формы бронирования
group_id number Идентификатор сети компаний (0 - если форма записи для несетевой компании)
company_id number Идентификатор компании (возвращается всегда, используется для получения дополнительных настроек)
phone_confirmation boolean Нужно ли подтверждать телефон по смс (если groupid = 0 (не групповая форма), иначе смотреть в настройки каждой компании отдельно)
lang string Язык формы бронирования (код из массива langs)
langs array of object Список языков виджета
comment_required boolean Является ли поле с комментарием к записи обязательным для заполнения
metrika_counter_id string Идентификатор Яндекс.Метрики
google_analytics_id string Идентификатор Google Analytics
facebook_pixel_id string Идентификатор Facebook Pixel
vkontakte_pixel_id string Идентификатор Вконтакте пиксель
app_metrika_id string Идентификатор Yandex AppMetrika
sms_enabled boolean Доступна ли отправка смс
comment_input_name string (optional) Заголовок для поля с вводом комментария к записи (если не задано, то используется значение по умолчанию)
booking_notify_text string (optional) Текст уведомления, которое выводится (если задано) на шаге ввода контактных данных
is_show_privacy_policy boolean Нужно ли отображать пользователю текст соглашения о политике обработки персональных данных
specialization_display_mode number Выводить специализацию или должность сотрудника. 0 - Специализация, 1 - Должность

Массив steps состоит из объектов которые имеют следующие поля:

Поле Тип Описание Для каких шагов указан
step string Шаг city/company/service/master/datetime/contact/confirm Для всех
title string Название шага для вывода в интерфейсе Для всех
num number Каким по счету должен выводиться данный шаг (начиная с 1) Для всех
default string или number Значение по умолчанию для данного шага, если задано Для всех, кроме datetime
hidden boolean Скрыть данный шаг при бронировании или нет Для всех
date_hidden boolean Скрыть данный шаг при бронировании или нет Для datetime
time_hidden boolean Скрыть данный шаг при бронировании или нет Для datetime
date_default string Значение по умолчанию для данного шага, если задано Для datetime
time_default number Значение по умолчанию для данного шага, если задано Для datetime

Объект style имеет следующие поля:

Поле Тип Описание
show_header boolean Выводить шапку и меню или нет
logo string Путь до картинки логотипа
header_background string Путь до картинки фона подзаголовка
menu_background string Путь до картинки фона меню
primaryPalette string Главный цвет формы (все цвета из списка: 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 Второстепенный цвет формы (полупрозрачный cover подзаголовка)
warnPalette string Цвет кнопок формы записи
backgroundPalette string Цвет фона формы записи
Authorizations:
bearer
path Parameters
id
required
number
Example: 1

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить параметры интернационализации

Перевод доступен на один из языков:

  • Русский - 'ru-RU'
  • Латвийский - 'lv-LV'
  • Английский - 'en-US'
  • Эстонский - 'ee-EE'
  • Литовский - 'lt-LT'
  • Немецкий - 'de-DE'
  • Украинский - 'uk-UK'
Authorizations:
bearer
path Parameters
langCode
required
string
Example: ru-RU

Код языка. Один из набора 'ru-RU', 'lv-LV', 'en-US', 'ee-EE', 'lt-LT', 'de-DE', 'uk-UK'

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

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": "и",
  • "terms-of-agreement": "Условия соглашения",
  • "data-processing": "Обработка данных",
  • "license-agreement": "Лицензионное соглашение",
  • "personal-data": "Ваши данные",
  • "buy-for": "Купить за",
  • "group_booking": {
    },
  • "geo": {
    },
  • "tooltips": {
    },
  • "prepaid": {
    },
  • "back": "Назад",
  • "backCity": "Города",
  • "backFilials": "Филиалы",
  • "backRecordType": "Тип записи",
  • "filials": "Филиалы",
  • "my_profile": "Кабинет",
  • "about_us": "О нас",
  • "record": {
    },
  • "at": "в",
  • "on": "на",
  • "h": "ч.",
  • "m": "мин.",
  • "from": "из",
  • "dist_m": "м",
  • "dist_km": "км",
  • "yesterday": "вчера",
  • "today": "сегодня",
  • "tomorrow": "завтра",
  • "Close": "Закрыть",
  • "Yes": "Да",
  • "No": "Нет",
  • "refresh": "Обновить",
  • "online_record_disabled": "Онлайн запись отключена. <br> Приносим извинения за доставленные неудобства.",
  • "online_record_disabled_long_text": "Онлайн-запись временно недоступна. Вы по-прежнему можете управлять своими онлайн-записями в личном кабинете, переносить их и удалять.",
  • "address": {
    },
  • "common": {
    },
  • "notification": {
    },
  • "header": {
    },
  • "loyalty": {
    },
  • "save": "Сохранить",
  • "proceed": "Продолжить",
  • "profile": {
    },
  • "registration": {
    },
  • "menu": {
    },
  • "footer": {
    },
  • "city": {
    },
  • "company": {
    },
  • "steps": {
    },
  • "master": {
    },
  • "cart": {
    },
  • "reviews": {
    },
  • "date": {
    },
  • "time": {
    },
  • "service": {
    },
  • "confirm": {
    },
  • "login": {
    },
  • "Jan": "января",
  • "Feb": "февраля",
  • "March": "марта",
  • "Mar": "марта",
  • "Apr": "апреля",
  • "May": "мая",
  • "Jun": "июня",
  • "Jul": "июля",
  • "Aug": "августа",
  • "Sep": "сентября",
  • "Oct": "октября",
  • "Nov": "ноября",
  • "Dec": "декабря",
  • "activity": {
    },
  • "button": {
    },
  • "landscape": "Будет удобнее, если повернуть устройство вертикально"
}

Отправить СМС код подтверждения номера телефона

  • Тело запроса
    • phone (required, string, '79991234567') - телефон, на который будет отправлен код
    • fullname (option, sring, Вася) - Имя клиента
Authorizations:
bearer
path Parameters
company_id
required
number
Example: 4564

ID компании

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
phone
string

Номер телефона клиента

fulname
string

Имя клиента

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Метаданные

Request samples

Content type
application/json
{
  • "phone": "79991234567",
  • "fulname": "Вася"
}

Response samples

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

Проверить параметры записи

После формирования параметров записи(ей) можно проверить их на возможность создание записей.

JSON-Объект содержащий параметры онлайн записи имеет следующие поля:

Поле Тип Обязательный Описание
appointments Массив объектов ДА Параметры записи (услуги, специалисты...)

Массив appointments состоит из объектов, которые имеют следующие поля:

Поле Тип Обязательный Описание
id number Да Идентификатор записи для обратной связи после сохранения (смотри ответ на запрос).
services array of numbers НЕТ Массив идентификаторов услуг, на которые клиент хочет записаться
staff_id number ДА Идентификатор специалиста, к которому клиент хочет записаться (0 если выбран любой мастер)
datetime datetime ДА Дата и время сеанса в формате ISO8601 (передается для каждого сеанса в ресурсе book_times)

В ответ на запрос проверки параметров придет пустой ответ с кодом 201 если параметры записи в порядке и записи могут быть созданы:

Если в ответ придет JSON с HTTP кодом отличным от 201, значит параметры записи не в порядке, а записи не могут быть созданы.

Ошибки, которые может вернуть сервер:

  1. Выбранное время одной из записей уже занято. В этом случае приходит ответ с http-кодом 422 и кодом ошибки 433, а так же в поле id передается идентификатор записи из массива appointments

  2. Нет сотрудников доступных для записи (если был выбран мастер по умолчанию). В этом случае приходит ответ с http-кодом 422 и кодом ошибки 436

  3. Выбранное время одной из записей пересекается с временем записи, создаваемой этим же запросом. В этом случае приходит ответ с http-кодом 422 и кодом ошибки 437, а так же в поле id передается идентификатор записи из массива appointments

  4. Нет записи на указанную услуги. (Компания уже удалили выбранные услуги) В этом случае приходит ответ с http-кодом 422 и кодом ошибки 438

Authorizations:
bearer
path Parameters
company_id
required
number

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

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

Параметры записи (услуги, специалисты...)

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Метаданные

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Метаданные

Request samples

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

Response samples

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

Создать запись на сеанс

JSON-Объект содержащий параметры онлайн записи имеет следующие поля:

Поле Тип Обязательный Описание
phone string ДА Телефон клиента (например 79161502239)
fullname string ДА Имя клиента
email string НЕТ Почтовый адрес клиента
appointments Массив объектов ДА Параметры записи (услуги, специалисты...)
code string НЕТ Код подтверждения номера телефона, высланный по СМС (нужен только в случае необходимости подтверждения номера)
notify_by_sms number НЕТ За какое кол-во часов отправить смс напоминание о записи (0 если не нужно напоминать)
notify_by_email number НЕТ За какое кол-во часов отправить email напоминание о записи (0 если не нужно напоминать)
comment string НЕТ Комментарий к записи
api_id string НЕТ Внешний идентификатор записи

Массив appointments состоит из объектов, которые имеют следующие поля:

Поле Тип Обязательный Описание
id number Да Идентификатор записи для обратной связи после сохранения (смотри ответ на запрос).
services array of numbers НЕТ Массив идентификаторов услуг, на которые клиент хочет записаться
staff_id number ДА Идентификатор специалиста, к которому клиент хочет записаться (0 если выбран любой мастер)
datetime datetime ДА Дата и время сеанса в формате ISO8601 (передается для каждого сеанса в ресурсе book_times)
custom_fields key-value object НЕТ Значения дополнительных полей записи которые возвращаются вместе с записью

Дополнительные поля в массиве appointments

При создании дополнительных полей записи (см. раздел "Дополнительные поля") становится возможным передавать собственные значения для полей. Дополнительные поля уникальны для каждой компании. После создания дополнительных полей, их значения для конкретной записи могут передаваться в необязательном поле custom_fields в виде пар ключ-значение где ключ это поле "code" дополнительного поля. Пример:

  • Создали дополнительное поле записи с code="my_custom_field" type="number", и второе поле code="some_another_field" type="list"
  • Передали при создании записи в элементе массива appointments еще один атрибут:"" appointments: [{ ... }, { ... custom_fields: { "my_custom_field": 123, "some_another_field": ["first value", "second value"] } }]"
  • При получении данной записи методом GET впоследствии, это же значение дополнительных полей вернется в ответе

В ответ на запрос создания записи придет массив объектов (кол-во объектов равно кол-ву объектов в массиве appointments) со следующими полями:

Поле Тип Описание
id number Идентификатор записи, переданный в массиве appointments
record_id number Идентификатор созданной в системе записи
record_hash string Идентификатор записи, для ее удаления непосредственно сразу после создания

Ошибки, которые необходимо обрабатывать:

  1. Введенный код подтверждения номера из SMS неправильный. В этом случае приходит ответ с http-кодом 422 и кодом ошибки 432

  2. Выбранное время одной из записей уже занято. В этом случае приходит ответ с http-кодом 422 и кодом ошибки 433, а так же в поле id передается идентификатор записи из массива appointments

  3. Пользователь с указанным телефоном в черном списке и не может записываться. В этом случае приходит ответ с http-кодом 403 и кодом ошибки 434

  4. Номер телефона пользователя в неправильном формате. В этом случае приходит ответ с http-кодом 422 и кодом ошибки 431

  5. Не указано имя клиента. В этом случае приходит ответ с http-кодом 422 и кодом ошибки 435

  6. Нет сотрудников доступных для записи (если был выбран мастер по умолчанию). В этом случае приходит ответ с http-кодом 422 и кодом ошибки 436

  7. Выбранное время одной из записей пересекается с временем записи, создаваемой этим же запросом. В этом случае приходит ответ с http-кодом 422 и кодом ошибки 437, а так же в поле id передается идентификатор записи из массива appointments

Authorizations:
bearer
path Parameters
company_id
required
number

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

Request Body schema: application/json
phone
required
string

Телефон клиента

fullname
required
string

Имя клиента

email
string

Почтовый адрес клиента

code
number

Код подтверждения телефона, высланный по смс (обязателен если у компании выставлен phone_conformation = true)

comment
string

Коммаентарий к записи

type
string

Источник записи

notify_by_sms
number

За сколько часов до визита следует выслать смс напоминание клиенту (0 - если не нужно)

notify_by_email
number

За сколько часов до визита следует выслать email напоминание клиенту (0 - если не нужно)

api_id
number

ID записи из внешней системы

Array of objects

Параметры записей (сеанс, услуги, мастер)

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Данные (массив объектов)

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "phone": "79000000000",
  • "fullname": "ДИМА",
  • "email": "[email protected]",
  • "code": "38829",
  • "comment": "тестовая запись!",
  • "type": "mobile",
  • "notify_by_sms": 6,
  • "notify_by_email": 24,
  • "api_id": "777",
  • "appointments": [
    ]
}

Response samples

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

Перенести запись на сеанс

Authorizations:
bearer
path Parameters
company_id
required
number

ID компании

record_id
required
number

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

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

Дата и время на которое мы хотим перенести запись

comment
string

Комментарий к записи

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Данные (объект)

Request samples

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

Response samples

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

Получить запись на сеанс

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

record_id
required
number
Example: 22123

ID записи (достаточно для просмотра записи если пользователь авторизован)

record_hash
required
string
Example: 'dawd4fs09rhf0s9fafef0'

HASH записи (обязательно для просмотра записи если пользователь не авторизован)

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
id
number

ID записи

Array of objects

Список ID услуг

object

Параметры компании

object

Параметры сотрудника

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

04-02T12:00:00Z' (required, string) - Дата сеанса

datetime
string <date-time>

Дата сеанса в ISO

create_date
string <date-time>

04-02T12:00:00Z' (required, string) - Дата создания записи

comment
string

Комментарий к записи

deleted
boolean

Удалена ли запись (true если удалена)

attendance
number

2 - Пользователь подтвердил запись, 1 - Пользователь пришел, услуги оказаны, 0 - ожидание пользователя, -1 - пользователь не пришел на визит

length
number

Длительность сеанса

notify_by_sms
number

За какое кол-во часов отправить смс напоминание о записи (0 если не нужно напоминать)

notify_by_email
number

За какое кол-во часов отправить email напоминание о записи (0 если не нужно напоминать)

master_requested
boolean

Был ли указан определенный специалист при записи (false если был указан "не имеет значения")

online
boolean

Запись онлайновая или нет (false если запись внес администратор)

api_id
string

Внешний идентификатор записи

last_change_date
string <date-time>

Дата последнего редактирования записи

prepaid
boolean

Доступна ли онлайн-оплата для записи

prepaid_confirmed
boolean

Статус online-оплаты

activity_id
number

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
}

Создать запись в групповом событии

Authorizations:
bearer
path Parameters
company_id
required
number

ID компании

activity_id
required
number

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

Request Body schema: */*
fullname
required
string

Имя клиента

phone
required
string

Телефон клиента (например 79161502239)

email
string

Почтовый адрес клиента

code
number

Код подтверждения телефона, высланный по смс (обязателен если у компании выставлен phone_conformation = true)

comment
string

Комментарий к записи

notify_by_sms
integer <int32>

За какое кол-во часов отправить смс напоминание о записи (0 если не нужно напоминать)

notify_by_email
integer <int32>

За какое кол-во часов отправить email напоминание о записи (0 если не нужно напоминать)

type
string

Источник записи

api_id
number

ID записи из внешней системы

clients_count
number

количество занимаемых мест

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить список дат доступных для бронирования

Объект даты, доступные для бронирования имеет следующие поля:

Поле Тип Описание
working_days массив рабочих дней сгруппированных по месяцам Рабочие дни сотрудника/организации
working_dates array of dates Массив дат, когда работает сотрудник/организация
booking_days массив дней, когда есть свободные сеансы Массив дней, которые доступны для бронирования на указанные услуги
booking_dates array of dates Массив дат, когда есть свободные сеансы на услугу к выбранному сотруднику/организации

working days и booking_days имеют одинаковый формат: месяц:[массив дней в этом месяце]

Например такой booking_days: "9": [ "4", "5"] "10": [ "14", "25"] Означает что на 4 и 5 сентября, и на 14 и 25 октября есть свободные сеансы для бронирования

Доступны следующие фильтры:

  • service_ids: Массив ID услуг. Если нужны даты, когда можно забронировать указанные услуги
  • staff_id: ID сотрудника. Если нужны даты, когда можно забронировать указанного специалиста
  • date: Дата в рамках месяца, если нужны даты по конкретному месяцу
Authorizations:
bearer
path Parameters
company_id
required
number

ID компании

query Parameters
service_ids[]
string

ID услуг. Фильтр по списку идентификаторов услуг

staff_id
number
Example: staff_id=0

ID сотрудника. Фильтр по идентификатору сотрудника Default: 0

date
string
Example: date=2015-09-01

дата в формате iso8601. Фильтр по месяцу бронирования.

date_from
string
Example: date_from=2015-09-01

дата в формате iso8601. Начало диапазона поиска. Используется в паре с параметром "date_to" и имеет приоритет перед параметром "date".

date_to
string
Example: date_to=2015-09-30

дата в формате iso8601. Окончание диапазона поиска. Используется в паре с параметром "date_from" и имеет приоритет перед параметром "date".

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Данные (объект)

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить список услуг доступных для бронирования

Объект услуг, доступных для бронирования имеет следующие поля:

Поле Тип Описание
categories массив объектов Массив категорий услуг (забронировать категорию нельзя)
services массив объектов Услуги, доступные для бронирования, с указанием категории

Объект из массива categories, имеет следующие поля:

Поле Тип Описание
id number Идентификатор категории
title string Название категории
sex number Принадлежность категории к полу (1 - мужской, 2 - женский, 0 - не задано)
weight number Вес категории. При выводе категории сортируются по весу, сначала более тяжелые
api_id string Внешний идентификатор категории

Объект из массива services, имеет следующие поля:

Поле Тип Описание
id number Идентификатор услуги
title string Название услуги
category_id number Идентификатор категории, которой принадлежит услуга
weight number Вес категории. При выводе услуги сортируются по весу, сначала более тяжелые
price_min number Минимальная стоимость услуги
price_max number Максимальная стоимость услуги
discount number Скидка по услуге
comment string Комментарий к услуге
active number Активная ли услуга
prepaid string Статус онлайн-оплаты
sex number Пол, для которого оказывается услуга
seance_length number Длительность оказания услуги в секундах (только если задан фильтр по сотруднику)
image string Изображение услуги

Если необходимо получить услуги, которые оказывает конкретный специалист, то нужно воспользоваться фильтром по специалисту. Доступны следующие фильтры:

  • staff_id: ID сотрудника. Если нужны услуги, которые оказывает только выбранный сотрудник
  • datetime: дата (в формате iso8601). Если нужны услуги, которые можно забронировать у мастера на определенное время
  • service_ids: Массив ID услуг. Если уже выбран мастер, время и услуга(и) в рамках этой записи, и необходимо выбрать еще услугу.
Authorizations:
bearer
path Parameters
company_id
required
number
Example: 4564

ID компании

query Parameters
staff_id
number
Example: staff_id=0

ID сотрудника. Фильтр по идентификатору сотрудника Default: 0

datetime
number
Example: datetime=``

дата (в формате iso8601). Фильтр по дате бронирования услуги (например '2005-09-09T18:30') Default: ''

service_ids[]
Array of numbers

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

Responses

Response Schema: application/json
success
boolean

Статус успшности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить список ближайших доступных сеансов

Объект ближайших сеансов сотрудника имеет следующие поля:

Поле Тип Описание
seance_date string Ближайшая дата с доступными сеансами
seances Array Список доступных сеансов
Authorizations:
bearer
path Parameters
company_id
required
number

ID компании

staff_id
required
number

ID сотрудника

query Parameters
service_ids[]
Array of numbers

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить список сотрудников доступных для бронирования

Каждый объект из массива сотрудников, доступных для бронирования имеет следующие поля:

Поле Тип Описание
id number Идентификатор сотрудника
name string Имя сотрудника
specialization string Специализация сотрудника
position object Должность сотрудника
bookable boolean Есть ли у сотрудника сеансы, доступные для бронирования
weight number Вес сотрудника. При выводе сотрудники сортируются по весу, сначала более тяжелые
show_rating number Показывать ли рейтинг сотрудника (1 - показывать, 0 - не показывать)
rating number Рейтинг сотрудника
votes_count number Кол-во голосов, оценивших сотрудника
comments_count number Кол-во комментариев к сотруднику
avatar string Путь к файлу аватарки сотрудника
information string Дополнительная информация о сотруднике (HTML формат)
seance_date string Дата ближайшего дня, на который есть доступные сеансы (только для bookable = true)

Доступны следующие фильтры:

  • service_ids: Массив ID услуг. Если нужны сотрудники, которые оказывают только выбранную услугу
  • datetime: дата (в формате iso8601). Если нужны сотрудники, у которых есть сеансы на указанную услугу в указанное время
Authorizations:
bearer
path Parameters
company_id
required
number
Example: 4564

ID компании

query Parameters
service_ids[]
Array of numbers

ID услуг. Фильтр по списку идентификаторов услуг

datetime
number

дата в формате iso8601. Фильтр по дате бронирования услуги (например '2005-09-09T18:30')

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить список сеансов доступных для бронирования

Объект сеансы, доступные для бронирования имеет следующие поля:

Поле Тип Описание
time string Время сеанса (17:30 например)
seance_length number Длительность сеанса в секундах
datetime datetime Дата и время сеанса в формате ISO8601 (нужно передавать при создании записи)

Доступны следующие фильтры:

  • service_ids: Массив ID услуг. Если нужны сеансы, когда можно забронировать указанные услуги
Authorizations:
bearer
path Parameters
company_id
required
number

ID компании

date
required
string

дата в формате iso8601. Фильтр по дате бронирования (например '2015-09-30')

staff_id
required
number
Example: 0

ID сотрудника. Фильтр по идентификатору сотрудника Default: 0

query Parameters
service_ids[]
string

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Записи пользователя

Для управлениями записями пользователя используются следующие методы

Авторизоваться по номеру телефона и коду

Для доступа к своим онлайн и оффлайн (сделанным по телефону) записям пользователь должен авторизоваться подтвердив свой номер телефона. Для этого ему нужно выслать на свой номер телефона код подтверждения с помощью ресурса "СМС код подтверждения номера телефона

Authorizations:
bearer
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

Request Body schema: application/json
login
required
string

Номер телефона или Email

password
required
string

Пароль

Responses

Response Schema: application/json
user_token
string

User_token пользователя

Request samples

Content type
application/json
{}

Response samples

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

Получить записи пользователя

JSON-Объект содержащий параметры записи пользователя имеет следующие поля:

Поле Тип Обязательный Описание
id number ДА ID записи
services array of numbers ДА Список ID услуг записи
company object ДА Параметры компании
staff object ДА Параметры специалиста, которые был забронирован
clients_count int ДА Количество клиентов
date string ДА Дата сеанса
datetime string ДА Дата сеанса в формате
create_date string ДА Дата создания записи
length number ДА Длительность сеанса
deleted boolean ДА Удалена ли запись (true если удалена)
notify_by_sms number НЕТ За какое кол-во часов отправить смс напоминание о записи (0 если не нужно напоминать)
notify_by_email number НЕТ За какое кол-во часов отправить email напоминание о записи (0 если не нужно напоминать)
comment string ДА Комментарий к записи
master_requested boolean ДА Был ли указан определенный специалист при записи (false если был указан "не имеет значения")
online boolean ДА Запись онлайновая или нет (false если запись внес администратор)
visit_attendance number ДА 2 - Пользователь подтвердил запись, 1 - Пользователь пришел, услуги оказаны, 0 - ожидание пользователя, -1 - пользователь не пришел на визит
api_id string НЕТ Внешний идентификатор записи
last_change_date string НЕТ Дата последнего редактирования записи
prepaid boolean НЕТ Доступна ли онлайн-оплата для записи
prepaid_confirmed boolean НЕТ Статус online-оплаты
last_change_date string НЕТ Дата последнего редактирования записи
activity_id int НЕТ ID чего групповой записи

Каждый объект из массива services имеет следующие поля:

Поле Тип Описание
id number Идентификатор услуги
title string Название услуги
cost float Стоимость услуги
price_min float Минимальная цена услуги
price_max float Максимальная цена услуги
discount float Скидка
amount int Количество заказанных услуг
seance_length int Длительность оказания услуги в секундах (только если задан фильтр по сотруднику)

Объект company имеет следующие поля:

Поле Тип Описание
id number Идентификатор компании
title string Название компании
country_id number Идентификатор страны, в которой расположена компания
country string Название старны компании
city_id number Идентификатор города, в котором расположена компания)
city string Название города компании
timezone string Timezone компании
address string Адрес, по которому расположена компания
phone string Основной номер телефона компании
phones array of strings Все номера телефонов компании
coordinate_lat float Широта, на которой расположена компания
coordinate_lng float Долгота
allow_delete_record boolean Можно ли удалять запись
allow_change_record boolean Можно ли переносить запись
site string Сайт компании
currency_short_title string Символ валюты
allow_change_record_delay_step int Время, через которое можно переносить запись
allow_delete_record_delay_step int Время, через которое можно удалять запись

Объект staff имеет следующие поля:

Поле Тип Описание
id number Идентификатор сотрудника
name string Имя сотрудника
specialization string Специализация сотрудника
position object Должность сотрудника
show_rating number Показывать ли рейтинг сотрудника (1 - показывать, 0 - не показывать)
rating number Рейтинг сотрудника
votes_count number Кол-во голосов, оценивших сотрудника
comments_count number Кол-во комментариев к сотруднику
avatar string Путь к файлу аватарки сотрудника
Authorizations:
(beareruser)
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

Статус успешности выполнения (true)

Array of objects

Массив объектов

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Удалить запись пользователя

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

ID записи (достаточно для удаления записи если пользователь авторизован)

record_hash
required
string
Example: 'dawd4fs09rhf0s9fafef0'

HASH записи (обязательно для удаления записи если пользователь не авторизован)

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

Пользователи онлайн-записи

Пользователи клиентской части онлайн-записи.

Авторизовать пользователя онлайн-записи

При смене пароля пользователем онлайн-записи его API-ключ изменится и потребуется новая авторизация

Атрибут Тип Описание
login string В качестве логина может быть использован номер телефона посетителя в формате 79161234567 или его Email
password string Пароль посетителя
Authorizations:
bearer
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

Request Body schema: application/json
login
required
string

Номер телефона или Email

password
required
string

Пароль

Responses

Response Schema: application/json
id
integer <int32>

Идентификатор пользователя

user_token
string

User_token пользователя

name
string

Имя пользователя

phone
string

Телефон пользователя

login
string

Логин пользователя

email
string

Почтовый адрес пользователя

avatar
string

Путь к файлу аватарки пользователя

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{}

Отправить СМС код подтверждения номера телефона для изменения данных

В запросе должен обязательно присутствовать один из двух параметров: company_id или group_id

Authorizations:
(beareruser)
query Parameters
company_id
required
integer

Идентификатор компании

group_id
required
integer

Идентификатор сети

phone
required
string

Номер телефона

header Parameters
Accept
required
string

application/vnd.yclients.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": {
    }
}

Обновление пароля пользователя онлайн-записи

Обновление пароля пользователя онлайн-записи.

В ответе приходит новый токен пользователя.

Authorizations:
(beareruser)
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
old_password
string

Текущий пароль

new_password
string

Новый пароль

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

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

Response samples

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

Обновление данных пользователя онлайн-записи

Обновление основных данных пользователя онлайн-записи.

При обновлении номера телефона нужно отправлять поле confirmation_code с кодом, который нужно получить из ресурса СМС код подтверждения номера телефона для изменения данных

Authorizations:
(beareruser)
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
name
string

Имя

email
string

Почта

phone
string

Номер телефона

confirmation_code
string

Код подтверждения из смс (при смене номера телефона)

Responses

Request samples

Content type
application/json
{
  • "name": "Вася",
  • "email": "[email protected]",
  • "phone": "79999999999",
  • "confirmation_code": "1234"
}

Response samples

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

Получение данных пользователя онлайн-записи

Получение данных пользователя онлайн-записи.

Authorizations:
(beareruser)
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
0
string

Токен пользователя

id
integer <int32>

Идентификатор пользователя

user_token
string

Токен пользователя

name
string

Имя пользователя

phone
string

Телефон пользователя

login
string

Логин пользователя

email
string

Почта пользователя

avatar
string

Аватар пользователя

Response samples

Content type
application/json
{}

Компании

Для работы с компаниями используются следующие методы

Коллекция компаний

Объект компании имеет следующие поля:

Поле Тип Описание
id number Идентификатор компании
title string Название компании (Обязательное поле для создания компании)
logo string Адрес изображения логотипа компании
short_descr string Категория компании
country_id number Идентификатор страны, в которой расположена компания
country string Название старны компании
city_id number Идентификатор города, в котором расположена компания)
city string Название города компании
timezone string Timezone компании
schedule string Расписание работы компании
address string Адрес, по которому расположена компания
phone string Номер телефона компании
coordinate_lat float Широта, на которой расположена компания
coordinate_lon float Долгота
app_ios string Ссылка на приложение под ios
app_android string Ссылка на приложение под android
phone_confirmation boolean Нужно ли подтверждать телефон по смс
active_staff_count number Кол-во сотрудников доступных для бронирования
next_slot datetime Дата и время ближайшего свободного сеанса в компании(ISO8601). Поле будет присутствовать только если передан GET параметр forBooking=1
booking_comment_required boolean Является ли поле с комментарием к записи обязательным для заполнения
booking_email_required boolean Является ли поле Email к записи обязательным для заполнения
booking_comment_input_name string (optional) Заголовок для поля с вводом комментария к записи (если не задано, то используется значение по умолчанию)
booking_notify_text string (optional) Текст уведомления, которое выводится (если задано) на шаге ввода контактных данных
reminds_sms_disabled boolean True - если у компании выключен сервис SMS напоминаний клиентам.
group_priority number Чем больше приоритет, тем выше компания при выводе в списке филиалов сети
allow_change_record boolean Изменение записи
allow_change_record_delay_step number Запретить изменять записи за период. (В секундах)
allow_delete_record boolean Удаление записи
allow_delete_record_delay_step number Запретить удалять записи за период. (В секундах)

Получить список компаний

Получить список с данными о компаниях

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

ID компании. Фильтр по идентификатору компании

group_id
number
Example: group_id=83

ID сети компаний. Фильтр по идентификатору сети компаний Default: 83

my
number
Example: my=1

Только для авторизованного пользователя. Если нужно компании, на управление которыми пользователь имеет права

active
number
Example: active=1

Если нужно получить только компании с активной лицензией и доступным бронированием

moderated
number
Example: moderated=1

Если нужно получить только прошедшие модерацию компании, чей контент проверен для публикации

forBooking
number
Example: forBooking=1

Показать дату и время ближайшего свободного сеанса в компании (ISO8601)

show_groups
number
Example: show_groups=1

Включить в объект компании список сетей в которые входит эта компания

city_id
number
Example: city_id=2

Поиск по ID города (метод получения городов)

showBookforms
number
Example: showBookforms=1

Включить в объект компании виджеты онлайн-записи

vk_api_id
number
Example: vk_api_id=2

Поиск виджеты онлайн-записи по vk_api_id. Параметр работает при showBookforms=1

min_id
number
Example: min_id=1000

Минимальный ID компании

show_deleted
number
Example: show_deleted=1

Включить в список удалённые компании

hide_record_type_single
number
Example: hide_record_type_single=1

Не показывать салоны с индивидуальной записью

hide_record_type_activity
number
Example: hide_record_type_activity=1

Не показывать салоны с групповой записью

hide_record_type_mixed
number
Example: hide_record_type_mixed=1

Не показывать салоны со смешанной записью

business_group_id
number
Example: business_group_id=1

Идентификатор группы бизнеса. Фильтр по группе бизнеса

business_type_id
number
Example: business_type_id=1

Идентификатор сферы бизнеса. Фильтр по сфере бизнеса

yandex
number
Example: yandex=1

Фильтр по синхронизации данных компании с партнерскими площадкам

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

Включить в объект компании дополнительные данные

count
number

Количество компаний на странице

page
number

Номер страницы

header Parameters
Accept
required
string

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string

Должен быть равен application/json

Authorization
required
string

Bearer partner_token

Responses

Response Schema: application/json
success
boolean

Статус успешного выполнения (true)

Array of objects

Массив объектов

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response samples

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

Создать компанию

Создать новую компанию.

Authorizations:
(beareruser)
header Parameters
Accept
required
string

Должен быть равен 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
string

Название компании

country_id
number

Идентификатор страны, в которой расположена копания (метод получения стран)

city_id
number

Идентификатор города, в котором расположена компания (метод получения городов)

address
string

Адрес компании

site
string

Сайт компании

coordinate_lat
number <float>

Широта

coordinate_lot
number <float>

Долгота

business_type_id
number

Сфера бизнеса

short_descr
string

Категория компании

Responses

Response Schema: application/json
success
boolean

Статус успешного выполнения (true)

object

Объект данных

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "title": "Новая компания",
  • "country_id": 1,
  • "city_id": 2,
  • "address": "Талалихина, д. 1, к. 2",
  • "site": "new-company.ru",
  • "coordinate_lat": "55.835662",
  • "coordinate_lot": "37.778218",
  • "business_type_id": 1,
  • "short_descr": "Салон красоты"
}

Response samples

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

Получить компанию

Получение данных о компании.

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

Идентификатор компании, информацию о которой нужно получить.

query Parameters
my
number
Example: my=1

Только для авторизованного пользователя. Если нужны дополнительные данные по компании, на управление которой пользователь имеет права

forBooking
number
Example: forBooking=1

Показать дату и время ближайшего свободного сеанса в компании (ISO8601).

show_groups
number
Example: show_groups=1

Включить в объект компании список сетей в которые входит эта компания

showBookforms
number
Example: showBookforms=1

Показать виджеты онлайн-записи компании

bookform_id
number
Example: bookform_id=19203

Показать адрес виджета онлайн-записи с указанным идентификатором

header Parameters
Accept
required
string

Должен быть равен 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

Статус успешного выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
object (Сообщение об ошибке запроса)

Дополнительная информация об ошибках.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
object (Сообщение об ошибке запроса)

Дополнительная информация об ошибках.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response samples

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

Изменить компанию

Изменение данных о компании.

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

Идентификатор компании

header Parameters
Accept
required
string

Должен быть равен 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
string

Название компании

country_id
number

Идентификатор страны (приоритетнее параметра country)

country
string

Страна

city_id
number

Идентификатор города (приоритетнее параметра city)

city
string

Город

address
string

Адрес компании

zip
string

Индекс

phones
Array of strings

Телефоны

object

Социальные сети компании

site
string

Сайт компании

coordinate_lat
number <float>

Широта

coordinate_lon
number <float>

Долгота

description
string <html>

Описание

business_type_id
number <int32>

Сфера бизнеса

short_descr
string

Категория бизнеса

Responses

Response Schema: application/json
id
number

Идентификатор компании

title
string

Название компании

country_id
number

Идентификатор страны, в которой расположена компания

country
string

Название страны, в которой расположена компания

city_id
number

Идентификатор города, в котором расположена компания

city
string

Название города, в котором расположена компания

timezone_name
string

Наименование временной зоны, в которой расположена компания

address
string

Адрес, по которому расположена компания

zip
number

Индекс

object

Социальные сети компании

site
string

Сайт компании

coordinate_lat
number <float>

Широта

coordinate_lon
number <float>

Долгота

description
string <html>

Описание

business_type_id
number <int32>

Сфера бизнеса

short_descr
string

Категория бизнеса

phone_confirmation
boolean

Нужно ли подтверждать телефон по смс, при бронировании

group_priority
integer <int32>

Чем больше приоритет, тем выше компания при выводе в списке филиалов сети

push_notification_phone_confirm
boolean

Подтверждать номер клиента для отправки push уведомлений

access
object

Список прав

Response Schema: application/json
object (Сообщение об ошибке запроса)

Дополнительная информация об ошибках.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
object (Сообщение об ошибке запроса)

Дополнительная информация об ошибках.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "title": "Новая компания",
  • "country": "Россия",
  • "city": "Москва",
  • "address": "Большой Саввинский пер., д. 4",
  • "zip": "119435",
  • "phones": [
    ],
  • "social": {
    },
  • "site": "new-company.ru",
  • "coordinate_lat": 55.735662,
  • "coordinate_lon": 37.678218,
  • "description": "Самая <strong>Новая компания</strong> на рынке",
  • "business_type_id": 1,
  • "short_descr": "Салон красоты"
}

Response samples

Content type
application/json
{
  • "id": 37532,
  • "title": "Новая компания",
  • "country_id": 1,
  • "country": "Россия",
  • "city_id": 2,
  • "city": "Москва",
  • "timezone_name": "Europe/Moscow",
  • "address": "Большой Саввинский пер., д. 3",
  • "zip": 119435,
  • "coordinate_lat": 55.735662,
  • "coordinate_lon": 37.678218,
  • "short_descr": "Салон красоты",
  • "social": {
    },
  • "site": "new-company.ru",
  • "business_type_id": 1,
  • "description": "Самая <strong>Новая компания</strong> на рынке",
  • "phone_confirmation": true,
  • "group_priority": 900,
  • "push_notification_phone_confirm": 1,
  • "access": { }
}

Удалить компанию

Удаление компании.

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

Идентификатор компании

header Parameters
Accept
required
string

Должен быть равен 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
object (Сообщение об ошибке запроса)

Дополнительная информация об ошибках.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
object (Сообщение об ошибке запроса)

Дополнительная информация об ошибках.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response samples

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

Категория услуг

Для работы с категориями услуг используются следующие методы

Объект категории услуг имеет следующие поля:

Поле Тип Описание
id number Идентификатор категории
title string Название категории
api_id Integer Внешний идентификатор категории
weight number Вес категории (используется для сортировки категорий при отображении)
staff array Список ID сотрудников, оказывающих услугу

Фильтрация категорий услуг

  • staff_id: ID сотрудника. Если нужны услуги, которые оказывает конкретный мастер

Создать категорию услугу

Authorizations:
(beareruser)
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
string

Название категории услуг

api_id
string

Внешний идентификатор категории

weight
number

Вес категории (используется для сортировки категорий при отображении)

staff
Array of numbers

Список ID сотрудников, оказывающих услуги из категории

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "title": "Стрижка очень женская",
  • "api_id": "adw322",
  • "weight": 111,
  • "staff": [
    ]
}

Response samples

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

Получить категорию услуг

Authorizations:
bearer
path Parameters
company_id
required
number

ID компании

id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов

object

Метаданные (количество категорий)

Response samples

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

Изменить категорию услуг

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

id
required
number

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
string

Название категории услуг

api_id
string

Внешний идентификатор категории

weight
number

Вес категории (используется для сортировки категорий при отображении)

staff
Array of numbers

Список ID сотрудников, оказывающих услуги из категории

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов

object

Метаданные (количество категорий)

Request samples

Content type
application/json
{
  • "title": "Стрижка очень женская",
  • "api_id": "adw322",
  • "weight": 111,
  • "staff": [
    ]
}

Response samples

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

Удалить категорию услуг

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

id
required
number

ID категории услуги

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

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

Conetnt-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Получить список категорий услуг сети

Authorizations:
(beareruser)
path Parameters
chain_id
required
integer

Идентификатор сети

query Parameters
include
string
Value: "services"

Включить в ответ дополительные ресурсы

header Parameters
Accept
required
string

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
Array
id
integer <int32>

Идентификатор категории услуг

title
string

Название категории услуг

Array of objects (Root Type for ServiceTitle)

Услуги в категории (по запросу)

Response samples

Content type
application/json
[
  • {
    }
]

Получить список категорий услуг

  • Параметры
    • company_id (required, number) - ID компании
    • id (optional, number) - ID категории услуг (для работы с конкретной категорией)
    • staff_id (optional, number) - ID сотрудника (для получения категорий, привязанных к сотруднику)
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

id
required
number

ID категории услуг

query Parameters
staff_id
number

ID сотрудника (для получения категорий, привязанных к сотруднику)

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов

object

Метаданные (количество категорий)

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

data
string

имеет значение null

object

Метаданные (сообщение об ошибке)

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

data
string

имеет значение null

object

Метаданные (содержит возможные сообщения об ошибке)

Response samples

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

Устаревшее. Получить список категорий услуг Deprecated

Получить список категорий услуг

Authorizations:
bearer
path Parameters
company_id
required
number

Идентификатор компании

id
required
number

Идентификатор категории услуги

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов

object

Метаданные (количество категорий)

Response samples

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

Услуги

Для работы с услугами используются следующие методы

Объект услуги имеет следующие поля:

Поле Тип Описание
id number Идентификатор услуги
category_id number Идентификатор категории, в которой состоит услуга
title string Название категории
price_min number Минимальная цена на услугу
price_max number Максимальная цена на услугу
duration number Длительность услуги, по умолчанию равна 3600 секундам
service_type number 1 - доступна для онлайн записи, 0 - не доступна
comment string комментарий у услуге
api_service_id Integer Внешний идентификатор услуги
weight number Вес категории (используется для сортировки категорий при отображении)
staff array Список сотрудников, оказывающих услугу и длительность сеанса
image_group object Группа изображений услуги

Массив со списком сотрудников, оказывающих услугу состоит из объектов со следующими полями

Поле Тип Описание
id number Идентификатор сотрудника
seance_length number Длительность оказания услуги мастером. (В секундах)

Фильтрация услуг

  • staff_id: ID сотрудника. Если нужны услуги, которые оказывает конкретный мастер

  • category_id: ID категории. Если нужны услуги, из конкретной категории

Создать услугу

Метод, позволяющий создать услугу

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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

Authorizarion
required
string

Bearer partner_token, User user_token

Request Body schema: application/json
title
string

Название услуги

category_id
number

ID категории услуг

price_min
number <float>

Минимальная стоимость услуги

price_max
number <float>

Максимальная стоимость услуги

duration
number

Длительность услуги, по умолчанию равна 3600 секундам

discount
number <float>

Скидка при оказании услуги

comment
string

Комментарий к услуге

weight
number

Вес услуги (используется для сортировки услуг при отображении)

service_type
number

Доступна ли для онлайн записи услуга. 1 - доступна, 0 не доступна.

api_service_id
string

Внешний идентификатор услуги

Array of objects

Сотрудники, оказываюшие услугу и длительность оказания услуги каждым из них

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "title": "Мужская стрижка",
  • "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": [ ]
}

Получить список услуг / конкретную услугу

  • Параметр
    • company_id (required, number, 1) - ID компании
    • service_id (optional, number, 1) - ID услуги
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

service_id
required
number

ID услуги, если нужно работать с конкретной услугой.

query Parameters
staff_id
number

ID сотрудника, если нужно отфильтровать по сотруднику

category_id
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных услуг)

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

data
string

имеет значение null

object

Метаданные (сообщение об ошибке)

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

data
string

имеет значение null

object

Метаданные (содержит возможные сообщения об ошибке)

Response samples

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

Изменить услугу

Метод, позволяющий изменить услугу

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

service_id
required
number

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

Название услуги

booking_title
required
string

Название услуги для онлайн-записи

category_id
required
number

ID категории услуг

price_min
required
number <float>

Минимальная стоимость услуги

price_max
required
number <float>

Максимальная стоимость услуги

duration
required
number

Длительность услуги, по умолчанию равна 3600 секундам

discount
number <float>

Скидка при оказании услуги

comment
string

Комментарий к услуге

is_multi
required
boolean

false - индивидуальная услуга, true - групповая услуга

tax_variant
required
number

ID системы налогообложения

vat_id
required
number

ID НДС

is_need_limit_date
required
boolean

Ограничение по датам для онлайн-записи

date_from
string

Дата с которой услуга будет доступна в формате yyyy-mm-dd

date_to
string

Дата до которой услуга будет доступна в формате yyyy-mm-dd

dates
array of strings

Список дат в которые будет доступна онлайн запись (если массив не передан, все даты за указанный период будут доступны)

seance_search_start
required
number

Начало периода в какое время доступна запись, указывается в секундах

seance_search_finish
required
number

Конец периода в какое время доступна запись, указывается в секундах

step
required
number

Шаг вывода сеансов, указывается в секундах

seance_search_step
required
number

Шаг поиска сеансов, указывается в секундах

weight
number

Вес услуги (используется для сортировки услуг при отображении)

service_type
number

Доступна ли для онлайн записи услуга. 1 - доступна, 0 не доступна.

api_service_id
integer

Внешний идентификатор услуги

online_invoicing_status
integer

Онлайн-предоплата включена (0-выключена, 2-включена)

price_prepaid_percent
integer

Размер предоплаты в процентах (от минимальной стоимости услуги)

price_prepaid_amount
integer

Сумма предоплаты

abonement_restriction_value
integer

Запрет записи без абонемента (Только если online_invoicing_status=0)

is_abonement_autopayment_enabled
integer

Автосписание с абонемента

autopayment_before_visit_time
integer

За какое время до визита производится автосписание

Array of objects

Сотрудники, оказываюшие услугу и длительность оказания услуги каждым из них

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object
meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "title": "Мужская стрижка",
  • "booking_title": "Мужская стрижка",
  • "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,
  • "api_service_id": 1234,
  • "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,
  • "service_type": 1,
  • "staff": [
    ]
}

Response samples

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

Устаревшее. Получить список услуг / конкретную услугу Deprecated

Authorizations:
bearer
path Parameters
company_id
required
number

ID компании

service_id
required
number

ID услуги, если нужно работать с конкретной услугой.

query Parameters
staff_id
number

ID сотрудника, если нужно отфильтровать по сотруднику

category_id
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных услуг)

Response samples

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

Устаревшее. Изменить услугу Deprecated

Устаревшее. Метод, позволяющий изменить услугу

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

service_id
required
number

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
string

Название услуги

category_id
number

ID категории услуг

price_min
number <float>

Минимальная стоимость услуги

price_max
number <float>

Максимальная стоимость услуги

duration
number

Длительность услуги, по умолчанию равна 3600 секундам

discount
number <float>

Скидка при оказании услуги

comment
string

Комментарий к услуге

weight
number

Вес услуги (используется для сортировки услуг при отображении)

service_type
number

Доступна ли для онлайн записи услуга. 1 - доступна, 0 не доступна.

api_service_id
string

Внешний идентификатор услуги

Array of objects

Сотрудники, оказываюшие услугу и длительность оказания услуги каждым из них

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "title": "Мужская стрижка",
  • "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": [ ]
}

Удалить услугу

Метод, позволяющий удалить услугу

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

service_id
required
number

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

Responses

Изменить длительность оказания услуги сотрудниками, технические карты, названия на других языках

Метод, позволяющий изменить длительность оказания услуги сотрудниками, технические карты, названия на других языках

path Parameters
company_id
required
number

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
service_id
required
number

ID услуги

required
Array of objects

Список сотрудников, оказывающих услугу c длительностью сеанса и технологическими картами

resource_ids
required
Array of numbers

Список ресурсов необходимых для оказания услуги

required
Array of objects

Список переводов для каждого языка

Request samples

Content type
application/json
{
  • "service_id": 10832939,
  • "master_settings": [
    ],
  • "resource_ids": [
    ],
  • "translations": [
    ]
}

Привязка сотрудника, оказывающего услугу

Создает привязку сотрудника к услуге с указанием длительности и технологической карты.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

service_id
required
number
Example: 123

Идентификатор услуги.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
master_id
required
number

Идентификатор сотрудника, оказывающего услугу.

seance_length
required
number

Длительность оказания услуги указанным сотрудником в секундах,
минимально 300 секунд (5 минут), максимально 86100 секунд (23 часа 55 минут).

technological_card_id
required
number or null

Идентификатор технологической карты, используемой при оказании услуги указанным сотрудником.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Сотрудник, оказывающий услугу")
meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

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": { }
}

Изменение настроек оказания услуги сотрудником

Обновляет данные привязки сотрудника к услуге с указанием длительности и технологической карты.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

service_id
required
number
Example: 123

Идентификатор услуги.

master_id
required
number
Example: 123

Идентификатор сотрудника.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
seance_length
required
number

Длительность оказания услуги указанным сотрудником в секундах,
минимально 300 секунд (5 минут), максимально 86100 секунд (23 часа 55 минут).

technological_card_id
required
number or null

Идентификатор технологической карты, используемой при оказании услуги указанным сотрудником.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Сотрудник, оказывающий услугу")
meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

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

Response samples

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

Отвязка сотрудника, оказывающего услугу

Удаляет привязку сотрудника к услуге.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

service_id
required
number
Example: 123

Идентификатор услуги.

master_id
required
number
Example: 123

Идентификатор сотрудника.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Пользователи

Управление пользователями, в частности работа с ролями и правами.

Получение списка ролей пользователей

Возвращает список ролей пользователей вместе с правами для каждой роли.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

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

Набор сущностей, которые должны быть включены в ответ.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects (Объект модели "Роль пользователя")
meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Получение списка ролей в контексте существующего пользователя

Возвращает список ролей пользователей вместе с правами для каждой роли. Позволяет увидеть возможность изменить конкретные права (поле is_editable) у существующего пользователя филиала в зависимости от набора прав пользователя, от имени которого выполняется запрос.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

user_id
required
number
Example: 123

Идентификатор пользователя.

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

Набор сущностей, которые должны быть включены в ответ.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects (Объект модели "Роль пользователя")
meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Получение значений прав и роли пользователя

Возвращает роль пользователя и список прав со значениями.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

user_id
required
number
Example: 123

Идентификатор пользователя.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Права и роль пользователя")

Данные по правам и роли пользователя

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Обновление прав и роли пользователя

Обновляет роль и права пользователя, а так же сотрудника который к этому пользователю прикреплен.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

user_id
required
number
Example: 123

Идентификатор пользователя.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

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

Название роли

Array of items

Список значений прав пользователя

staff_id
number

Идентификатор сотрудника привязанного к пользователю

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Права и роль пользователя")

Данные по правам и роли пользователя

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

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

Response samples

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

Копирование пользователя в филиалы

Копирует пользователя с правами в несколько указанных филиалов. Если пользователя ранее не было в этих филиалах, он будет добавлен в них как активный. Если пользователь был приглашен в филиал, будут обновлены только его права, пользователю по-прежнему будет необходимо принять приглашение.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

user_id
required
number
Example: 123

Идентификатор пользователя.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

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

Список филиалов, куда необходимо скопировать права пользователя

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

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

Response samples

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

Удаление пользователя из филиалов

Удаляет пользователя из нескольких указанных филиалов.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

user_id
required
number
Example: 123

Идентификатор пользователя.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

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

Список филиалов, откуда необходимо удалить пользователя

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

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

Response samples

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

Пользователь

Описание разделов прав доступа:

Значение Описание
'settings' Список прав относящиеся к группе настройки
'finances' Список прав относящиеся к группе финансы
'loyalty' Список прав относящиеся к группе лояльность
'notification' Список прав относящиеся к группе уведомления
'storages' Список прав относящиеся к группе склады
'clients' Список прав относящиеся к группе клиенты
'dashboard' Список прав относящиеся к группе журнал записей

В списке прав содержатся следующие поля:

Поле Тип Описание
timetable_access boolean true - есть доступ к журналу записи, false - нет доступа
master_id number 0 - если пользователь может просматривать расписание и записи всех сотрудников, иначе только того сотрудника, ID которого задан
position_id number 0 - если пользователь может просматривать расписание и записи всех сотрудников, иначе только ту должность, ID которого задан
last_days_count number 0 - не ограничить доступ к истории расписаний и записям
schedule_edit_access boolean true - есть доступ к графику работы сотрудника в журнале, false - нет доступа
timetable_phones_access boolean true - есть доступ к номеру телефона в журнале записи, false - нет доступа
timetable_transferring_record_access boolean true - есть доступ к переносу записей, false - нет доступа
timetable_statistics_access boolean true - есть доступ к просмотру статистики, false - нет доступа
record_form_access boolean true - есть доступ к окну записи, false - нет доступа
record_form_client_access boolean true - есть доступ к данным клиентов, false - нет доступа
records_autocomplete_access boolean true - есть доступ к выпадающему списку с данными о клиентах, false - нет доступа
create_records_access boolean true - есть доступ к созданию записей, false - нет доступа Создавать записи
edit_records_access boolean true - есть доступ к изменение записей, false - нет доступа
edit_records_attendance_access boolean true - есть доступ к записям со статусом визита "клиент пришел", false - нет доступа
records_services_cost_access boolean true - есть доступ к изменению стоимости услуг, false - нет доступа
records_services_discount_access boolean true - есть доступ к изменению скидки на услуги, false - нет доступа
record_edit_full_paid_access boolean true - есть доступ к редактированию оплаченной записи, false - нет доступа
delete_records_access boolean true - есть доступ к удалению записи, false - нет доступа
delete_customer_came_records_access boolean true - есть доступ к удалению записей со статусом "клиент пришел", false - нет доступа
delete_paid_records_access boolean true - есть доступ к удалению оплаченных записей, false - нет доступа
records_goods_access boolean true - есть доступ к продажам товаров, false - нет доступа
records_goods_create_transaction_access boolean true - есть доступ к созданию товарных транзакций, false - нет доступа
records_goods_create_last_days_count number -1 - есть доступ к созданию товарных транзакций за все время, >= 0 - доступ к созданию товарных транзакций за указанное количество дней прошлое
records_goods_edit_transaction_access boolean true - есть доступ к редактированию товарных транзакций, false - нет доступа
records_goods_edit_last_days_count number -1 - есть доступ к редактированию товарных транзакций за все время, >= 0 - доступ к редактированию товарных транзакций за указанное количество дней прошлое
records_goods_cost_access boolean true - есть доступ к изменению стоимость товаров, false - нет доступа
records_goods_discount_access boolean true - есть доступ к изменению скидки на товары, false - нет доступа
records_finances_access boolean true - есть доступ к оплате, false - нет доступа
records_finances_last_days_count number -1 - есть доступ к проведению оплаты в записях за все время, >= 0 - доступ к проведению оплаты в записях за указанное количество дней прошлое
records_finances_pay_from_deposits_access boolean true - есть доступ к проведению оплаты в записях с личного счета клиента, false - нет доступа
records_group_id_access boolean true - есть доступ к данным клиентов по сети, false - нет доступа
records_group_id number ID сети к которой есть доступ к данным клиентов
finances_access boolean true - есть доступ к финансам, false - нет доступа
finances_accounts_ids array массив ID к выбранным кассам
finances_transactions_access boolean true - есть доступ к просмотру движений средств, false - нет доступа
finances_last_days_count number -1 - есть доступ к просмотру движений средств за все время, >= 0 - доступ к просмотру движений средств за указанное количество дней прошлое
finances_create_transactions_access boolean true - есть доступ к созданию транзакций, false - нет доступа
finances_create_last_days_count number -1 - есть доступ к созданию транзакций за все время, >= 0 - доступ к созданию транзакций за указанное количество дней прошлое
finances_edit_transactions_access boolean true - есть доступ к редактированию транзакций, false - нет доступа
finances_edit_last_days_count number -1 - есть доступ к редактированию транзакций за все время, >= 0 - доступ к редактированию транзакций за указанное количество дней прошлое
finances_delete_transactions_access boolean true - есть доступ к удалению транзакций, false - нет доступа
finances_transactions_excel_access boolean true - есть доступ к выгрузке движений средств в Excel, false - нет доступа
finances_expenses_ids array true - есть доступ к переводам между кассами, false - нет доступа
finances_accounts_access boolean true - есть доступ к счетам и кассам, false - нет доступа
finances_accounts_banalce_access boolean true - есть доступ к балансу, false - нет доступа
finances_suppliers_read_access boolean true - есть доступ к контрагентам, false - нет доступа
finances_suppliers_create_access boolean true - есть доступ к созданию контрагентов, false - нет доступа
finances_suppliers_update_access boolean true - есть доступ к изменению контрагентов, false - нет доступа
finances_suppliers_delete_access boolean true - есть доступ к удалению контрагентов, false - нет доступа
finances_suppliers_excel_access boolean true - есть доступ к выгрузке в Excel, false - нет доступа
finances_expenses_read_access boolean true - есть доступ к статье платежей, false - нет доступа
expenses_read_access boolean true - есть доступ к статье платежей, false - нет доступа
finances_expenses_create_access boolean true - есть доступ к созданию статьи платежа, false - нет доступа
expenses_create_access boolean true - есть доступ к созданию статьи платежа, false - нет доступа
finances_expenses_update_access boolean true - есть доступ к изменению статьи платежа, false - нет доступа
expenses_update_access boolean true - есть доступ к изменению статьи платежа, false - нет доступа
finances_expenses_delete_access boolean true - есть доступ к удалению статьи платежа, false - нет доступа
expenses_delete_access boolean true - есть доступ к удалению статьи платежа, false - нет доступа
finances_kkm_transactions_access boolean true - есть доступ к операциям с KKM, false - нет доступа
kkm_transactions_accounts_access boolean true - есть доступ к операциям с KKM, false - нет доступа
finances_kkm_settings_read_access boolean true - есть доступ к настройкам KKM, false - нет доступа
kkm_settings_reed_access boolean true - есть доступ к настройкам KKM, false - нет доступа
finances_kkm_settings_update_access boolean true - есть доступ к изменению KKM, false - нет доступа
kkm_settings_update_access boolean true - есть доступ к изменению KKM, false - нет доступа
finances_settings_invoicing_read_access boolean true - есть доступ к онлайн-оплатам, false - нет доступа
finances_settings_invoicing_update_access boolean true - есть доступ к изменению онлайн-оплат, false - нет доступа
settings_invoicing_update_access boolean true - есть доступ к изменению онлайн-оплат, false - нет доступа
finances_options_read_access boolean true - есть доступ к настройкам оплаты, false - нет доступа
finances_options_update_access boolean true - есть доступ к изменению настроек оплаты, false - нет доступа
options_update_access boolean true - есть доступ к изменению настроек оплаты, false - нет доступа
finances_salary_schemes_access boolean true - есть доступ к схемам расчета заработной платы, false - нет доступа
finances_salary_calc_access boolean true - есть доступ к расчету заработной платы, false - нет доступа
finances_salary_not_limitation_today_access boolean true - есть доступ к расчету заработной платы, false - доступ к расчету заработной платы за текущий день
finances_payroll_calculation_create_access boolean true - есть доступ к начислению заработной платы, false - нет доступа
finances_payroll_calculation_create_not_limitation_today_access boolean true - есть доступ к начислению заработной платы, false - доступ к начислению заработной платы за текущий день
finances_salary_access_master_checkbox boolean true - есть доступ к расчету заработной платы только конкретного сотрудника, false - полный доступ
finances_salary_access_master_id number ID сотрудника к которому есть доступ на расчет заработной платы
get_salary_access_master_id number ID сотрудника к которому есть доступ на расчет заработной платы
finances_salary_master_not_limitation_today_access boolean true - не ограничивать текущим днем, false - доступ только на сегодняшний день
finances_payroll_calculation_create_by_master_access boolean true - есть доступ к начислению заработной платы по конкретному сотруднику, false - без ограничений
calculation_create_by_master_not_limitation_today_access boolean true - есть доступ к начислению заработной платы, false - нет доступа
finances_period_report_access boolean true - есть доступ к отчету за период, false - нет доступа
finances_period_report_excel_access boolean true - есть доступ к выгрузке в Excel отчета за период, false - нет доступа
finances_year_report_access boolean true - есть доступ к годовому отчету, false - нет доступа
finances_year_report_excel_access boolean true - есть доступ к выгрузке в Excel годового отчета, false - нет доступа
finances_print_check_access boolean true - есть доступ к печати чека, false - нет доступа
finances_z_report_access boolean true - есть доступ к отчету по кассе за день, false - нет доступа
finances_z_report_no_limit_today_access boolean true - есть доступ к отчету по кассе, false - доступ к отчету по кассе за текущий день
finances_z_report_excel_access boolean true - есть доступ к выгрузке в Excel, false - нет доступа
clients_access boolean true - есть доступ к клиентской базе, false - нет доступа
clients_phones_email_access boolean true - есть доступ к номерам телефонов и email в списке клиентов, false - нет доступа
client_phones_access boolean true - есть доступ к номерам телефонов в списке клиентов, false - нет доступа
clients_card_phone_access boolean true - есть доступ к телефонам в карточке клиента, false - нет доступа
clients_delete_access boolean true - есть доступ к удалению клиентов, false - нет доступа
clients_excel_access boolean true - есть доступ к выгрузке списка клиентов в Excel, false - нет доступа
excel_access number 1 - есть доступ к выгрузке списка клиентов в Excel, 0 - нет доступа
client_comments_list_access boolean true - есть доступ к просмотру комментарии, false - нет доступа
client_comments_add_access boolean true - есть доступ к добавлению комментарии, false - нет доступа
client_comments_own_edit_access boolean true - есть доступ к изменению/удалению своих комментарии, false - нет доступа
client_comments_other_edit_access boolean true - есть доступ к изменению/удалению чужих комментарии, false - нет доступа
client_files_list_access boolean true - есть доступ к просмотрам и скачиванию файлов, false - нет доступа
client_files_upload_access boolean true - есть доступ к загрузке файлов, false - нет доступа
client_files_delete_access boolean true - есть доступ к удалению файлов, false - нет доступа
clients_visit_master_id number ID мастера по которому можно посмотреть клиентов посещавшие мастера, 0 - без ограничений
get_visit_master_id number ID мастера по которому можно посмотреть клиентов посещавшие мастера, 0 - без ограничений
dashboard_access boolean true - есть доступ к разделу обзор, false - нет доступа
dash_access boolean true - есть доступ к разделу сводка, false - нет доступа
dash_phones_access boolean true - есть доступ к показу номера телефонов в сводке, false - нет доступа
dash_records_access boolean true - есть доступ к просмотру списка записей, false - нет доступа
dash_records_last_days_count number -1 - есть доступ к просмотру списка записей за все время, >= 0 - доступ к просмотру списка записей за указанное количество дней прошлое
dash_records_excel_access boolean true - есть доступ к выгрузке списка записей в Excel, false - нет доступа
dash_records_phones_access boolean true - есть доступ к показу номера телефонов в записях, false - нет доступа
dash_message_access boolean true - есть доступ к просмотру детализаций сообщений, false - нет доступа
dash_message_excel_access boolean true - есть доступ к выгрузке детализаций сообщений в Excel, false - нет доступа
dash_message_phones_access boolean true - есть доступ к показу номера телефонов в сообщениях, false - нет доступа
dash_reviews_access boolean true - есть доступ к просмотру отзывов, false - нет доступа
dash_reviews_delete_access boolean true - есть доступ к удалению отзывов, false - нет доступа
dashboard_calls_access boolean true - есть доступ к разделу звонки, false - нет доступа
dashboard_calls_excel_access boolean true - есть доступ к выгрузке звонков Excel, false - нет доступа
dashboard_calls_phones_access boolean true - есть доступ к просмотру номера телефона у клиентов, false - нет доступа
notification boolean true - есть доступ к Уведомления, false - нет доступа
web_push boolean true - есть доступ к показу Push уведомлений о записях в Web-версии, false - нет доступа
web_phone_push boolean true - есть доступ к показу Push уведомлений о звонках в Web-версии, false - нет доступа
notification_sms_ending_license boolean true - есть доступ к отправки SMS уведомлений о скором окончании лицензии, false - нет доступа
notification_sms_low_balance boolean true - есть доступ к отправки SMS уведомлений о низком балансе, false - нет доступа
notification_email_ending_license boolean true - есть доступ к отправки Email уведомлений о скором окончании лицензии, false - нет доступа
loyalty_access boolean true - есть доступ к лояльности, false - нет доступа
has_loyalty_access boolean true - есть доступ к лояльности, false - нет доступа
loyalty_cards_manual_transactions_access boolean true - есть доступ к ручному пополнению/списанию с карт лояльности, false - нет доступа
has_loyalty_cards_manual_transactions_access boolean true - есть доступ к ручному пополнению/списанию с карт лояльности, false - нет доступа
loyalty_certificate_and_abonement_manual_transactions_access boolean true - есть доступ к оплате сертификатом и абонементом без кода, false - нет доступа
storages_access boolean true - есть доступ к складу, false - нет доступа
storages_ids boolean true - есть доступ к выбранным складам, false - нет доступа
storages_transactions_access boolean true - есть доступ к просмотру движений товаров, false - нет доступа
storages_last_days_count number -1 - есть доступ к просмотру движений товаров за все время, >= 0 - доступ к просмотру движений товаров за указанное количество дней прошлое
storages_move_goods_access boolean true - есть доступ к перемещение товаров между складами, false - нет доступа
storages_create_transactions_access boolean true - есть доступ к созданию товарных транзакций, false - нет доступа
storages_create_last_days_count number -1 - есть доступ к создание товарных транзакций за все время, >= 0 - доступ к создание товарных транзакций за указанное количество дней прошлое
storages_create_transactions_buy_access boolean true - есть доступ к оформлению прихода товаров, false - нет доступа
storages_create_transactions_sale_access boolean true - есть доступ к оформлению продаж товаров, false - нет доступа
storages_edit_transactions_access boolean true - есть доступ к редактированию товарных транзакций, false - нет доступа
storages_edit_last_days_count number -1 - есть доступ к редактированию товарных транзакций за все время, >= 0 - доступ к редактированию товарных транзакций за указанное количество дней прошлое
storages_edit_transactions_buy_access boolean true - есть доступ к оформлению прихода товаров, false - нет доступа
storages_edit_transactions_sale_access boolean true - есть доступ к оформлению продаж товаров, false - нет доступа
storages_delete_transactions_access boolean true - есть доступ к удалению товарных транзакций, false - нет доступа
storages_transactions_excel_access boolean true - есть доступ к выгрузке движений товаров в Excel, false - нет доступа
storages_transactions_types boolean true - есть доступ к выгрузке движений товаров в Excel, false - нет доступа
storages_inventory_access boolean true - есть доступ к инвентаризации, false - нет доступа
storages_inventory_create_edit_access boolean true - есть доступ к созданию и редактированию инвентаризации, false - нет доступа
storages_inventory_delete_access boolean true - есть доступ к удалению инвентаризации, false - нет доступа
storages_inventory_excel_access boolean true - есть доступ к выгрузке инвентаризации в Excel, false - нет доступа
storages_remnants_report_access boolean true - есть доступ к отчету остатков на складе, false - нет доступа
storages_remnants_report_excel_access boolean true - есть доступ к выгрузке остатков в Excel, false - нет доступа
storages_sales_report_access boolean true - есть доступ к отчету по продажам, false - нет доступа
storages_sales_report_excel_access boolean true - есть доступ к выгрузке отчета по продажам в Excel, false - нет доступа
storages_consumable_report_access boolean true - есть доступ к отчету по списанию расходников, false - нет доступа
storages_consumable_report_excel_access boolean true - есть доступ к выгрузке отчета по списанию расходников в Excel, false - нет доступа
storages_write_off_report_access boolean true - есть доступ к отчету по списанию товаров, false - нет доступа
storages_write_off_report_excel_access boolean true - есть доступ к выгрузке отчета по списанию товаров в Excel, false - нет доступа
storages_turnover_report_access boolean true - есть доступ к отчету по оборачиваемости, false - нет доступа
storages_turnover_report_excel_access boolean true - есть доступ к выгрузке отчета по оборачиваемости в Excel, false - нет доступа
storages_goods_crud_access boolean true - есть доступ к управлению товарами, false - нет доступа
storages_goods_create_access boolean true - есть доступ к созданию товаров, false - нет доступа
storages_goods_update_access boolean true - есть доступ к изменению товаров, false - нет доступа
storages_goods_title_edit_access boolean true - есть доступ к названию, Артикул, Штрих-код, false - нет доступа
storages_goods_category_edit_access boolean true - есть доступ к категориям, false - нет доступа
storages_goods_selling_price_edit_access boolean true - есть доступ к ценам продажи, false - нет доступа
storages_goods_cost_price_edit_access boolean true - есть доступ к себестоимости, false - нет доступа
storages_goods_units_edit_access boolean true - есть доступ к единицам измерения, false - нет доступа
storages_goods_critical_balance_edit_access boolean true - есть доступ к критичным остаткам, Желаемый остаток, false - нет доступа
storages_goods_masses_edit_access boolean true - есть доступ к массе, false - нет доступа
storages_goods_comment_edit_access boolean true - есть доступ к комментариям, false - нет доступа
storages_goods_archive_access boolean true - есть доступ к архивации и восстановлению товаров, false - нет доступа
storages_goods_delete_access boolean true - есть доступ к удалению товаров, false - нет доступа
settings_access boolean true - есть доступ к разделу настройки, false - нет доступа
settings_basis_access boolean true - есть доступ к разделу Основные, false - нет доступа
settings_information_access boolean true - есть доступ к разделу Информация, false - нет доступа
users_access boolean true - есть доступ к управлению пользователями, false - нет доступа
delete_users_access boolean true - есть доступ к удалению пользователей, false - нет доступа
create_users_access boolean true - есть доступ к добавлению пользователей, false - нет доступа
edit_users_access boolean true - есть доступ к управлению правами пользователей, false - нет доступа
limited_users_access boolean true - есть доступ к управлению правами в рамках своего набора прав, false - нет доступа
settings_services_access boolean true - есть доступ к разделу Услуги, false - нет доступа
settings_services_create_access boolean true - есть доступ к созданию услуг, false - нет доступа
services_edit boolean true - есть доступ к редактированию услуг, false - нет доступа
settings_services_edit_title_access boolean true - есть доступ к названиям услуг и название для онлайн-записи, false - нет доступа
settings_services_relation_category_access boolean true - есть доступ к категориям услуги, false - нет доступа
settings_services_edit_price_access boolean true - есть доступ к ценам услуг, false - нет доступа
settings_services_edit_image_access boolean true - есть доступ к загрузкам и изменениям изображений, false - нет доступа
settings_services_edit_online_seance_date_time_access boolean true - есть доступ к отображениям услуг в виджете, false - нет доступа
settings_services_edit_online_pay_access boolean true - есть доступ к онлайн-оплате услуги, false - нет доступа
settings_services_edit_services_related_resource_access boolean true - есть доступ к ресурсам услуги, false - нет доступа
settings_positions_read boolean true - есть доступ к разделу должности, false - нет доступа
settings_positions_create boolean true - есть доступ к созданию должностей, false - нет доступа
settings_positions_delete boolean true - есть доступ к удалению должностей, false - нет доступа
edit_master_service_and_duration boolean true - есть доступ к изменению услуги сотрудников и их длительность, false - нет доступа
tech_card_edit boolean true - есть доступ к изменению технологической карты, false - нет доступа
services_delete boolean true - есть доступ к удалению услуг, false - нет доступа
settings_master_access boolean true - есть доступ к разделу Сотрудники, false - нет доступа
master_create boolean true - есть доступ к созданию сотрудников, false - нет доступа
master_edit boolean true - есть доступ к редактированию сотрудников, false - нет доступа
master_delete boolean true - есть доступ к удалению сотрудников, false - нет доступа
settings_master_dismiss_access boolean true - есть доступ к увольнению сотрудников, false - нет доступа
schedule_edit boolean true - есть доступ к редактированию графика работы, false - нет доступа
settings_notifications_access boolean true - есть доступ к разделу Sms уведомления, false - нет доступа
settings_email_notifications_access boolean true - есть доступ к разделу Email уведомления, false - нет доступа
settings_template_notifications_access boolean true - есть доступ к разделу Типы уведомлений, false - нет доступа
webhook_read_access boolean true - есть доступ к изменению настроек WebHook, false - нет доступа
stat_access boolean true - есть доступ к аналитике, false - нет доступа
billing_access boolean true - есть доступ к биллингу (раздел меню баланс), false - нет доступа
send_sms boolean true - есть доступ к SMS рассылки клиентам, false - нет доступа
auth_enable_check_ip boolean true - есть доступ к филиалу только с IP-адресов (v4, v6), false - нет доступа
auth_list_allowed_ip array список IP адресов
  • Параметр
    • company_id (required, number, 1) - ID компани

Получить список прав

  • Параметр
    • company_id (required, number, 1) - ID компании
Authorizations:
(beareruser)
path Parameters
company_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с категориями прав доступа

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Создание и отправка приглашения

Приглашение к управлению филиалом предполагает отправку по e-mail или телефону ссылки. Перейдя по этой ссылке, пользователь после регистрации получает доступ к управлению филиалом в соответствии с назначенными правами. Назначение прав осуществляется после отправки приглашения отдельным запросом.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
required
Array of objects

Массив приглашений

Responses

Response Schema: application/json
success
boolean

Статус успешной отправка (true)

data
string

Имеет значение null

object

Метаданные (содержит сообщение о том, что данные сохранены)

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

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

Response samples

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

Сотрудники

Для работы с сотрудниками используются следующие методы

Объект сотрудника имеет следующие поля:

Поле Тип Описание
id number Идентификатор сотрудника
api_id string|null Внешний идентификатор сотрудника
name string Имя сотрудника
specialization string Специализация сотрудника
position object Должность сотрудника
weight number Вес сотрудника. При выводе сотрудники сортируются по весу, сначала более тяжелые
show_rating number Показывать ли рейтинг сотрудника (1 - показывать, 0 - не показывать)
rating number Ретинг сотрудника
votes_count number Кол-во голосов, оценивших сотрудника
comments_count number Кол-во комментариев к сотрунику
avatar string Путь к файлу аватарки сотрудника
avatar_big string Путь к файлу аватарки сотрудника в более высоком разрешении
information string Дополнительная информация о сотруднике (HTML формат)
hidden number 1 - скрыт от онлайн записей, 0 - не скрыт
fired number 1 - уволен, 0 - не уволен
status number Статус удаления сотрудника, 1 - удален, 0 - не удален
image_group object Группа изображений сотрудника

Быстрое создание сотрудника

Создает нового сотрудника в филиале с минимальным набором входных параметров.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
name
required
string

Имя сотрудника.

specialization
required
string

Специализация сотрудника.

position_id
required
number or null

Идентификатор должности, к которой необходимо привязать сотрудника.

phone_number
required
string or null

Номер телефона пользователя, к которому необходимо привязать сотрудника (без "+", от 9 до 15 цифр).

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Сотрудник с Должностью")
meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "name": "Иван Иванов",
  • "specialization": "Мастер",
  • "position_id": 123,
  • "phone_number": "71234567890"
}

Response samples

Content type
application/json
{}

Устаревшее. Добавить нового сотрудника Deprecated

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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
name
string

Имя сотрудника

specialization
string

Специализация сотрудника

weight
number

Вес сотрудника. При выводе сотрудники сортируются по весу, сначала более тяжелые

information
string

Информация о сотруднике (HTML-формат)

api_id
string

Внещний идентификатор сотрудника

hidden
number

Статус отображения в онлайн-записи, 1 - скрыт, 0 - не скрыт

fired
number

Статус увольнения сотрудника, 1 - уволен, 0 - не уволен

user_id
number

ID привязанного пользователя, 0 - удалить связь с пользователем

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержат количество найденных сотрудников)

Request samples

Content type
application/json
{
  • "name": "Василий",
  • "specialization": "парикмахер",
  • "weight": 10,
  • "information": "Стрижет методом трех рук",
  • "api_id": "42",
  • "hidden": 0,
  • "fired": 0,
  • "user_id": 123
}

Response samples

Content type
application/json
{}

Получить список сотрудников / конкретного сотрудника

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

staff_id
required
number

ID сотрудника, если нужно работать с конкретным сотрудником.

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержат количество найденных сотрудников)

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

data
string

Содержит null

object

Метаданные (содержит в себе сообщение об ошибке)

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

object

Метаданные (содержит в себе сообщение об ошибке)

Response samples

Content type
application/json
{}

Устаревшее. Получить список сотрудников / конкретного сотрудника Deprecated

Authorizations:
bearer
path Parameters
company_id
required
number

ID компании

staff_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

Content type
application/json
{}

Изменить сотрудника

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

staff_id
required
number

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: */*
name
string

Имя сотрудника

specialization
string

Специализация сотрудника

weight
number

Вес сотрудника. При выводе сотрудники сортируются по весу, сначала более тяжелые

information
string

Информация о сотруднике (HTML-формат)

api_id
string

Внещний идентификатор сотрудника

hidden
number

Статус отображения в онлайн-записи, 1 - скрыт, 0 - не скрыт

fired
number

Статус увольнения сотрудника, 1 - уволен, 0 - не уволен

user_id
number

ID привязанного пользователя, 0 - удалить связь с пользователем

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержат количество найденных сотрудников)

Response samples

Content type
application/json
{}

Удалить сотрудника

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

staff_id
required
number

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

Responses

Должности

Описание методов для работы с должностями сотрудников

Получить список должностей компании

Метод позволяет получить список актуальных должностей компании

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

Responses

Response Schema: application/json
required
Array of objects (StaffPosition)

Массив объектов с данными

meta
required
Array of objects

Метаданные (содержит количество найденных должностей)

success
required
boolean

Статус успешности выполнения (true)

Response samples

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

Быстрое создание должности

Создает новую должность в филиале; должность создается как сетевая сущность и одновременно привязывается к филиалу, в которой запрошено ее создание.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
title
required
string

Название должности.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Должность")

Данные существующей должности в сети.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "title": "Должность"
}

Response samples

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

Клиенты

Для работы с клиентами

Коллекция клиентов

  • Параметр
    • company_id (required, number, 1) - ID компании

Получить список клиентов

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

header Parameters
Accept
required
string

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
page
number

Номер страница

page_size
number

Количество выводимых строк на странице. Максимум 200. (По умолчанию 25)

fields
Array of strings

Поля, которые нужно вернуть в ответе

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

По какому полю сортировать

order_by_direction
string
Enum: "ASC" "DESC"

Как сортировать (по возрастанию / по убыванию)

operation
string
Enum: "AND" "OR"

Тип операции

Array of objects

Фильтры для поиска по клиентам

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных клиентов)

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

data
string

Содержит null

object

Метаданные (содержит сообщение об ошибке)

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

data
string

Содержит null

object

Метаданные (содержит сообение об ошибке)

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

object

Метаданные (содержит сообщение об ошибке)

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

  • Параметр
    • company_id (required, number, 1) - ID компании
    • page (number, 1) - Номер страницы
    • count (number, 20) - Количество клиентов на странице

Фильтрация клиентов

  • fullname:Joh (optional, string) - Имя (часть имени) для фильтрации клиентов
  • phone:7916 (optional, string) - Телефон (часть номера) для фильтрации клиентов
  • email:test@ (optional, string) - Email (часть) для фильтрации клиентов
  • card:5663rt (optional, string) - Card (часть) для фильтрации клиентов по номеру карты лояльности
  • paid_min:100 (optional, number) - Минимально оплачено в кассу, для фильтрации клиентов по сумме оплат
  • paid_max:0 (optional, number) - Максимально оплачено в кассу, для фильтрации клиентов по сумме оплат
  • paid_max:0 (optional, number) - Максимально оплачено в кассу, для фильтрации клиентов по сумме оплат
  • id:66 (optional, number) - ID одного клиента для фильтрации клиентов
  • id[]: 66 (optional, array) - ID нескольких клиентов для фильтрации
  • changed_after: '2000-01-01T00:00:00' (optional, string) - Фильтрация клиентов, измененных/созданных начиная с конкретной даты и времени
  • changed_before: '2020-12-31T23:59:59' (optional, string) - Фильтрация клиентов, измененных/созданных до конкретной даты и времени
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
fullname
string
Example: fullname=Joh

Имя (часть имени) для фильтрации клиентов

phone
string
Example: phone=7916

Телефон (часть номера) для фильтрации клиентов

email
string
Example: email=test@

Email (часть) для фильтрации клиентов

paid_min
number
Example: paid_min=1

Минимально оплачено в кассу, для фильтрации клиентов по сумме оплат

paid_max
number
Example: paid_max=1

Максимально оплачено в кассу, для фильтрации клиентов по сумме оплат

page
number
Example: page=1

Номер страницы

count
number
Example: count=20

Количество клиентов на странице

id
number
Example: id=66

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит номер страницы и количество клиентов на странице)

Response samples

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

Добавить клиента

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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: */*
name
required
string

Имя клиента

surname
string

Фамилия клиента

patronymic
string

Отчество клиента

phone
required
string

Телефон клиента

email
string

Email клиента

sex_id
number

Пол клиента (1 - мужской, 2 - женский, 0 - не известен)

importance_id
number

Класс важности клиента (0 - нет, 1 - бронза, 2 - серебро, 3 - золото)

discount
number

Скидка клиента

card
string

Номер карты клиента

birth_date
string

Дата рождения клиента в формате yyyy-mm-dd

comment
string

Комментарий

spent
number

Сколько потратил средств в компании на момент добавления

balance
number

Баланс клиента

sms_check
number

1 - Поздравлять с Днем Рождения по SMS, 0 - не поздравлять

sms_not
number

1 - Исключить клиента из SMS рассылок, 0 - не исключать

categories
object

Массив идентификаторов категорий клиента

custom_fields
object

Массив дополнительных полей клиента в виде пар "api-key": "value"

Responses

Response samples

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

Массовое добавление клиентов

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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: */*
name
required
string

Имя клиента

surname
string

Фамилия клиента

patronymic
string

Отчество клиента

phone
required
string

Телефон клиента

email
string

Email клиента

sex_id
number

Пол клиента (1 - мужской, 2 - женский, 0 - не известен)

importance_id
number

Класс важности клиента (0 - нет, 1 - бронза, 2 - серебро, 3 - золото)

discount
number

Скидка клиента

card
string

Номер карты клиента

birth_date
string

Дата рождения клиента в формате yyyy-mm-dd

comment
string

Комментарий

spent
number

Сколько потратил средств в компании на момент добавления

balance
number

Баланс клиента

sms_check
number

1 - Поздравлять с Днем Рождения по SMS, 0 - не поздравлять

sms_not
number

1 - Исключить клиента из SMS рассылок, 0 - не исключать

categories
object

Массив идентификаторов категорий клиента

Responses

Response samples

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

Пример запроса на получение списка файлов клиента

Список загруженных файлов клиента можно получить, сделав запрос с указанием идентификатора филиала и идентификатора клиента, для которого необходимо получить список. Идентификатор клиента можно получить из коллекции клиентов.

Список представляет собой массив файлов клиента.

Файл клиента имеет следующую структуру:

Поле Тип Описание
id number Идентификатор файла
client_id number Идентификатор клиента
name string Имя файла с расширением
description string Описание файла
extension string Расширение имени файла
mime string MIME-тип файла
link string Ссылка на скачивание файла
date_create string Дата загрузки файла в формате ISO8601
size string Форматированная строка размера файла
user_name string Имя пользователя, загрузившего файл
user_avatar string Аватар пользователя, загрузившего файл
can_edit boolean Есть ли право изменять и удалять файл? true - право есть, false - права нет
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

client_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество файлов)

Response samples

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

Пример запроса на удаление

Authorizations:
bearer
path Parameters
company_id
required
number

ID компании

client_id
required
number

ID клиента

file_id
required
number

ID файла

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

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

Responses

Response samples

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

Поиск по истории посещений клиента

Выводит записи из истории посещений клиента по его идентификатору или номеру телефона. В ответ попадают записи и продажи товаров, объединенные по визитам, отфильтрованные по статусу посещения и статусу оплаты визита. Результат сортируется по дате и разбивается на страницы по 25 элементов (или более, если дата последней записи совпадает с датой следующей записи). Идентификация клиента происходит по входному параметру client_id либо по client_phone. Остальные параметры могут иметь пустое значение.
Для получения данных на следующей странице необходимо выполнить запрос с параметрами from и to, полученными в результате текущего запроса в поле meta.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

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

Идентификатор клиента.

client_phone
required
string or null

Номер телефона клиента.

from
required
string or null <date>

Дата начала периода.

to
required
string or null <date>

Дата конца периода.

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

Статус оплаты визита:
not_paid - визит неоплачен, никаких оплат по визиту не проходило;
paid_not_full - визит оплачен частично;
paid_full - визит оплачен полностью, переплаты нет;
paid_over - по визиту есть переплата.
Если фильтр по статусу оплаты не требуется, то необходимо передать пустой массив [].

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

Статус посещения:
-1: - клиент не пришёл;
0: - ожидание клиента;
1: - клиент пришёл;
2: - клиент подтвердил запись.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "История посещений клиента")

Данные по визитам клиента, включая записи и продажи товаров.

object (Объект информации о постраничной навигации, основанной на дате.)

Информация о постраничной навигации, содержащая данные о текущей, следующей и предыдущей страницах. Данные отсортированы и разбиты на страницы по датам в убывающем порядке.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

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": {
    }
}

Получить клиента

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

id
required
number

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

Responses

Response samples

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

Редактировать клиента

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

id
required
number

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: */*
name
required
string

Имя клиента

surname
string

Фамилия клиента

patronymic
string

Отчество клиента

phone
required
string

Телефон клиента

email
string

Email клиента

sex_id
number

Пол клиента (1 - мужской, 2 - женский, 0 - не известен)

importance_id
number

Класс важности клиента (0 - нет, 1 - бронза, 2 - серебро, 3 - золото)

discount
number

Скидка клиента

card
string

Номер карты клиента

birth_date
string

Дата рождения клиента в формате yyyy-mm-dd

comment
string

Комментарий

spent
number

Сколько потратил средств в компании на момент добавления

balance
number

Баланс клиента

sms_check
number

1 - Поздравлять с Днем Рождения по SMS, 0 - не поздравлять

sms_not
number

1 - Исключить клиента из SMS рассылок, 0 - не исключать

labels
object

Массив идентификаторов категорий клиента

custom_fields
object

Массив дополнительных полей клиента в виде пар "api-key": "value"

Responses

Response samples

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

Удалить клиента

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

id
required
number

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

Responses

Получение списка комментариев к клиенту

Возвращает список комментариев к клиенту, а также историю загрузки файлов в карточку клиента в виде комментариев.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

client_id
required
number
Example: 123

Идентификатор клиента филиала.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects (Объект модели "Комментарий к клиенту")
object (Объект дополнительной информации о запросе с кол-вом найденных результатов)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Добавление комментария к клиенту

Создает новый текстовый комментарий к клиенту.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

client_id
required
number
Example: 123

Идентификатор клиента филиала.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
text
required
string

Текст комментария к клиенту.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Комментарий к клиенту")

Данные по комментарию к клиенту.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "text": "Комментарий к клиенту"
}

Response samples

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

Удаление комментария к клиенту

Удаляет комментарий к клиенту; не удаляет загруженные в карточку клиента файлы, загрузка которых породила создание комментария.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

client_id
required
number
Example: 123

Идентификатор клиента филиала.

comment_id
required
number
Example: 123

Идентификатор комментария клиента.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Сетевые клиенты

Для работы с клиентами

Получить сетевого клиента по номеру телефона.

  • Параметр
    • group_id (required, number, 43877) - Id сети салонов

Фильтрация клиентов

  • phone:'70001234567' (optional, string) - Телефон для фильтрации клиентов
Authorizations:
(beareruser)
path Parameters
group_id
required
number

ID сети салонов

query Parameters
phone
required
string
Example: phone='79264037640'

Телефон для фильтрации клиентов, обязательный параметр

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

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean

Статус успешности выполнения

data
string

Содержит null

object

Объект с сообщением об ошибке

Response samples

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

Записи

Получить список записей

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
page
number
Example: page=1

Номер страницы

count
number
Example: count=50

Количество записей на странице

staff_id
number
Example: staff_id=7572

ID сотрудника, если нужно только записи к конкретному сотруднику

client_id
number
Example: client_id=572

ID клиента. Если нужны записи к конкретному клиенту

created_user_id
number
Example: created_user_id=7572

ID пользователя создавшего запись. Если нужны записи созданные конкретным пользователем

start_date
date
Example: start_date=2019-01-01

Дата сеанса начина с (фильтр по дате сеанса). Если нужны записи на сеанс начиная с конкретной даты

end_date
date
Example: end_date=2019-05-01

Дата сеанса по. Если нужны записи на сеанс до конкретной даты

c_start_date
date
Example: c_start_date=2019-01-01

Дата создания записи начиная с(фильтр по дате создания записи). Если нужны записи созданные начиная с конкретной даты

c_end_date
date
Example: c_end_date=2019-05-01

Дата создания записи по(фильтр по дате создания записи).

changed_after
date
Example: changed_after=2019-01-01

Дата изменения/создания записи. Если нужны записи созданные/измененные начиная с конкретной даты и времени

changed_before
date
Example: changed_before=2019-05-01

Дата изменения/создания записи. Если нужны записи созданные/измененные до конкретной даты и времени

include_consumables
number
Example: include_consumables=0

Флаг для включения в ответ списка расходников по записям

include_finance_transactions
number
Example: include_finance_transactions=0

флаг для включения в ответ финансовых транзакций по записям

with_deleted
boolean

Включить в выдачу удаленные записи (with_deleted=1 вернет и удаленные записи)

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит номер страницы и количество записей на странице)

Response samples

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

Создать новую запись

Для групповых событий При создании записи в групповом событии параметр activity_id становится обязательным, параметры staff_id, services, datetime, seance_length становятся необязательными.

Дополнительные поля При создании дополнительных полей записи(см. раздел "Дополнительные поля") становится возможным передавать собственные значения для полей. Дополнительные поля уникальны для каждой компании. После создания дополнительных полей, их значения для конкретной записи могут передаваться в необязательном поле custom_fields в виде пар ключ-значение где ключ это поле "code" дополнительного поля. Пример:

  • Создали дополнительное поле записи с code="my_custom_field" type="number", и второе поле code="some_another_field" type="list"

  • Передали при создании записи еще один атрибут: custom_fields: { "my_custom_field": 123, "some_another_field": ["first value", "second value"] }

  • При получении данной записи методом GET впоследствии, это же значение дополнительных полей вернется в ответе

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

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
staff_id
number

Идентификатор сотрудника

Array of objects

Параметры услуг (id, стоимость, скидка)

object

Параметры клиента (телефон, имя, email)

save_if_busy
boolean

Сохранять ли запись если время занято или нерабочее, или выдать ошибку

datetime
string <date-time>

Дата и время записи

seance_length
number

Длительность записи в секундах

send_sms
boolean

Отправлять ли смс с деталями записи клиенту

comment
string

Комментарий к записи

sms_remain_hours
number

За сколько часов до визита следует выслать смс напоминание клиенту (0 - если не нужно)

email_remain_hours
number

За сколько часов до визита следует выслать email напоминание клиенту (0 - если не нужно)

attendance
number

Статус записи (2 - Пользователь подтвердил запись, 1 - Пользователь пришел, услуги оказаны, 0 - ожидание пользователя, -1 - пользователь не пришел на визит)

api_id
string

Идентификатор внешней системы

custom_color
string

Цвет записи

record_labels
Array of strings

Массив идентификаторов категорий записи

object

Дополнительные поля записи

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит номер страницы и количество записей на странице)

Request samples

Content type
application/json
{
  • "staff_id": 8886,
  • "services": [
    ],
  • "client": {
    },
  • "save_if_busy": false,
  • "datetime": "2019-01-01 17:00:00",
  • "seance_length": 3600,
  • "send_sms": true,
  • "comment": "тестовая запись!",
  • "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": {
    }
}

Получить список записей партнёра

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

Номер страницы

editable_length
number
Example: editable_length=50

Количество записей на странице, максимум 100

salon_id
number
Example: salon_id=1

ID филиала

start_date
string
Example: start_date='17.01.2018'

Фильтр по дате визита с

end_date
string
Example: end_date='17.01.2018'

Фильтр по дате визита по

created_start_date
string
Example: created_start_date='17.01.2018'

Фильтр по дате создания записи с

created_end_date
string
Example: created_end_date='17.01.2018'

Фильтр по дате создания записи по

user_id
number
Example: user_id=1

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

Responses

Response samples

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

Получить запись

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

record_id
required
number

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.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

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Изменить запись

При изменении записи в групповом событии параметр activity_id становится обязательным, параметры staff_id, services, datetime, seance_length становятся необязательными

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

record_id
required
number

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.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
staff_id
number

Идентификатор сотрудника

Array of objects

Параметры услуг (id, стоимость, скидка)

object

Параметры клиента (телефон, имя, email)

save_if_busy
boolean

Сохранять ли запись если время занято или нерабочее, или выдать ошибку

datetime
string <date-time>

Дата и время записи

seance_length
number

Длительность записи в секундах

send_sms
boolean

Отправлять ли смс с деталями записи клиенту

comment
string

Комментарий к записи

sms_remain_hours
number

За сколько часов до визита следует выслать смс напоминание клиенту (0 - если не нужно)

email_remain_hours
number

За сколько часов до визита следует выслать email напоминание клиенту (0 - если не нужно)

attendance
number

Статус записи (2 - Пользователь подтвердил запись, 1 - Пользователь пришел, услуги оказаны, 0 - ожидание пользователя, -1 - пользователь не пришел на визит)

api_id
string

Идентификатор внешней системы

custom_color
string

Цвет записи

record_labels
Array of strings

Массив идентификаторов категорий записи

object

Дополнительные поля записи

Responses

Response Schema: application/json
success
boolean

Статус успешного выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "staff_id": 8886,
  • "services": [
    ],
  • "client": {
    },
  • "save_if_busy": false,
  • "datetime": "2019-01-01 17:00:00",
  • "seance_length": 3600,
  • "send_sms": true,
  • "comment": "тестовая запись!",
  • "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": [ ]
}

Удалить запись

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

record_id
required
number

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.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

Визиты

Для работы с визитами

Получить визит

Authorizations:
(beareruser)
path Parameters
visit_id
required
number
Example: 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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить детали визита

Блок "kkm_transaction_details_container"

Флаг "last_operation_type"

Значение Описание
0 Распечатать чек возврата
1 Распечатать чек продажи

Типы всех операций c ККМ

Значение Описание
0 Операция продажи (активна для документа с типом "Визит")
1 Операция возврата продажи (активна для документа с типом "Визит")
2 Операция коррекции
4 Операция открытия смены
5 Операция закрытия смены
9 Операция получения статуса ККМ
11 Операция получения статуса команды ККМ
12 Операция коррекции
13 Печать X-отчёта
6 Внесение наличных
7 Изъятие наличных

Статусы всех операций с ККМ

Значение Описание
0 Ошибка соединения с KKM
1 Успешно
2 Отправлен на печать
3 Ошибка выполнения
4 Ошибка проверки статуса
5 Ожидание готовности KKM

Типы документов

Значение Описание
1 Продажа товара
2 Оказание услуг
3 Приход товара
4 Списание товара
5 Движение товара
6 Инвентаризация
7 Визит
8 Списание расходников
Authorizations:
(beareruser)
path Parameters
salon_id
required
number
Example: ID филиала
record_id
required
number
Example: ID записи
visit_id
required
number
Example: ID визита
header Parameters
Accept
required
string

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer access_token, User user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Изменить визит

Authorizations:
(beareruser)
path Parameters
visit_id
required
number
Example: ID визита
record_id
required
number
Example: 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: */*
attendance
required
number

Статус визита (2 - Пользователь подтвердил запись, 1 - Пользователь пришел, услуги оказаны, 0 - ожидание пользователя, -1 - пользователь не пришел на визит)

comment
required
string

Комментарий

Array of objects

Массив объектов новых товарных транзакций

deleted_transaction_ids
Array of objects

Массив ID экземпляров

Array of objects

Массив объектов товарных транзакций

Array of objects

Массив объектов с услугами

fast_payment
number

Быстрая оплата 1 - наличными, 2 - безналичными, 129 - наличными и распечатать, 130 - безналичными и распечатать

Responses

Чек PDF по визиту

Authorizations:
(beareruser)
path Parameters
visit_id
required
number
Example: 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

Responses

Response samples

Content type
application/pdf

Групповые события

Для управлениями групповыми событиями используются следующие методы

Создание группового события

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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
date
required
string <date-time>

Дата и время

service_id
required
number

Идентификатор услуги

staff_id
required
number

Идентификатор сотрудника

capacity
required
number

Вместимость

resource_instance_ids
Array of numbers

Массив идентификаторов экземпляров ресурсов

force
required
boolean

Игнорировать ошибки (занятость мастера/ресурсов и т.п.)

length
number

Длительность события в секундах

color
string

Цвет события

label_ids
Array of arrays

Категории событий

comment
string

Комментарий события

stream_link
string

Ссылка на онлайн-событие

instructions
string

Инструкции

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "date": "2020-01-01 12:00:00",
  • "service_id": 1185299,
  • "staff_id": 26427,
  • "length": 3600,
  • "capacity": 9,
  • "resource_instance_ids": [
    ],
  • "force": false,
  • "label_ids": [
    ],
  • "comment": "",
  • "color": "",
  • "stream_link": "",
  • "instructions": ""
}

Response samples

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

Чтение группового события

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

activity_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Обновление группового события

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

activity_id
required
number

ID группового события

header Parameters
Accept
required
string

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
date
required
string <date-time>

Дата и время

service_id
required
number

Идентификатор услуги

staff_id
required
number

Идентификатор сотрудника

capacity
required
number

Вместимость

resource_instance_ids
Array of numbers

Массив идентификаторов экземпляров ресурсов

force
required
boolean

Игнорировать ошибки (занятость мастера/ресурсов и т.п.)

length
number

Длительность события в секундах

color
string

Цвет события

label_ids
Array of arrays

Категории событий

comment
string

Комментарий события

stream_link
string

Ссылка на онлайн-событие

instructions
string

Инструкции

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "date": "2020-01-01 12:00:00",
  • "service_id": 1185299,
  • "staff_id": 26427,
  • "length": 3600,
  • "capacity": 9,
  • "resource_instance_ids": [
    ],
  • "force": false,
  • "label_ids": [
    ],
  • "comment": "",
  • "color": "",
  • "stream_link": "",
  • "instructions": ""
}

Response samples

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

Удаление группового события

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

activity_id
required
number

ID групповой записи

header Parameters
Accept
required
string

application/vnd.yclients.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": {
    }
}

Фильтры групповых событий

Authorizations:
BearerPartner
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

query Parameters
service_ids
Array of integers
Example: service_ids=123

Фильтр по ID услуг.

staff_ids
Array of integers
Example: staff_ids=456

Фильтр по ID сотрудников филиала.

resource_ids
Array of integers
Example: resource_ids=789

Фильтр по ID ресурсов.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects (Объект "Фильтр для поиска событий")
object (Объект дополнительной информации о запросе с кол-вом найденных результатов)

Дополнительная информация о запросе.

Response samples

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

Поиск диапазона дат групповых событий

Authorizations:
BearerPartner
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

query Parameters
service_ids
Array of integers
Example: service_ids=123

Фильтр по ID услуг.

staff_ids
Array of integers
Example: staff_ids=456

Фильтр по ID сотрудников филиала.

resource_ids
Array of integers
Example: resource_ids=789

Фильтр по ID ресурсов.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект "Диапазон данных для поиска событий")

Диапазон данных для поиска событий.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Поиск дат групповых событий

Authorizations:
BearerPartner
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

query Parameters
from
required
string
Example: from=2023-06-01

Дата начала поиска (формат ГГГГ-ММ-ДД).

till
required
string
Example: till=2023-07-15

Дата окончания поиска (формат ГГГГ-ММ-ДД).

service_ids
Array of integers
Example: service_ids=123

Фильтр по ID услуг.

staff_ids
Array of integers
Example: staff_ids=456

Фильтр по ID сотрудников филиала.

resource_ids
Array of integers
Example: resource_ids=789

Фильтр по ID ресурсов.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response samples

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

Поиск групповых событий

Authorizations:
BearerPartner
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

query Parameters
from
required
string
Example: from=2023-06-01

Дата начала поиска (формат ГГГГ-ММ-ДД).

till
required
string
Example: till=2023-07-15

Дата окончания поиска (формат ГГГГ-ММ-ДД).

service_ids
Array of integers
Example: service_ids=123

Фильтр по ID услуг.

staff_ids
Array of integers
Example: staff_ids=456

Фильтр по ID сотрудников филиала.

resource_ids
Array of integers
Example: resource_ids=789

Фильтр по ID ресурсов.

page
number
Example: page=1

Номер страницы (по умолчанию 1).

count
number
Example: count=25

Количество элементов на странице (по умолчанию 25).

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит в себе количество найденных событий)

Response samples

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

Поиск групповых услуг

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

ID компании

query Parameters
staff_id
number

Идентификатор сотрудника для фильтрации

term
string

Поиске по названию или части названия услуги

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
staff_id
number

Идентификатор сотрудника для фильтрации

term
string

Поиск по названию или части названия услуги

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных услуг)

Request samples

Content type
application/json
{
  • "staff_id": 1,
  • "term": "test"
}

Response samples

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

Получение стратегий дублирования групповых событий

Дублирование событий происходит на основе набора параметров, объединенных в сущность "стратегия дублирования"

Поле Тип Описание
title string Название стратегии
repeat_mode_id integer Режим повторения
days integer[] Перечень дней недели: 0 вс, 6 пт
interval integer Перерыв в поиске дат, в единицах типа
content_type integer Дублировать записи? 1 - нет, 2 - да

Режим повторения может принимать значения

Значение Описание Единица измерения перерыва
1 Ежедневно День
2 По будням -
3 Пн Ср Пт -
4 Вт Чт -
5 Каждую неделю Неделя
6 Каждый месяц Месяц
7 Каждый год Год

Поле days актуально только для режима 5 - неделя, для указания конкретных дней повторения Если указать repeat_mode = 5, days = [1,4], interval = 2, то событие будет повторяться каждую 3ю неделю в пн и чт

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

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

Responses

Response samples

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

Создание шаблона дублирования группового события

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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: */*
title
required
string

Название

days
Array of objects

Дни повторений для недельного режима

repeat_mode_id
required
number

Режим повторений

interval
number

Перерыв в поиске дат

content_type
number

Дублировать записи? 1 - нет, 2 - да

Responses

Response samples

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

Обновление шаблона дублирования группового события

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

ID компании

strategy_id
required
number
Example: 3

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: */*
title
required
string

Название

days
Array of objects

Дни повторений для недельного режима

repeat_mode_id
required
number

Режим повторений

interval
number

Перерыв в поиске дат

content_type
number

Дублировать записи? 1 - нет, 2 - да

Responses

Response samples

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

Запрос дублирования группового события

Запрос на дублирование можно оформить 3 способами:

  • Указав список дат и времени для дублирования

  • Указав id стратегии повторения

  • Указав все параметры повторения

Authorizations:
(beareruser)
path Parameters
company_id
required
number
Example: 1
activity_id
required
number
Example: 2
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
object

Responses

Request samples

Content type
application/json
{ }

Response samples

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

Расписание работы сотрудника

график работы сотрудника

Расписание сотрудника передается в виде массива объектов, каждый из которых имеет следующие поля:

Поле Тип Описание
date string Дата, на которую необходимо установить расписание
is_working boolean true, если сотрудник работает в этот день. false, если не работает и существующие расписание нужно удалить
slots array Массив содержащий промежутки рабочего времени сотрудника. (Может быть пустым если is_working = false)

Массив slots состоит из объектов, содержащих следующие поля:

Поле Тип Описание
from string Время начала рабочего промежутка сотрудника. Например "11:00" или "10:30"
to string Время окончания рабочего промежутка сотрудника. Например "18:00" или "19:45"

Получить расписание сотрудника

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

staff_id
required
number

ID сотрудника.

start_date
required
date
Example: 2023-01-01

Дата начала периода

end_date
required
date
Example: 2023-03-01

Дата окончания периода

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
date
required
string

дата в формате iso8601.

is_working
required
boolean

Свободно время или нет.

slots
Array of objects

Массив (from, to) промежутков рабочего времени.

Response samples

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

Изменить расписание работы сотрудника

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

staff_id
required
number

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: */*
date
required
string

Дата

is_working
required
boolean

Рабочая дата или нет

slots
required
object

Массив (from, to) промежутков рабочего времени

Responses

Даты для журнала

Для выбора дат в журнале записи

Получить список дат для журнала

Даты для журнала представляют из себя массив с датами. (например ["2015-10-26", "2015-10-30"]).Для получения дат нужно передать дату, относительно которой будут получен список рабочих дат салона/сотрудника.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

date
required
string

дата в формате iso8601. Фильтр по дате бронирования (например '2015-09-30')

query Parameters
staff_id
number

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

Responses

Response samples

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

Сеансы для журнала

Для выбора сеансов в журнале записи

Получить список сеансов для журнала

Объект сеансы для журнала имеет следующие поля:

Поле Тип Описание
time string Время сеанса (17:30 например)
free boolean Свободно время или занято
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

date
required
string

дата в формате iso8601. Фильтр по дате бронирования (например '2015-09-30')

staff_id
required
number

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

Responses

Response Schema: application/json
time
required
string

Время сеанса

is_free
required
boolean

Свободно время или нет

Response samples

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

Комментарии

Комментарии пользователей к компаниии и сотрудникам

Получить комментарии

Объект комментарии имеет следующие поля:

Поле Тип Описание
id number Id комментария
salon_id number Id компании
type number 1 - комментарий к мастеру, 0 - к салону
master_id number ID мастера, если type = 1
text string Текст комментария
date string Дата, когда был оставлен комментарий
rating number Оценка ( от 1 до 5)
user_id number Id пользователя, оставившего комментарий
user_name string Имя пользователя, оставившего комментарий
user_avatar string Аватар пользователя, оставившего комментарий
record_id number Идентификатор записи, после которой оставили отзыв (значение будет ненулевым, если отзыв оставлен по ссылке с просьбой оставить отзыв после визита)
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
start_date
string

дата в формате iso8601. Фильтр по дате с (например '2015-09-30')

end_date
string

дата в формате iso8601. Фильтр по дате по (например '2015-09-30')

staff_id
number

ID сотрудника

rating
number

Оценка в рейтинге. Фильтр по отзывам с конкретной оценкой.

page
number

Номер страницы

count
number

Количество отзывов на странице

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Оставить комментарии

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

staff_id
required
number

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
mark
required
number

Оценка от 1 до 5

text
required
string

Текст отзыва

name
required
string

Имя пользователя, которое будет отображено на странице с отзывами

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "mark": "4",
  • "text": "Все очень плохо!",
  • "name": "Виктор"
}

Response samples

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

Пользователи компании

Пользователи, имеющие доступ к управлению определенной компанией

Устаревшее. Получить пользователей компании Deprecated

Объект пользователь компании имеет следующие поля:

Поле Тип Описание
id number Id пользователя
firstname string Имя пользователя
login string login пользователя для авторизации в системе (для авторизации так же можно в качестве логина поля phone и email)
email string Почтовый адрес пользователя
phone string Телефон пользоватя
information string Информация о пользователе
access object Объект прав доступа пользоватей к модулям системы

Объект access имеет следующие поля:

Поле Тип Описание
timetable_access boolean true - есть доступ к журналу записи, false - нет доступа
master_id number 0 - если пользователь может просматривать расписание и записи всех сотрудников, иначе только того сотрудника, ID которого задан
position_id number 0 - если пользователь может просматривать расписание и записи всех сотрудников, иначе только ту должность, ID которого задан
last_days_count number 0 - не ограничить доступ к истории расписаний и записям
schedule_edit_access boolean true - есть доступ к графику работы сотрудника в журнале, false - нет доступа
timetable_phones_access boolean true - есть доступ к номеру телефона в журнале записи, false - нет доступа
timetable_transferring_record_access boolean true - есть доступ к переносу записей, false - нет доступа
timetable_statistics_access boolean true - есть доступ к просмотру статистики, false - нет доступа
record_form_access boolean true - есть доступ к окну записи, false - нет доступа
record_form_client_access boolean true - есть доступ к данным клиентов, false - нет доступа
records_autocomplete_access boolean true - есть доступ к выпадающему списку с данными о клиентах, false - нет доступа
create_records_access boolean true - есть доступ к созданию записей, false - нет доступа Создавать записи
edit_records_access boolean true - есть доступ к изменение записей, false - нет доступа
edit_records_attendance_access boolean true - есть доступ к записям со статусом визита "клиент пришел", false - нет доступа
records_services_cost_access boolean true - есть доступ к изменению стоимости услуг, false - нет доступа
records_services_discount_access boolean true - есть доступ к изменению скидки на услуги, false - нет доступа
record_edit_full_paid_access boolean true - есть доступ к редактированию оплаченной записи, false - нет доступа
delete_records_access boolean true - есть доступ к удалению записи, false - нет доступа
delete_customer_came_records_access boolean true - есть доступ к удалению записей со статусом "клиент пришел", false - нет доступа
delete_paid_records_access boolean true - есть доступ к удалению оплаченных записей, false - нет доступа
records_goods_access boolean true - есть доступ к продажам товаров, false - нет доступа
records_goods_create_transaction_access boolean true - есть доступ к созданию товарных транзакций, false - нет доступа
records_goods_create_last_days_count number -1 - есть доступ к созданию товарных транзакций за все время, >= 0 - доступ к созданию товарных транзакций за указанное количество дней прошлое
records_goods_edit_transaction_access boolean true - есть доступ к редактированию товарных транзакций, false - нет доступа
records_goods_edit_last_days_count number -1 - есть доступ к редактированию товарных транзакций за все время, >= 0 - доступ к редактированию товарных транзакций за указанное количество дней прошлое
records_goods_cost_access boolean true - есть доступ к изменению стоимость товаров, false - нет доступа
records_goods_discount_access boolean true - есть доступ к изменению скидки на товары, false - нет доступа
records_finances_access boolean true - есть доступ к оплате, false - нет доступа
records_finances_last_days_count number -1 - есть доступ к проведению оплаты в записях за все время, >= 0 - доступ к проведению оплаты в записях за указанное количество дней прошлое
records_finances_pay_from_deposits_access boolean true - есть доступ к проведению оплаты в записях с личного счета клиента, false - нет доступа
records_group_id_access boolean true - есть доступ к данным клиентов по сети, false - нет доступа
records_group_id number ID сети к которой есть доступ к данным клиентов
finances_access boolean true - есть доступ к финансам, false - нет доступа
finances_accounts_ids array массив ID к выбранным кассам
finances_transactions_access boolean true - есть доступ к просмотру движений средств, false - нет доступа
finances_last_days_count number -1 - есть доступ к просмотру движений средств за все время, >= 0 - доступ к просмотру движений средств за указанное количество дней прошлое
finances_create_transactions_access boolean true - есть доступ к созданию транзакций, false - нет доступа
finances_create_last_days_count number -1 - есть доступ к созданию транзакций за все время, >= 0 - доступ к созданию транзакций за указанное количество дней прошлое
finances_edit_transactions_access boolean true - есть доступ к редактированию транзакций, false - нет доступа
finances_edit_last_days_count number -1 - есть доступ к редактированию транзакций за все время, >= 0 - доступ к редактированию транзакций за указанное количество дней прошлое
finances_delete_transactions_access boolean true - есть доступ к удалению транзакций, false - нет доступа
finances_transactions_excel_access boolean true - есть доступ к выгрузке движений средств в Excel, false - нет доступа
finances_expenses_ids array true - есть доступ к переводам между кассами, false - нет доступа
finances_accounts_access boolean true - есть доступ к счетам и кассам, false - нет доступа
finances_accounts_banalce_access boolean true - есть доступ к балансу, false - нет доступа
finances_suppliers_read_access boolean true - есть доступ к контрагентам, false - нет доступа
finances_suppliers_create_access boolean true - есть доступ к созданию контрагентов, false - нет доступа
finances_suppliers_update_access boolean true - есть доступ к изменению контрагентов, false - нет доступа
finances_suppliers_delete_access boolean true - есть доступ к удалению контрагентов, false - нет доступа
finances_suppliers_excel_access boolean true - есть доступ к выгрузке в Excel, false - нет доступа
finances_expenses_read_access boolean true - есть доступ к статье платежей, false - нет доступа
expenses_read_access boolean true - есть доступ к статье платежей, false - нет доступа
finances_expenses_create_access boolean true - есть доступ к созданию статьи платежа, false - нет доступа
expenses_create_access boolean true - есть доступ к созданию статьи платежа, false - нет доступа
finances_expenses_update_access boolean true - есть доступ к изменению статьи платежа, false - нет доступа
expenses_update_access boolean true - есть доступ к изменению статьи платежа, false - нет доступа
finances_expenses_delete_access boolean true - есть доступ к удалению статьи платежа, false - нет доступа
expenses_delete_access boolean true - есть доступ к удалению статьи платежа, false - нет доступа
finances_kkm_transactions_access boolean true - есть доступ к операциям с KKM, false - нет доступа
kkm_transactions_accounts_access boolean true - есть доступ к операциям с KKM, false - нет доступа
finances_kkm_settings_read_access boolean true - есть доступ к настройкам KKM, false - нет доступа
kkm_settings_reed_access boolean true - есть доступ к настройкам KKM, false - нет доступа
finances_kkm_settings_update_access boolean true - есть доступ к изменению KKM, false - нет доступа
kkm_settings_update_access boolean true - есть доступ к изменению KKM, false - нет доступа
finances_settings_invoicing_read_access boolean true - есть доступ к онлайн-оплатам, false - нет доступа
finances_settings_invoicing_update_access boolean true - есть доступ к изменению онлайн-оплат, false - нет доступа
settings_invoicing_update_access boolean true - есть доступ к изменению онлайн-оплат, false - нет доступа
finances_options_read_access boolean true - есть доступ к настройкам оплаты, false - нет доступа
finances_options_update_access boolean true - есть доступ к изменению настроек оплаты, false - нет доступа
options_update_access boolean true - есть доступ к изменению настроек оплаты, false - нет доступа
finances_salary_schemes_access boolean true - есть доступ к схемам расчета заработной платы, false - нет доступа
finances_salary_calc_access boolean true - есть доступ к расчету заработной платы, false - нет доступа
finances_salary_not_limitation_today_access boolean true - есть доступ к расчету заработной платы, false - доступ к расчету заработной платы за текущий день
finances_payroll_calculation_create_access boolean true - есть доступ к начислению заработной платы, false - нет доступа
finances_payroll_calculation_create_not_limitation_today_access boolean true - есть доступ к начислению заработной платы, false - доступ к начислению заработной платы за текущий день
finances_salary_access_master_checkbox boolean true - есть доступ к расчету заработной платы только конкретного сотрудника, false - полный доступ
finances_salary_access_master_id number ID сотрудника к которому есть доступ на расчет заработной платы
get_salary_access_master_id number ID сотрудника к которому есть доступ на расчет заработной платы
finances_salary_master_not_limitation_today_access boolean true - не ограничивать текущим днем, false - доступ только на сегодняшний день
finances_payroll_calculation_create_by_master_access boolean true - есть доступ к начислению заработной платы по конкретному сотруднику, false - без ограничений
calculation_create_by_master_not_limitation_today_access boolean true - есть доступ к начислению заработной платы, false - нет доступа
finances_period_report_access boolean true - есть доступ к отчету за период, false - нет доступа
finances_period_report_excel_access boolean true - есть доступ к выгрузке в Excel отчета за период, false - нет доступа
finances_year_report_access boolean true - есть доступ к годовому отчету, false - нет доступа
finances_year_report_excel_access boolean true - есть доступ к выгрузке в Excel годового отчета, false - нет доступа
finances_print_check_access boolean true - есть доступ к печати чека, false - нет доступа
finances_z_report_access boolean true - есть доступ к отчету по кассе за день, false - нет доступа
finances_z_report_no_limit_today_access boolean true - есть доступ к отчету по кассе, false - доступ к отчету по кассе за текущий день
finances_z_report_excel_access boolean true - есть доступ к выгрузке в Excel, false - нет доступа
clients_access boolean true - есть доступ к клиентской базе, false - нет доступа
clients_phones_email_access boolean true - есть доступ к номерам телефонов и email в списке клиентов, false - нет доступа
client_phones_access boolean true - есть доступ к номерам телефонов в списке клиентов, false - нет доступа
clients_card_phone_access boolean true - есть доступ к телефонам в карточке клиента, false - нет доступа
clients_delete_access boolean true - есть доступ к удалению клиентов, false - нет доступа
clients_excel_access boolean true - есть доступ к выгрузке списка клиентов в Excel, false - нет доступа
excel_access number 1 - есть доступ к выгрузке списка клиентов в Excel, 0 - нет доступа
client_comments_list_access boolean true - есть доступ к просмотру комментарии, false - нет доступа
client_comments_add_access boolean true - есть доступ к добавлению комментарии, false - нет доступа
client_comments_own_edit_access boolean true - есть доступ к изменению/удалению своих комментарии, false - нет доступа
client_comments_other_edit_access boolean true - есть доступ к изменению/удалению чужих комментарии, false - нет доступа
client_files_list_access boolean true - есть доступ к просмотрам и скачиванию файлов, false - нет доступа
client_files_upload_access boolean true - есть доступ к загрузке файлов, false - нет доступа
client_files_delete_access boolean true - есть доступ к удалению файлов, false - нет доступа
clients_visit_master_id number ID мастера по которому можно посмотреть клиентов посещавшие мастера, 0 - без ограничений
get_visit_master_id number ID мастера по которому можно посмотреть клиентов посещавшие мастера, 0 - без ограничений
dashboard_access boolean true - есть доступ к разделу обзор, false - нет доступа
dash_access boolean true - есть доступ к разделу сводка, false - нет доступа
dash_phones_access boolean true - есть доступ к показу номера телефонов в сводке, false - нет доступа
dash_records_access boolean true - есть доступ к просмотру списка записей, false - нет доступа
dash_records_last_days_count number -1 - есть доступ к просмотру списка записей за все время, >= 0 - доступ к просмотру списка записей за указанное количество дней прошлое
dash_records_excel_access boolean true - есть доступ к выгрузке списка записей в Excel, false - нет доступа
dash_records_phones_access boolean true - есть доступ к показу номера телефонов в записях, false - нет доступа
dash_message_access boolean true - есть доступ к просмотру детализаций сообщений, false - нет доступа
dash_message_excel_access boolean true - есть доступ к выгрузке детализаций сообщений в Excel, false - нет доступа
dash_message_phones_access boolean true - есть доступ к показу номера телефонов в сообщениях, false - нет доступа
dash_reviews_access boolean true - есть доступ к просмотру отзывов, false - нет доступа
dash_reviews_delete_access boolean true - есть доступ к удалению отзывов, false - нет доступа
dashboard_calls_access boolean true - есть доступ к разделу звонки, false - нет доступа
dashboard_calls_excel_access boolean true - есть доступ к выгрузке звонков Excel, false - нет доступа
dashboard_calls_phones_access boolean true - есть доступ к просмотру номера телефона у клиентов, false - нет доступа
notification boolean true - есть доступ к Уведомления, false - нет доступа
web_push boolean true - есть доступ к показу Push уведомлений о записях в Web-версии, false - нет доступа
web_phone_push boolean true - есть доступ к показу Push уведомлений о звонках в Web-версии, false - нет доступа
notification_sms_ending_license boolean true - есть доступ к отправки SMS уведомлений о скором окончании лицензии, false - нет доступа
notification_sms_low_balance boolean true - есть доступ к отправки SMS уведомлений о низком балансе, false - нет доступа
notification_email_ending_license boolean true - есть доступ к отправки Email уведомлений о скором окончании лицензии, false - нет доступа
loyalty_access boolean true - есть доступ к лояльности, false - нет доступа
has_loyalty_access boolean true - есть доступ к лояльности, false - нет доступа
loyalty_cards_manual_transactions_access boolean true - есть доступ к ручному пополнению/списанию с карт лояльности, false - нет доступа
has_loyalty_cards_manual_transactions_access boolean true - есть доступ к ручному пополнению/списанию с карт лояльности, false - нет доступа
loyalty_certificate_and_abonement_manual_transactions_access boolean true - есть доступ к оплате сертификатом и абонементом без кода, false - нет доступа
storages_access boolean true - есть доступ к складу, false - нет доступа
storages_ids boolean true - есть доступ к выбранным складам, false - нет доступа
storages_transactions_access boolean true - есть доступ к просмотру движений товаров, false - нет доступа
storages_last_days_count number -1 - есть доступ к просмотру движений товаров за все время, >= 0 - доступ к просмотру движений товаров за указанное количество дней прошлое
storages_move_goods_access boolean true - есть доступ к перемещение товаров между складами, false - нет доступа
storages_create_transactions_access boolean true - есть доступ к созданию товарных транзакций, false - нет доступа
storages_create_last_days_count number -1 - есть доступ к создание товарных транзакций за все время, >= 0 - доступ к создание товарных транзакций за указанное количество дней прошлое
storages_create_transactions_buy_access boolean true - есть доступ к оформлению прихода товаров, false - нет доступа
storages_create_transactions_sale_access boolean true - есть доступ к оформлению продаж товаров, false - нет доступа
storages_edit_transactions_access boolean true - есть доступ к редактированию товарных транзакций, false - нет доступа
storages_edit_last_days_count number -1 - есть доступ к редактированию товарных транзакций за все время, >= 0 - доступ к редактированию товарных транзакций за указанное количество дней прошлое
storages_edit_transactions_buy_access boolean true - есть доступ к оформлению прихода товаров, false - нет доступа
storages_edit_transactions_sale_access boolean true - есть доступ к оформлению продаж товаров, false - нет доступа
storages_delete_transactions_access boolean true - есть доступ к удалению товарных транзакций, false - нет доступа
storages_transactions_excel_access boolean true - есть доступ к выгрузке движений товаров в Excel, false - нет доступа
storages_transactions_types boolean true - есть доступ к выгрузке движений товаров в Excel, false - нет доступа
storages_inventory_access boolean true - есть доступ к инвентаризации, false - нет доступа
storages_inventory_create_edit_access boolean true - есть доступ к созданию и редактированию инвентаризации, false - нет доступа
storages_inventory_delete_access boolean true - есть доступ к удалению инвентаризации, false - нет доступа
storages_inventory_excel_access boolean true - есть доступ к выгрузке инвентаризации в Excel, false - нет доступа
storages_remnants_report_access boolean true - есть доступ к отчету остатков на складе, false - нет доступа
storages_remnants_report_excel_access boolean true - есть доступ к выгрузке остатков в Excel, false - нет доступа
storages_sales_report_access boolean true - есть доступ к отчету по продажам, false - нет доступа
storages_sales_report_excel_access boolean true - есть доступ к выгрузке отчета по продажам в Excel, false - нет доступа
storages_consumable_report_access boolean true - есть доступ к отчету по списанию расходников, false - нет доступа
storages_consumable_report_excel_access boolean true - есть доступ к выгрузке отчета по списанию расходников в Excel, false - нет доступа
storages_write_off_report_access boolean true - есть доступ к отчету по списанию товаров, false - нет доступа
storages_write_off_report_excel_access boolean true - есть доступ к выгрузке отчета по списанию товаров в Excel, false - нет доступа
storages_turnover_report_access boolean true - есть доступ к отчету по оборачиваемости, false - нет доступа
storages_turnover_report_excel_access boolean true - есть доступ к выгрузке отчета по оборачиваемости в Excel, false - нет доступа
storages_goods_crud_access boolean true - есть доступ к управлению товарами, false - нет доступа
storages_goods_create_access boolean true - есть доступ к созданию товаров, false - нет доступа
storages_goods_update_access boolean true - есть доступ к изменению товаров, false - нет доступа
storages_goods_title_edit_access boolean true - есть доступ к названию, Артикул, Штрих-код, false - нет доступа
storages_goods_category_edit_access boolean true - есть доступ к категориям, false - нет доступа
storages_goods_selling_price_edit_access boolean true - есть доступ к ценам продажи, false - нет доступа
storages_goods_cost_price_edit_access boolean true - есть доступ к себестоимости, false - нет доступа
storages_goods_units_edit_access boolean true - есть доступ к единицам измерения, false - нет доступа
storages_goods_critical_balance_edit_access boolean true - есть доступ к критичным остаткам, Желаемый остаток, false - нет доступа
storages_goods_masses_edit_access boolean true - есть доступ к массе, false - нет доступа
storages_goods_comment_edit_access boolean true - есть доступ к комментариям, false - нет доступа
storages_goods_archive_access boolean true - есть доступ к архивации и восстановлению товаров, false - нет доступа
storages_goods_delete_access boolean true - есть доступ к удалению товаров, false - нет доступа
settings_access boolean true - есть доступ к разделу настройки, false - нет доступа
settings_basis_access boolean true - есть доступ к разделу Основные, false - нет доступа
settings_information_access boolean true - есть доступ к разделу Информация, false - нет доступа
users_access boolean true - есть доступ к управлению пользователями, false - нет доступа
delete_users_access boolean true - есть доступ к удалению пользователей, false - нет доступа
create_users_access boolean true - есть доступ к добавлению пользователей, false - нет доступа
edit_users_access boolean true - есть доступ к управлению правами пользователей, false - нет доступа
limited_users_access boolean true - есть доступ к управлению правами в рамках своего набора прав, false - нет доступа
settings_services_access boolean true - есть доступ к разделу Услуги, false - нет доступа
settings_services_create_access boolean true - есть доступ к созданию услуг, false - нет доступа
services_edit boolean true - есть доступ к редактированию услуг, false - нет доступа
settings_services_edit_title_access boolean true - есть доступ к названиям услуг и название для онлайн-записи, false - нет доступа
settings_services_relation_category_access boolean true - есть доступ к категориям услуги, false - нет доступа
settings_services_edit_price_access boolean true - есть доступ к ценам услуг, false - нет доступа
settings_services_edit_image_access boolean true - есть доступ к загрузкам и изменениям изображений, false - нет доступа
settings_services_edit_online_seance_date_time_access boolean true - есть доступ к отображениям услуг в виджете, false - нет доступа
settings_services_edit_online_pay_access boolean true - есть доступ к онлайн-оплате услуги, false - нет доступа
settings_services_edit_services_related_resource_access boolean true - есть доступ к ресурсам услуги, false - нет доступа
settings_positions_read boolean true - есть доступ к разделу должности, false - нет доступа
settings_positions_create boolean true - есть доступ к созданию должностей, false - нет доступа
settings_positions_delete boolean true - есть доступ к удалению должностей, false - нет доступа
edit_master_service_and_duration boolean true - есть доступ к изменению услуги сотрудников и их длительность, false - нет доступа
tech_card_edit boolean true - есть доступ к изменению технологической карты, false - нет доступа
services_delete boolean true - есть доступ к удалению услуг, false - нет доступа
settings_master_access boolean true - есть доступ к разделу Сотрудники, false - нет доступа
master_create boolean true - есть доступ к созданию сотрудников, false - нет доступа
master_edit boolean true - есть доступ к редактированию сотрудников, false - нет доступа
master_delete boolean true - есть доступ к удалению сотрудников, false - нет доступа
settings_master_dismiss_access boolean true - есть доступ к увольнению сотрудников, false - нет доступа
schedule_edit boolean true - есть доступ к редактированию графика работы, false - нет доступа
settings_notifications_access boolean true - есть доступ к разделу Sms уведомления, false - нет доступа
settings_email_notifications_access boolean true - есть доступ к разделу Email уведомления, false - нет доступа
settings_template_notifications_access boolean true - есть доступ к разделу Типы уведомлений, false - нет доступа
webhook_read_access boolean true - есть доступ к изменению настроек WebHook, false - нет доступа
stat_access boolean true - есть доступ к аналитике, false - нет доступа
billing_access boolean true - есть доступ к биллингу (раздел меню баланс), false - нет доступа
send_sms boolean true - есть доступ к SMS рассылки клиентам, false - нет доступа
auth_enable_check_ip boolean true - есть доступ к филиалу только с IP-адресов (v4, v6), false - нет доступа
auth_list_allowed_ip array список IP адресов
Authorizations:
(beareruser)
path Parameters
company_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить пользователей компании

Метод позволяет получить пользователей компании.
Объект имеет следующие поля:

Поле Тип Описание
id number Id пользователя
name string Имя пользователя
phone string Телефон пользоватя
email string Почтовый адрес пользователя
information string Информация о пользователе
is_approved boolean Принял ли пользователь приглашение к управлению филиалом
is_non_deletable boolean Является ли пользователь неудаляемым
user_role_slug string Роль пользователя в филиале (доступно только для типа бизнеса "Красота")
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
filter[is_approved]
number
Example: filter[is_approved]=1

Принял ли пользователь приглашение к управлению филиалом. 1 - принял, 0 - не принял

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных пользователей)

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Удалить пользователя в компании

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

user_id
required
number

ID пользователя

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Кассы

Получить кассы компании

Объект кассы компании имеет следующие поля:

Поле Тип Описание
id number Id кассы
title string Название
type number 1 - для безналичных платежей, 0 для наличных
comment string Описание к кассе
Authorizations:
(beareruser)
path Parameters
company_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Склады

Получить склады компании

Объект склада компании имеет следующие поля:

Поле Тип Описание
id number ID склада
title string Название
for_services number 1 - если используется для автоматического списания расходников
for_sale number 1 - если склад по умолчанию для продажи товаров
comment string Описание к складу
Authorizations:
(beareruser)
path Parameters
company_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

SMS рассылка

Отправить SMS рассылку по списку клиентов

Объект для создания SMS рассылки имеет следующие поля:

Поле Тип Описание
client_ids array of number Массив ID клиентов
text string Текст SMS сообщения
Authorizations:
(beareruser)
path Parameters
company_id
required
number

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
client_ids
Array of numbers

Массив идентификаторов клиентов

text
string

Текст SMS сообщения

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

data
string

Имеет значение null

object

Объект, содержащий сообщение 201 статус-кода

Request samples

Content type
application/json
{
  • "client_ids": [
    ],
  • "text": "Уважаемые клиенты, поздравляем Вас с тем, что вы наши клиенты! Вам очень повезло!"
}

Response samples

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

Отправить SMS рассылку по клиентам, подходящим под фильтры

Объект для создания SMS рассылки имеет следующие поля:

Поле Тип Описание
text string Текст SMS сообщения

Фильтрация клиентов

  • fullname:'Joh' (optional, string) - Имя (часть имени) для фильтрации клиентов
  • phone:'7916' (optional, string) - Телефон (часть номера) для фильтрации клиентов
  • email:'test@' (optional, string) - Email (часть) для фильтрации клиентов
  • card:'5663rt' (optional, string) - Card (часть) для фильтрации клиентов по номеру карты лояльности

Внимание: При отсутствии фильтров SMS рассылка уйдет по всей базе!

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
fullname
string
Example: fullname='Joh'

Имя (часть имени) для фильтрации клиентов

phone
string
Example: phone='7916'

Телефон (часть номера) для фильтрации клиентов

email
string
Example: email='test@'

Email (часть) для фильтрации клиентов

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
text
string

Текст SMS сообщения

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

data
string

Имеет значение null

object

Объект, содержащий сообщение 201 статус-кода

Request samples

Content type
application/json
{
  • "text": "Уважаемые клиенты, поздравляем Вас с тем, что вы наши клиенты! Вам очень повезло!"
}

Response samples

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

Email рассылка

Отправить Email рассылку по списку клиентов

Объект для создания Email рассылки имеет следующие поля:

Поле Тип Описание
client_ids array of number Массив ID клиентов
text string Текст Email сообщения
subject string Тема Email сообщения
Authorizations:
(beareruser)
path Parameters
company_id
required
number

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
client_ids
required
Array of numbers

Массив идентификаторов клиентов

subject
required
string

Тема Email сообщения

text
required
string

Текст Email сообщения

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

data
string

Имеет значение null

object

Объект, содержащий сообщение 201 статус-кода

Request samples

Content type
application/json
{
  • "client_ids": [
    ],
  • "subject": "Важно!",
  • "text": "Уважаемые клиенты, поздравляем Вас с тем, что вы наши клиенты! Вам очень повезло!"
}

Response samples

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

Отправить Email рассылку по клиентам, подходящим под фильтры

Объект для создания Email рассылки имеет следующие поля:

Поле Тип Описание
text string Текст Email сообщения
subject string Тема Email сообщения

Фильтрация клиентов

  • fullname:'Joh' (optional, string) - Имя (часть имени) для фильтрации клиентов
  • phone:'7916' (optional, string) - Телефон (часть номера) для фильтрации клиентов
  • email:'test@' (optional, string) - Email (часть) для фильтрации клиентов
  • card:'5663rt' (optional, string) - Card (часть) для фильтрации клиентов по номеру карты лояльности

Внимание: При отсутствии фильтров Email рассылка уйдет по всей базе!

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
fullname
string
Example: fullname='Joh'

Имя (часть имени) для фильтрации клиентов

phone
string
Example: phone='7916'

Телефон (часть номера) для фильтрации клиентов

email
string
Example: email='test@'

Email (часть) для фильтрации клиентов

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
subject
required
string

Тема Email сообщения

text
required
string

Текст Email сообщения

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

data
string

Имеет значение null

object

Объект, содержащий сообщение 201 статус-кода

Request samples

Content type
application/json
{
  • "subject": "Важно!",
  • "text": "Уважаемые клиенты, поздравляем Вас с тем, что вы наши клиенты! Вам очень повезло!"
}

Response samples

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

ККМ транзакции

Получить транзакции

Фильтры

Параметр Описание
page Номер страницы
editable_length Количество клиентов на странице
type Тип операции
status Статус операции
start_date Дата начала периода
end_date Дата окончания периода

Типы всех операций c ККМ

Значение Описание
0 Операция продажи (активна для документа с типом "Визит")
1 Операция возврата продажи (активна для документа с типом "Визит")
2 Операция коррекции
4 Операция открытия смены
5 Операция закрытия смены
9 Операция получения статуса ККМ
11 Операция получения статуса команды ККМ
12 Операция коррекции
13 Печать X-отчёта
6 Внесение наличных
7 Изъятие наличных

Статусы всех операций с ККМ

Значение Описание
0 Ошибка соединения с KKM
1 Успешно
2 Отправлен на печать
3 Ошибка выполнения
4 Ошибка проверки статуса
5 Ожидание готовности KKM

Типы документов

Значение Описание
1 Продажа товара
2 Оказание услуг
3 Приход товара
4 Списание товара
5 Движение товара
6 Инвентаризация
7 Визит
8 Списание расходников
9 Пополнение депозита
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
page
number
Example: page=1

Номер страницы

editable_length
number
Example: editable_length=25

Количество клиентов на странице

type
number
Example: type=20

Тип операции

status
number
Example: status=6

Статус операции

start_date
number
Example: start_date=''

Дата начала периода

end_date
number
Example: end_date=''

Дата окончания периода

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer access_token, User user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных транзакций)

Response samples

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

Напечатать чек

Типы всех операций c ККМ

Значение Описание
0 Операция продажи (активна для документов с типами "Визит" и "Пополнение депозита")
1 Операция возврата продажи (активна для документов с типами "Визит" и "Пополнение депозита")
2 Операция коррекции
4 Операция открытия смены
5 Операция закрытия смены
9 Операция получения статуса ККМ
11 Операция получения статуса команды ККМ
12 Операция коррекции
13 Печать X-отчёта
6 Внесение наличных
7 Изъятие наличных

Типы документов

Значение Описание
1 Продажа товара
2 Оказание услуг
3 Приход товара
4 Списание товара
5 Движение товара
6 Инвентаризация
7 Визит
8 Списание расходников
9 Пополнение депозита
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

Request Body schema: */*
document_id
required
number

ID документа

type
required
number

тип операции с ККМ (см. таблицу типов всех операций)

is_pos_enabled
boolean

задействовать POS-терминал (по умолчанию false)

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Операция продажи

Объект операции продажи имеет следующую структуру:

Поле Тип Описание
state state Состояние продажи
kkm_state kkm_state Состояние ККМ
payment_methods payment_method[] Доступные методы оплаты

Тип state имеет следующие поля:

Поле Тип Описание
items sale_item[] Продаваемая единица
loyalty_transactions loyalty_transaction[] Транзакция оплаты с помощью лояльности
payment_transactions payment_transaction[] Транзакция оплаты в кассу

Тип kkm_state имеет следующие поля:

Поле Тип Описание
last_operation_type integer Тип последней операции ККМ
transactions kkm_transaction[] Транзакция ККМ

Тип payment_method имеет следующие поля:

Поле Тип Описание
slug slug(string) Тип метода оплаты
is_applicable boolean Возможно ли применить данный метод
applicable_amount float Возможная сумма, приминимая к оплате
applicable_count int Возможное количество посещений (в случае абонемента)
applicable_value float Применимый бонус (в случае программ лояльности)
account_id integer(optional) ID кассы (зависит от slug)
deposit_id integer(optional) ID депозитного счета (зависит от slug)
loyalty_card_id integer(optional) ID карты лояльности (зависит от slug)
loyalty_program_id integer(optional) ID программы лояльности (зависит от slug)
loyalty_certificate_id integer(optional) ID сертификата (зависит от slug)
loyalty_abonement_id integer(optional) ID абонемента (зависит от slug)
account account(optional) Связанная сущность (зависит от slug)
deposit object(optional) Связанная сущность (зависит от slug)
loyalty_card object(optional) Связанная сущность (зависит от slug)
loyalty_program object(optional) Связанная сущность (зависит от slug)
loyalty_certificate object(optional) Связанная сущность (зависит от slug)
loyalty_abonement object(optional) Связанная сущность (зависит от slug)

Все типы методов оплаты делятся на две группы:

1 - Оплата в кассу:

Значение Описание
account Оплата в кассу

2 - Оплата лояльностью:

Значение Описание
deposit Списание с личного счета
loyalty_program Использование программы лояльности
loyalty_card Списание с карты лояльности
loyalty_certificate Списание с сертификата
loyalty_abonement Использование абонемента (применяется только к визиту)
referral_loyalty_program Использование реферальной программы (применяется только к визиту)

Тип sale_item имеет следующие поля:

Поле Тип Описание
id integer ID продаваемой единицы
type string Тип ("service"/"good")
title string Название
amount integer Количество
default_cost_per_unit float Цена за единицу по умолчанию
default_cost_total float Общая цена по умолчанию
cost_to_pay_total float Цена к оплате
client_discount_percent float Процент скидки

Получение Операции продажи

Authorizations:
(beareruser)
path Parameters
document_id
required
integer

ID документа продажи

company_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Удаление транзакции оплаты в кассу

В качестве ответа возвращается информация об Операции продажи

Authorizations:
(beareruser)
path Parameters
document_id
required
integer

ID документа продажи

payment_transaction_id
required
integer

ID транзакции

company_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Удаление транзакции оплаты лояльностью

В качестве ответа возвращается информация об Операции продажи

Authorizations:
(beareruser)
path Parameters
document_id
required
integer

ID документа продажи

payment_transaction_id
required
integer

ID транзакции

company_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Оплата в кассу и лояльностью (различными методами)

В качестве ответа возвращается информация об Операции продажи

Authorizations:
(beareruser)
path Parameters
document_id
required
number

Идентификатор документа

company_id
required
number

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
  1. В случае оплаты сертификатом, если у пользователя нет права "Оплата сертификатом и абонементом без кода" в теле запроса также необходимо передать пераметр "number" (string), содержащий код сертификата.
  2. В случае оплаты абонементом, если у пользователя нет права "Оплата сертификатом и абонементом без кода" в теле запроса также необходимо передать пераметр "number" (string), содержащий код абонемента.
Any of
object

Объект, содержащий метод оплаты

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
Example
{
  • "payment": {
    }
}

Response samples

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

Финансовые транзакции

Объект транзакции имеет следующие поля:

Поле Тип Описание
id number ID транзакции
document_id number ID документа
expense expense Тип платежа
date string Дата создания транзакции
amount float Сумма транзакции
comment string Комментарий
master master Сотрудник
supplier supplier Контрагент
account account Касса
client client Клиент

Объекты expense, master, account, supplier имеют следующие поля:

Поле Тип Описание
id number ID
title string Описание

Объект client имеет следующие поля:

Поле Тип Описание
id number ID
name string Имя
phone string Номер телефона

Получить транзакции

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
page
number
Example: page=1

Номер страницы

count
number
Example: count=50

Количество клиентов на странице

account_id
number
Example: account_id=0

ID кассы

supplier_id
number
Example: supplier_id=0

ID контрагента

client_id
number
Example: client_id=0

ID клиента

user_id
number
Example: user_id=0

ID пользователя

master_id
number
Example: master_id=0

ID сотрудника

type
number
Example: type=0

тип транзакции

real_money
number
Example: real_money=0

транзакция реальными деньгами

deleted
number
Example: deleted=0

была ли удалена транзакция

start_date
number
Example: start_date=2023-01-01

дата начала периода

end_date
number
Example: end_date=2023-03-01

дата окончания периода

balance_is
number
Example: balance_is=0

0 - любой баланс, 1 - положительный, 2 - оттрицательный

document_id
number
Example: document_id=0

идентификатор документа

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получение транзакций по ID визита или записи

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
record_id
number
Example: record_id=0

ID записи

visit_id
number
Example: visit_id=0

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Создание финансовой транзакции

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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
expense_id
number

Статья платежа

amount
number <float>

Сумма транзакции

account_id
number

Идентификатор кассы

client_id
number

Идентификатор клиента

supplier_id
number

Идентификатор контрагента

master_id
number

Идентификатор сотрудника

comment
number

Комментарий

date
string <date-time>

Дата создания транзакции

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

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": "2023-01-01 10:00:00"
}

Response samples

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

Получение финансовой транзакции

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

transaction_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Обновление финансовой транзакции

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

transaction_id
required
number

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: */*
expense_id
number

Статья платежа

amount
number <float>

Сумма транзакции

account_id
number

Идентификатор кассы

client_id
number

Идентификатор клиента

supplier_id
number

Идентификатор контрагента

master_id
number

Идентификатор сотрудника

comment
number

Комментарий

date
string <date-time>

Дата создания транзакции

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Удаление транзакции

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

transaction_id
required
number

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

Responses

Интеграция с сетевой телефонией

События телефонии

Подключить интеграцию

Для использования api и активации доступа к настройкам в пользовательском интерфейсе необходимо активировать интеграцию, отправив запрос "Подключить интеграцию". После успешного подключения, в сетевом интерфейсе пользователя будет открыт доступ в раздел с настройками маршрутизации.

Отключить интеграция

Для отключения интеграции можно воспользоваться методом "Отключить интеграцию". После отключения интеграции закрывается доступ в раздел настроек пользовательского интерфейса, обработка запросов "Уведомление о звонке" и "Сохранение информации о звонке" не производится.

Уведомление о звонке

Для отображения уведомлений о входящем звонке используется метод "Уведомление о звонке", в параметрах указыватеся тип звонка ("incoming", "outgoing", "internal"), но на текущий момент уведомления отображаются только для значения "incoming". Уведомления отображаются для пользователей, определенных на основе настроек маршрутизации. При одновременном указании параметров "user" и "diversion" приоритетным при поиске маршрутов является "user".

Сохранение информации о звонке

Сохранение информации о звонке автоматически происходит в сетевую историю и в историю компаний сети в соответствии с настройками маршрутизации звонка.

Authorizations:
bearer
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

Request Body schema: application/json

Тела запросов

Any of
command
required
string

Slug операции 'setup'

type
required
string

Тип операции, в данном случае 'enable'

crm_token
required
string

CRM-токен из раздела Телефония-Интеграция в сети клиента

Responses

Response Schema: application/json
success
boolean

Статус успшности выполнения (true)

data
string

Содержит null

object

Метаданные (содержить сообщение "Accepted")

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": {
    }
}

Получить список звонков филиала

Данный эндпойнт предназначен для получения списка звонков в филиале с учетом фильтров и с пагинацией

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

Идентификатор салона.

date_from
required
string

Дата начала выборки.

date_to
required
string

Дата окончания выборки.

phone
string

Номер телефона.

types
Array of strings
Items Enum: "incoming" "outgoing" "internal"

Набор типов звонка

statuses
Array of strings
Items Enum: "success" "missed" "cancel" "busy" "notallowed" "notavailable" "notfound"

Набор статусов

page
number

Номер страницы

limit
number <= 1000

Количество элементов на странице

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects

Список звонков

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

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": [
    ]
}

Лояльность

Сгенерированный объект кода имеет следующие поля:

Поле Тип Описание
code string Сгенерированный код

Получить список шаблонов уведомлений лояльности

Authorizations:
(beareruser)
path Parameters
chain_id
required
integer

Идентификатор сети

header Parameters
Accept
required
string

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
Array
id
integer <int32>

Идентификатор шаблона

type
string
Enum: "big" "mid" "small" "custom"

Вариант шаблона

body
string

Текст шаблона

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"

Тип сообщения

Response samples

Content type
application/json
[
  • {
    }
]

Создать акцию в сети

Authorizations:
(beareruser)
path Parameters
chain_id
required
integer

Идентификатор сети

query Parameters
include
string
Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template"

Включить в ответ дополнительные ресурсы

header Parameters
Accept
required
string

application/vnd.yclients.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

Название акции

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"

Тип акции

service_item_type
required
string
Enum: "any_allowed" "not_allowed" "custom_allowed"

Тип применения к услугам

good_item_type
required
string
Enum: "any_allowed" "not_allowed" "custom_allowed"

Тип применения к товарам

value_unit
required
string
Enum: "percent" "amount"

Единица измерения бонуса или скидки (процент, фиксированная сумма)

usage_limit
integer <int32>

Ограничение по количеству применений (только для кэшбека)

visit_multiplicity
integer <int32>

Кратность применения по визитам (только для кэшбека)

sold_items_multiplicity
integer <int32>

Сколько услуг нужно оплатить, чтобы получить скидку на акционные услуги (только для типа акции "Скидка по условию")

expiration_timeout
integer <int32>

Срок сгорания бонусов или скидки

expiration_timeout_unit
string
Enum: "day" "week" "month" "year"

Единица измерения срока сгорания бонусов или скидки

expiration_notification_timeout
integer <int32>

За сколько дней до наступления срока сгорания бонуса или скидки необходимо отправить клиенту уведомление

params_source_type
string
Enum: "loyalty_card" "active_companies" "chain"

Откуда брать историю клиента для расчета размера бонуса или скидки (для накпоительных акций или скидки по условию)

history_start_date
string <date>

С какой даты учитывать историю клиента для расчета размера бонуса или скидки (для накопительных акций или скидки по условию)

loyalty_card_type_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы типов карт, для которых действует акция

object (Root Type for LoyaltyNotificationMessageTemplateRequest)

Тело запроса на привязку шаблона уведомления лояльности

object (Root Type for LoyaltyNotificationMessageTemplateRequest)

Тело запроса на привязку шаблона уведомления лояльности

required
Array of objects (Root Type for LoyaltyProgramRuleRequest)

Правила для определения значения бонуса или скидки (допустимо только одно правило для фиксированных акций)

company_ids
required
Array of integers <int32> [ items <int32 > ]

Идентификаторы филиалов, в которых действует акция

allowed_service_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы услуг и категорий услуг (если задан тип применения для некоторых услуг)

allowed_good_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы товаров (если задан тип применения для некоторых товаров)

allowed_good_category_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы категорий товаров (если задан тип применения для некоторых товаров)

Responses

Response Schema: application/json
id
integer <int32>

Идетификатор акции

title
string

Название акции

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"

Тип акции

service_item_type
string
Enum: "any_allowed" "not_allowed" "custom_allowed"

Тип применения к услугам

good_item_type
string
Enum: "any_allowed" "not_allowed" "custom_allowed"

Тип применения к товарам

value_unit
string
Enum: "percent" "amount"

Единица измерения бонуса или скидки (процент, фиксированная сумма)

usage_limit
integer <int32>

Ограничение по количеству применений (только для кэшбека)

visit_multiplicity
integer <int32>

Кратность применения по визитам (только для кэшбека)

sold_items_multiplicity
integer <int32>

Сколько услуг нужно оплатить, чтобы получить скидку на акционные услуги (только для типа акции "Скидка по условию")

expiration_timeout
integer <int32>

Срок сгорания бонусов или скидки

expiration_timeout_unit
string
Enum: "day" "week" "month" "year"

Единица измерения срока сгорания бонусов или скидки

expiration_notification_timeout
integer <int32>

За сколько дней до наступления срока сгорания бонуса или скидки необходимо отправить клиенту уведомление

params_source_type
string
Enum: "loyalty_card" "active_companies" "chain"

Откуда брать историю клиента для расчета размера бонуса или скидки (для накпоительных акций или скидки по условию)

history_start_date
string <date>

С какой даты учитывать историю клиента для расчета размера бонуса или скидки (для накопительных акций или скидки по условию)

on_changed_notification_template_id
integer <int32>

Идентификатор шаблона уведомления при изменении бонуса или скидки

on_expiration_notification_template_id
integer <int32>

Идентификатор шаблона уведомления при сгорании бонуса или скидки

Array of objects (Root Type for LoyaltyCardType)

Тип карт, для которых действует акция (по запросу)

object (Root Type for LoyaltyNotificationMessageTemplate)

Шаблон уведомлений лояльности

object (Root Type for LoyaltyNotificationMessageTemplate)

Шаблон уведомлений лояльности

Array of objects (Root Type for LoyaltyProgramRule)

Правила для определения значения бонуса или скидки (допустимо только одно правило для фиксированных акций) (по запросу)

Array of objects (Company)

Филиалы, в которых действует акция (по запросу)

Array of objects (Root Type for LoyaltyEntityAttendanceItem)

Связанные сущности для выборочного применения акции (по запросу)

Request samples

Content type
application/json
{
  • "title": "Накопительная скидка для некоторых услуг и не для товаров",
  • "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": "Накопительная скидка для некоторых услуг и не для товаров",
  • "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": [
    ]
}

Получить акцию в сети

Authorizations:
(beareruser)
path Parameters
chain_id
required
integer

Идентификатор сети

loyalty_program_id
required
integer

Идентификатор акции

query Parameters
include
string
Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template"

Включить в ответ дополнительные ресурсы

header Parameters
Accept
required
string

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
id
integer <int32>

Идетификатор акции

title
string

Название акции

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"

Тип акции

service_item_type
string
Enum: "any_allowed" "not_allowed" "custom_allowed"

Тип применения к услугам

good_item_type
string
Enum: "any_allowed" "not_allowed" "custom_allowed"

Тип применения к товарам

value_unit
string
Enum: "percent" "amount"

Единица измерения бонуса или скидки (процент, фиксированная сумма)

usage_limit
integer <int32>

Ограничение по количеству применений (только для кэшбека)

visit_multiplicity
integer <int32>

Кратность применения по визитам (только для кэшбека)

sold_items_multiplicity
integer <int32>

Сколько услуг нужно оплатить, чтобы получить скидку на акционные услуги (только для типа акции "Скидка по условию")

expiration_timeout
integer <int32>

Срок сгорания бонусов или скидки

expiration_timeout_unit
string
Enum: "day" "week" "month" "year"

Единица измерения срока сгорания бонусов или скидки

expiration_notification_timeout
integer <int32>

За сколько дней до наступления срока сгорания бонуса или скидки необходимо отправить клиенту уведомление

params_source_type
string
Enum: "loyalty_card" "active_companies" "chain"

Откуда брать историю клиента для расчета размера бонуса или скидки (для накпоительных акций или скидки по условию)

history_start_date
string <date>

С какой даты учитывать историю клиента для расчета размера бонуса или скидки (для накопительных акций или скидки по условию)

on_changed_notification_template_id
integer <int32>

Идентификатор шаблона уведомления при изменении бонуса или скидки

on_expiration_notification_template_id
integer <int32>

Идентификатор шаблона уведомления при сгорании бонуса или скидки

Array of objects (Root Type for LoyaltyCardType)

Тип карт, для которых действует акция (по запросу)

object (Root Type for LoyaltyNotificationMessageTemplate)

Шаблон уведомлений лояльности

object (Root Type for LoyaltyNotificationMessageTemplate)

Шаблон уведомлений лояльности

Array of objects (Root Type for LoyaltyProgramRule)

Правила для определения значения бонуса или скидки (допустимо только одно правило для фиксированных акций) (по запросу)

Array of objects (Company)

Филиалы, в которых действует акция (по запросу)

Array of objects (Root Type for LoyaltyEntityAttendanceItem)

Связанные сущности для выборочного применения акции (по запросу)

Response samples

Content type
application/json
{
  • "id": 34,
  • "title": "Накопительная скидка для некоторых услуг и не для товаров",
  • "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": [
    ]
}

Изменить акцию в сети

Authorizations:
bearer
path Parameters
chain_id
required
integer

Идентификатор сети

loyalty_program_id
required
integer

Идентификатор акции

query Parameters
include
string
Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template"

Включить в ответ дополнительные ресурсы

Request Body schema: application/json
title
string

Название акции

usage_limit
integer <int32>

Ограничение по количеству применений (только для кэшбека)

expiration_timeout
integer <int32>

Срок сгорания бонусов или скидки

expiration_timeout_unit
string
Enum: "day" "week" "month" "year"

Единица измерения срока сгорания бонусов или скидки

expiration_notification_timeout
integer <int32>

За сколько дней до наступления срока сгорания бонуса или скидки необходимо отправить клиенту уведомление

loyalty_card_type_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы типов карт, для которых действует акция

object (Root Type for LoyaltyNotificationMessageTemplateRequest)

Тело запроса на привязку шаблона уведомления лояльности

object (Root Type for LoyaltyNotificationMessageTemplateRequest)

Тело запроса на привязку шаблона уведомления лояльности

Array of objects (Root Type for LoyaltyProgramRuleRequest)

Правила для определения значения бонуса или скидки (допустимо только одно правило для фиксированных акций)

company_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы филиалов, в которых действует акция

allowed_service_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы услуг и категорий услуг (если задан тип применения для некоторых услуг)

allowed_good_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы товаров (если задан тип применения для некоторых товаров)

allowed_good_category_ids
Array of integers <int32> [ items <int32 > ]

Идентификаторы категорий товаров (если задан тип применения для некоторых товаров)

Responses

Response Schema: application/json
id
integer <int32>

Идетификатор акции

title
string

Название акции

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"

Тип акции

service_item_type
string
Enum: "any_allowed" "not_allowed" "custom_allowed"

Тип применения к услугам

good_item_type
string
Enum: "any_allowed" "not_allowed" "custom_allowed"

Тип применения к товарам

value_unit
string
Enum: "percent" "amount"

Единица измерения бонуса или скидки (процент, фиксированная сумма)

usage_limit
integer <int32>

Ограничение по количеству применений (только для кэшбека)

visit_multiplicity
integer <int32>

Кратность применения по визитам (только для кэшбека)

sold_items_multiplicity
integer <int32>

Сколько услуг нужно оплатить, чтобы получить скидку на акционные услуги (только для типа акции "Скидка по условию")

expiration_timeout
integer <int32>

Срок сгорания бонусов или скидки

expiration_timeout_unit
string
Enum: "day" "week" "month" "year"

Единица измерения срока сгорания бонусов или скидки

expiration_notification_timeout
integer <int32>

За сколько дней до наступления срока сгорания бонуса или скидки необходимо отправить клиенту уведомление

params_source_type
string
Enum: "loyalty_card" "active_companies" "chain"

Откуда брать историю клиента для расчета размера бонуса или скидки (для накпоительных акций или скидки по условию)

history_start_date
string <date>

С какой даты учитывать историю клиента для расчета размера бонуса или скидки (для накопительных акций или скидки по условию)

on_changed_notification_template_id
integer <int32>

Идентификатор шаблона уведомления при изменении бонуса или скидки

on_expiration_notification_template_id
integer <int32>

Идентификатор шаблона уведомления при сгорании бонуса или скидки

Array of objects (Root Type for LoyaltyCardType)

Тип карт, для которых действует акция (по запросу)

object (Root Type for LoyaltyNotificationMessageTemplate)

Шаблон уведомлений лояльности

object (Root Type for LoyaltyNotificationMessageTemplate)

Шаблон уведомлений лояльности

Array of objects (Root Type for LoyaltyProgramRule)

Правила для определения значения бонуса или скидки (допустимо только одно правило для фиксированных акций) (по запросу)

Array of objects (Company)

Филиалы, в которых действует акция (по запросу)

Array of objects (Root Type for LoyaltyEntityAttendanceItem)

Связанные сущности для выборочного применения акции (по запросу)

Request samples

Content type
application/json
{
  • "title": "Накопительная скидка для некоторых услуг и не для товаров",
  • "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": "Накопительная скидка для некоторых услуг и не для товаров",
  • "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": [
    ]
}

Удалить акцию в сети

Authorizations:
bearer
path Parameters
chain_id
required
integer

Идентификатор сети

loyalty_program_id
required
integer

Идентификатор акции

query Parameters
include
string
Enum: "applicable_items" "rules" "companies" "loyalty_card_types" "on_changed_notification_template" "on_expiration_notification_template"

Включить в ответ дополнительные ресурсы

Responses

Получить список транзакций лояльности в сети

Authorizations:
(beareruser)
path Parameters
chain_id
required
integer

Идентификатор сети

query Parameters
created_after
required
string <date>

Дата начала выборки в формате Y-m-d

created_before
required
string <date>

Дата окончания выборки в формате Y-m-d

types
Array of strings
Items Enum: "1" "2" "3" "4" "5" "6" "7" "8" "9" "10" "11"

Типы транзакций лояльности, включенные в выборку: 1 - Скидка по акции, 2 - Начисление по программе лояльности, 3 - Списание с карты лояльности, 4 - Начисление по реферальной программе, 5 - Ручное пополнение, 6 - Ручное списание, 7 - Списание просроченных баллов, 8 - Списание с сертификата, 9 - Использование абонемента, 10 - Перерасчет стоимости по абонементу, 11 - Списание с личного счета

company_ids
Array of integers

Идентификаторы филиалов транзакций лояльности, включенные в выборку

visit_ids
Array of integers

Идентификаторы визитов транзакций лояльности, включенные в выборку

page
integer

Страница выборки

count
integer

Количество результатов на одной странице выборки

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество элементов в ответе)

Response samples

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

Генерация кода сертификата/абонемента

  • Параметры
    • salonId (required, number, 1) - ID салона
    • goodId (required, number, 1) - ID товара (сертификат/абонемент)
Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор филиала

good_Id
required
number

Идентификатор товара (абонемент/сертификат)

header Parameters
Accept
required
string

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
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": [ ]
}

Получить список доступных типов абонементов

Список типов абонементов, доступных в филиале, можно получить, сделав запрос с указанием идентификатора филиала. Список можно отфильтровать по названию типа абонемента, передав параметр title. Поддерживается постраничный вывод, задаваемый параметрами page и page_size.

Список представляет собой массив типов абонементов.

Тип абонемента имеет следующую структуру:

Поле Тип Описание
id number Идентификатор типа абонемента
title string Название типа абонемента
allow_freeze boolean Допускается ли заморозка абонементов? true - допускается, false - не допускается
freeze_limit number Максимальный общий период заморозки (дни)
salon_group_id number Идентификатор сети, в которой действует тип абонемента
period number Срок действия абонемента (0, если не задан)
period_unit_id number Единица измерения срока действия абонемента (список возможных значений, если не задан - 0)
is_allow_empty_code boolean Разрешить продажу абонемента без кода? true - разрешить, false - не разрешать
is_united_balance boolean Общий или раздельный баланс абонемента: true - общий, false - раздельный
united_balance_services_count number Количество посещений для общего баланса

Единицы измерения срока действия типа абонемента

Значение Описание
1 День
2 Неделя
3 Месяц
4 Год
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
title
string

Название типа абонемента

page
number

Номер страницы

page_size
number

Количество выводимых строк на странице. Максимум 100

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

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

Conetnt-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив с объектами данных

object

Метаданные (содержит количество найденных типов абонементов)

Response samples

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

Получить список типов абонементов по идентификатору

Список типов абонементов, доступных в филиале, можно получить, сделав запрос с указанием идентификатора филиала и идентификаторов типов абонементов.

Список представляет собой массив типов абонементов.

Получить список типов абонементов по идентификатору

  • Parameters
    • company_id (required, number) - ID компании
    • id: 1 (optional, number) - ID типа абонемента (можно указать несколько дополнительными параметрами &ids[]={id}
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
ids[]
number

ID типа абонемента (можно указать несколько дополнительными параметрами &ids[]={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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив с объектами данных

object

Метаданные (содержит количество найденных типов абонементов)

Response samples

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

Получить список доступных типов сертификатов

Список типов сертификатов, доступных в филиале, можно получить, сделав запрос с указанием идентификатора филиала. Список можно отфильтровать по названию типа сертификата, передав параметр title. Поддерживается постраничный вывод, задаваемый параметрами page и page_size.

Список представляет собой массив типов сертификатов.

Тип сертификата имеет следующую структуру:

Поле Тип Описание
id number Идентификатор типа сертификата
title string Название типа сертификата
balance number Номинал сертификата
is_multi boolean Тип списания: true - многократное списание, false - однократное списание
company_group_id number Идентификатор сети, в которой действует тип сертификата
item_type_id number Ограничение применения (список возможных значений)
expiration_type_id number Ограничение срока действия (список возможных значений)
expiration_date string Фиксированная дата сгорания в формате ISO8601 (null, если не задана)
expiration_timeout number Срок действия сертификата с момента продажи (0, если не задан)
expiration_timeout_unit_id number Единица измерения срока действия сертификата с момента продажи (список возможных значений, если не задан - 0)
is_allow_empty_code boolean Разрешить продажу сертификата без кода? true - разрешить, false - не разрешать

Ограничение применения типа сертификата

Значение Описание
0 Без ограничений
1 Любые услуги без товаров
2 Любые товары без услуг
3 Некоторые услуги без товаров
4 Некоторые услуги и любые товары

Ограничение срока действия типа сертификата

Значение Описание
0 Без ограничения срока действия
1 Фиксированная дата для всех экземпляров
2 Фиксированный срок действия с момента продажи

Единицы измерения срока действия типа сертификата

Значение Описание
1 День
2 Неделя
3 Месяц
4 Год
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
title
string

Название типа сертификата

page
number

Номер страницы

page_size
number

Количество выводимых строк на странице. Максимум 100

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
integer

Bearer partner_token, User user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных типов сертификатов)

Response samples

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

Получить список типов сертификатов по идентификатору

Список типов сертификатов, доступных в филиале, можно получить, сделав запрос с указанием идентификатора филиала и идентификаторов типов сертификатов.

Список представляет собой массив типов сертификатов.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных типов сертификатов)

Response samples

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

Получить список акций, действующих в филиале

Метод позволяет получить список акций, которые активны для указанного филиала.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
include
string

Значение first_transaction_date добавляет в ответ дату первой транзакции по акции.

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"

Тип акции

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer bearer_token, User user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения.

Array of objects

Массив объектов с данными.

object

Метаданные (содержит количество найденных объектов)

Response samples

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

Получить статистику по клиентам

Метод позволяет получить статистику по вернувшимся, новым и потерянным клиентам

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
date_to
required
string

Дата окончания периода

date_from
required
string

Дата начала периода

loyalty_program_id
required
string

Идентификатор акции

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer bearer_token, User user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить статистику по выручке

Метод позволяет получить статистику по выручке.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
date_to
required
string

Дата окончания периода

date_from
required
string

Дата начала периода

loyalty_program_id
required
string

Идентификатор акции

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer bearer_token, User user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить возвращаемость по сотруднику

Метод позволяет получить статистику возвращаемости по сотруднику

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
date_to
required
string

Дата окончания периода

date_from
required
string

Дата начала периода

loyalty_program_id
required
string

Идентификатор акции

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer bearer_token, User user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения

Array of objects

Массив с объектами данных

object

Метаданные (содержит количество найденных объектов)

Response samples

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

Карты лояльности

Получить список типов карт доступных в филиале

Возвращает список типов карт, которые действуют для данного филиала.

Атрибуты и их описания соответсвуют методу "Коллекция типов карт доступных клиенту", описанному выше.

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

ID компании

Responses

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

Идентификатор типа карты

title
string

Название типа карты

salon_group_id
integer <int32>

Идентификатор сети, где создан тип карты

object

Объект, содержащий в себе поля "id" и "title": идентификатор сети, где создан тип карты и название этой сети

Response samples

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

Получить список карт клиента по номеру телефона

Возвращает список карт клиента с программами, которые активны в данном салоне

Атрибут Тип Описание
id int Идентификатор карты лояльности
balance decimal Баланс карты лояльности
paid_amount decimal Сумма "Оплачено"
sold_amount decimal Сумма "Продано"
visits_count int Количество визитов
number string Номер карты
type_id int Идентификатор типа карты лояльности
salon_group_id int Идентификатор сети, где создана карта
type object Объект, содержащий в себе поля "id" и "title": идентификатор типа карты и название типа карты, соотвественно
salon_group object Объект, содержащий в себе поля "id" и "title": идентификатор сети, где создан тип карты и название этой сети
programs array Массив с информацией об акциях, привязанных к карте лояльности
rules array Массив с информацией о правилах, настроенных в акции

Массив programs состоит из объектов со следующими полями:

Атрибут Тип Описание
id int Идентификатор акции
title string Название акции
loyalty_type_id int Идентификатор типа акции
item_type_id int Начисляется ли кэшбек от товаров
value_unit_id int Поле "Бонус". Скидка % или Фикс. сумма
group_id int Идентифкатор сети, где создана акция
loyalty_type object Объект с информацией о акции

Массив rules состоит из объектов со следующими полями:

Атрибут Тип Описание
id int Идентификатор правила
loyalty_program_id int Идентификатор акции, к которой привязано правило
loyalty_type_id int Идентификатор типа акции
value decimal Значение от которого сработает правило
Authorizations:
(beareruser)
path Parameters
phone
required
string

Номер телефона клиента в формате 70001234567

group_id
required
number

ID сети

company_id
required
number

ID филиала

header Parameters
Accept
required
string

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
id
integer <int32>

Идентификатор карты лояльности

balance
number <float>

Баланс карты лояльности

points
integer <int32>
paid_amount
number <float>

Сумма "Оплачено"

sold_amount
number <float>

Сумма "Продано"

visits_count
integer <int32>

Количество визитов

number
string

Номер карты

type_id
integer <int32>

Идентификатор типа карты лояльности

salon_group_id
integer <int32>

Идентификатор сети, где создана карта

object

Объект, содержащий в себе поля "id" и "title": идентификатор типа карты и название типа карты, соотвественно

object

Объект, содержащий в себе поля "id" и "title": идентификатор сети, где создан тип карты и название этой сети

Array of objects

Массив с информацией об акциях, привязанных к карте лояльности

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": [
    ]
}

Получить список карт клиента по ID

Возвращает список карт клиента с программами, которые активны в данном салоне

Атрибуты в ответе на запрос полностью совпадают с методом "Получить список выданных карт по номеру телефона", описанным выше

Authorizations:
(beareruser)
path Parameters
client_id
required
number

ID клиента

header Parameters
Accept
required
string

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
id
integer <int32>

Идентификатор карты лояльности

balance
number <float>

Баланс карты лояльности

points
integer <int32>
paid_amount
number <float>

Сумма "Оплачено"

sold_amount
number <float>

Сумма "Продано"

visits_count
integer <int32>

Количество визитов

number
string

Номер карты

type_id
integer <int32>

Идентификатор типа карты лояльности

salon_group_id
integer <int32>

Идентификатор сети, где создана карта

object

Объект, содержащий в себе поля "id" и "title": идентификатор типа карты и название типа карты, соотвественно

object

Объект, содержащий в себе поля "id" и "title": идентификатор сети, где создан тип карты и название этой сети

Array of objects

Массив с информацией об акциях, привязанных к карте лояльности

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": [
    ]
}

Получить карты лояльности пользователя

Возвращает список карт авторизованного пользователя с программами, фильтруя карты по сети салонов/салону

Authorizations:
(beareruser)
path Parameters
group_id
required
number

ID сети

header Parameters
Accept
required
string

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
id
integer <int32>

Идентификатор карты лояльности

balance
number <float>

Баланс карты лояльности

points
integer <int32>
paid_amount
number <float>

Сумма "Оплачено"

sold_amount
number <float>

Сумма "Продано"

visits_count
integer <int32>

Количество визитов

number
string

Номер карты

type_id
integer <int32>

Идентификатор типа карты лояльности

salon_group_id
integer <int32>

Идентификатор сети, где создана карта

object

Объект, содержащий в себе поля "id" и "title": идентификатор типа карты и название типа карты, соотвественно

object

Объект, содержащий в себе поля "id" и "title": идентификатор сети, где создан тип карты и название этой сети

Array of objects

Массив с информацией об акциях, привязанных к карте лояльности

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": [
    ]
}

Выдать карту лояльности

Атрибут Тип Описание
loyalty_card_number number Номер карты лояльности
loyalty_card_type_id number Идентификатор типа карты лояльности
phone number Номер телефона клиента в формате 70001234567
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

header Parameters
Accept
required
string

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
loyalty_card_number
string

Номер карты лояльности

loyalty_card_type_id
string

Идентификатор типа карты лояльности

phone
number

Номер телефона клиента в формате 70001234567

Responses

Response Schema: application/json
id
integer <int32>

Идентификатор карты лояльности

balance
number <float>

Баланс карты лояльности

points
integer <int32>
paid_amount
number <float>

Сумма "Оплачено"

sold_amount
number <float>

Сумма "Продано"

visits_count
integer <int32>

Количество визитов

number
string

Номер карты

type_id
integer <int32>

Идентификатор типа карты лояльности

salon_group_id
integer <int32>

Идентификатор сети, где создана карта

object

Объект, содержащий в себе поля "id" и "title": идентификатор типа карты и название типа карты, соотвественно

object

Объект, содержащий в себе поля "id" и "title": идентификатор сети, где создан тип карты и название этой сети

Array of objects

Массив с информацией об акциях, привязанных к карте лояльности

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": [
    ]
}

Удалить карту лояльности

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

card_id
required
number

ID карты лояльности

Responses

Ручное списание/пополнение карты лояльности в сети

Ручное списание/пополнение карты лояльности в сети

Authorizations:
BearerPartnerUser
path Parameters
chain_id
required
number
Example: 123

Идентификатор сети.

card_id
required
number

ID карты лояльности

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
amount
required
number

Сумма списания/пополнения. Положительная для пополнения, отрицательная для списания.

title
string

Примечание к транзакции.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (loyalty_card)

Карта лояльности

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "amount": 100.5,
  • "title": "string"
}

Response samples

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

Получить список типов карт, доступных в сети

Authorizations:
(beareruser)
path Parameters
chain_id
required
integer

Идентификатор сети

header Parameters
Accept
required
string

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
Array
id
integer <int32>

Идентификатор типа карты

title
string

Название типа карты

Response samples

Content type
application/json
[
  • {
    }
]

Ручное списание/пополнение карты лояльности в компании

Ручное списание/пополнение карты лояльности в компании

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

card_id
required
number

ID карты лояльности

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
amount
required
number

Сумма списания/пополнения. Положительная для пополнения, отрицательная для списания.

title
string

Примечание к транзакции.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (loyalty_card)

Карта лояльности

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "amount": 100.5,
  • "title": "string"
}

Response samples

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

Получить список типов карт доступных для выдачи клиенту

Возвращает список типов карт, которые доступны для выдачи клиенту салона.

Атрибут Тип Описание
id int Идентификатор типа карты
title string Название типа карты
salon_group_id int Идентификатор сети, где создан тип карты
salon_group object Объект, содержащий в себе поля "id" и "title": идентификатор сети, где создан тип карты и название этой сети
Authorizations:
(beareruser)
path Parameters
company_id
required
number
Example: 12345

ID компании

phone
required
number
Example: 70001234567

Номер телефона клиента

header Parameters
Accept
required
string

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
Array
id
integer <int32>

Идентификатор типа карты

title
string

Название типа карты

salon_group_id
integer <int32>

Идентификатор сети, где создан тип карты

object

Объект, содержащий в себе поля "id" и "title": идентификатор сети, где создан тип карты и название этой сети

Response samples

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

Сертификаты

Получить сертификаты клиента

Возвращает список сертификатов клиента по телефону

Атрибут Тип Описание
id int Идентификатор сертификата
number string Код сертификата
balance decimal Текущий баланс
default_balance decimal Начальный баланс
type_id int Идентификатор типа сертификата
status_id int Идентификатор статуса
created_date datetime Дата продажи
expiration_date datetime Дата сгорания
type object Объект с информацией о типе сертификата
status object Объект с информацией о текущем статусе сертификата

Массив type содержит следующие объекты:

Атрибут Тип Описание
id int Идентификатор типа сертификата
title string Название типа
balance decimal Номинал сертификата
is_multi boolean Доступен ли для многократрного списания
company_group_id int Идентификатор сети, где создан тип сертификата
item_type_id int Ограничение применения списания баллов. 0 - без ограничений, 1 - Только услуги, 2 - Некоторые услуги + все товары, 3 - Некоторые услуги, 4 - Только товары
expiration_type_id int Идентификатор ограничения срока действия. 0 - без ограничения, 1 - фиксированная дата, 2 - фиксированный срок
expiration_date datetime Дата сгорания всех сертифкатов. Заполняется с expiration_type_id = 1
expiration_timeout int Срок действия сертифкатов. Заполняется с expiration_type_id = 2
expiration_timeout_unit_id int Единицы измерения времени. 1 - День, 2 - Неделя, 3 - месяц, 4 - год
is_allow_empty_code boolean Продажа без кода
item_type object Объект с item_type_id и его названием
Authorizations:
(beareruser)
query Parameters
copmany_id
required
number

Идентификатор филиала

phone
required
number

Номер телефона клиента

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных сертификатов)

Response samples

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

Получить сертификаты пользователя

Возвращает список сертификатов авторизованного пользователя

Authorizations:
(beareruser)
query Parameters
company_id
required
number

Идентификатор филиала

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных сертификатов)

Response samples

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

Абонементы

Атрибут Тип Описание
is_frozen boolean Указывает заморожен ли абонемент
freeze_period int Период, который абонемент был заморожен
period int Значение срока действия абонемента
period_unit_id int Идентификатор единиц измерения срока действия. 1 - день, 2 - неделя, 3 - месяц, 4 - год
expiration_date datetime Дата сгорания абонемента
status int Текущий статус абонемента
balance_container object Объект включающий в себя массив links с информацией о балансе абонемента
type object Объект с информацией о типе абонемента
allow_freeze boolean Допускается ли заморозка (для объекта type)
is_allow_empty_code boolean Допускается ли продажа без кода (для объекта type)

Заморозить абонемент

Authorizations:
(beareruser)
path Parameters
chain_id
required
number
Example: 123

Идентификатор сети.

abonementId
required
number
Example: 123

Идентификатор абонемента.

Request Body schema: application/json
freeze_till
required
string

Дата, до которой будет заморожен абонемент.

Responses

Request samples

Content type
application/json
{
  • "freeze_till": "string"
}

Response samples

Content type
application/json
[
  • {
    }
]

Разморозить абонемент

Authorizations:
(beareruser)
path Parameters
chain_id
required
number
Example: 123

Идентификатор сети.

abonementId
required
number
Example: 123

Идентификатор абонемента.

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Изменить длительность абонемента

Authorizations:
(beareruser)
path Parameters
chain_id
required
number
Example: 123

Идентификатор сети.

abonementId
required
number
Example: 123

Идентификатор абонемента.

Request Body schema: application/json
period
required
number

Длительность периода

period_unit_id
required
number

Тип периода (1 - день, 2 - неделя, 3 - месяц, 4 - год)

Responses

Request samples

Content type
application/json
{
  • "period": 0,
  • "period_unit_id": 0
}

Response samples

Content type
application/json
[
  • {
    }
]

Изменить количество использований абонемента

Authorizations:
(beareruser)
path Parameters
chain_id
required
number
Example: 123

Идентификатор сети.

abonementId
required
number
Example: 123

Идентификатор абонемента.

Request Body schema: application/json
united_balance_services_count
required
number

Количество услуг для абонемента с объединенным балансом

required
Array of objects

Перечисление услуга-количество для абонемента с раздельным балансом

Responses

Request samples

Content type
application/json
{
  • "united_balance_services_count": 0,
  • "services_balance_count": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Получить список абонементов по фильтру

Authorizations:
(beareruser)
path Parameters
chain_id
required
number
Example: 123

Идентификатор сети.

query Parameters
created_after
string
Example: created_after=1630454400

Дата создания с (фильтр по дате создания).

created_before
string
Example: created_before=1630454400

Дата создания по (фильтр по дате создания).

abonements_ids
Array of numbers

Список идентификаторов для фильтра.

page
number
Example: page=1

Номер страницы.

count
number
Example: count=25

Количество записей на странице.

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Получить абонементы клиента

Возвращает список абонементов клиента по телефону

Authorizations:
(beareruser)
query Parameters
company_id
required
number

Идентификатор филиала

phone
required
number

Номер телефона клиента

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных абонементов)

Response samples

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

Получить абонементы пользователя

Возвращает список абонементов авторизованного пользователя

Authorizations:
(beareruser)
query Parameters
company_id
required
number

Идентификатор филиала

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных абонементов)

Response samples

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

Применение лояльности в визите

Атрибут Тип Описание
loyalty_transactions array Массив с информацией о примененных транзакциях лояльности в визите
is_discount boolean Является ли транзакцией скидки
is_loyalty_withdraw boolean Является ли транзакцией списания баллов
items array Массив с информацией о товарах и услугах записи
payment_transactions array Массив с информацией о финансовых транзакциях записи
kkm_transactions object Объект с информацией о ККМ транзакциях записи

Применить акцию скидки в визите

Применение акции к визиту, имеет смысл тольо если есть визит

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

card_id
required
number

ID карты клиента

program_id
required
number

ID акции, привязанной к карте

header Parameters
Accept
required
string

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
record_id
required
number

Идентификатор записи

visit_id
required
number

Идентификатор визита

Responses

Response Schema: application/json
payment_transactions
Array of objects

Массив с информацией о финансовых транзакциях записи

Array of objects

Массив с информацией о примененных транзакциях лояльности в визите

object

Объект с информацией о ККМ транзакциях записи

Array of objects

Массив с информацией о товарах и услугах записи

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": [
    ]
}

Отменить применение акции скидки в визите

Отмена примененной к визиту акции.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

card_id
required
number

ID карты клиента

program_id
required
number

ID акции, привязанной к карте

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
record_id
required
number

Идентификатор записи

visit_id
required
number

Идентификатор визита

Responses

Response Schema: application/json
payment_transactions
Array of objects

Массив с информацией о финансовых транзакциях записи

loyalty_transactions
Array of objects

Массив с информацией о примененных транзакциях лояльности в визите

object

Объект с информацией о ККМ транзакциях записи

Array of objects

Массив с информацией о товарах и услугах записи

Response samples

Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [ ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}

Применить списание с карты лояльности в визите

Списание бонусов с карты Сумма не будет превышать остаток на оплату Если 0 то транзакции не будет

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

card_id
required
number

ID карты клиента

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
record_id
required
number

Идентификатор записи

visit_id
required
number

Идентификатор визита

amount
required
number

Количество баллов для списания

Responses

Response Schema: application/json
payment_transactions
Array of objects

Массив с информацией о финансовых транзакциях записи

Array of objects

Массив с информацией о примененных транзакциях лояльности в визите

object

Объект с информацией о ККМ транзакциях записи

Array of objects

Массив с информацией о товарах и услугах записи

Response samples

Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [
    ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}

Отменить списание с карты лояльности в визите

Отмена списания с карты лояльности.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

card_id
required
number

ID карты клиента

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
record_id
required
number

Идентификатор записи

visit_id
required
number

Идентификатор визита

Responses

Response Schema: application/json
payment_transactions
Array of objects

Массив с информацией о финансовых транзакциях записи

loyalty_transactions
Array of objects

Массив с информацией о примененных транзакциях лояльности в визите

object

Объект с информацией о ККМ транзакциях записи

Array of objects

Массив с информацией о товарах и услугах записи

Response samples

Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [ ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}

Применить реферальную программу в записи

Применение реферальной программы к визиту

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

group_id
required
number

ID сети, где настроена реферальная программа

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
record_id
required
number

Идентификатор записи

visit_id
required
number

Идентификатор визита

referrer_phone
required
number

Номер телефона пригласившего

Responses

Response Schema: application/json
payment_transactions
Array of objects

Массив с информацией о финансовых транзакциях записи

Array of objects

Массив с информацией о примененных транзакциях лояльности в визите

object

Объект с информацией о ККМ транзакциях записи

Array of objects

Массив с информацией о товарах и услугах записи

Response samples

Content type
application/json
{
  • "payment_transactions": [ ],
  • "loyalty_transactions": [
    ],
  • "kkm_transaction_details_container": {
    },
  • "items": [
    ]
}

Получить транзакции лояльности по визиту

Список транзакций по акциям лояльнсти для данного визита

Authorizations:
(beareruser)
path Parameters
visit_id
required
number

ID визита

header Parameters
Accept
required
string

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
Array
id
integer <int32>

Идентификатор транзакции лояльности

status_id
integer <int32>

Идентификатор статуса

amount
number <float>

Сумма транзакции

type_id
integer <int32>

Идентификатор типа транзакции

program_id
integer <int32>

Идентификатор программы лояльности

card_id
integer <int32>

Идентификатор карты лояльности

salon_group_id
integer <int32>

Идентификатор сети, которой принадлежит лояльность

item_id
integer <int32>

Идентификатор товара/услуги, к которой применяется акция

item_type_id
integer <int32>

Идентификатор типа операции

item_record_id
integer <int32>

Идентификатор записи, которой принадлежит услуга/товар

goods_transaction_id
integer <int32>

Идентификатор товарной транзакции

is_discount
boolean

Является ли скидкой

is_loyalty_withdraw
boolean

Отменено ли применение лояльности

object

Тип лояльности

object

Информация об акции

Response samples

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

Справочники

Получение списка бизнес-типов сгруппированных по группам

Объект бизнес-группы имеет следующие поля:

Поле Тип Описание
id number ID категории
title string Название категории
image string Изображение группы
types array Связанные бизнес-типы

Объект бизнес-типа имеет следующие поля:

Поле Тип Описание
id number ID типа
title string Название типа
business_group_id number ID бизнес-группы

Получить бизнес-типы по группам

Authorizations:
(beareruser)
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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденых бизнес-типов)

Response samples

Content type
application/json
{}

Категории

Объект категории имеет следующие поля:

Поле Тип Описание
id number ID категории
salon_id number ID компании
title string Название категории
color string Цвет метки в формате #RRGGBB
icon string Название иконки
entity number Объект категории (1 - категория для клиентов, 2 - категория для записей)
deleted number Метка удаления
not_editable number Разрешены ли изменения категории (1 - разрешены, 0 - не разрешены)

Получить категории компании

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

entity
required
number

Объект категории (0 - общие метки, 1 - метки клиентов, 2 - метки записей)

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
Array
id
number

Идентификатор категории

salon_id
number

Идентификатор филиала

title
string

Название категории

color
string

Цвет метки в формате #RRGGBB

icon
string

Название иконки

entity
number

Объект категории (1 - категория для клиентов, 2 - категория для записей)

deleted
number

Метка удаления

not_editable
number

Разрешены ли изменения категории (1 - разрешены, 0 - не разрешены)

Response samples

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

Создать клиентскую категорию компании

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Request Body schema: */*
title
string

Название категории

color
string

Цвет метки в формате #RRGGBB

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

data
string

Содержит null

object

Метаданные (содержит сообщение об ошибке)

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

data
string

Содержит null

object

Содержит массив с сообщениями о возможных ошибках

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

data
string

Содержит null

object

Содержит массив сообщений о возможных ошибках

Response samples

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

Создать категорию

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
title
required
string

Название категории

color
required
string

Цвет метки в формате #RRGGBB

entity
number

Объект категории (0 - общие метки, 1 - метки клиентов, 2 - метки записей)

icon
string

Название иконки

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

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Обновить категорию

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

label_id
required
number

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
string

Название категории

color
string

Цвет метки в формате #RRGGBB

entity
number

Объект категории (1 - категория для клиентов, 2 - категория для записей)

icon
string

Название иконки

Responses

Request samples

Content type
application/json
{
  • "title": "Тествая2",
  • "color": "#aa11ff",
  • "entity": 2,
  • "icon": "Тест"
}

Response samples

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

Удалить категорию компании

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

label_id
required
number

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

Responses

Response samples

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

Получить клиентские категории с поиском по названию

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив с объектами данных

object

Метаданные (содержит номер страницы и количество найденных категорий)

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

data
string

Содержит null

object

Содержит массив с сообщениями о возможных ошибках

Response Schema: application/json
success
boolean

Статус успешности выполнения (false)

data
string

Содержит null

object

Содержит массив сообщений о возможных ошибках

Response samples

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

Товары

Описание API объектов сущности «Товар»

Объект товара имеет следующие поля:

Поле Тип Описание
title string Наименование товара
value string Наименование товара
print_title string Наименование товара для печати в чеке
label string Наименование товара с артикулом (если имеется)
good_id number Идентификатор товара
cost float Цена продажи
sale_unit_id int ID единицы измерения для продажи
unit_short_title string Единица измерения для продажи
service_unit_id int ID единицы измерения для списания
service_unit_short_title string Единица измерения для списания
actual_cost float Себестоимость
unit_actual_cost float Себестоимость единицы
unit_actual_cost_format string Формат себестоимости единицы
unit_equals float Отношение единицы измерения для продажик еденице за списание
barcode string Штрих-код
critical_amount float Критчный остаток
desired_amount float Желаемый остаток
netto float Масса нетто
brutto float Масса брутто
tax_variant int СНО
vat_id int НДС
loyalty_abonement_type_id int Идентификатор тип абонемента (если товар является абонементом)
loyalty_certificate_type_id int Идентификатор тип сертификата (если товар является сертификатом)
loyalty_allow_empty_code boolean Разрешена ли продажа без кода
actual_amounts array Остатки на складах
is_barcode number Товар по штрих-коду
last_change_date string Дата последнего изменения сущности
comment string Комментарий

Объект из actual_amounts имеет следующие поля:

Поле Тип Описание
storage_id number ID склада
amount number Количество

Объекты из массива correction_rules имеют следующие поля:

Поле Тип Описание
type int Тип операции (1 - Продажа товара, 2 - Списание расходников, 3 - Приход товара, 4 - Списание товара, 5 - Перемещение товара)
base_unit string Основная единица измерения при корректировке ("sale" - Для продажи, "service" - Для списания)

Единицы измерения:

ID Название ID Название ID Название
216760 Штука 216761 Миллилитр 216762 Сертификат
216763 Грамм 216764 Упаковка 216765 Миллиграмм
216766 Сантиметр 216767 Микролитр 216768 Пара
216769 Метр 216770 Рулон 216771 Литр
216772 Флакон 216773 Единица 216774 Тюбик
216775 Минута 216776 Килограмм 216777 Ампула
216778 Банка 216779 Другое 216780 Коробка
216781 Набор 216782 Миллиметры 216783 Порция
216784 Линия 216785 Бутылка 216786 Шприц
216787 Процедура 216788 Лента 216789 Час
216790 Капсула 216791 Доза 216792 Рубль
216793 Километр 216794 Гривна 216795 Тенге
216796 Погонный метр

Виды систем налогообложения:

ID СНО
0 Общая ОСН
1 Упрощенная УСН (Доход)
2 Упрощенная УСН (Доход минус Расход)
3 Единый налог на вмененный доход ЕНВД
4 Единый сельскохозяйственный налог ЕСН
5 Патентная система налогообложения

Виды НДС:

ID НДС
1 0%
2 10%
3 20%
4 Не облагается

Создать товар

Метод позволяет создать товар

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор филиала

header Parameters
Accept
required
string

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

Название товара

print_title
string

Название для печати в чеке

article
string

Артикул

barcode
string

Штрих-код

category_id
required
integer

Идентификатор категории товара

cost
number <float>

Цена продажи

actual_cost
number <float>

Себестоимость

sale_unit_id
required
integer

Единица измерения для продажи

service_unit_id
required
integer

Единица измерения для списания

unit_equals
number <float>

Отношение ед.имзерения для продажи к ед.измерения для списания

critical_amount
number <float>

Критичный остаток

desired_amount
number <float>

Желаемый остаток

netto
number <float>

Масса нетто

brutto
number <float>

Масса брутто

comment
string

Комментарий

tax_variant
integer

Система налогообложения

vat_id
integer

НДС

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив с объектами данных

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean

Статус успешности выполнения

data
string

Содержит null

object

Содержит сообщение об ошибках

Request samples

Content type
application/json
{
  • "title": "Шампунь",
  • "print_title": "Шампунь",
  • "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": [ ]
}

Получить товары

  • term: Наименование, артикул или штрих-код

  • page (number, 1) - Номер страницы (не используется, если передан good_id)

  • count (number, 25) - Количество товаров на странице (не используется, если передан good_id)

  • category_id (number, 777) - Id категории товаров (не используется, если передан good_id)

  • changed_after (string) - фильтрация товаров, измененных/созданных начиная с конкретной даты и времени (не используется, если передан good_id)

  • changed_before (string) - фильтрация товаров, измененных/созданных до конкретной даты и времени (не используется, если передан good_id)

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

good_id
required
number

ID товара (если нужно получить конкретный товар)

query Parameters
term
string

наименование, артикул или штрих-код

page
number
Example: page=1

номер страницы

count
number
Example: count=25

количество товаров на странице

category_id
number

Id категории товаров

changed_after
string
Example: changed_after=1483272000

фильтрация товаров, измененных/созданных начиная с конкретной даты и времени

changed_before
string
Example: changed_before=2017-01-01T12:00:00+0400

фильтрация товаров, измененных/созданных до конкретной даты и времени

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

Статус успешности выполнения (true)

Array of objects

Массив с объектами данных

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Редактировать товар

Метод позволяет изменить параметры товара. При редактировании единиц измерения у товара, по которому уже имеются складские операции, необходимо добавлять массив правил пересчета единиц измерения - correction_rules. В ином случае, массив является необязательным.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор филиала

good_id
required
number

Идентификатор товара

header Parameters
Accept
required
string

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

Название товара

print_title
string

Название для печати в чеке

article
string

Артикул

barcode
string

Штрих-код

category_id
required
integer

Идентификатор категории товара

cost
number <float>

Цена продажи

actual_cost
number <float>

Себестоимость

sale_unit_id
required
integer

Единица измерения для продажи

service_unit_id
required
integer

Единица измерения для списания

unit_equals
number <float>

Отношение ед.имзерения для продажи к ед.измерения для списания

critical_amount
number <float>

Критичный остаток

desired_amount
number <float>

Желаемый остаток

netto
number <float>

Масса нетто

brutto
number <float>

Масса брутто

comment
string

Комментарий

tax_variant
integer

Система налогообложения

vat_id
integer

НДС

Array of objects

Массив правил пересчета единиц измерения (необходим, если по товару есть складские операциии)

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив с объектами данных

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean

Статус успешности выполнения

data
string

Содержит null

object

Объект с сообщением об ошибке

Response Schema: application/json
success
boolean

Статус успешности выполнения

data
string

Содержит null

object

Содержит сообщение об ошибках

Request samples

Content type
application/json
{
  • "title": "Шампунь",
  • "print_title": "Шампунь",
  • "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": [ ]
}

Удалить товар

Метод позволяет удалить товар

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор филиала

good_id
required
number

Идентификатор товара

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Категории товаров

Объект категории товаров имеет следующие поля:

Поле Тип Описание
id number id категории
title string Название категории
parent_category_id string ID родительской категории

Пример запроса на получение списка

Список товаров и товарных категорий

Список товаров и товарных категорий можно получить, сделав запрос с указанием идентификатора филиала. Список можно отфильтровать по названию или артикулу категории товаров, по названию, артикулу или штрихкоду товара, передав параметр search_term. Количество результатов ограничивается параметром max_count.

Если search_term не передан, выводится список корневых категорий филиала без учета max_count. Если search_term передан, сначала производится поиск по категориям, затем (если найдено меньше, чем max_count) - по товарам

Список представляет собой массив элементов дерева товаров.

Элемент дерева товаров имеет следующую структуру:

Поле Тип Описание
parent_id number Идентификатор родительского элемента (0 для корневых элементов)
item_id number Идентификатор товара (0, если элемент - категория)
category_id number Идентификатор товарной категории (0, если элемент - товар)
title string Название товара или товарной категории
is_chain boolean Является ли элемент привязанным к сети? true - элемент привязан к сети, false - не привязан
is_category boolean Является ли элемент категорией? true - категория, false - товар
is_item boolean Является ли элемент товаром? true - товар, false - категория
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
search_term
string

Поисковый запрос по названию, артикулу или штрихкоду

max_count
number

Количество выводимых строк на странице. Максимум 100

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

Статус успешности выполнения (true)

Array of objects

Массив с объектами данных

object

Метаданные (содержит количество найденных категорий)

Response samples

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

Пример запроса на получение состава категории

##№ Состав товарной категории

Информацию по товарной категории и ее потомкам можно получить, сделав запрос с указанием идентификатора филиала и товарной категории. Поддерживается постраничный вывод, задаваемый параметрами page и count.

Состав товарной категории имеет следующую структуру:

Поле Тип Описание
parent_id number Идентификатор родительского элемента (0 для корневых элементов)
item_id number Идентификатор товара (всегда 0)
category_id number Идентификатор товарной категории
title string Название товарной категории
is_chain boolean Является ли элемент привязанным к сети? true - элемент привязан к сети, false - не привязан
is_category boolean Является ли элемент категорией? всегда true
is_item boolean Является ли элемент товаром? всегда false
children Array of objects(Элемент дерева товаров) Дочерние элементы товарной категории
children_count number Полное число дочерних товаров и категорий (без рекурсии)
Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

category_id
required
number

ID товарной категории

query Parameters
page
number

Номер страницы

count
number

Количество выводимых товаров на странице. Максимум 1000

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

Статус успешности выполнения (true)

object

Объект с данными

Response samples

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

Получить список категорий товаров Deprecated

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

parent_category_id
required
number

ID родительской категории товара. По умолчанию 0 - выводятся категории верхнего уровня (необязательный)

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить список категорий товаров по идентификатору

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
id
number

ID товарной категории (можно указать несколько дополнительными параметрами &ids[]={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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Пример запроса на получение категорий

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

parent_category_id
required
number

ID родительской товарной категории

query Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Создать категорию товаров

Метод позволяет создать категорию товаров.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор филиала

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

Название категории товаров

parent_category_id
integer <int32>

Инедтификатор родительской категории (параметр необязательный, но может принимать значение 0 или null, в случае, когда не нужно указывать родительскую категорию)

article
string

Артикул

comment
string

Комментарий

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "title": "Маникюр",
  • "parent_category_id": 123456,
  • "article": "123article",
  • "comment": "Категория товаров для маникюра"
}

Response samples

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

Редактировать категорию товаров

Метод позволяет отредактировать категорию товаров

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор филиала

category_id
required
number

Идентификатор категории товаров

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

Название категории товаров

parent_category_id
integer <int32>

Инедтификатор родительской категории (параметр необязательный, но может принимать значение 0 или null, в случае, когда не нужно указывать родительскую категорию)

article
string

Артикул

comment
string

Комментарий

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "title": "Маникюр",
  • "parent_category_id": 123456,
  • "article": "123article",
  • "comment": "Категория товаров для маникюра"
}

Response samples

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

Удалить категорию товаров

Метод позволяет удалить категорию товаров

Authorizations:
(userbearer)
path Parameters
company_id
required
number

Идентификатор филиала

category_id
required
number

Идентификатор категории товаров

header Parameters
Accept
required
string

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

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token, User user_token

Responses

Технологические карты и расходники

Объект технологической карты имеет следующие поля:

Поле Тип Описание
id number id тех карты
title string Название тех карты
technological_card_items array Список расходников тех карты

Получить список тех карт

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

query Parameters
search
string
Example: search='test'

параметр для поиска по названию тех карты

page
number
Example: page=1

номер страницы

count
number
Example: count=20

количество тех карт на странице

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

Статус успешности выполнения (true)

Array of objects

Массив объеков с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить тех карту для связи сотрудник услуга

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

staffId
required
number

ID сотрудника

serviceId
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объеков с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить список тех карт и расходников записи

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

record_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Удалить технологическую из связи запись-услуга

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

record_id
required
number

ID записи

service_id
required
number

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: */*
delete_consumables
number

удалить ли расходники вместе с удалением тех карты. По умолчанию 0

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив с объектом

object

Метаданные (пустой массив)

Response samples

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

Изменить список расходников связи запись-услуга

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

record_id
required
number

ID записи

service_id
required
number

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
Array of objects

Список расходников

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

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

Response samples

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

Товарные транзакции

Объект товарной транзакции имеет следующие поля:

Поле Тип Описание
id number ID транзакции
document_id number ID документа
type_id number ID типа транзакции
type string Тип транзакции
good good Товар
storage storage Склад
unit unit Единица измерения
operation_unit_type number Тип единицы измерения: 1 - для продажи, 2 - для списания
create_date string Дата создания
last_change_date string Дата последнего изменения
cost_per_unit float Цена за единицу
cost float Цена
discount float Скидка
master master Сотрудник
supplier supplier Поставщик
service service Услуга
client client Клиент

Объект good имеет следующие поля:

Поле Тип Описание
id number ID товара
title string Наименование
unit string Единица измерения
value string Название товара
label string Название товара
article string Артикул
category string Название категории товара
category_id number Идентификатор категории товара
salon_id number Идентификатор компании
good_id number Идентификатор товара
cost float Стоимость
unit_id number Идентификатор единицы измерения
unit_short_title string Сокращенное название единицы измерения
service_unit_id number Идентификатор единицы измерения для услуги
service_unit_short_title string Сокращенное название единицы измерения для услуги
actual_cost float Себестоимость
unit_actual_cost float Себестоимость за единицу
unit_actual_cost_format string Формат себестоимости за единицу
unit_equals number Значение единицы измерения
barcode string Штрих-код
loyalty_abonement_type_id number Идентификатор абонемента (если товар это абонемент)
loyalty_certificate_type_id number Идентификатор сертификата (если товар это сертификат)
good_special_number string Код абонемента\сертификата
loyalty_allow_empty_code number Разрешена ли продажа без кода
actual_amounts array Количество товара
last_change_date string Дата последнего изменения товара

Объект storage имеет следующие поля:

Поле Тип Описание
id number ID склада
title string Наименование

Объект unit имеет следующие поля:

Поле Тип Описание
id number ID склада
title string Единица измерения

Объект master имеет следующие поля:

Поле Тип Описание
id number ID сотрудника
title string Имя сотрудника

Объект supplier имеет следующие поля:

Поле Тип Описание
id number ID поставщика
title string Имя поставщика

Объект service имеет следующие поля:

Поле Тип Описание
id number ID услуги
title string Название услуги

Объект client имеет следующие поля:

Поле Тип Описание
id number ID клиента
name string Имя клиента
phone string Телефон клиента

Поиск товарных транзакций

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

query Parameters
page
number
Example: page=1

номер страницы

count
number
Example: count=20

количество транзакций на странице

start_date
date
Example: start_date=2020-01-01

дата начала периода

end_date
date
Example: end_date=2020-02-01

дата окончания периода

document_id
string

ID документа

changed_after
ISO 8601
Example: changed_after=2020-01-01T00:00:00

Фильтрация товарных транзакций, измененных/созданных начиная с конкретной даты и времени

changed_before
ISO 8601
Example: changed_before=2020-03-01T23:59:59

Фильтрация товарных транзакций, измененных/созданных до конкретной даты и времени

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Создать транзакцию

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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
document_id
required
number <float>

Идентификатор документа

good_id
required
number

Идентификатор товара

amount
required
number

Количество

cost_per_unit
required
number <float>

Стоимость за единицу товара

discount
required
number

Скидка в %

cost
required
number <float>

Итоговая сумма транзакции

operation_unit_type
required
number

тип единицы измерения: 1 - для продажи, 2 - для списания

good_special_number
string

Код абонемента\сертификата, если товар является абонементом или сертификатом

master_id
number

Идентификатор мастера, продавшего товар

client_id
number

Идентификатор клиента, купившего товар

supplier_id
number

Идентификатор поставщика

comment
string

Комментарий

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

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": [ ]
}

Получение транзакции

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

transaction_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Обновление транзакции

Authorizations:
(beareruser)
path Parameters
transaction_id
required
number

ID транзакции

company_id
required
number

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: */*
document_id
required
number <float>

Идентификатор документа

good_id
required
number

Идентификатор товара

amount
required
number

Количество

cost_per_unit
required
number <float>

Стоимость за единицу товара

discount
required
number

Скидка в %

cost
required
number <float>

Итоговая сумма транзакции

operation_unit_type
required
number

тип единицы измерения: 1 - для продажи, 2 - для списания

good_special_number
string

Код абонемента\сертификата, если товар является абонементом или сертификатом

master_id
number

Идентификатор мастера, продавшего товар

client_id
number

Идентификатор клиента, купившего товар

supplier_id
number

Идентификатор поставщика

comment
string

Комментарий

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Удаление транзакции

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

transaction_id
required
number

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

Responses

Складские операции

Создание складской операции

Создание складской операции предполагает создание документа и нескольких товарных транзакций в рамках одного запроса к API.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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: */*
type_id
required
number

Тип документа (1 продажа, 3 приход, 4 списание, 5 перемещение)

comment
string

Комментарий

create_date
required
string <date-time>

Дата создания документа

master_id
number

Идентификатор мастера

storage_id
required
number

Идентификатор склада

goods_transactions
required
Array of objects

Массив объектов содержащих параметры транзакций, аналогично запросу на создание товарной транзакции

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Документы складских операций

Документ операции является обьединяющей сущностью для товарных и финансовых транзакций

Создать документ

Authorizations:
(beareruser)
path Parameters
company_id
required
number

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
type_id
required
number

Тип документа (1 продажа, 3 приход, 4 списание)

comment
string

Комментарий

storage_id
required
number

Идентификатор склада

create_date
required
string <date-time>

Дата проведения складской операции

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "type_id": 1,
  • "comment": "Комментарий документа",
  • "storage_id": 36539,
  • "create_date": "2017-04-24 20:00:00"
}

Response samples

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

Получить документ

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

document_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Обновить документ

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

document_id
required
number

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: */*
type_id
required
number

Тип документа (1 продажа, 3 приход, 4 списание)

comment
string

Комментарий

storage_id
required
number

Идентификатор склада

create_date
required
string <date-time>

Дата проведения складской операции

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Удалить документ

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

document_id
required
number

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

Responses

Получить финансовые транзакции документа

Authorizations:
(beareruser)
path Parameters
document_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получить товарные транзакции документа

Authorizations:
(beareruser)
path Parameters
document_id
required
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (количество найденных транзакций)

Response samples

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

Личные счета

Создание операции пополнения личного счёта

Создание операции с личным счётом предполагает создание документа, транзакции с личным счётом и финансовой транзакции в рамках одного запроса к API.

Authorizations:
(beareruser)
path Parameters
salon_id
required
number

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: */*
client_id
required
number

ID клиента, владельца личного счёта

deposit_id
required
number

ID личного счёта

amount
required
number

сумма пополнения

master_id
number

ID сотрудника

account_id
required
number

ID кассы для оплаты

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Получение списка личных счетов по филиалу и клиенту

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID филиала

client_id
required
number

ID клиента

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

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

Responses

Response samples

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

Получение списка личных счетов по сети и набору фильтров

Authorizations:
(beareruser)
path Parameters
chain_id
required
number

ID сети

query Parameters
balance_from
number

Минимальный баланс для фильтрации

balance_to
number

Максимальный баланс для фильтрации

page
number

Номер страницы

limit
number

Количество элементов на странице

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

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

Responses

Response samples

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

Получение списка личных счетов по сети и номеру телефона клиента

Authorizations:
(beareruser)
path Parameters
chain_id
required
number

ID сети

phone
required
number

Номер телефона клиента

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

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

Responses

Response samples

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

Получение истории операции личного счета

Authorizations:
BearerPartnerUser
path Parameters
chain_id
required
number

ID сети

deposit_id
required
number

ID личного счета

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

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

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects
meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Response samples

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

Страны

Объект страны имеет следующие поля:

Поле Тип Описание
id number ID страны
title string Краткое название страны
full_title string Полное название страны
phone_code number Телефонный код
phone_template string Шаблон номера телефона страны
phone_example string Пример номера телефона страны
currency string Валюта
exchange float Ставка обмена валют по отношению к рублю

Получить список стран

Authorizations:
bearer
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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Города

Объект города имеет следующие поля:

Поле Тип Описание
id number ID города
title string Краткое название города
country_id number ID страны

Получить список городов

Authorizations:
bearer
query Parameters
country_id
number

ID страны, из которой нужно получить города

company_id
number

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Изображения

Загрузка изображения

Объект ответа имеет следующие поля:

Поле Тип Описание
image_binded boolean Статус привязки изображений к сущности
image_group object Объект группа изображений
Authorizations:
(beareruser)
path Parameters
entity
required
string
Example: "master"

название сущности (master/service)

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

e.g. application/vnd.yclients.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

ID салона для привязки изображения (для entity=service)

service_id
number

ID услуги для привязки изображения (для entity=service)

master_id
number

ID сотрудника для привязки изображения (для entity=master)

image
required
string

передаваемое изображение (image/jpeg, image/png)

Responses

Response Schema: application/json
object (ImageGroup)
required
object (ImageGroup)

Response samples

Content type
application/json
{}

Удаление изображений

Объект ответа имеет следующие поля:

Поле Тип Описание
success boolean Результат удаления
Authorizations:
(beareruser)
path Parameters
entity
required
string

название сущности (master/service)

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

e.g. application/vnd.yclients.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

ID группы изображения для удаления

Responses

Сети салонов

Получение доступных пользователю сетей

Объект сети салонов имеет следующие поля:

Поле Тип Описание
id number Id сети салонов
title string Название сети салонов
companies array Список салонов сети
access object Объект с правами доступа для управления сетью
Authorizations:
(beareruser)
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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

Response samples

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

Аналитика

Сводные и статистические данные

Получить основные показатели компании

Метод позволяет получить основные показатели компании за выбранный период и сравнить с предыдущим периодом той же длительности

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
date_from
required
string <date>

Дата начала анализируемого периода

date_to
required
string <date>

Дата окончания анализируемого периода (включается в отчет)

staff_id
integer

Идентификатор сотрудника компании, работу которого нужно анализировать

position_id
integer

Идентификатор должности компании для анализа работы всех сотрудников, относящихся к одной должности

user_id
integer

Идентификатор пользователя компании, работу которого нужно анализировать

Responses

Response Schema: application/json
required
object (AnalyticsReportOverallStats)

Сводные показатели

meta
required
Array of objects

Метаданные

success
required
boolean

Статус успешности выполнения (true)

Response samples

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

Получить данные о выручке в разрезе по дням

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
date_from
required
string <date>

Дата начала анализируемого периода

date_to
required
string <date>

Дата окончания анализируемого периода (включается в отчет)

staff_id
integer

Идентификатор сотрудника компании, работу которого нужно анализировать

position_id
integer

Идентификатор должности компании для анализа работы всех сотрудников, относящихся к одной должности

user_id
integer

Идентификатор пользователя компании, работу которого нужно анализировать

Responses

Response Schema: application/json
Array
label
string

Название ряда данных

data
Array of integers (AnalyticsReportOverallChartDailyRowItem) [ items <int32 >[ items <int32 > ] ]

Данные за каждый день. Каждый день - это массив из двух чисел. Первое число - timestamp начала дня в зоне UTC, второе число - значение показателя в этот день.

Response samples

Content type
application/json
[
  • {
    }
]

Получить данные о количестве записей в разрезе по дням

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
date_from
required
string <date>

Дата начала анализируемого периода

date_to
required
string <date>

Дата окончания анализируемого периода (включается в отчет)

staff_id
integer

Идентификатор сотрудника компании, работу которого нужно анализировать

user_id
integer

Идентификатор пользователя компании, работу которого нужно анализировать

Responses

Response Schema: application/json
Array
label
string

Название ряда данных

data
Array of integers (AnalyticsReportOverallChartDailyRowItem) [ items <int32 >[ items <int32 > ] ]

Данные за каждый день. Каждый день - это массив из двух чисел. Первое число - timestamp начала дня в зоне UTC, второе число - значение показателя в этот день.

Response samples

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

Получить данные о заполненности в разрезе по дням

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
date_from
required
string <date>

Дата начала анализируемого периода

date_to
required
string <date>

Дата окончания анализируемого периода (включается в отчет)

staff_id
integer

Идентификатор сотрудника компании, работу которого нужно анализировать

user_id
integer

Идентификатор пользователя компании, работу которого нужно анализировать

Responses

Response Schema: application/json
Array
label
string

Название ряда данных

data
Array of integers (AnalyticsReportOverallChartDailyRowItem) [ items <int32 >[ items <int32 > ] ]

Данные за каждый день. Каждый день - это массив из двух чисел. Первое число - timestamp начала дня в зоне UTC, второе число - значение показателя в этот день.

Response samples

Content type
application/json
[
  • {
    }
]

Получить структуру записей по источникам

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
date_from
required
string <date>

Дата начала анализируемого периода

date_to
required
string <date>

Дата окончания анализируемого периода (включается в отчет)

staff_id
integer

Идентификатор сотрудника компании, работу которого нужно анализировать

user_id
integer

Идентификатор пользователя компании, работу которого нужно анализировать

Responses

Response Schema: application/json
Array
label
string

Название показателя

data
integer

Значение показателя

Response samples

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

Получить структуру записей по статусам визитов

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
date_from
required
string <date>

Дата начала анализируемого периода

date_to
required
string <date>

Дата окончания анализируемого периода (включается в отчет)

staff_id
integer

Идентификатор сотрудника компании, работу которого нужно анализировать

user_id
integer

Идентификатор пользователя компании, работу которого нужно анализировать

Responses

Response Schema: application/json
Array
label
string

Название показателя

data
integer

Значение показателя

Response samples

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

Z-Отчет

Объект Z-Отчета имеет следующие поля:

Поле Тип Описание
stats stats Общая статистика
paids paids Оплаты
z_data z_data Данные отчета
currency string Валюта

Объект stats имеет следующие поля:

Поле Тип Описание
clients integer Количество клиентов
clients_average float Среддняя оплата по клиентам
records integer Количество записей
records_average float Среддняя оплата по записям
visit_records integer Количество записей с клиентами
visit_records_average float Среддняя оплата по записям с клиентами
non_visit_records integer Количество записей без клиентов
non_visit_records_average float Среддняя оплата по записям без клиентов
targets integer Количество услуг
targets_paid float Оплата по услугам
goods integer Количество товаров
goods_paid float Оплата по товарам
certificates integer Количество сертификатов
certificates_paid float Оплата по сертификатам
abonement integer Количество абонементов
abonement_paid float Оплата по абонементам

Объект paids имеет следующие поля:

Поле Тип Описание
accounts array of paid Оплаты в кассы
discount array of paid Оплата по скидке и лояльности
total total_paid Итог

Объект paid имеет следующие поля:

Поле Тип Описание
title string Название кассы или тип скидки/лояльности
amount float Сумма оплаты

Объект total_paid имеет следующие поля:

Поле Тип Описание
accounts float Общая сумма оплат в кассы
discount float Общая сумма скидок/лояльности

Объект z_data состоит из пар ключ-значение, где:

  • ключ - дата;

  • значение - объект client;

Объект client имеет следующие поля:

Поле Тип Описание
client_id integer ID клиента (0, если клиент не из базы)
client_name string Имя клиента
client_phone string Номер телефона клиента
client_email string Email клиента
masters array of master Сотрудники

Объект master имеет следующие поля:

Поле Тип Описание
master_id integer ID сотрудника
master_name string Имя сотрудника
service array of operation Услуги
good array of operation Товары
others operation Другие операции

Объект operation имеет следующие поля:

Поле Тип Описание
item_title string Название услуги/товара
first_cost integer Цена
discount integer Скидка
result_cost integer К оплате
transactions array of transaction Оплаты

Объект transaction имеет следующие поля:

Поле Тип Описание
accounts_amount integer Оплачено в кассу
loyalty_amount integer Оплачено по программе лояльности
payment_type string Тип оплаты

Получить данные Z-Отчета

  • start_date: Дата отчета

  • master_id: ID сотрудника

Authorizations:
(beareruser)
path Parameters
company_id
required
integer

ID компании

query Parameters
start_date
string
Example: start_date=''

дата начала периода

master_id
integer
Example: master_id=0

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Дополнительные поля

Описание функционала и объекты API

Описание

Дополнительные поля позволяют добавлять к отдельным объектам системы свойства заданного типа и впоследствии привязывать к этим полям значения, соответствующие данному типу. На данный момент функционал реализован для Записей и Клиентов.

Объекты Дополнительных полей:

Поле Тип Описание
code string Код поля по которому устанавливаются значения для полей записи
id integer Уникальный идентификатор поля
type CustomFieldType Тип поля
show_in_ui boolean Показывать ли поле в интерфейсе
title string Название поля
user_can_edit boolean Можно ли редактировать в интерфейсе
values array or null Список допустимых значений для типа "список"

На данный момент поддерживаются следующие типы (поле code):

  • text - строка длиной до 255 символов

  • number - число

  • select - список

  • date - Дата (Y-m-d)

  • datetime - Дата и время (Y-m-d H:i:s)

Следующие коды полей являются зарезервированными:

code type Описание
yc_partner_public_key text Используется для определения партнера при создании записи, является более приоритетным, чем Bearer-токен из авторизации

Получение коллекции полей филиала

Authorizations:
(beareruser)
path Parameters
field_category
required
string
Example: record

Категория полей.

  • Для записей - record

  • Для клиентов - client

company_id
required
integer

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Добавление дополнительного поля

Для добавления поля пользователь должен быть добавлен в связанной с филиалом сети, и иметь права доступа в разделе:
Настройки - Доступ к разделу Дополнительные поля - Создание доп. полей

Authorizations:
(beareruser)
path Parameters
field_category
required
string
Example: record

Категория полей.

  • Для записей - record

  • Для клиентов - client

company_id
required
integer

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
type
required
string

Тип поля

code
required
string

Идентификатор поля

title
required
string

Название поля

user_can_edit
required
boolean

Может ли пользователь редактировать поле

show_in_ui
required
boolean

Показывать ли поле в интерфейсе

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "type": "text",
  • "code": "my_text_field",
  • "title": "поле для теста",
  • "user_can_edit": true,
  • "show_in_ui": true
}

Response samples

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

Обновление дополнительного поля

Для добавления поля пользователь должен быть добавлен в связанной с филиалом сети, и иметь права доступа в разделе:
Настройки - Доступ к разделу Дополнительные поля - Изменение доп. полей

path Parameters
field_category
required
string
Example: record

Категория полей.

  • Для записей - record

  • Для клиентов - client

company_id
required
integer

ID компании

field_id
required
integer

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
type
required
string

Тип поля

code
required
string

Идентификатор поля

title
required
string

Название поля

user_can_edit
required
boolean

Может ли пользователь редактировать поле

show_in_ui
required
boolean

Показывать ли поле в интерфейсе

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

Content type
application/json
{
  • "type": "text",
  • "code": "my_text_field",
  • "title": "поле для теста",
  • "user_can_edit": true,
  • "show_in_ui": true
}

Response samples

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

Удаление дополнительного поля из филиала

Для добавления поля пользователь должен быть добавлен в связанной с филиалом сети, и иметь права доступа в разделе:
Настройки - Доступ к разделу Дополнительные поля - Удаление доп. полей

Authorizations:
(beareruser)
path Parameters
field_category
required
string
Example: record

Категория полей.

  • Для записей - record

  • Для клиентов - client

company_id
required
integer

ID компании

field_id
required
integer

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Отправка СМС через операторов

Описание функционала и объекты API

Для отправки SMS, оператору необходимо предоставить адрес (url_operator), на который будут уходить запросы описанные ниже. Авторизация запросов к API производится в соответствии с RFC 6749 "Resource Owner Password Credentials Grant". При запросах к API в HTTP заголовок Authorization должен быть включен ключ доступа в следущем формате: Ключ авторизации (partner_token) должен быть указан в настройках модуля уведомлений компании.

Authorization: Bearer <partner token>

Отправка СМС

Отправка СМС

В случае ошибки возвращается ее HTTP-код. В некоторых случаях также возвращается текстовое описание ошибки. Все методы API могут возвращать следующие коды ошибок:

Error code Http status code Название Описание
5 400 ENTITY_VALIDATION_ERROR Тело запроса не прошло валидацию
10 400 FIELD_VALIDATION_ERROR Параметр не прошел валидацию
32 200 FIELD_VALIDATION_ERROR Недостаточно средств
15 403 ACCESS_FORBIDDEN Действие недоступно, у приложения нет требуемых разрешений.
20 401 INVALID_PARTNER_TOKEN partner_token отсутствует или невалиден
30 404 RESOURCE_NOT_FOUND Ресурс по запрошенному пути не существует
Authorizations:
bearer
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

Request Body schema: */*
destination_params
required
object

обьект, содержащий параметры ИД отправки и номер телефона

from
required
string

имя отправителя

text
required
string

текст отправления

channel
required
string
Enum: "whatsapp" "sms"

Канал отправки

dispatch_type
required
string

тип рассылки (service - сервисная, adds - рекламная)

delivery_callback_url
required
string

url, на который приходят статусы сообщений

Responses

Response samples

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

Получение статусов сообщений

Получение статусов сообщений

Номер Название
1 Доставлено
2 Не доставлено
4 Отправлено на телефон
8 Передано оператору
16 Отклонено оператором
52 Недостаточно средств

В случае ошибки возвращается ее HTTP-код. В некоторых случаях также возвращается текстовое описание ошибки. Все методы API могут возвращать следующие коды ошибок:

Error code Http status code Название Описание
5 400 ENTITY_VALIDATION_ERROR Тело запроса не прошло валидацию
10 400 FIELD_VALIDATION_ERROR Параметр не прошел валидацию
15 403 ACCESS_FORBIDDEN Действие недоступно, у приложения нет требуемых разрешений.
20 401 INVALID_PARTNER_TOKEN partner_token отсутствует или невалиден
30 404 RESOURCE_NOT_FOUND Ресурс по запрошенному пути не существует

При отправке смс в запросе передается атрибут delivery_callback_url - это url, на который должны приходить статусы сообщений.

Используйте его для отправки статусов сообщений. Url, на который должны приходить статусы сообщений - https://yclients.com/smsprovider/status/callback/{partner_token}

Authorizations:
bearer
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

Request Body schema: application/json
Array
id
string

Идентификатор

status
number

Статус сообщения

payment_sum
number

Полная стоимость сообщения

currency_iso
string

ISO валюты платежа (например: RUB, EUR, BYN)

parts_amount
number

Количество частей сообщения

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

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

Лицензии

При наличии лицензии у компании объект лицензии имеет следующие поля:

Поле Тип Описание
id number ID лицензии
salon_id number ID компании
staff_limit number Количество сотрудников (0 - не ограничено)
deactivation_date string Дата деактивации
start_date string Дата начала лицензии
name string Название тарифа лицензии
active boolean Активность
options array Массив подключенных опций

Получение информация о лицензии компании

Authorizations:
(beareruser)
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
object (LicenseOption)
active
required
number

Активна ли лицензия

deactivation_date
required
string

Дата окончания срока действия лицензии

id
required
number

Идентификатор лицензии

name
required
string

Наименование лицезнии

options
required
Array of objects

Опции лицензии

salon_id
required
number

Идентификатор компании

staff_limit
required
number

Лимит сотрудников

start_date
required
string

Дата начала срока действия лицензии

Response samples

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

Правила обработки персональных данных

В соответствии с Федеральным законом №152-ФЗ «О персональных данных» от 27.07.2006 г. компании могут заполнить текст согласия на обработку персональных данных. Текст согласия отображается перед непосредственным подтверждением записи.

Получение информация о правилах обработки персональных данных компании

Authorizations:
bearer
path Parameters
company_id
required
number

Идентификатор компании

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

Responses

Response samples

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

Валидация данных

Проверка формата номера телефона

Происходит проверка переданного номера телефона на соответствие правилам YCLIENTS.

Authorizations:
(beareruser)
path Parameters
phone
required
string

Проверяемый номер телефона в формате +71234567890 или 71234567890

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 samples

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

Фискализация чеков

Система YCLIENTS позволяет партнерам реализовывать API фискализации чеков. В систему добавляется партнер, реализовавший этот API. После этого у тех пользователей YCLIENTS, которые находятся в той же стране, что и партнер, появляется возможность выбрать этого партнера в списке возможных решений для фискализации чеков. Для того, чтобы партнер был добавлен в список возможных решений, он должен связаться с YCLIENTS посредством email: partner@yclients.tech.

YCLIENTS создает документ продажи, и отправляет его на сервер фискализации по адресу, указанному партнером. Отвечая на HTTP-запрос, сервер фискализации должен вернуть HTTP-ответ со статусом 200 в том случае, если документ успешно получен и передан в обработку, либо со статусом 400 в случае ошибки. Тело ответа должно содержать данные определенного формата, описывающие текущий статус документа. При обновлении статуса сервер фискализации должен отправить callback запрос с данными того же формата.

Документ продажи имеет следующую структуру:

  • Структура документа (json):

      {
          "id": "d72fece5-6825-4895-9395-0133195612a4",
          "date": "2020-07-31T14:11:36+04:00",
          "document_id": 239083104,
          "type": "sale",
          "print_receipt": true,
          "customer": {
              "email": "[email protected]",
              "phone": "91111111111"
          },
          "positions": [
              {
                  "type": "service",
                  "title": "Consultation",
                  "price": 10.5,
                  "quantity": 1.0,
                  "discount_amount": 2.5,
                  "vat": "ru_vat_10",
                  "payment_method": "payment",
                  "barcode": "12345"
              }
          ],
          "payments": [
              {
                  "type": "card",
                  "sum": 5.5
              },
              {
                  "type": "cash",
                  "sum": 4.5
              },
              {
                  "type": "prepaid",
                  "sum": 0.5
              }
          ],
          "tax": "ru_osn",
          "cashier": {
              "uid": "4895-9395-0133195612a4",
              "name": "John Smith",
              "position": "Cashier"
          },
          "pos": {
              "enabled": true,
              "slip_count": 2
          },
          "callback_url": "https://yclients.com/api/v1/integration/kkm/callback/",
          "custom_text": "some custom text"
      }
    

Описание полей структуры документа:

Поле Тип Описание
id integer Уникальный идентификатор документа продажи
date string Дата и время отправки документа на печать (в формате ISO-8601)
document_id integer Внутренний идентификатор документа в системе YCLIENTS
type enum(string) Тип документа (список возможных значений)
print_receipt boolean Печатать ли бумажный чек на кассе при фискализации
customer object(Customer) Сущность клиента
positions Array of objects(Position[]) Список позиций в чеке
payments Array of objects(Payment[]) Список оплат, применяемых на чек
tax enum(string) Тип системы налогообложения (slug из списка систем налогообложения)
cashier object(Cashier) Сущность кассира
pos object(POS) Опции для подключенного POS-терминала
callback_url string Ссылка для обновления статуса фискализации
custom_text string | null Произвольный текст для печати на чеке

Тип документа

Значение Описание
sale Приход
return Возврат прихода

Сущность клиента имеет следующую структуру:

Поле Тип Описание
email string | null E-mail клиента
phone string | null Телефон клиента

Позиция в чеке имеет следующую структуру:

Поле Тип Описание
type enum(string) Тип позиции ("service" — услуга / "commodity" — товар / "payment" — платеж)
title string Название позиции
price float Цена позиции с точностью 2 знака после запятой
quantity float Количество
discount_amount float Скидка, примененная к позиции с точностью 2 знака после запятой
vat enum(string) Тип НДС (slug из списка НДС)
payment_method enum(string) Признак расчета ("payment" — оплата / "prepayment" — предоплата)
barcode string | null Штрихкод товара

Оплата, применяемая на чек, имеет следующую структуру:

Поле Тип Описание
type enum(string) Тип оплаты ("card" - безналичная оплата / "cash" — оплата наличными / "prepaid" — предварительная оплата)
sum float Сумма оплаты с точностью 2 знака после запятой

Сущность кассира имеет следующую структуру:

Поле Тип Описание
id string Уникальный идентификатор кассира
name string Имя кассира
position string Должность кассира (максимальная длина строки – 64 символа)

Опции для подключенного POS-терминала имеет следующую структуру:

Поле Тип Описание
enabled boolean Надо ли перед фискализацией принять карту через POS-терминал
slip_count integer Количество чеков, которые необходимо распечатать после успешной транзакции по POS-терминалу

Ответ, описывающий текущий статус документа, должен содержать идентификатор документа, текущий статус фискализации, соответствующий статусу код ответа, а также произвольное сообщение, которое может быть показано пользователю или использовано для отладки (например, сообщние об ошибке).

Ответ должен иметь следующую структуру:

  • Структура ответа (json):

      {
          "id": "d72fece5-6825-4895-9395-0133195612a4",
          "status": "error",
          "code": 2002,
          "message": "Кассовое оборудование недоступно по причине..."
      }
    

Описание полей структуры ответа:

Поле Тип Описание
id integer Уникальный идентификатор документа продажи
status enum(string) Статус печати чека (список возможных значений)
code enum(integer) Код ошибки (список возможных значений)
message string Детальное сообщние, которое может быть показано пользователю (например, сообщние об ошибке)

Статус печати чека

Статус pending должен быть отправлен в ответ на запрос фискализации документа в том случае, если документ успешно получен и находится в обработке. Статус success может быть отправлен в callback только при обновлении статуса документа, уже находящегося в статусе pending. В случае ошибки статус error может быть отправлен как в ответ на запрос фискализации документа, так и в callback

Значение Описание
success Документ успешно фискализирован (отрпавляется в callback)
pending Документ получен и находится в обработке (отправляется в ответ на запрос фискализации документа)
error Произошла ошибка

Код ошибки (код результата обработки запроса)

Значение Соответсвует статусу Описание
0 "success" | "pending" Без ошибок
1001 "error" Ошибка данных документа
1002 "error" Ошибка в позициях документа
1003 "error" Ошибка в оплатах документа
1004 "error" Ошибка в данных клиента
1005 "error" Ошибка в данных кассира
2001 "error" Ошибка кассового оборудования
2002 "error" Кассовое оборудование недоступно

Пример запроса на фискализацию документа

Authorizations:
bearer
header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer partner_token

Request Body schema: application/json
id
string

Уникальный идентификатор документа продажи

date
string <date-time>

Дата и время отправки документа на печать (в формате ISO-8601)

document_id
integer <int32>

Внутренний идентификатор документа в системе YCLIENTS

type
string
Enum: "sale" "return"

Тип документа (список возможных значений)

print_receipt
boolean

Печатать ли бумажный чек на кассе при фискализации

object

Сущность клиента

Array of objects

Список позиций в чеке

Array of objects

Список оплат, применяемых на чек

tax
string

Тип системы налогообложения (slug из списка систем налогообложения)

object

Сущность кассира

object

Опции для подключенного POS-терминала

callback_url
string

Ссылка для обновления статуса фискализации

custom_text
string

Произвольный текст для печати на чеке

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": {
    },
  • "custom_text": "some custom text"
}

Response samples

Content type
application/json
{
  • "id": "d72fece5-6825-4895-9395-0133195612a4",
  • "status": "success",
  • "code": 0,
  • "message": "OK"
}

Пример запроса на получение списка

Список доступных для страны систем налогообложения и НДС можно получить, сделав запрос с указанием идентификатора страны, для которой необходимо получить список. Идентификатор страны можно получить из списка стран.

Список представляет собой массив систем налогообложения со вложенным массивом НДС для каждой системы налогообложения.

Cистема налогообложения имеет следующую структуру:

Поле Тип Описание
title string Название системы налогообложения
slug string Кодовое название системы налогообложения
vats Array of objects(Vat[]) Список доступных НДС для системы налогообложения

НДС имеет следующую структуру:

Поле Тип Описание
title string Название НДС
slug string Кодовое название НДС
Authorizations:
bearer
path Parameters
countryId
required
number
Example: 1

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

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных систем налогообложения)

Response samples

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

Пример запроса в случае успешной фискализации или в случае ошибка

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

e.g. application/vnd.yclients.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
{ }

Отзывы и чаевые

После визита клиенту отправляется ссылка на форму отзыва, где он может оценить качество оказанных услуг и оставить чаевые мастеру, если у него подключен кошелек

Получение статуса формы отзыва

Authorizations:
bearer
path Parameters
recordToken
required
string

Короткий токен записи

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

Content type
application/json
{}

Отправка формы отзыва

Authorizations:
(beareruser)
path Parameters
recordToken
required
string

Короткий токен записи

Request Body schema: application/json
rating
required
integer <int32>

Оценка, выставляемая за отзыв (кол-во звезд от 1 до 5)

text
string

Текст отзыва

tips_amount
number <double>

Сумма чаевых

redirect_prefix
string

Префиксная часть url, на который будет выполнен редирект после возврата с формы оплаты

Responses

Request samples

Content type
application/json
{
  • "rating": 5,
  • "text": "Отличный мастер!",
  • "tips_amount": 22.5,
  • "redirect_prefix": "https://n1.yclients.com"
}

Response samples

Content type
application/json
{}

Ресурсы

Для управления ресурсами используются следующие методы

Получение ресурсов в филиале

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

query Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив с объектами данных

object

Метаданные (содержит количество найденных ресурсов)

Response samples

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

Расчёт зарплат

Описание методов для работы с расчётом зарплат.

Поиск начислений по сотруднику

Метод позволяет владельцу получить список начислений зарплаты по сотруднику.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

query Parameters
date_from
required
string
Example: date_from=2023-03-01

Дата начала периода.

date_to
required
string
Example: date_to=2023-03-31

Дата окончания периода.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects (Взаиморасчёты)
object (Объект дополнительной информации о запросе с кол-вом найденных результатов)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Response samples

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

Получение данных о начислении по сотруднику

Метод позволяет владельцу получить подробную информацию о конкретном начислении зарплаты.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

calculation_id
required
number
Example: 789

Идентификатор начисления зарплаты.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект начисления заработной платы с подробной информацией)
meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Получение количества схем расчёта зарплат у сотрудника

Метод позволяет получить количество схем расчёта зарплат по сотруднику перед тем, как запрашивать данные о суммах.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Количество прикреплённых схем расчёта зарплат)
meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Получение взаиморасчётов с сотрудником

Метод позволяет владельцу получить взаиморасчёты с сотрудником.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

query Parameters
date_from
required
string
Example: date_from=2023-03-01

Дата начала периода.

date_to
required
string
Example: date_to=2023-03-31

Дата окончания периода.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Взаиморасчёты)

Взаиморасчёты.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Response samples

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

Получение взаиморасчётов с сотрудником в разрезе по дате

Метод позволяет владельцу получить взаиморасчёты с сотрудником с группировкой по дате.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

query Parameters
date_from
required
string
Example: date_from=2023-03-01

Дата начала периода.

date_to
required
string
Example: date_to=2023-03-31

Дата окончания периода.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Взаиморасчёты с группировкой по дате)

Взаиморасчёты с группировкой по дате.

object (Объект дополнительной информации о запросе с кол-вом найденных результатов)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Response samples

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

Получение расчёта зарплаты за период по сотруднику

Метод позволяет владельцу получить расчёт зарплаты за период по сотруднику.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

query Parameters
date_from
required
string
Example: date_from=2023-03-01

Дата начала периода.

date_to
required
string
Example: date_to=2023-03-31

Дата окончания периода.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Взаиморасчёты)

Взаиморасчёты.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Response samples

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

Получение расчёта зарплаты за период по сотруднику в разрезе по дате

Метод позволяет владельцу получить расчёт зарплаты за период по сотруднику с группировкой по дате.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

query Parameters
date_from
required
string
Example: date_from=2023-03-01

Дата начала периода.

date_to
required
string
Example: date_to=2023-03-31

Дата окончания периода.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Расчёт за период по конкретному сотруднику с группировкой по дате)

Получение расчёта за период по конкретному сотруднику с группировкой по дате.

object (Объект дополнительной информации о запросе с кол-вом найденных результатов)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Response samples

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

Получение собственных взаиморасчётов сотрудника с филиалом

Метод позволяет получить собственные взаиморасчёты сотрудника с филиалом. В правах доступа пользователя должна быть указана галочка "Доступ к расчёту заработной платы только конкретного сотрудника".

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

query Parameters
date_from
required
string
Example: date_from=2023-03-01

Дата начала периода.

date_to
required
string
Example: date_to=2023-03-31

Дата окончания периода.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Взаиморасчёты)

Взаиморасчёты.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Response samples

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

Получение собственных схем расчёта зарплат

Метод позволяет получить собственные схемы расчёта зарплат. В правах доступа пользователя должна быть указана галочка "Доступ к расчёту заработной платы только конкретного сотрудника".

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects (Объект схемы расчёта зарплаты)
object (Объект дополнительной информации о запросе с кол-вом найденных результатов)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Получение расчёта собственной зарплаты за период

Метод позволяет получить расчёт собственной зарплаты за период. В правах доступа пользователя должна быть указана галочка "Доступ к расчёту заработной платы только конкретного сотрудника".

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

staff_id
required
number
Example: 123

Идентификатор сотрудника филиала.

query Parameters
date_from
required
string
Example: date_from=2023-03-01

Дата начала периода.

date_to
required
string
Example: date_to=2023-03-31

Дата окончания периода.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Расчёт за период по конкретному сотруднику)

Получение расчёта за период по конкретному сотруднику.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Response samples

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

Уведомления

В этом разделе расположены методы для получения и изменения настроек уведомлений.

Объекты имееют следующие поля:

Поле Тип Описание
mode string Тип уведомления, выбранный у пользователя ("admin", "staff", "disabled")
record_create_online_staff string Уведомление сотруднику об онлайн-записи
record_create_offline_staff string Уведомление сотруднику об офлайн-записи
record_delete_staff string Уведомление сотруднику об удалении записи через Интернет
record_move_staff string Уведомление сотруднику о переносе записи через Интернет
record_create_online_admin string Уведомление администратору об онлайн-записи
record_create_offline_admin string Уведомление администратору об офлайн-записи
record_delete_admin string Уведомление администратору об удалении записи через Интернет
record_move_admin string Уведомление администратору о переносе записи через Интернет
license_expire string Уведомление сотруднику/администратору об окончании лицензии

Получить настройки уведомлений в филиале

Метод позволяет получить настройки уведомлений в филиале.

Authorizations:
(userbearer)
path Parameters
company_id
required
number

Идентификатор компании

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer bearer_token, USer user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения

Array of objects

Массив объектов

object

Метаданные (содержит количество объектов)

Response samples

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

Получить настройки уведомлений пользователя

Метод позволяет получить настройки уведомлений конкретного пользователя филиала.

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

user_id
required
number

Идентификатор пользователя

header Parameters
Accept
required
string

application/vnd.yclients.v2+json

Content-Type
required
string

application/json

Authorization
required
string

Bearer bearer_token, User user_token

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Response samples

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

Изменить настройки PUSH-уведомлений пользователя

Метод позволяет изменить настройки PUSH-уведомлений пользователя. Выбирать тип уведомления для изменения (record_create_online_staff или record_create_online_admin и т.д.) следует исходя их указанного типа уведомления у пользователя (mode: admin или mode: staff)

Authorizations:
(beareruser)
path Parameters
company_id
required
number

Идентификатор компании

user_id
required
number

Идентификатор пользователя

header Parameters
Accept
required
string

application/vnd.yclients.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

Массив объектов

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения

object

Объект с данными

meta
Array of objects

Метаданные (пустой массив)

Request samples

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

Response samples

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

Настройки онлайн-записи

Получение настроек онлайн-записи

Authorizations:
(beareruser)
header Parameters
Accept
required
string

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

Authorization
required
string

Bearer partner_token, User user_token

Content-Type
required
string

application/json

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object (Root Type for company_get_online_settings_response_data_field_data_types)
meta
Array of objects

Метаданные

Response samples

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

Обновление настроек онлайн-записи

Authorizations:
(beareruser)
header Parameters
Accept
required
string

e.g. application/vnd.yclients.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

Подтверждать номер клиента по SMS

any_master
required
boolean

Режим "Любой сотрудник"

seance_delay_step
required
integer [ 0 .. 1380 ]

Задержка до ближайшего сеанса, в минутах от 0 до 23 часов (включительно) с шагом 30 минут

activity_online_record_clients_count_max
required
integer [ 1 .. 255 ]

Максимальное количество мест в одной записи события

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object (Root Type for company_get_online_settings_response_data_field_data_types)
meta
Array of objects

Метаданные

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": [ ]
}

Настройки журнала записи

Получение настроек журнала записи

Authorizations:
(beareruser)
header Parameters
Accept
required
string

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

Authorization
required
string

Bearer partner_token, User user_token

Content-Type
required
string

application/json

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object (Root Type for company_get_timetable_settings_response_data_field_data_types)
meta
Array of objects

Метаданные

Response samples

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

Обновление настроек журнала записи

Authorizations:
(beareruser)
header Parameters
Accept
required
string

e.g. application/vnd.yclients.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 ]

Тип записи по умолчанию: 0 - Смешанная запись, 1 - Индивидуальная запись, 2 - Групповая запись

activity_record_clients_count_max
required
integer [ 1 .. 255 ]

Максимальное количество мест в одной записи события

Responses

Response Schema: application/json
success
boolean

Статус успешности выполнения (true)

object (Root Type for company_get_timetable_settings_response_data_field_data_types)
meta
Array of objects

Метаданные

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": [ ]
}

Настройки букформы

Получить список букформ

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

header Parameters
Accept
required
string

e.g. application/vnd.yclients.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": [ ]
}

Создать букформу

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

header Parameters
Accept
required
string

e.g. application/vnd.yclients.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

Название букформы

description
string
Default: ""

Описание букформы

is_default
boolean
Default: false

Флаг дефолтной букформы

without_menu
boolean
Default: false

Флаг пошагового режима

service_step_default
number

ID услуги

service_step_hide
boolean
Default: false

Флаг скрытия услуги

master_step_default
number

ID мастера

master_step_hide
boolean
Default: false

Флаг скрытия мастера

service_step_num
number

Порядковый номер шага услуги

master_step_num
number

Порядковый номер шага мастера

datetime_step_num
number

Порядковый номер шага даты и времени

show_button
boolean
Default: true

Флаг включения видимости кнопки

button_position
string
Default: "bottom right"
Enum: "bottom right" "bottom left" "top right" "top left "

Расположение кнопки на странице

form_position
string
Default: "right"
Enum: "right" "left"

Расположение панели на странице

button_color
string
Default: "#1c84c6"

Цвет кнопки

button_animation
boolean
Default: true

Флаг включения анимации кнопки

Responses

Response Schema: application/json
required
object (Root Type BookformSettingsResponse)

Настройки букформы

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": [ ]
}

Получить букформу

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

form_id
required
number

ID букформы

header Parameters
Accept
required
string

e.g. application/vnd.yclients.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)

Настройки букформы

meta
required
Array of objects

Metadata

success
required
boolean

Success status (true)

Response samples

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

Удалить букформу

path Parameters
company_id
required
number

ID компании

form_id
required
number

ID букформы

header Parameters
Accept
required
string

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

Authorization
required
string

Bearer partner_token, User user_token

Content-Type
required
string

application/json

Responses

Изменить букформу

Authorizations:
(beareruser)
path Parameters
company_id
required
number

ID компании

form_id
required
number

ID букформы

header Parameters
Accept
required
string

e.g. application/vnd.yclients.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

Название букформы

description
required
string

Описание букформы

is_default
required
boolean

Флаг дефолтной букформы

without_menu
required
boolean

Флаг пошагового режима

service_step_default
required
number

ID услуги

service_step_hide
required
boolean

Флаг скрытия услуги

master_step_default
required
number

ID мастера

master_step_hide
required
boolean

Флаг скрытия мастера

service_step_num
required
number

Порядковый номер шага услуги

master_step_num
required
number

Порядковый номер шага мастера

datetime_step_num
required
number

Порядковый номер шага даты и времени

show_button
required
boolean

Шаг включения видимости кнопки

button_position
required
string
Enum: "bottom right" "bottom left" "top right" "top left"

Расположение кнопки на странице

form_position
required
string
Enum: "right" "left"

Расположение панели на странице

button_color
required
string

Цвет кнопки

button_animation
required
boolean

Флаг включения анимации кнопки

Responses

Response Schema: application/json
required
object (Root Type BookformSettingsResponse)

Настройки букформы

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": [ ]
}

Расписания записей/событий

С помощью расписания можно удобно настроить повторения индивидуальных записей (пока не поддерживается) или групповых событий. В рамках расписания можно настроить несколько серий по одному конкретно взятому дню недели, и настроить параметры этих серий под определенные нужды. В рамках разных серий расписания можно настроить разных сотрудников, оказывающих услуги, разные категории и ресурсы для этих сущностей и прочее.

Поиск расписания по сущности

Осуществляет поиск расписания по записи или событию, принадлежащему расписанию или на основе которого расписание было построено.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

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

Тип сущности, для которой осуществляется поиск расписания:
record - индивидуальная запись, не поддерживается в текущий момент;
activity - групповое событие.

entity_id
required
number
Example: 123

Идентификатор сущности, для которой осуществляется поиск расписания.

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

Набор сущностей, которые должны быть включены в ответ.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Расписание")

Данные по существующему в филиале расписанию записей или событий.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Создание расписания

Создает расписание записей или событий, основываясь на исходной записи или событии.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

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

Набор сущностей, которые должны быть включены в ответ.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

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

Тип сущности, на основе которой будет построено расписание:
record - индивидуальная запись, не поддерживается в текущий момент;
activity - групповое событие.

original_entity_id
required
number

Идентификатор сущности, на основе которой будет построено расписание.

date_end
required
string <date>

Дата окончания расписания.

required
Array of objects [ 1 .. 7 ] items

Настройки серий расписания, минимально 1 серия, максимально 7 серий (серия соответствует дню недели).

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Расписание")

Данные по существующему в филиале расписанию записей или событий.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

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": { }
}

Обновление расписания

Обновляет настройки расписания записей или событий.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

schedule_id
required
number
Example: 123

Идентификатор расписания.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

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

Дата окончания расписания.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Расписание")

Данные по существующему в филиале расписанию записей или событий.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

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

Response samples

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

Удаление расписания

Полностью удаляет расписание и все записи или события, привязанные к нему.

path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

schedule_id
required
number
Example: 123

Идентификатор расписания.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Создание серии расписания

Добавляет к существующему расписанию записей или событий новую серию.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

schedule_id
required
number
Example: 123

Идентификатор расписания.

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

Набор сущностей, которые должны быть включены в ответ.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

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

День недели серии расписания.

events_master_id
required
number

Идентификатор сотрудника, оказывающего услуги в рамках серии расписания.

events_time
required
string

Время начала записей или событий в рамках серии расписания (в формате HH:MM:SS).

events_duration
required
number

Длительность записей или событий в рамках серии расписания (в секундах).

events_capacity
required
number

Вместимость событий в рамках серии расписания (для записей значение должно быть равно 1).

labels_ids
Array of numbers

Идентификаторы категорий, привязанных к записям или событиям в рамках серии расписания.

resource_instances_ids
Array of numbers

Идентификаторы экземпляров ресурсов, привязанных к записям или событиям в рамках серии расписания.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Серия Расписания")

Данные по существующей в филиале серии расписания.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

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": { }
}

Обновление серии расписания

Обновляет настройки серии расписания записей или событий.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

schedule_id
required
number
Example: 123

Идентификатор расписания.

day_id
required
number
Example: 123

Идентификатор серии расписания.

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

Набор сущностей, которые должны быть включены в ответ.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
force
required
boolean

Флаг переопределения ручных изменений в записях/событиях при обновлении серии расписания.

events_master_id
number

Идентификатор сотрудника, оказывающего услуги в рамках серии расписания.

events_time
string

Время начала записей или событий в рамках серии расписания (в формате HH:MM:SS).

events_duration
number

Длительность записей или событий в рамках серии расписания (в секундах).

events_capacity
number

Вместимость событий в рамках серии расписания (для записей значение должно быть равно 1).

labels_ids
Array of numbers

Идентификаторы категорий, привязанных к записям или событиям в рамках серии расписания.

resource_instances_ids
Array of numbers

Идентификаторы экземпляров ресурсов, привязанных к записям или событиям в рамках серии расписания.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "Серия Расписания")

Данные по существующей в филиале серии расписания.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

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": { }
}

Удаление серии расписания

Полностью удаляет серию расписания и все записи или события, привязанные к нему.

path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

schedule_id
required
number
Example: 123

Идентификатор расписания.

day_id
required
number
Example: 123

Идентификатор серии расписания.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Получение списка сущностей записей/событий в рамках серии расписания

Выводит список сущностей записей или событий, созданных в рамках серии расписания.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

schedule_id
required
number
Example: 123

Идентификатор расписания.

day_id
required
number
Example: 123

Идентификатор серии расписания.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects (Объект модели "Сущность записи/события в Расписании")
object (Объект дополнительной информации о запросе с кол-вом найденных результатов)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Создание графика посещений клиента

Создает график посещений клиента, представляющий собой набор записей на события расписания.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

schedule_id
required
number
Example: 123

Идентификатор расписания.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Request Body schema: application/json
client_id
required
number

Идентификатор клиента, для которого будет создан график посещений.

comer_id
number

Идентификатор посетителя клиента, для которого будет создан график посещений.

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

Идентификаторы серий расписания, минимально 1 серия, максимально 7 серий.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "График посещений клиента")

Данные по существующему в филиале графику посещений клиента.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

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": { }
}

Обновление графика посещений клиента

Обновляет график посещений клиента, прикрепляя или открепляя серии расписания, что вызывает создание новых или удаление существующих записей клиента в будущих событиях расписания.

Authorizations:
BearerPartnerUser
path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

schedule_id
required
number
Example: 123

Идентификатор расписания.

client_schedule_id
required
number
Example: 123

Идентификатор графика посещений клиента.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

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

Идентификаторы серий расписания, минимально 1 серия, максимально 7 серий.

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object (Объект модели "График посещений клиента")

Данные по существующему в филиале графику посещений клиента.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

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

Response samples

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

Удаление графика посещений клиента

Полностью удаляет график посещений клиента и все записи данного клиента в рамках будущих событий расписания.

path Parameters
company_id
required
number
Example: 123

Идентификатор филиала.

schedule_id
required
number
Example: 123

Идентификатор расписания.

client_schedule_id
required
number
Example: 123

Идентификатор графика посещений клиента.

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

Должен быть равен application/vnd.yclients.v2+json

Content-Type
required
string
Example: application/json

Должен быть равен application/json

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Маркетплейс

Настройка уведомлений в визарде внутри витрины уведомлений проходит в несколько этапов

  • Компания-партнер должна передать всю необходимую информацию для технической реализации интеграции: домен, адрес для регистрации пользователя, адрес для получения коллбеков по событиям.
  • Пользователь YCLIENTS подтверждает согласие с условиями интеграции, происходит редирект на страницу регистрации в сервисе партнера. К роуту мы добавляем GET параметр salon_id, в котором хранится ID филиала, запросившего регистрацию.
  • После регистрации необходимо отправить пользователя обратно в YCLIENTS, переадресовав на соответствующий роут.
  • При успешной оплате услуг сервиса, необходимо уведомить YCLIENTS, послав пинг на соответствующий роут.

Адрес для редиректа пользователя после регистрации в сервисе-партнере

На этот адрес необходимо перенаправить пользователя в браузере после прохождения регистрации с данными, которые необходимы сервису-партнеру

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

Идентификатор филиала.

application_id
required
number

Идентификатор приложения (выдается после создания в витрине YCLIENTS).

api_key
number

API-ключ для отправки уведомлений.

webhook_urls
Array of strings

Массив адресов вебхуков.

Responses

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

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": {
    }
}

Установка приложения для филиала

На этот адрес необходимо направить настройки интеграции сервиса-партнера, после чего будет произведена настройка и установка приложения в филиале

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

Идентификатор филиала.

application_id
required
number

Идентификатор приложения (выдается после создания в витрине YCLIENTS).

api_key
number

API-ключ для отправки уведомлений.

webhook_urls
Array of strings

Массив адресов вебхуков.

channels
Array of strings
Items Enum: "sms" "whatsapp"

Каналы, по которым доступна отправка уведомлений (только для приложений из категорий Чат-Боты и СМС-агрегаторы).

Responses

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

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

Response samples

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

Уведомление YCLIENTS об успешном платеже

На данный адрес необходимо присылать webhook-уведомление об успешной оплате услуг на стороне сервиса-партнера

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

Идентификатор филиала.

application_id
required
number

Идентификатор приложения (выдается после создания в витрине YCLIENTS).

payment_sum
required
number

Сумма платежа.

currency_iso
required
string

ISO валюты платежа (например: RUB, EUR, BYN)

payment_date
required
string

Дата и время платежа.

period_from
required
string

Дата, с которой начинается оплаченный период (включительно).

period_to
required
string

Дата, которой заканчивается оплаченный период (включительно).

Responses

Response Schema: application/json
success
boolean (Статус запроса.)

Статус запроса.

object

Данные по запросу.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "payment_sum": 990.99,
  • "currency_iso": "RUB",
  • "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": {
    }
}

Оповещение YCLIENTS о доступных именах отправителя SMS-сообщений

Этот адрес предназначен для отправки в YCLIENTS доступных пользователю именах отправителя SMS-сообщений. Пользователь будет иметь возможность выбрать любое доступное из переданных

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

Идентификатор филиала.

application_id
required
number

Идентификатор приложения (выдается после создания в витрине YCLIENTS).

short_names
required
Array of strings

Массив коротких имен отправителя SMS-сообщений

Responses

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

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": {
    }
}

Уведомление о возврате платежа

Адрес предназначен для уведомления YCLIENTS о возврате платежа

Authorizations:
bearer
path Parameters
payment_id
required
number
Example: 123

Идентификатор платежа для отмены.

Responses

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Response samples

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

Вебхук из YCLIENTS о событиях

Это не действующий эндпойнт. Здесь описывается отправка вебхуков из YCLIENTS при возникновении определенных событий в процессе жизненного цикла "приложение - салон". В данный момент доступны события к получению:

  • uninstall - событие отправляется при отключении приложения на стороне YCLIENTS.
  • freeze - событие отправляется при заморозке интеграции вследствие экспирации.

Настроить адрес для получения вебхуков можно в личном кабинете разработчика YCLIENTS.

Request Body schema: application/json
salon_id
required
number

Идентификатор филиала.

application_id
required
number

Идентификатор приложения.

event
required
string
Enum: "uninstall" "freeze"

Slug произошедшего события.

partner_token
required
string

Bearer токен компании разработчика (для удостоверения происхождения вебхука).

Responses

Request samples

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

Данные о подключении приложения в салоне

Данный эндпойнт предназначен для получения информации об установке приложения в конкретном салоне.

Authorizations:
bearer
path Parameters
salon_id
required
number

ID филиала

application_id
required
number

ID приложения

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

object
meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Данные о салонах, подключивших приложение

Данный эндпойнт предназначен для получения списка салонов, которые подключили некоторое приложение, с подробной информацией о них

Authorizations:
bearer
path Parameters
application_id
required
number

ID приложения в маркетплейсе

query Parameters
page
required
number

Страница списка

count
required
number <= 1000

Кол-во элементов на странице списка

Responses

Response Schema: application/json
success
boolean

Статус успешного выполнения (true)

Array of objects

Массив объектов

meta
Array of objects

Метаданные (пустой массив)

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response samples

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

Отключение приложения

Данный эндпойнт предназначен для инициирования отключения приложения со стороны партнера.

Authorizations:
bearer
path Parameters
salon_id
required
number

ID филиала

application_id
required
number

ID приложения

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Данные о тарифах приложения

Данный эндпойнт предназначен для получения списка тарифов.

Authorizations:
bearer
path Parameters
application_id
required
number

ID приложения

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

Array of objects

Список тарифов

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response samples

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

Установить скидку салонам на оплату

Данный эндпойнт предназначен для установки скидки при оплате через YCLIENTS определенным салонам

Authorizations:
bearer
Request Body schema: application/json
salon_ids
required
Array of numbers

Список ID салонов

application_id
required
number

Идентификатор приложения.

discount
required
number

Величина скидки

Responses

Response Schema: application/json
success
boolean (Успешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

meta
object (Пустой объект дополнительной информации о запросе)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "salon_ids": [
    ],
  • "application_id": 123,
  • "discount": 15.54
}

Response samples

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

Изменение доступности каналов отправки

Только для приложений из категории Чат-Боты и СМС-агрегаторы. Позволяет изменить доступные каналы отправки уведомлений для приложения.

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

Идентификатор филиала.

application_id
required
number

Идентификатор приложения (выдается после создания в витрине YCLIENTS).

channel_slug
required
string
Enum: "sms" "whatsapp"

Канал, доступность которого необходимо изменить.

is_available
required
boolean

Флаг доступности канала отправки.

Responses

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке запроса)

Дополнительная информация о запросе.

Response Schema: application/json
success
boolean (Неуспешный статус запроса)

Статус запроса.

data
object or null (Отсутствие данных по запросу)

Данные по запросу.

object (Сообщение об ошибке валидации данных запроса)

Дополнительная информация о запросе.

Request samples

Content type
application/json
{
  • "salon_id": 123,
  • "application_id": 123,
  • "channel_slug": "sms",
  • "is_available": true
}

Response samples

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

Чаевые

Получить список мастеров салона с их настройками чаевых

Authorizations:
(beareruser)
path Parameters
company_id
required
integer

id салона

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных мастеров)

Response samples

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

Включить чаевые у мастера

Authorizations:
(beareruser)
path Parameters
master_tips_settings_id
required
integer

id настроек чаевых

company_id
required
number

Идентификатор компании

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных мастеров)

Response samples

Content type
application/json
{}

Отключить чаевые у мастера

Authorizations:
(beareruser)
path Parameters
company_id
required
integer

id салона

master_tips_settings_id
required
integer

id настроек чаевых

header Parameters
Accept
required
string

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

Статус успешности выполнения (true)

Array of objects

Массив объектов с данными

object

Метаданные (содержит количество найденных мастеров)

Response samples

Content type
application/json
{}