Описание API (конн ектор АТОЛ Онлайн)
Сервис предназначен для удаленной регистрации (фискализации) чеков на арендованных клиентом у Эвотор кассах (ККТ) посредством разработанного клиентского API.
Версия сервиса v5 поддерживает регистрацию чеков формата фискальных данных версии 1.2 (ФФД 1.2) согласно вступившему в силу приказу ФНС России от 14.09.2020 № ЕД-7-20/662@.
Для начала регистрации чеков через API необходимо предварительно пройти процедуру регистрации компании (магазина) и получить учетные данные (логин, пароль, идентификатор группы ККТ) посредством Личного кабинета Эвотор.
Общий алгоритм взаимодействия с сервисом через API
После получения учетных данных необходимо запросить токен авторизации используя метод, описанный в соответствующем разделе.
Для отправки чека на регистрацию в ККТ необходи мо воспользоваться POST-запросом. В случае корректного запроса сервис пришлет ответ, содержащий уникальный идентификатор, присвоенный данному документу, и статус.
Результат регистрации чека на ККТ может быть получен двумя способами:
- В случае, если в запросе на регистрацию был указан
callback_url, сервис по результатам обработки чека вернет POST запрос на этот URL; - В случае, если
callback_urlне был указан, или запрос не пришел в течение 300 секунд с момента отправки чека, клиент самостоятельно может запросить результат обработки чека GET-запросом к сервису, описанному в разделе Получение результата обработки документа.

