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

Очередь

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

GET queue

Запрос: queue

URL: {{HTTPRoot}}/queue

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

Тело ответа

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

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

Тип: список объектов ResponseQueue

ResponseQueue

Имя поля Тип Назначение Пример
DocId string Идентификатор документа “a4de574d-41d5-40ab-8699-d10a14679d51”
DeviceName string Название устройства “Atol”
SentToPrint int Состояние: 0 — не отправлен, 1 — отправлен (ожидает), 2 — ошибка 1
Time datetime Время постановки в очередь “2026-05-21T08:57:34”
Printed bool Признак успешной печати false
Sum decimal Сумма документа 0.0
ErrorDescription string Описание ошибки “Постановка в очередь печати”
Session int Сессия 0
DocNumber int Номер документа 0

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

Запрос: queue/task/history

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

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

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

Параметр Обяз Пример Описание
taskId + 53edb056-1bc0-458d-84d1-46e0cea211c1 Идентификатор задачи

Тело ответа

Успешный ответ (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
}

Тип: объект QueueTaskHistoryResult

QueueTaskHistoryResult

Имя поля Тип Назначение Пример
Time datetime Время события “2026-05-21T16:57:25”
State enum Код состояния 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}

Запрос: queue/task

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

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

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

Параметр Обяз Пример Описание
taskId + 13d58bac-0bb2-4da3-a986-a0514247010e идентификатор задачи

Тело ответа

Успешный ответ (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
}

Тип: объект QueueStatus

QueueStatus

Имя поля Тип Назначение Пример
DocId guid Идентификатор документа “593ab0d0-1fdd-4b11-85af-0e6c2f09284c”
DocState enum Статус обработки задания 5
QueueState enum Статус в очереди 0
ResultCode enum Результат обработки 1
ResultDescription string Описание результата “Документ удален из очереди”
NumberInQueue int Номер в очереди 0
Time 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}

Запрос: queue/task

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

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

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

Параметр Обяз Пример Описание
taskId + 53edb056-1bc0-458d-84d1-46e0cea211c1 Идентификатор задачи

Тело ответа

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

Тип: объект QueueStatus

QueueStatus

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

Поле 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 Номер смены 41
DocNumber int Номер фискального документа 352
FiscalSign string Фискальный признак документа “3281370535”
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
}

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
}