ТЕХНИЧЕСКАЯ ДОКУМЕНТАЦИЯ

Служебные

> СерверККМ V4 > REST API
Дата обновления: 7 августа 2026 г.

GET ping

Проверка доступности сервера ККМ. Не требует передачи ключа доступа (api_key)

URL: {{HTTPRoot}}/ping

Тело ответа

200 OK

{
    "Result": {
        "product": "RB-Soft:Server KKM",
        "version": "4.0.12.306"
    },
    "Code": 0,
    "Description": "OK",
    "success": true
}

Result (Ping)

Имя параметра Тип Обяз Назначение Пример
product string - Название продукта “RB-Soft:Server KKM”
version string - Версия сервера “4.0.70.611”

GET version

Получение текущей версии сервера.

URL: {{HTTPRoot}}/version

Тело ответа

Result (ResServerVersion)

Имя параметра Тип Обяз Назначение Пример
ServerVersion string - Версия сервера “4.0.62.521”

Примеры ошибок

ОК

{
    "Result": {
        "ServerVersion": "4.0.61.427"
    },
    "Code": 0,
    "Description": "OK",
    "Success": true
}

GET task/status?id=b0ce9370-4435-49f8-a5e8-9bc267a26f77

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

URL: {{HTTPRoot}}/task/status?id=b0ce9370-4435-49f8-a5e8-9bc267a26f77

Параметры запроса

Имя параметра Тип Обяз Назначение Пример
id string + Идентификатор документа b0ce9370-4435-49f8-a5e8-9bc267a26f77

Тело ответа:

200 OK

