Служебные

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

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

GET `ping`

Запрос: ping

URL: {{HTTPRoot}}/ping

Проверка доступности сервера ККМ.

Тело ответа

Успешный ответ (200 OK)

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

Поле Result

Тип: ping

Ping

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

GET `version`

Запрос: version

URL: {{HTTPRoot}}/version

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

Тело ответа

Успешный ответ (200 OK)

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

Поле Result

Тип: объект Version

Version

Имя поля	Тип	Назначение	Пример
ServerVersion	string	Версия сервера	“4.0.62.521”

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

72 — Не указан id

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

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

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

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

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

GET `task/status?id={id}`

Запрос: task/status

URL: {{HTTPRoot}}/task/status?id={id}

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

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

Параметр	Обяз	Пример	Описание
`id`	+	9c5231d8-8075-4619-967e-8637e2a7b22d	Идентификатор документа

Тело ответа

Успешный ответ (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": "00106305393630",
            "Vatin": "0326031413",
            "Cashier": "",
            "RnNumber": "0000000002005725",
            "Fn": "9999078902010507",
            "FnsUrl": "www.nalog.gov.ru",
            "ShiftNumber": 39,
            "DocNumber": 343,
            "FiscalSign": "1352614355",
            "OfdOrganizationName": "Один ОФД тест ру 1-ofd-test.ru",
            "OfdVatin": "7709364346"
        },
        "ResultCode": 0,
        "ResultDescription": "OK"
    },
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Тип: объект DocumentHeader

status

Имя поля	Тип	Назначение	Пример
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
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

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

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

72 — Не указан id

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

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

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

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

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

GET `task/form?id={id}`

Запрос: task/form

URL: {{HTTPRoot}}/task/form?id={id}

Получение печатной формы задания

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

Параметр	Обяз	Пример	Описание
`id`	+	—	идентификатор документа

Тело ответа

Успешный ответ (200 OK)

