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

Очередь

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

GET queue

Получение текущего списка заданий, находящихся в очереди обработки сервера.

URL: {{HTTPRoot}}/queue

Тело ответа

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

{
    "Result": [
        {
            "DocId": "97826202-3698-4fcc-a0a4-a8a48c757479",
            "DeviceName": "Atol",
            "PoolId": "",
            "SentToPrint": 1,
            "Time": "2026-05-12T02:03:54",
            "Printed": false,
            "Sum": 50,
            "ErrorDescription": "Постановка в очередь печати",
            "Session": 0,
            "DocNumber": 0
        }
    ],
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Тип: список ResponseQueue

Имя поля Тип Назначение Пример
DocId string Идентификатор документа “97826202-3698-4fcc-a0a4-a8a48c757479”
DeviceName string Название устройства, которому адресовано задание “Atol”
PoolId string Идентификатор пула, если задание адресовано пулу устройств, а не конкретному устройству ”“
SentToPrint int Состояние обработки задания:
0 — задание ещё не отправлено на устройство;
1 — задание отправлено на устройство и ожидает завершения;
2 — обработка завершилась ошибкой		 1
Time datetime Время постановки задания в очередь “2026-05-21T08:57:34”
Printed bool Признак того, что задание уже успешно напечатано false
Sum decimal Сумма документа 50
ErrorDescription string Текстовое описание текущего состояния или ошибки задания “Постановка в очередь печати”
Session int Номер кассовой смены, к которой относится задание 0
DocNumber int Номер документа (заполняется после успешной обработки) 0

GET queue/task/history?taskId={taskId}

Получение истории событий обработки конкретного задания в очереди

URL: {{HTTPRoot}}/queue/task/history?taskId={taskId}

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

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

Тело ответа

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

{
    "Result": {
        "History": [
            {
                "Time": "2026-05-21T16:57:25",
                "State": 4,
                "Description": "Добавление в очередь",
                "Info": ""
            },
            {
                "Time": "2026-05-21T16:57:34",
                "State": 0,
                "Description": "Начало выполнения",
                "Info": ""
            },
            {
                "Time": "2026-05-21T16:57:44",
                "State": 1,
                "Description": "Успешное завершение",
                "Info": ""
            }
        ]
    },
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Тип: QueueTaskHistoryResult

Имя поля Тип Назначение Пример
History Массив типа данных Хронология событий обработки задачи, от самого раннего к самому позднему “History”: [
{
“Time”: “2026-05-21T16:57:25”,
“State”: 4,
“Description”: “Добавление в очередь”,
“Info”: “”
},
{
“Time”: “2026-05-21T16:57:34”,
“State”: 0,
“Description”: “Начало выполнения”,
“Info”: “”
},
{
“Time”: “2026-05-21T16:57:44”,
“State”: 1,
“Description”: “Успешное завершение”,
“Info”: “”
}
]

Тип: History

Имя поля Тип Назначение Пример
Time datetime Время события “2026-05-21T16:57:25”
State int Код состояния задачи на момент события. 4
Description string Описание события “Добавление в очередь”
Info string Дополнительная информация ”“

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

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

{
    "Code": 72,
    "Description": "Некорректный id",
    "Success": false
}
    "Description": "Описание ошибки (зависит от ситуации)",
    "Success": false
}

72 — Не указан id

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

DELETE queue/task?taskId={taskId}

Удаление задания из очереди

URL: {{HTTPRoot}}/queue/task?taskId={taskId}

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

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

Тело ответа

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

{
    "Result": {
        "DocId": "593ab0d0-1fdd-4b11-85af-0e6c2f09284c",
        "DocState": 5,
        "QueueState": 0,
        "ResultCode": 0,
        "ResultDescription": "Документ удален из очереди",
        "NumberInQueue": 0,
        "Date": "0001-01-01T00:00:00"
    },
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Тип: QueueStatus

Имя поля Тип Назначение Пример
DocId string Идентификатор документа “593ab0d0-1fdd-4b11-85af-0e6c2f09284c”
DocState int Состояние документа после удаления 5
QueueState int Состояние очереди после удаления 0
ResultCode int Код результата операции 1
ResultDescription string Описание результата “Документ удален из очереди”
NumberInQueue int Позиция в очереди на момент запроса 0
Date datetime Время записи о последнем статусе “0001-01-01T00:00:00”

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

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

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

72 — Не указан id

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

-1 — Задание не найдено в очереди

{
    "Code": -1,
    "Description": "Задание не найдено в очереди",
    "Success": false
}

GET queue/task?taskId={taskId}

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

URL: {{HTTPRoot}}/queue/task?taskId={taskId}

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

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

Тело ответа

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

{
    "Result": {
        "DeviceName": "Atol",
        "DocId": "a4de574d-41d5-40ab-8699-d10a14679d51",
        "DocState": 1,
        "QueueState": 1,
        "ResultCode": 0,
        "ResultDescription": "OK",
        "NumberInQueue": 2,
        "Date": "2026-05-21T16:57:34.0476203+08:00",
        "FiscalSign": "3327337010",
        "DocumentHeader": {
            "OrganizationInfo": "ООО 'Ромашка'",
            "SerialNumber": "0020260207",
            "Vatin": "7722345678",
            "Cashier": "Иванов А.И.",
            "RnNumber": "00031415926",
            "Fn": "0123123123123",
            "FnsUrl": "nalog.ru",
            "ShiftNumber": 39,
            "DocNumber": 336,
            "FiscalSign": "5847203916",
            "OfdOrganizationName": "Тестовый ОФД",
            "OfdVatin": "1234554321"
        }
    },
    "Code": 0,
    "Description": "OK",
    "Success": true
}

Поле Result

Тип: QueueStatus

Имя поля Тип Назначение Пример
DeviceName string Название устройства “Atol”
DocId string Идентификатор документа “53edb056-1bc0-458d-84d1-46e0cea211c1”
DocState int Код состояния документа 1
QueueState int Код состояния очереди 1
NumberInQueue int Позиция задания в очереди на момент запроса 0
ResultCode int Код результата. 0
ResultDescription string Описание результата “OK”
Date datetime Дата и время последнего изменения статуса задачи “2026-05-21T16:57:34”
FiscalSign string Фискальный признак документа. Заполняется только для успешно обработанных фискальных заданий. “3327337010”
DocumentHeader Тип данных Заголовок документа. “DocumentHeader”:

Тип: DocumentHeader

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

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

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

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

72 — Не указан id

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

704 — Нет истории задачи

{
    "Result": {
        "DocId": "a4de574d-41d5-40ab-8699-d10a14679d21",
        "DocState": -1,
        "QueueState": 1,
        "ResultCode": 704,
        "ResultDescription": "Нет истории задачи a4de574d-41d5-40ab-8699-d10a14679d21",
        "NumberInQueue": 0,
        "Date": "0001-01-01T00:00:00"
    },
    "Code": 0,
    "Description": "OK",
    "Success": true
}