{
    "Result": {
        "DeviceName": "Atol",
        "DocId": "b0ce9370-4435-49f8-a5e8-9bc267a26f77",
        "Date": "2026-05-22T15:06:42",
        "SentToPrint": -1,
        "NumberInQueue": -1,
        "QueueSize": 0,
        "PoolId": "",
        "ShiftNumber": 39,
        "DocNumber": 343,
        "TaskType": 1,
        "FiscalSign": "1352614355",
        "DocumentHeader": {
            "OrganizationInfo": "ООО 'Ромашка'",
            "SerialNumber": "0020260207",
            "Vatin": "7722345678",
            "Cashier": "Иванов А.И.",
            "RnNumber": "00031415926",
            "Fn": "0123123123123",
            "FnsUrl": "nalog.ru",
            "ShiftNumber": 39,
            "DocNumber": 343,
            "FiscalSign": "1352614355",
            "OfdOrganizationName": "Тестовый ОФД",
            "OfdVatin": "1234554321"
        },
        "ResultCode": 0,
        "ResultDescription": "OK"
    },
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Result (ResponseGetStatus)

Имя параметра Тип Обяз Назначение Пример
DeviceName string + Имя устройства “Atol”
DocId string + Идентификатор документа “855fa6cb-5e05-4983-8e39-de5187ac7a21”
Date datetime - Дата и время постановки задания в обработку “2026-03-18T16:23:59”
SentToPrint int - Статус отправки:
0 — Задача новая, в очереди,
1 — Задача отправлена на выполнение,
2 — Задача удачно обработана,
-1 — Задача вернулась из обработки с ошибкой,		 -1
NumberInQueue int - Позиция задания в очереди на момент запроса.
-1 — задание уже покинуло очередь (обработано или завершилось ошибкой).		 -1
QueueSize int - Размер очереди 0
PoolId string - Идентификатор пула, в рамках которого обрабатывалось задание. Если устройство не входит в пул — не заполняется. “pool”
ShiftNumber int + Номер смены 306
DocNumber int + Номер чека 1373
TaskType int - Тип чека:
0 — Текст
1 — Приход
2 — Возврат прихода
3 — Расход
4 — Возврат расхода
5 — Коррекция прихода
6 — Коррекция возврата прихода
7 — Коррекция расхода
8 — Коррекция возврата расхода
9 — Слип
10 — Фискализация
11 — Открытие смены
12 — Z-отчет
13 — X-отчет
14 — Отчет о состоянии расчетов
20 — Выемка
21 — Внесение
22 — Открытие денежного ящика		 1
FiscalSign string - Фискальный признак. Фискальный признак документа. Заполняется только для фискальных документов “1173363965”
ResultCode int - Код результата обработки задания 0
ResultDescription string - Описание результата обработки задания “OK”
DocumentHeader DocumentHeader - Заголовок документа Заголовок фискального документа

DocumentHeader

Имя параметра Тип Обяз Назначение Пример
OrganizationInfo string - Название организации “ООО ‘Ромашка’“
SerialNumber string - Заводской номер ККТ “00106305393630”
Vatin string - ИНН Организации “7722345678”
Cashier string - Кассир “Иванов А.И.”
RnNumber string - Регистрационный номер ККТ “0000000002005725”
Fn string - Фискальный накопитель “0123123123123”
FnsUrl string - Адрес сайта уполномоченного органа (ФНС) в сети «Интернет» “nalog.ru”
ShiftNumber int - Номер смены 39
DocNumber int - Номер фискального документа 343
FiscalSign string - Фискальный признак документа “1352614355”
OfdOrganizationName string - Наименование провайдера ОФД Тестовый ОФД
OfdVatin string - ИНН провайдера ОФД 7709364346

Примеры ошибок

700 Задание не найдено

{
    "Code": 700,
    "Description": "Задание не найдено",
    "Success": false
}

72 Некорректный id

{
    "Code": 72,
    "Description": "Некорректный id",
    "Success": false
}

72 Не указан id

{
    "Code": 72,
    "Description": "Не указан id",
    "Success": false
}

GET task/form?id=b0ce9370-4435-49f8-a5e8-9bc267a26f77

Возвращает печатную форму документа по его идентификатору (docId), полученному в ответе на любой POST-запрос.

URL: {{HTTPRoot}}/task/form?id=b0ce9370-4435-49f8-a5e8-9bc267a26f77

Параметры запроса

Имя параметра Тип Обяз Назначение Пример
id string + Идентификатор документа (docId) из ответа POST-запроса. b0ce9370-4435-49f8-a5e8-9bc267a26f77

Тело ответа

200 OK

{
  "Result": [
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "Кассовый чек",
      "LineRight": "",
      "Alignment": 1,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "СМЕНА 50",
      "LineRight": "ЧЕК 6",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 0,
      "Width": 0,
      "Scale": 100,
      "Line": "1. Кофе 250г",
      "LineRight": "",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "",
      "LineRight": "= 150,00",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "НДС 20% =25,00",
      "LineRight": "",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "Товар",
      "LineRight": "ПОЛНЫЙ РАСЧЕТ",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 4,
      "Width": 0,
      "Scale": 100,
      "Line": "",
      "LineRight": "",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": false,
      "Wrap": false,
      "SeparatorLine": {
        "LineStyle": 0
      },
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "ИТОГ",
      "LineRight": "=150,00",
      "Alignment": 0,
      "Font": 4,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 4,
      "Width": 0,
      "Scale": 100,
      "Line": "",
      "LineRight": "",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": false,
      "Wrap": false,
      "SeparatorLine": {
        "LineStyle": 0
      },
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "F:СУММА БЕЗ НДС",
      "LineRight": "=125,00",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "СУММА НДС 20%",
      "LineRight": "=25,00",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "НАЛИЧНЫМИ",
      "LineRight": "=150,00",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "ПОЛУЧЕНО",
      "LineRight": "=150,00",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "СНО",
      "LineRight": "ОСН",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 4,
      "Width": 0,
      "Scale": 100,
      "Line": "",
      "LineRight": "",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": false,
      "Wrap": false,
      "SeparatorLine": {
        "LineStyle": 0
      },
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "Кассир ",
      "LineRight": "Иванов А.И.",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "ООО 'Ромашка'",
      "LineRight": "",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "г.Улан-Удэ, ул.Виноградная, д11А, офис 25",
      "LineRight": "",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 1,
      "Width": 0,
      "Scale": 100,
      "Line": "Место расчетов",
      "LineRight": "Офис",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": true,
      "Wrap": true,
      "IsCreateFromTemplate": false
    },
    {
      "Type": 2,
      "Width": 0,
      "Scale": 100,
      "Line": "",
      "LineRight": "",
      "Alignment": 0,
      "Font": 0,
      "IsFontSpecified": false,
      "Wrap": true,
      "Barcode": {
        "Type": "QR",
        "Value": "t=20260724T1928&s=150.00&fn=123123123123&i=445&fp=4200564124&n=1",
        "PictureBase64": "iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAIAAAAA4vtyAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAgxSURBVHhe7ZDBjqhIDAPf///07mEkq51qggNomAN1dMoJ9L//Pt7gXw0+foXv3d/he/d3+N79Hb53f4fv3d/he/d3+N79Hb53f4fv3d/he/d3+N79HdJ3/3ePum5ZWAc7npI1IomTYPeOib171HXt65CnZI1I4iTYvWNi7x51Xfs65ClZI5I4CXbvmNgb7v2BLSVPjRpqZ4FOkyRMW7E33PsDW0qeGjXUzgKdJkmYtmJvuPcHtpQ8NWqonQU6TZIwbcUe9iohdJRwRKqawbotPcBWeIsJoaOkJ/awVwmho4QjUtUM1m3pAbbCW0wIHSU9sYe9SggdJRyRqmawbksPsBXeYkLoKOmJPexVQugwaUZJMkL1Zg9HTAgdJT2xh71KCB0mzShJRqje7OGICaGjpCf2sFcJocOkGSXJCNWbPRwxIXSU9MQe9iohdJQQOkxGsK6EWNNlJoSOkp7Yw14lhI4SQofJCNaVEGu6zITQUdITe9irhNBRQugwGcG6EmJNl5kQOkp6Ym+49we2koSjhtpZqOpO5ohJwrQVe8O9P7CVJBw11M5CVXcyR0wSpq3YG+79ga0k4aihdhaqupM5YpIwbcXePbjn7yfX0J6e2LsH9/z95Bra0xN79+Cev59cQ3t6Uu83af7h5ohU9bd47XBD8yg3R6Sqv8VrhxuaR7k5IlX9LdLD9XtbfrPVoIUNtbP7jFESkhZ0IOE3Ww1a2FA7u88YJSFpQQcSfrPVoIUNtbP7jFESMi/gEhMih1R1IXGIbT+jlnf1auwcUdUDUk/wABMih1R1IXGIbT+jlnf1auwcUdUDUk/wABMih1R1IXGIbT+jlnf1auwcUdUDYu+YqrYyudm6Sd27+x4rPES61D7NqWork5utm9S9u++xwkOkS+3TnKq2MrnZukndu/seKzzE9aX2sf59TDhqqJ2Fqu7kaizQsaaPCB1rTrjRBBxZwUcNtbNQ1Z1cjQU61vQRoWPNCTeagCMr+KihdhaqupOrsUDHmj4idKw5IW3afaeqC1XdQTlJGiQn1PKuXo2dMyVdUS8vVHWhqjsoJ0mD5IRa3tWrsXOmpCvq5YWqLlR1B+UkaZCcUMu7ejV2zpQnVgRfQ0dJMhJySFWzhQmjPZJ7Uq8hOUlHSTISckhVs4UJoz2Se1KvITlJR0kyEnJIVbOFCaM9kntiD1Tj9uNqRKq622OFs5FoHI0a5zLprvoJu4/gyArxiFR1t8cKZyPROBo1zmXSXfUTdh/BkRXiEanqbo8VzkaicTRqnMuku5rbHDEZwfoouTkiktlqkp7YO97LEZMRrI+SmyMima0m6Ym9470cMRnB+ii5OSKS2WqSntQTyQE5pKq7hVY4Gwk5lOtgiJ15YuH37hF25omF37tH2JknFg7evTnJERMiZyTXwYLtcrkOhtiZs4VVPSD2jvdyxITIGcl1sGC7XK6DIXbmbGFVD4i9470cMSFyRnIdLNgul+tgiJ05W1jVA1JP1Du730uSBLWSelUXGsdWOFVdSJyecdM+zW+PkgS1knpVFxrHVjhVXUicnnHTPs1vj5IEtZJ6VRcax1Y4VV1InJ60aV/kVPUqzUK75zTOK6OQtFDvLFT1Ks1Cu+c0ziujkLRQ7yxU9SrNQrvnNM4ro5BxQfBkk3A0ckRVF6q6+55r2BlfWAfxrdQjvNQkHI0cUdWFqu6+5xp2xhfWQXwr9QgvNQlHI0dUdaGqu++5hp3xhXUQ34o97LVrPiKNw5ESjhLYsl1zRnsk98Qe9to1H5HG4UgJRwls2a45oz2Se2IPe+2aj0jjcKSEowS2bNec0R7JPbF3vNfOxrBuS31Eqrrbw4QkjhjJPemK5qRGI1i3pT4iVd3tYUISR4zknnRFc1KjEazbUh+Rqu72MCGJI0ZyT7oiOSmHMpNmpKQZKbk2upYko5C0mVySQ5lJM1LSjJRcG11LklFI2kwuyaHMpBkpaUZKro2uJckoJG02lzSi83iSwJYSjq7BPbY9IC00BzSi83iSwJYSjq7BPbY9IC00BzSi83iSwJYSjq7BPbY9YFy4CT+UyQjWm6QZKSF0lBBrHpN6T8HvYzKC9SZpRkoIHSXEmsek3lPw+5iMYL1JmpESQkcJseYxsXcP7rHtPkqcOtjRyBrRSZJk1JMWdOAa3GPbfZQ4dbCjkTWikyTJqCct6MA1uMe2+yhx6mBHI2tEJ0mSUU9auHZg1GpkjRpH0LHmwUgJocNkStq8dmnUamSNGkfQsebBSAmhw2RK2rx2adRqZI0aR9Cx5sFICaHDZEra5CUlhE6TJCMhp4GyrXCsGVO3zElX8KR9iEOnSZKRkNNA2VY41oypW+akK3jSPsSh0yTJSMhpoGwrHGvG1C1z0hU8aR/i0GHCUeOIqu6gbCsORkqINZ2qxqRNXrL7Dh0mHDWOqOoOyrbiYKSEWNOpakza5CW779BhwlHjiKruoGwrDkZKiDWdqsakTV6y+w4dJkTONbmhadnSA2pn16rGGWmBB+ysQ4cJkXNNbmhatvSA2tm1qnFGWuABO+vQYULkXJMbmpYtPaB2dq1qnJEWrh1gSwlpHI0aaqddKOgkCUdT0ua1S2wpIY2jUUPttAsFnSThaEravHaJLSWkcTRqqJ12oaCTJBxNSZv14BDuse0OHSUJbCkh1pzLoqpnpIV6Zwj32HaHjpIEtpQQa85lUdUz0kK9M4R7bLtDR0kCW0qINeeyqOoZ48LHI3zv/g7fu7/D9+7v8L37O3zv/g7fu7/D9+7v8L37O3zv/g7fu7/D9+7v8L37O/wPBk7z2xYc81oAAAAASUVORK5CYII=",
        "PrintText": 1,
        "Height": 100,
        "BarWidth": 100
      },
      "BarcodeLines": [
        "ЗН ККТ: 0020260207",
        "РН ККТ: 00031415926",
        "ИНН 7722345678",
        "ФН: 0123123123123",
        "ФД: 445",
        "ФП: 5847203916",
        "ПРИХОД",
        "24.07.26 19:28",
        "Сайт ФНС: nalog.ru"
      ],
      "IsCreateFromTemplate": false
    }
  ],
  "Code": 0,
  "Description": "OK",
  "Success": true
}