{
    "Result": [
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "Кассовый чек",
            "LineRight": "",
            "Alignment": 1,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "СМЕНА 39",
            "LineRight": "ЧЕК 2",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 0,
            "Width": 0,
            "Scale": 100,
            "Line": "1. Выдать:  Основание:",
            "LineRight": "",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "",
            "LineRight": "= 50,00",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "НДС 20% =8,33",
            "LineRight": "",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "Аванс",
            "LineRight": "АВАНС",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 4,
            "Width": 0,
            "Scale": 100,
            "Line": "",
            "LineRight": "",
            "Alignment": 0,
            "Font": 0,
            "Wrap": false,
            "SeparatorLine": {
                "LineStyle": 0
            },
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "ИТОГ",
            "LineRight": "=50,00",
            "Alignment": 0,
            "Font": 4,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 4,
            "Width": 0,
            "Scale": 100,
            "Line": "",
            "LineRight": "",
            "Alignment": 0,
            "Font": 0,
            "Wrap": false,
            "SeparatorLine": {
                "LineStyle": 0
            },
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "F:СУММА БЕЗ НДС",
            "LineRight": "=41,67",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "СУММА НДС 20%",
            "LineRight": "=8,33",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "НАЛИЧНЫМИ",
            "LineRight": "=50,00",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "ПОЛУЧЕНО",
            "LineRight": "=50,00",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "СНО",
            "LineRight": "УСН доход",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 4,
            "Width": 0,
            "Scale": 100,
            "Line": "",
            "LineRight": "",
            "Alignment": 0,
            "Font": 0,
            "Wrap": false,
            "SeparatorLine": {
                "LineStyle": 0
            },
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "РБ-Софт",
            "LineRight": "",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "Улан-Удэ, Балтахинова, 17",
            "LineRight": "",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "Место расчетов",
            "LineRight": "Офис на 2 этаже",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 1,
            "Width": 0,
            "Scale": 100,
            "Line": "Эл. адр. покупателя ",
            "LineRight": "asdawwd@gmail.com",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "IsCreateFromTemplate": false
        },
        {
            "Type": 2,
            "Width": 0,
            "Scale": 100,
            "Line": "",
            "LineRight": "",
            "Alignment": 0,
            "Font": 0,
            "Wrap": true,
            "Barcode": {
                "Type": "QR",
                "Value": "t=20260522T1506&s=50.00&fn=9999078902010507&i=343&fp=1352614355&n=1",
                "PictureBase64": "iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAIAAAAA4vtyAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAAgrSURBVHhe7ZHBjuRKDgPn/39691AAkVJksimXpz0PcBypoJTl+vO/lyf404OXX+H97s/wfvdneL/7M7zf/Rne7/4M73d/hve7P8P73Z/h/e7P8H73Z3i/+zOk3/3Pd/R1C3SShMgxcjcWEieh3DsTe9/R1y3QSRIix8jdWEichHLvTOx9R1+3QCdJiBwjd2MhcRLKvTOxN9z7ga0kIXIMvbNrdWPHSBbTVuwN935gK0mIHEPv7Frd2DGSxbQVe8O9H9hKEiLH0Du7Vjd2jGQxbcUe9iohdJQkmFYySujlBTqlWaGjxBN72KuE0FGSYFrJKKGXF+iUZoWOEk/sYa8SQkdJgmklo4ReXqBTmhU6Sjyxh71KCB0mxDhmJORQ7oPhSAmho8QTe9irhNBhQoxjRkIO5T4YjpQQOko8sYe9SggdJsQ4ZiTkUO6D4UgJoaPEE3vYq4TQUZKMiJE1Il3NZJMQOko8sYe9SggdJcmIGFkj0tVMNgmho8QTe9irhNBRkoyIkTUiXc1kkxA6SjyxN9z7gS0lyUjQUXL7iEnCtBV7w70f2FKSjAQdJbePmCRMW7E33PuBLSXJSNBRcvuIScK0FXvfwT3/fnIN7fHE3ndwz7+fXEN7PLH3Hdzz7yfX0B5P6t1Of+9CV+3XKd4ByaSrv8Vzh890dfeVmRgkk67+Fs8dPtPV3VdmYpBMuvpbpIf7ey2jFuUkMVBWwhGhM0pC0oIOJIxalJPEQFkJR4TOKAlJCzqQMGpRThIDZSUcETqjJCQtmAMaGcfAVpKYEROObndEVw/E3nlvOXtwDGwliRkx4eh2R3T1QOyd95azB8fAVpKYEROObndEVw+knuh3dpe6sXPEyElk0Tu7Vjd2/x9H3zPe1d+ye003do4YOYksemfX6sb73VfKrp9k0Tu7Vjf+Q99d0DGJgTKTBLUMvZPdShzPuKmThI5JDJSZJKhl6J3sVuJ4xk2dJHRMYqDMJEEtQ+9ktxLH80XzfFujEaZuRoSyElKaB7kbO2fK9RXmEeWNMaZuRoSyElKaB7kbO2fK9RXmEeWNMaZuRoSyElKaB7kbO2fKeAVvjxIix3CXrBGdPlhIHCHZk3qCB0YJkWO4S9aITh8sJI6Q7Ek9wQOjhMgx3CVrRKcPFhJHSPbE3mRveUglccRIFmqx3gdXR9+TLh09QjJJHDGShVqs98HV0fekS0ePkEwSR4xkoRbrfXB19D3pUj5CCUekqzs5GZGu7uidhZFD2SSe2MNeJRyRru7kZES6uqN3FkYOZZN4Yg97lXBEurqTkxHp6o7eWRg5lE3iiT3sVTIaGUfQYWKgrISMnEQOSVfwZHlIPDKOoMPEQFkJGTmJHJKu4MnykHhkHEGHiYGyEjJyEjkkXXHXyfL8w0IzSmBdyTXK9p8WdvVA7A33nihvPCw0owTWlVyjbP9pYVcPxN5w74nyxsNCM0pgXck1yvafFnb1QOqRfjD7ncbRyDikdxa6upO7sdDVhcTxfNEEZiSMo5FxSO8sdHUnd2OhqwuJ4/miCcxIGEcj45DeWejqTu7GQlcXEseTNpNLcoxsRiJxiGklI+OQ3slaK2khOVAecpDNSCQOMa1kZBzSO1lrJS0kB8pDDrIZicQhppWMjEN6J2utjAukP2FHIidOAvcouUbZXhf2QXwr9Qz98o5ETpwE7lFyjbK9LuyD+FbqGfrlHYmcOAnco+QaZXtd2AfxrdgD3VigU5oHyora6gMLW0quMdoj2RN7oBsLdErzQFlRW31gYUvJNUZ7JHtiD3RjgU5pHigraqsPLGwpucZoj2RP7A33fmBLyd+jvKBCpzTriHTVyp60ee0SW0r+HuUFFTqlWUekq1b2pM1rl9hS8vcoL6jQKc06Il21sidt8lKScETolGYlcYharPfBbqQkGYWkTV5KEo4IndKsJA5Ri/U+2I2UJKOQtMlLScIRoVOalcQharHeB7uRkmQUkjZ5Scnt8AQTA2UlpDRjWC9LA9ICDyi5HZ5gYqCshJRmDOtlaUBa4AElt8MTTAyUlZDSjGG9LA0YF76kPL8yckhXd3I3Frq6QKc0K6V5JvXuoj9zYeSQru7kbix0dYFOaVZK80zq3UV/5sLIIV3dyd1Y6OoCndKslOaZ2PsOs6ecOdA7O3pngU5pHkYmSUaetKAD1zB7ypkDvbOjdxbolOZhZJJk5EkLOnANs6ecOdA7O3pngU5pHkYmSUaetHDtwF0tJcQ4HClJRoKOElKaZ2JvuPfDXS0lxDgcKUlGgo4SUppnYm+498NdLSXEOBwpSUaCjhJSmmdiD3vLtQodkxA5Ru6GdfpgoayI6VvmpCt4sjykQsckRI6Ru2GdPlgoK2L6ljnpCp4sD6nQMQmRY+RuWKcPFsqKmL5lTrqCJ8tDKnRGCRk5RjYjA1tMpqRNXlJC6IwSMnKMbEYGtphMSZu8pITQGSVk5BjZjAxsMZmSNnlJCaGTJEQOZZMQOiYhckjibEkLPKCE0EkSIoeySQgdkxA5JHG2pAUeUELoJAmRQ9kkhI5JiBySOFvSwrUDbCkxIyUcJU4fZHVCuayooylp89oltpSYkRKOEqcPsjqhXFbU0ZS0ee0SW0rMSAlHidMHWZ1QLivqaEra7AeHcE/ZXkcjR3TV3hKJIySTrv5EWuh3hnBP2V5HI0d01d4SiSMkk67+RFrod4ZwT9leRyNHdNXeEokjJJOu/sS48HIL73d/hve7P8P73Z/h/e7P8H73Z3i/+zO83/0Z3u/+DO93f4b3uz/D+92f4f3uz/B/haAptI8uPCYAAAAASUVORK5CYII=",
                "PrintText": 1,
                "Height": 100,
                "BarWidth": 100
            },
            "BarcodeLines": [
                "ЗН ККТ: 00106305393630",
                "РН ККТ: 0000000002005725",
                "ИНН 0326031413",
                "ФН: 9999078902010507",
                "ФД: 343",
                "ФП: 1352614355",
                "ПРИХОД",
                "22.05.26 15:06",
                "Сайт ФНС: www.nalog.gov.ru"
            ],
            "IsCreateFromTemplate": false
        }
    ],
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Тип: массив объектов PrintLine

