Поддерживаемые методы

Печать чека

Запрос: POST /api/v1/cashbox
Отправить чек в очередь, обязательными полями запроса являются

session - глобальный уникальный идентификатор, используется для защиты от повторной печати и для получения статуса чека
inn - ИНН организации
cashier - идентификатор кассира. См. Кассиры

Пример вызова:

curl -v http://192.168.121.112:1337-H "Content-Type: application/json" 
-d '{
      "session": "2fa6b8e30-87f0-4897-8626-18c305e69c04", 
      "inn": "7453313477", 
      "cashier": "b6396c2a-849b-4a86-98c2-40d7bf4e71d8", 
      "content": {
        "info": "Лицевой Счёт", 
        "infoValue": "31337", 
        "operation": 1, 
        "paymentType": 1, 
        "buyeremail": "sergey@octonica.com", 
        "positions": [
          {
            "product": "товар 1",
            "price": 10, 
            "qty":1, 
            "vat": 1, 
            "unit": "кг", 
            "subject": 3
          }]}
    }'

Объект запроса

Таблица 1 - реквизиты чека:

Поле	Назначение	Описание
inn	ИНН организации	Число 10 знаков
cashier	Идентификатор кассира	Идентификатор кассира, от имен которого будет отбит чек, см. Кассиры
session	Идентификатор сессии	Глобальный идентификатор чека, любая строка, например преобразованный в строку uuid
content	Содержимое чека	см. таблицу 2

Таблица 2 - содержимое чека:

Поле	Назначение	Описание	По умолчанию
paymentType	Тип оплаты	1 - Наличными, 2 - Электронными, 3 - Предоплатой, 4 - В кредит, 5 - Встречным представлением, 6 - Смешанный вид	2
operation	Тип документа\признак расчета	1 - Приход (продажа) , 2 - Возврат, 3 - Расход, 4 - Возврат расхода	1
taxKind	Тип СНО	1 - Общая 2 - Упрощённая доход 4 - Упрощённая доход минус расход 8 - ЕНВД 16 - ЕСН 32 - Патентная СНО	Необязательно, если при регистрации кассы указан один вид СНО
cashierName	ФИО кассира	любая строка	Необязательно, возьмётся из ЛК по полю `cashier`
cashierPosition	должность кассира	любая строка	Необязательно, возьмётся из ЛК по полю `cashier`
cashierInn	ИНН	любая строка	Необязательно, возьмётся из ЛК по полю `cashier`
buyerEmail	e-mail покупателя	строка вида name@domain	Обязательно
info	Наименование доп. реквизита чека	строка, будет указана в низу чека
infoValue	Значение доп. реквизита чека	строка, будет указана в низу чека
positions	Список товарных позиций чека	см. таблицу 3

Таблица 3 - товарная позиция:

Поле	Назначение	Описание	По умолчанию
product	Наименование предмета расчета	Строка	Обязательно
price	Цена за единицу предмета расчета с учетом скидок и наценок	целое число, в копейках	Обязательно
qty	Количество предмета расчета	дробное число, больше нуля	Обязательно
vat	НДС	1 - 20%, 2 - 10%, 3 - 120%, 4 - 110%, 5 - 0%, 6 - Без НДС	Обязательно
subject	Признак предмета расчета	1 - 20%, 2 - 10%, 3 - 120%, 4 - 110%, 5 - 0%, 6 - Без НДС	Обязательно
unit	Едининца измерения предмета расчёта	см. таблицу 4	4

Таблица 4 - признаки предмета расчета:

Значение	Описание
1	Реализуемый товар - за исключением подакцизного товара (наименование и иные сведения - описывающие товар)
2	Реализуемый подакцизный товар (наименование и иные сведения - описывающие товар)
3	Выполняемая работа (наименование и иные сведения - описывающие работу)
4	Оказываемая услуга (наименование и иные сведения - описывающие услугу)
5	Прием ставок при осуществлении деятельности по проведению азартных игр
6	Выплата денежных средств в виде выигрыша при осуществлении деятельности по проведению азартных игр
7	Прием денежных средств при реализации лотерейных билетов - электронных лотерейных билетов - приеме лотерейных ставок при осуществлении деятельности по проведению лотерей
8	Выплата денежных средств в виде выигрыша при осуществлении деятельности по проведению лотерей
9	Предоставление прав на использование результатов интеллектуальной деятельности или средств индивидуализации
10	Аванс, задаток, предоплата, кредит, взнос в счет оплаты, пени, штраф, вознаграждение, бонус и иной аналогичный предмет расчета
11	Вознаграждение пользователя - являющегося платежным агентом (субагентом) - банковским платежным агентом (субагентом) - комиссионером - поверенным или иным агентом
12	Предмет расчета - состоящий из предметов - каждому из которых может быть присвоено значение от "1" до "11"
13	Предмет расчета - не относящийся к предметам расчета - которым может быть присвоено значение от "1" до "12" и от "14" до "18"
14	Передача имущественных прав
15	Внереализационный доход
16	Суммы расходов - уменьшающих сумму налога (авансовых платежей) в соответствии с пунктом 3.1 статьи 346.21 Налогового кодекса Российской Федерации
17	Суммы уплаченного торгового сбора
18	Курортный сбор
19	Залог

Состояние чека в очереди

Запрос: POST /api/v1/cashbox/status

Получить состояние чеков, идентификаторы которых переданы в массиве sessions.
Ответ возвращается в виде двух списков: 1. notFounded - такие идентификаторы не найдены, 2.founded - чеки найдены, структура найденных ответов приведена в таблице 5.

curl -v http://192.168.121.112:31337/api/v1/cashbox/status -H "Content-Type: application/json" 
-d '{
     "sessions":[
       "71ce7fa0-0f52-449e-b874-a6380a3ad43d",
       "fb6b8e30-87f0-4897-8626-18c305e69c04"
       ]
    }'

Ответ:

{
"founded":[
            {
              "processed":true,
              "session":"71ce7fa0-0f52-449e-b874-a6380a3ad43d",
              "fp":"2757357341",
              "errorCode":"UMKA-0",
              "errorText":""
            }],
"notFounded":[
               "fb6b8e30-87f0-4897-8626-18c305e69c04"
             ]
}

Таблица 5 - ответ о состоянии чеков:

Поле	Назначение	Описание
processed	Состояние чека в очереди	false, если запрос найден, но находится в очереди, иначе true
session	Идентификатор чека
fp	Фискальный признак чека	пусто, если чек не обработан
errorCode	Код ошибки	0, если ошибок не было, иначе стандартный код ошибки АТОЛ
errorText	Текст ошибки	пусто, ошибок при обработке не было

Визуализация чека

Запрос: GET /api/v1/cashbox/print/{session}

Получить печатную форму чека в нескольких вариантах:

JSON
PDF - стандартная форма чека
PNG\base64 - картинка отдаваемая в виде строки base64

Требуемый формат передаётся с помощью заголовка Accept