Result (массив PrintLine)

Имя параметра Тип Обяз Назначение Пример
Type int - Тип строки.
0 — фискальная строка;
1 — текстовая строка;
2 — штрихкод;
3 — изображение;
4 — разделительная линия		 1
Width int - Ширина 0
Scale int - Масштаб 100
Line string - Текст строки (левая часть) “Кассовый чек”
LineRight string - Текст строки (правая часть) “ЧЕК 2”
Alignment int - Выравнивание.
0 — выравнивание по левому краю;
1 — Выравнивание по центру;
2 — Выравнивание по правому краю;
3 — По ширине		 1
Font int - Шрифт.
Normal — Шрифт для обычных строк;
Bold — Жирный шрифт;
Small — Мелкий шрифт;
Medium — Средний шрифт;
Big — Крупный шрифт;
H1 — Стиль заголовка первого уровня (название документа);
H2 — Стиль заголовка второго уровня (раздел документа);
H3 — Стиль заголовка третьего уровня (подраздел);
H4 — Стиль заголовка четвёртого уровня (детализация подраздела);
H5 — Стиль заголовка пятого уровня (дополнительная детализация);		 0
IsFontSpecified bool - Признак, что шрифт задан явно во входящих данных или при создании строки true
Wrap bool - Признак переноса строк.
false - строка обрезается;
true - строка переносится		 true
Barcode Barcode - Штрихкод “Barcode”:
SeparatorLine - SeparatorLine Разделительная линиия “SeparatorLine”:
IsCreateFromTemplate bool - Признак создания строки из печатного шаблона.
true - создано из печатного шаблона;
false — не создан из печатного шаблона		 false
BarcodeLines Список string - Массив строк, выводимые спрва или слева от штрихакодв “ЗН ККТ: 0020260207”,
“РН ККТ: 00031415926”,
“ИНН 7722345678”,
“ФН: 0123123123123”,
“ФД: 343”,
“ФП: 1352614355”,
“ПРИХОД”,
“22.05.26 15:06”,
“Сайт ФНС:
nalog.ru”