PrintLine

Имя поля	Тип	Назначение	Пример
Type	int	Тип строки. 0, Fiscal — фискальная строка; 1, TextString — строка; 2, Barcode — штрихкод; 3, Picture — изображение; 4, Line — линия	1
Width	int	Ширина	0
Scale	int	Масштаб	100
Line	string	Текст строки (левая часть)	“Кассовый чек”
LineRight	string	Текст строки (правая часть)	”“
Alignment	int	Выравнивание. 0 — выравнивание по левому краю; 1 — Выравнивание по центру; 2 — Выравнивание по правому краю; 3 — По ширине	1
Font	int	Шрифт: 0, Normal — Шрифт для обычных строк; 1, Bold — Жирный шрифт для обычных строк; 2, Small — Мелкий шрифт для обычных строк; 3, Medium — Средний шрифт (применятся в шаблоне копий чеков); 4, Big — Крупный шрифт (применяется в шалоне копий чекой); 5, H1 — Шрифт заголовков (для шаблонов рекламных чеков); 6, H2 — Шрифт заголовков (для шаблонов рекламных чеков); 7, H3 — Шрифт заголовков (для шаблонов рекламных чеков); 8, H4 — Шрифт заголовков (для шаблонов рекламных чеков); 9, H5 — Шрифт заголовков (для шаблонов рекламных чеков);	0
Wrap	bool	Признак переноса строк: false - строка обрезается; true - строка переносится	true
Barcode	object	Штрихкод
SeparatorLine	object	Разделительная линиия
IsCreateFromTemplate	bool	Создано из шаблона: true - создано из печатного шаблона; false — не создан из печатного шаблона	false
BarcodeLines	string	Массив строк, выводимые спрва или слева от штрихакодв	“ЗН ККТ: 00106305393630”; “РН ККТ: 0000000002005725”; “ИНН 0326031413”; “ФН: 9999078902010507”; “ФД: 343”; “ФП: 1352614355”; “ПРИХОД”,; “22.05.26 15:06”,; “Сайт ФНС: www.nalog.gov.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	Изображение barcode закодированное в строке	“iVBORw0KGgoAAAANSUhEUgAAAH0AAAB9CAIAAAAA4vtyAAAA…”
PrintText	int	Задает способ печати текста штрихкода(только для одномерных штрихкодов): 0 — не печатать; 1 — печатать снизу; 2 — печатать сверху; 3 — печатать сверху и снизу	1
Height	int	Высота штрихкода в точках. Допустимые значения свойства: 0..1199	100
BarWidth	int	Ширина штриха в точках. Допустимые значения свойства: 0..1199; Рекомендуемое значение – 2.	100

SeparatorLine

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

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

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

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

72 — Не указан id

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

Служебные

GET ping

Тело ответа

Успешный ответ (200 OK)

Поле Result

Ping

GET version

Тело ответа

Успешный ответ (200 OK)

Поле Result

Version

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

72 — Не указан id

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

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

GET task/status?id={id}

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

Тело ответа

Успешный ответ (200 OK)

Поле Result

status

DocumentHeader

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

72 — Не указан id

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

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

GET task/form?id={id}

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

Тело ответа

Успешный ответ (200 OK)

Поле Result

PrintLine

Barcode

SeparatorLine

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

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

72 — Не указан id

GET `ping`

GET `version`

GET `task/status?id={id}`

GET `task/form?id={id}`