Авторизация пользователя
Описание
Для отправки чеков через API необходимо получить автор изационный токен одним из описанных ниже методов.
Авторизационный токен, дает право доступа к системе посредством интеграционного API в течение 24 часов с момента его формирования. Токен должен передаваться в качестве параметра во все методы API сервиса. Максимальная длина токена – 1000 символов.
Если в течение 24 часов с момента запроса токена повторно запросить токен, то вы получите новый токен и время его жизни будет так же 24 часа, либо ранее полученный токен и время его жизни будет 24 часа от момента первого получения клиентом этого токена. Количество одновременно действующих токенов, которые может получить клиент равно количеству реплик сервиса Эвотор, работающих в текущий момент. Рекомендуется запрашивать новый токен только при получении от сервиса ошибки об истечении времени жизни предыдущего токена.
Например, вы запросили повторно токен спустя 10 часов с момента первого запроса. Вы получите новый токен и он будет действовать еще 24 часа, либо ранее выданный токен и он будет действовать 14 часов с момента этого запроса (24 часа с момента его первой выдачи клиенту).
POST запрос
POST https://fiscalization.evotor.ru/possystem/v5/getToken
Заголовок запроса должен содержать параметр:
Content-type: application/json; charset=utf-8
Тело запроса должно содержать документ в формате JSON, соответствующий схеме.
curl -X POST "https://fiscalization.evotor.ru/possystem/v5/getToken" \
-H "Content-type: application/json; charset=utf-8" \
-d '{
"login": "3G5aGT8Xfs",
"pass": "8IKyTEs1Zk"
}'
Параметры запроса:
login: логин из настроек интеграцииpass: пароль из настроек интеграции
GET запрос
GET https://fiscalization.evotor.ru/possystem/v5/getToken?login=<login>&pass=<pass>
Ответ на запрос
{
"error": null,
"token": "fj45u923j59ju42395iu9423i59243u0",
"timestamp": "30.11.22 17:58:53"
}
{
"error": {
"error_id": "20003",
"code": 12,
"text": "Неверный логин или пароль",
"type": "system"
},
"timestamp": null
}
Параметры ответа на запрос:
error: ошибка.error_id: уникальный идентификатор ошибки;code: код ошибки;text: текст ошибки;type: тип ошибки.
token: авторизационный токен. Максимальная длина строки – 1000 символов. Возвращается только при отсутствии ошибки.timestamp: дата и время ответа.
Регистрация документа
Описание
Метод позволяет отправить запрос на формирование чека и отправку его на регистрацию в ККТ.
Запрос
POST https://fiscalization.evotor.ru/possystem/v5/<group_code>/<operation>
Заголовок запроса должен содержать параметры:
Content-type: application/json; charset=utf-8Token: <token>
При технической невозможности передать token в заголовке запроса можно п ередать параметр в строке запроса:
https://fiscalization.evotor.ru/possystem/v5/<group_code>/<operation>?token=<token>
Параметры заголовка и строки запроса:
group_code: идентификатор группы ККТ ;operation: тип операции на регистрацию чека, которая должна быть выполнена. Возможные типы операции:sell: чек «Приход»;buy: чек «Расход»;sell_refund: чек «Возврат прихода»;buy_refund: чек «Возврат расхода»;sell_correction: чек «Коррекция прихода»;buy_correction: чек «Коррекция расхода»;sell_refund_correction: чек «Коррекция возврата прихода»;buy_refund_correction: чек «Коррекция возврата расхода»;
token: авторизационный токен.
Пример регистрации чека с операцией «Приход»:
https://fiscalization.evotor.ru/possystem/v5/group1/sell?token=<token>
Тело запроса должно содержать документ в формате JSON, соответствующий схеме.
Тело запроса для чеков прихода, возврата прихода, расхода, возврата расхода
{
"timestamp":" 03.06.2020 12:05:31",
"external_id": "892924433234522512289444",
"service": {
"callback_url": "https://shop.ru"
},
"receipt": {
"client": {
"email": "client@client.ru",
"phone": "+70002410085",
"name": "Иванов Иван Иванович",
"inn": "112233445573"
},
"company": {
"email": "email@evotor.ru",
"sno": "osn",
"inn": "0923341225",
"payment_address": "shop-url.ru"
},
"cashier_inn": "112233445573",
"cashier": "Антон Чеков",
"items": [
{
"name": "Ваш любимый товар1",
"price": 120,
"quantity": 1.0,
"measure": 0,
"sum": 120,
"payment_method": "full_payment",
"payment_object": 1,
"vat": {
"type": "vat20",
"sum": 20.0
},
"user_data": "Дополнительный реквизит предмета расчета",
"excise": 10.0,
"mark_quantity": {
"numerator": 1,
"denominator": 3
},
"mark_processing_mode": "0",
"mark_code": {
"gs1m": "010463003407001221CMK45BrhN0WLf"
},
"agent_info": {
"type": "another",
"paying_agent": {
"operation": "Операция 1",
"phones": ["+79999999999"]
},
"receive_payments_operator": {
"phones": ["+79999999999"]
},
"money_transfer_operator": {
"phones": ["+79999999999"],
"name": "Оператор перевода",
"address": "г. Москва, ул. Сказочная д.3",
"inn": "112233445573"
}
},
"supplier_info": {
"phones": [
"+79999999999"
],
"name": "Название поставщика",
"inn": "112233445573"
},
"sectoral_item_props": [
{
"federal_id": "030",
"date": "21.11.2023",
"number": "1944",
"value": "UUID=5231bbb2-a5b8-408d-8464-57043d3596b6&Time=1759965114765"
}
],
}
],
"payments":[
{
"type": 1,
"sum": 120.0
}
],
"vats":[
{
"type": "vat20",
"sum": 20.0
}
],
"sectoral_check_props":[
{
"date": "01.01.2000",
"value": "value",
"number": "number",
"federal_id": "001"
}
],
"additional_check_props": "445334544",
"total": 120.0,
"additional_user_props": {
"name": "название доп реквизита",
"value": "значение доп реквизита"
},
"device_number":"211749646136539",
"internet": true,
"timezone": 2
}
}
Описание полей для тела запроса
Описание полей для тела запроса на регистрацию документа с типом операции «Приход», «Возврат прихода», «Расход», «Возврат расхода» представлено ниже. Описание для тела запроса на регистрацию документов коррекции находится ниже: регистрация чеков коррекции.
| Поле | Тип | Обязательное | Описание | Тег ФФД |
|---|---|---|---|---|
| timestamp | string | да | Дата и время документа внешней системы в формате:
| - |
| external_id | string | да | Идентификатор документа внешней системы, уникальный среди всех документов, отправленных одним пользователем. Максимум 128 символов. | - |
| service | object | нет | Служебный раздел. См. Описание объекта service | - |
| receipt | object | да | Чек. См. описание объекта Чек. | - |
Описание объекта service
| Поле | Тип | Обязательное | Описание | Тег ФФД |
|---|---|---|---|---|
| callback_url | string | нет | URL, на который необходимо ответить после обработки документа. Максимальная длина строки – 256 символов. | - |
Описание объекта receipt
| Поле | Тип | Обязательное | Описание | Тег ФФД |
|---|---|---|---|---|
| client | object | да | сведения о покупателе (клиенте). См. Описание объекта client | - |
| company | object | да | См. Описание объекта company | - |
| items | array of objects | да | Заполняется для каждого добавленного товара. См. Описание объекта items | - |
| payments | array of objects | да | Оплаты. Ограничение по количеству от 1 до 10. См. Описание объекта payments | - |
| vats | array of objects | нет | Атрибуты налогов на чек. Ограничение по количеству от 1 до 6. Необходимо передать либо сумму налога на позицию, либо сумму налога на чек. Если будет переданы и сумма налога на позицию и сумма налога на чек, сервис учтет только сумму налога на чек. См. Описание объекта vats | - |
| cashier | string | нет | ФИО кассира. Максимальная длина строки – 64 символа. | 1021 Кассир |
| cashier_inn | string | нет | ИНН кассира. Ровно 12 цифр | 1203 ИНН кассира |
| additional_check_props | string | нет | Дополнительный реквизит чека. Максимальная длина строки – 16 символов. | 1192 Дополнитель ный реквизит чека (БСО) |
| total | number | да | Итоговая сумма чека в рублях с заданным округлением:
Значение вычисляется, как сумма всех значений реквизита «стоимость предмета расчета с учетом скидок и наценок» (тег 1043). | 1020 Сумма расчета, указанного в чеке (БСО) |
| additional_user_props | object | нет | Дополнительный реквизит пользователя. См. Описание объекта additional_user_props | 1084 Дополнитель ный реквизит пользователя. |
| sectoral_check_props | array of objects | нет | Включается в состав кассового чека (БСО) в случае, если включение этого отраслевого реквизита кассового чека предусмотрено законодательством Российской Федерации. См. Описание элемента массива объектов sectoral_check_props и sectoral_item_props | 1261 отраслевой реквизит чека |
| device_number | string | нет | Номер автоматического устройства для расчетов. От 1 до 20 символов. Применяется только если касса зарегистрирована с признаком автоматического устройства для расчетов. В случае, если параметр не будет передан, в чеке будет указан внутренний номер кассы в сервисе Цифровая касса. | 1036 номер автомата |
| internet | boolean | нет | Признак применения ККТ при осуществлении расчета в безналичном порядке в сети «Интернет». Принимает значения: true/false. Если ККТ зарегистрирована с признаком "ККТ ДЛЯ ИНТЕРНЕТ" (тег 1108), то во все чеки будет автоматически передан тег 1125: True (тег 1125 будет передан в чек). Если признак "ККТ ДЛЯ ИНТЕРНЕТ" (тег 1108) не был указан при регистрации, то в чек передается значение присланное пользователем через API в параметре internet. Если значение не передано в API, то в чек будет записан тег 1125: False (тег 1125 НЕ будет передан в чек). | 1125 Признак расчета в интернет |
| timezone | number | нет | Номер часовой зоны места (адреса) осуществления расчетов (целое число от 1 до 11) в соответствии с законом об исчислении времени. Если пользователь не указал значение в API, то в чек будет передан номер часовой зоны, указанной при регистрации Цифровой кассы. Для большинства касс - это часовой пояс Москвы. Тег заполняется в технических документах, связанных с продажей маркированных товаров. В фискальный чек тег 1011 не передается. | 1011 Часовая зона |
Описание объекта client
| Поле | Тип | Обязательное | Описание | Тег ФФД |
|---|---|---|---|---|
| string | обязательно для заполнения хотя бы одно поле из двух: email или phone | Электронный адрес покупателя. До 64 символов. Маска: {С}@{С} или значение "none" | 1008 Телефон или электронный адрес покупателя | |
| phone | string | см. выше | Телефон покупателя. Номер необходимо передать вместе с кодом страны без пробелов и дополнительных символов, кроме символа + (номер +371 2 1234567 необходимо передать как +37121234567). До 19 символов. Маски: +{Ц} или значение "none" | 1008 Телефон или электронный адрес покупателя |
| name | string | нет | Наименование покупателя (клиента). Максимальная длина строки – 256 символов. | 1227 Наименование организации или фамилия, имя, отчество (при наличии), серия и номер паспорта покупателя (клиента) |
| inn | string | нет | ИНН покупателя (клиента). Допустимое количество символов 10 или 12, только цифры. | 1228 ИНН организации или покупателя (клиента) |
Описание объекта company
| Поле | Тип | Обязательное | Описание | Тег ФФД |
|---|---|---|---|---|
| string | да | Электронная почта отправителя чека. При передаче ОФД кассового чека (БСО), кассового чека коррекции (БСО коррекции) покупателю (клиенту) в электронной форме указывается адрес электронной почты ОФД. Максимальная длина строки – 64 символа. Маска: {С}@{С} | 1117 Адрес электронной почты отправителя чека | |
| sno | enum (string) | да | Система налогообложения. Должно принимать одно из значений:
| 1055 Применяемая система налогообложения |
| inn | string | да | ИНН организации. Используется для предотвращения ошибочных регистраций чеков на ККТ зарегистрированных с другим ИНН (сравнивается со значением в ФН). Допустимое количество символов 10 или 12. | 1018 ИНН пользователя |
| payment_address | string | да | Место расчетов. Максимальная длина строки – 256 символов. | 1187 Место расчетов |