Barcode

Имя параметра Тип Обяз Назначение Пример
Type string - Тип штрихкода.
Возможные значения:
UPCA,
CODE39,
EAN13,
EAN8,
UPCE,
ITF,
CODABAR,
CODE93,
CODE128,
PDF417,
CODE32,
QR		 “QR”
Value string - Значение штрихкода “t=20260522T1506&s=50.00&fn=9999078902010507&i=343&fp=1352614355&n=1”
PictureBase64 string - Изображение штрихкода, закодированное в Base64 “iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAIAAAAA4vtyAAAA…”
PrintText int - Задает способ печати текста штрихкода(только для одномерных штрихкодов).
0 — не печатать
1 — печатать снизу
2 — печатать сверху
3 — печатать сверху и снизу		 1
Height int - Высота штрихкода в точках.
Допустимые значения свойства: 0..1199		 100
BarWidth int - Ширина штриха в точках.
Допустимые значения свойства: 0..1199
Рекомендуемое значение – 2.		 100

SeparatorLine

Имя параметра Тип Обяз Назначение Пример
LineStyle int - Стиль разделительной линии:
0 — сплошная линия;
1 — жирная линия;
2 — штриховая линия;
3 — пунктирная линия;
4 — двойная линия		 1

Примеры ошибок

-1 Документ не найден

{
    "Code": -1,
    "Description": "Значение не может быть неопределенным.\r\nИмя параметра: Метод GetFormDocument: по docId = 'dd49e710-1702-477c-952a-c45fdd48c984' документ не найден.",
    "Success": false
}

72 Не указан id

{
    "Code": 72,
    "Description": "Не указан id",
    "Success": false
}

72 Некорректный id

{
    "Code": 72,
    "Description": "Некорректный id",
    "Success": false
}