Администрирование
>
СерверККМ V4
>
REST API
Дата обновления: 12 июня 2026 г.
Настройки службы и администрирование подключённых ККТ (регистрация устройств, статус, счётчики, пулы).
ККТ
GET kkt/list
Запрос: kkt/list
URL: {{HTTPRoot}}/kkt/list
Получение список зарегистрированных ККТ.
Тело ответа
Успешный ответ (200 OK)
{
"Result": [
{
"DeviceName": "Atol",
"Driver": 3,
"DeviceStatusDescription": "НетСвязи(выкл)"
},
{
"DeviceName": "Emu",
"Driver": 100,
"DeviceStatusDescription": "Ok"
}
],
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: массив объектов DeviceListResponse
DeviceListResponse
| Имя поля |
Тип |
Назначение |
Пример |
| DeviceName |
string |
Название устройства |
“atol” |
| Driver |
int |
Тип драйвера. 1 — Shtrih; 2 — 1C(4.7); 3 — Atol; 4 — RrElectro; 5 — 1C(5.0); 100 — Emulator; |
3 |
| DeviceStatusDescription |
string |
Описание статуса устройства |
“Ok” |
GET kkt/list/byPool?pool={pool}
Запрос: kkt/list/byPool
URL: {{HTTPRoot}}/kkt/list/byPool?pool={pool}
Получить список устройств, входящих в указанный пул.
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
pool |
+ |
— |
Идентификатор пула |
Тело ответа
Успешный ответ (200 OK)
{
"Result": [
"Atol",
"Emu",
"Shtrih"
],
"Code": 0,
"Description": "OK",
"Success": true
}
Поле Result
Тип: массив строк — названия устройств в пуле.
| Имя поля |
Тип |
Назначение |
Пример |
| Result |
string |
Название устройства |
“Atol”, “Emu”, “Shtrih” |
GET kkt?device={device}
Запрос: kkt
URL: {{HTTPRoot}}/kkt?device={device}
Получение подробной информации об устройстве ККТ.
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
device |
+ |
Emu |
Название устройства |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"ServerVersion": "4.0.58.211",
"Fn": {
"Execution": "",
"FnContainsKeysUpdaterServerUri": false,
"FiscalizationsCount": 1,
"FiscalizationsFree": 0,
"FiscalizationDocumentNumber": "1",
"FiscalizationDateTime": "2025-03-16T00:00:00",
"ReasonCode": 0,
"LivePhase": "fiscalMode",
"Version": "1.0",
"RnNumber": "00031415926",
"FnsUrl": "nalog.ru",
"SenderEmail": "serverkkm@mail.ru",
"FfdVersion": "1.2",
"SerialNumber": "0123123123123",
"OrganizationName": "\"ООО `РБ-Софт`\"",
"Vatin": "0326012345",
"ValidityDate": "2027-02-15T23:36:30.0725604+08:00",
"SaleAddress": "г.Улан-Удэ, ул.Балтахинова, д17Е, офис 215",
"SaleLocation": "Офис",
"TaxVariant": 63,
"SignOfAgent": 127,
"AutomaticNumber": "",
"Ofd": {
"Name": "Тестовый ОФД",
"Vatin": "1234554321",
"Host": "ofd.rbsoft.ru",
"Port": 7777
},
"Warnings": {
"CriticalError": false,
"MemoryOverflow": false,
"NeedReplacement": false,
"OfdTimeout": false,
"ResourceExhausted": false
},
"Modes": {
"PrinterAutomatic": false,
"OfflineMode": false,
"ServiceSign": true,
"BsoSign": false,
"CalcOnlineSign": false,
"DataEncryption": true,
"SaleExcisableGoods": true,
"SignOfGambling": true,
"SignOfLottery": true,
"Pawnshop": true,
"Assurance": true,
"Marking": true,
"VendingMachine": true,
"CateringServices": true,
"WholesaleTrade": true,
"AutomaticMode": false
}
},
"Device": {
"FfdVersion": "1.2",
"FnFfdVersion": "1.2",
"IsFiscal": true,
"LineLength": 64,
"DeviceClass": 4,
"Model": "РБ-Софт:Эмулятор ККМ",
"ModelName": "РБ-Софт:Эмулятор ККМ",
"SerialNumber": "0020260207",
"FirmwareVersion": "2026",
"ConfigurationVersion": "02.07"
},
"Driver": {
"Type": "EmulatorFR",
"Version": "26.01.27",
"Vendor": "РБ-Софт"
},
"Status": {
"IsFnPresent": true,
"IsFnError": false,
"IsIsmDisconnected": false,
"IsOfdDisconnected": false,
"Backlog": {
"DocumentsCounter": 0,
"DocumentFirstNumber": 0,
"DocumentFirstDateTime": "0001-01-01T00:00:00"
},
"ExchangeStatusIsm": {
"AddressIsm": "testism.ru",
"PortIsm": 20,
"Errors": {
"FnCommandCode": 0,
"DocumentNumber": 0,
"LastSuccessConnectionDateTime": "0001-01-01T00:00:00",
"Fn": {
"Code": 0
},
"Network": {
"Code": 0
},
"Ism": {
"Code": 0
}
},
"Status": {
"DocumentsCounter": 0,
"DocumentFirstNumber": 0,
"DocumentFirstDateTime": "0001-01-01T00:00:00"
},
"Warnings": {
"DataForSendIsEmpty": false
}
},
"Warnings": {
"CriticalError": false,
"MemoryOverflow": false,
"NeedReplacement": false,
"OfdTimeout": false,
"ResourceExhausted": false
},
"ShiftNumber": 4,
"CheckNumber": 22,
"CheckNumberByShift": 13,
"CashSum": 2624.89,
"Sum": 10588.89,
"IsFiscal": true,
"OpenShiftTime": "2026-02-15T00:18:26",
"IsShiftOpened": true,
"IsShiftExpired": false,
"ComputerTime": "2026-02-15T23:37:05.0357118+08:00",
"DeviceTime": "2026-02-15T23:37:05.0357118+08:00",
"IsDrawerOpened": false,
"IsCheckPaperPresent": true,
"IsControlPaperPresent": false,
"IsWaitContinuePrint": false,
"IsCoverOpened": false,
"IsBatteryLow": false,
"IsOpenDocument": false,
"LineLength": 42,
"TaskId": "00000000-0000-0000-0000-000000000000",
"Error": 0,
"IsBusy": false,
"ErrorCode": 0,
"ErrorCodeDescription": "OK",
"DriverMode": 0,
"DriverModeDescription": "",
"DriverAdvancedMode": 0,
"DriverAdvancedModeDescription": "",
"LicenseStatus": 0,
"License": {
"code": 0,
"isEndUser": false,
"isActivated": false,
"isBlocked": false,
"blockDate": "0001-01-01T00:00:00",
"date": "0001-01-01T00:00:00",
"expired": "0001-01-01T00:00:00",
"updateExpired": "0001-01-01T00:00:00",
"limitInstalls": 0,
"needObjectActivation": false,
"limitObjects": 0,
"setupTokenIndex": 0,
"licenseUpdated": "0001-01-01T00:00:00"
},
"LicenseUpdated": "0001-01-01T00:00:00"
}
},
"Code": 0,
"Description": "OK",
"Success": true
}
Поле Result
Тип: объект DataKkt
DataKkt
| Имя поля |
Тип |
Назначение |
Пример |
| ServerVersion |
string |
Версия сервера ККМ |
”“ |
| Fn |
FnInfo |
Описание фискального накопителя |
”“ |
| Device |
KktInfo |
Описание ККМ |
”“ |
| Driver |
DriverInfo |
Описание драйвера ККМ |
”“ |
| Status |
KktStatus |
Состояние обмена с ОФД |
”“ |
Поле Fn
| Имя поля |
Тип |
Назначение |
Пример |
| Execution |
string |
Исполнение ФН |
”“ |
| FnContainsKeysUpdaterServerUri |
bool |
ФН содержит URI сервера ОКП |
false |
| FiscalizationsCount |
int |
Количество проведенных регистраций |
0 |
| FiscalizationsFree |
int |
Количество оставшихся регистраций |
0 |
| FiscalizationDocumentNumber |
string |
Номер документа регистрация фискального накопителя |
”“ |
| FiscalizationDateTime |
datetime |
Дата и время операции регистрации фискального накопителя |
“2026-02-15T00:00:00” |
| ReasonCode |
int |
Код причины перерегистрации |
0 |
| LivePhase |
string |
Фаза жизни ФН |
”“ |
| Version |
string |
Версия ФН |
”“ |
| RnNumber |
string |
Регистрационный номер ККТ |
”“ |
| FnsUrl |
string |
Адрес сайта уполномоченного органа(ФНС) в сети «Интернет» |
”“ |
| SenderEmail |
string |
Адрес электронной почты отправителя чека |
”“ |
| FfdVersion |
string |
Версия ФФД ФН |
”“ |
| SerialNumber |
string |
Серийный номер ФН |
”“ |
| OrganizationName |
string |
Название организации |
”“ |
| Vatin |
string |
ИНН организации |
”“ |
| ValidityDate |
datetime |
Срок действия ФН |
“2026-02-15T00:00:00” |
| SaleAddress |
string |
Адрес установки ККТ для проведения расчетов |
”“ |
| SaleLocation |
string |
Место проведения расчетов |
”“ |
| TaxVariant |
int |
Коды систем налогообложения |
0 |
| SignOfAgent |
int |
Коды признаков агента |
0 |
| AutomaticNumber |
string |
Номер автомата |
”“ |
| Ofd |
Ofd |
ОФД |
”“ |
| Warnings |
Warnings |
|
”“ |
| Modes |
FnModes |
|
”“ |
Поле Ofd
| Имя поля |
Тип |
Назначение |
Пример |
| Name |
string |
Имя ОФД |
“Тестовый ОФД” |
| Vatin |
string |
ИНН ОФД |
“1234554321” |
| Host |
string |
Адрес сервера ОФД |
“ofd.rbsoft.ru” |
| Port |
int |
Порт сервера ОФД |
7777 |
Поле Warnings
| Имя поля |
Тип |
Назначение |
Пример |
| CriticalError |
bool |
Критическая ошибка ФН |
false |
| MemoryOverflow |
bool |
Память ФН переполнена |
false |
| NeedReplacement |
bool |
Требуется срочная замена ФН |
false |
| OfdTimeout |
bool |
Превышено время ожидания ответа от ОФД |
false |
| ResourceExhausted |
bool |
Исчерпан ресурс ФН |
false |
Поле Modes
| Имя поля |
Тип |
Назначение |
Пример |
| PrinterAutomatic |
bool |
Признак установки принтера в автомате |
false |
| OfflineMode |
bool |
Признак автономного режима |
false |
| ServiceSign |
bool |
Признак расчетов за услуги |
false |
| BsoSign |
bool |
Признак формирования только БСО |
false |
| CalcOnlineSign |
bool |
Признак ККТ для расчетов только в Интернет |
false |
| DataEncryption |
bool |
Признак шифрование данных |
false |
| SaleExcisableGoods |
bool |
Продажа подакцизного товара |
false |
| SignOfGambling |
bool |
Признак проведения азартных игр |
false |
| SignOfLottery |
bool |
Признак проведения лотереи |
false |
| Pawnshop |
bool |
Признак применения при осуществлении ломбардами кредитования граждан |
false |
| Assurance |
bool |
Признак применения при осуществлении деятельности по страхованию |
false |
| Marking |
bool |
Признак применения при осуществлении торговли товарами, подлежащими обязательной маркировке средствами идентификации |
false |
| VendingMachine |
bool |
Признак применения в автоматическом торговом автомате |
false |
| CateringServices |
bool |
Признак применения при оказании услуг общественного питания |
false |
| WholesaleTrade |
bool |
Признак применения о оптовой торговле с организациями и ИП |
false |
| AutomaticMode |
bool |
Признак автоматического режима |
false |
Поле Device
| Имя поля |
Тип |
Назначение |
Пример |
| FfdVersion |
string |
Версия ФФД |
“1.2 |
| FnFfdVersion |
string |
Версия ФФД ФН |
“1.2” |
| TimeZone |
int |
Часовая зона устройства |
7 |
| KktLicenses |
array |
Массив лицензий ККТ |
[] |
| IsFiscal |
bool |
Фискальный |
true |
| LineLength |
int |
Ширина чековой ленты |
64 |
| LineLengthPixels |
int |
Ширина чековой ленты в пикселях |
0 |
| DeviceClass |
int |
Тип устройства: 1 — Принтер; 2 — Чековый принтер; 3 — Фискальный регистратор (не онлайн-ккм); 4 — Онлайн-ккм, применяемая в РФ в соответствии с ФЗ-54.; 5 — Эквайринговый терминал; 6 — Терминал сбора данных; 7 — Электронные весы; 8 — Электронные весы; 9 — Сканер штрихкодов |
7 |
| SerialNumber |
string |
Заводской номер ККТ |
“0020260207” |
| FirmwareVersion |
string |
Версия прошивки |
“2026” |
| ConfigurationVersion |
string |
Версия конфигурации прошивки устройства |
“02.07” |
Поле Driver
| Имя поля |
Тип |
Назначение |
Пример |
| Type |
string |
Тип драйвера |
“EmulatorFR” |
| Version |
string |
Версия драйвера |
“26.01.27” |
| Vendor |
string |
Данные поставщика |
“РБ-Софт” |
Поле Status
| Имя поля |
Тип |
Назначение |
Пример |
| IsFnPresent |
bool |
Присутствует ли фискальный накопитель |
false |
| IsFnError |
bool |
Находится ли фискальный накопитель в состоянии ошибки |
false |
| IsIsmDisconnected |
bool |
Доступен ли информационной системы маркировки |
false |
| IsOfdDisconnected |
bool |
Доступен ли оператор информационной системы маркировки |
false |
| ShiftNumber |
int |
Номер смены |
0 |
| DocNumber |
int |
Номер фискального документа |
0 |
| DocNumberInShift |
int |
Номер фискального документа за смену |
0 |
| CashSum |
decimal |
Сумма наличных в денежном ящике |
0.0 |
| TotalSum |
decimal |
Сумма выручки |
0.0 |
| IsFiscal |
bool |
Фискальный |
true |
| OpenShiftTime |
DateTime |
Время открытия кассовой смены |
“0001-01-01T00:00:00” |
| IsShiftOpened |
bool |
Смена открыта |
false |
| IsShiftExpired |
bool |
Смена истекла |
false |
| ComputerTime |
DateTime |
Время получения данных |
“2026-05-23T19:50:04.7531056+08:00” |
| DeviceTime |
DateTime |
Время в часах устройства |
“2026-05-23T19:50:04.7531056+08:00” |
| IsDrawerOpened |
bool |
Открыт денежный ящик |
false |
| IsCheckPaperPresent |
bool |
Наличие чековой ленты |
false |
| IsControlPaperPresent |
bool |
Наличие контрольной ленты |
false |
| IsWaitContinuePrint |
bool |
Ожидание продолжения печати |
false |
| IsCoverOpened |
bool |
Открыта ли крышка |
false |
| IsBatteryLow |
bool |
Аккумулятор разряжен |
false |
| IsOpenDocument |
bool |
Открытый документ |
false |
| LineLength |
int |
Ширина чековой ленты |
42 |
| LineLengthPixels |
int |
Ширина чековой ленты в пикселях |
512 |
| TaskId |
Guid |
Идентификатор текущей задачи |
“00000000-0000-0000-0000-000000000000” |
| Error |
int |
Код ошибки |
0 |
| ErrorCodeDescription |
string |
Описание ошибки устройства по данным драйвера |
“OK” |
| DriverMode |
int |
Режим по данным драйвера |
0 |
| DriverModeDescription |
string |
Описание режима Mode по данным драйвера |
”“ |
| DriverAdvancedMode |
int |
Специальный режим по данным драйвера |
0 |
| DriverAdvancedModeDescription |
string |
Описание режима AdvancedMode по данным драйвера |
0 |
| LicenseStatus |
enum |
Статус состояния лицензии |
0 |
| LicenseUpdated |
DateTime |
Время последней проверке лицензии |
“0001-01-01T00:00:00” |
Поле Ism
| Имя поля |
Тип |
Назначение |
Пример |
| Address |
string |
Адрес |
“ism.rbsoft.ru” |
| Port |
int |
Порт |
8888 |
Поле Errors
| Имя поля |
Тип |
Назначение |
Пример |
| FnCommandCode |
int |
Код фискального накопителя |
0 |
| DocumentNumber |
int |
Номер документа |
0 |
| LastSuccessConnectionDateTime |
DateTime |
Время последнего успешного подключения |
“0001-01-01T00:00:00” |
Поле Backlog
| Имя поля |
Тип |
Назначение |
Пример |
| DocumentsCounter |
int |
Количество непереданных документов |
0 |
| DocumentFirstNumber |
int |
Номер первого непереданного документ |
0 |
| DocumentFirstDateTime |
DateTime |
Дата и время первого из непереданных документов |
“0001-01-01T00:00:00” |
Поле Warnings
| Имя поля |
Тип |
Назначение |
Пример |
| CriticalError |
bool |
Критическая ошибка ФН |
false |
| MemoryOverflow |
bool |
Память ФН переполнена |
false |
| NeedReplacement |
bool |
Требуется срочная замена ФН |
false |
| OfdTimeout |
bool |
Превышено время ожидания ответа от ОФД |
false |
| ResourceExhausted |
bool |
Исчерпан ресурс ФН |
false |
Поле License
| Имя поля |
Тип |
Назначение |
Пример |
| code |
int |
Код ошибки |
0 |
| isEndUser |
bool |
Признак лицензии на конечного пользователя. <br>true — лицензия выдана конечному пользователю. <br>false — лицензия выдана партнеру для перепродажи |
false |
| isActivated |
bool |
Признак активации |
false |
| isBlocked |
bool |
Признак блокировки |
0 |
| blockDate |
DateTime |
Дата блокировки |
“0001-01-01T00:00:00” |
| date |
DateTime |
Дата продажи |
“0001-01-01T00:00:00” |
| expired |
DateTime |
Дата истечения срока действия |
“0001-01-01T00:00:00” |
| updateExpired |
DateTime |
Дата истечения доступа к обновлениям |
“0001-01-01T00:00:00” |
| limitInstalls |
int |
Количество разрешенных привязок равно числу ККМ, которые можно привязать к одной лицензии |
0 |
| needObjectActivation |
bool |
Признак необходимости привязки объектов лицензирования после привязки. |
0 |
| limitObjects |
int |
Количество объектов привязки на каждую установку |
0 |
| setupTokenIndex |
int |
Индекс установочного токена |
0 |
| LicenseUpdated |
DateTime |
Время последней проверке лицензии |
“0001-01-01T00:00:00” |
Примеры ошибок
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
709 — Устройство не найдено
{
"Code": 709,
"Description": "Устройство не найдено: Устройство '{device}' не найдено.",
"Success": false
}
POST kkt
Запрос: kkt
URL: {{HTTPRoot}}/kkt
Добавление устройства ККТ.
Тело запроса
{
"DeviceName": "MyKkt054",
"Settings": {
"DeviceType": 1,
"Available": true,
"DeviceName": "MyKkt054",
"MethodConnection": 0,
"PortNumber": 1,
"BaudRate": 9600,
"IpAddress": "192.168.0.109",
"TcpPort": 7778,
"Password": "30",
"SerialNumber": "0392790042005043",
"SenderEmail": "noreply@example.com",
"Cashier": "Иванов И.И.",
"CashierVatin": "000000000000",
"Vatin": "7700000000",
"OrganizationName": "ООО Ромашка",
"SaleAddress": "г. Москва, ул. Пример, д. 1",
"ClientSaleLocation": "Торговый зал",
"TimeoutConnection": 5000,
"TimeoutWaitForPrinting": 60000,
"OfdAddress": "ofd.example.ru",
"OfdPort": 7777
}
}
Поле Settings
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| DeviceName |
string |
+ |
Название устройства |
“MyKkt04” |
| DeviceType |
int |
+ |
Тип драйвера |
1 |
| Available |
bool |
- |
Признак доступности |
true |
| MethodConnection |
int |
+ |
Метод подключения: 0 — COM; 1 — TCP/IP |
0 |
| PortNumber |
int |
- |
Номер COM-порта. Обязательно при MethodConnection=0 |
1 |
| BaudRate |
int |
- |
Скорость COM-порта. Обязательно при MethodConnection=0 |
9600 |
| IpAddress |
string |
- |
IP-адрес. Обязательно при MethodConnection=1 |
“192.168.0.109” |
| TcpPort |
int |
- |
TCP-порт. Обязательно при MethodConnection=1 |
7778 |
| Password |
string |
+ |
Пароль устройства |
“30” |
| SerialNumber |
string |
- |
Серийный номер устройства |
“0392790042005043” |
| Vatin |
string |
- |
ИНН организации |
“7700000000” |
| OrganizationName |
string |
- |
Название организации |
“ООО Ромашка” |
| SaleAddress |
string |
- |
Адрес расчётов |
“г. Москва, ул. Пример, д. 1” |
| ClientSaleLocation |
string |
- |
Место расчётов |
“Торговый зал” |
| Cashier |
string |
- |
ФИО кассира по умолчанию |
“Иванов И.И.” |
| CashierVatin |
string |
- |
ИНН кассира |
“000000000000” |
| SenderEmail |
string |
- |
Email отправителя чека |
"noreply@example.com“ |
| TimeoutConnection |
int |
- |
Таймаут подключения (мс) |
5000 |
| TimeoutWaitForPrinting |
int |
- |
Таймаут ожидания печати (мс) |
60000 |
| OfdAddress |
string |
- |
Адрес ОФД |
“ofd.example.ru” |
| OfdPort |
int |
- |
Порт ОФД |
7777 |
| Pool |
string |
- |
Имя пула |
”“ |
Тело ответа
Успешный ответ (200 OK)
{
"Code": 0,
"Description": "OK",
"Success": true
}
Примеры ошибок
-1 — Устройство с таким именем уже существует
{
"Code": -1,
"Description": "ошибка: Ошибка добавления устройства. Устройство с таким именем уже существует",
"Success": false
}
DELETE kkt?device={device}
Запрос: kkt
URL: {{HTTPRoot}}/kkt?device={device}
Удаление устройства ККТ
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
device |
+ |
MyKkt04 |
Название устройства |
Тело ответа
Успешный ответ (200 OK)
{
"Code": 0,
"Description": "OK",
"Success": true
}
Примеры ошибок
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
PUT kkt
Запрос: kkt
URL: {{HTTPRoot}}/kkt
Редактирование параметров устройства ККТ.
Тело запроса
{
"DeviceName": "MyKkt045",
"Settings": {
"DeviceName": "MyKkt042",
"DeviceType": 1,
"MethodConnection": 0,
"PortNumber": 1,
"BaudRate": 9600,
"IpAddress": "192.168.0.101",
"TcpPort": 7778,
"Password": "30",
"AccessPassword": "0000",
"UseAccessPassword": false,
"TimeoutConnection": 5000,
"TimeoutWaitForPrinting": 60000,
"Available": true
}
}
Поле Settings
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| DeviceName |
string |
+ |
Название устройства |
“MyKkt04” |
| DeviceType |
int |
+ |
Тип драйвера |
1 |
| MethodConnection |
int |
+ |
Метод подключения: 0 — COM; 1 — TCP/IP |
0 |
| PortNumber |
int |
- |
Номер COM-порта. Обязательно при MethodConnection=0 |
1 |
| BaudRate |
int |
- |
Скорость COM-порта. Обязательно при MethodConnection=0 |
9600 |
| IpAddress |
string |
- |
IP-адрес. Обязательно при MethodConnection=1 |
“192.168.0.101” |
| TcpPort |
int |
- |
TCP-порт. Обязательно при MethodConnection=1 |
7778 |
| Password |
string |
- |
Пароль устройства |
“30” |
| Available |
bool |
- |
Признак доступности |
true |
| AccessPassword |
string |
- |
Пароль доступа |
“0000” |
| UseAccessPassword |
bool |
- |
Использовать пароль доступа |
false |
| TimeoutConnection |
int |
- |
Таймаут подключения (мс) |
5000 |
| TimeoutWaitForPrinting |
int |
- |
Таймаут ожидания печати (мс) |
60000 |
Тело ответа
Примеры ошибок
-1 — Устройство не поддерживает метод UpdateKKM
{
"Code": -1,
"Description": "ошибка: Ошибка обновления устройства: Устройство не поддерживает метод UpdateKKM",
"Success": false
}
GET kkt/lineLength?device={device}
Запрос: kkt/lineLength
URL: {{HTTPRoot}}/kkt/lineLength?device={device}
Получение максимальную ширину строки чека устройства.
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
device |
+ |
Emu |
название устройства |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"LineLength": 64,
"LineLengthPixels": 512
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект LineLength
LineLength
| Имя поля |
Тип |
Назначение |
Пример |
| LineLength |
int |
Ширина чековой ленты в символах |
42 |
| LineLengthPixels |
int |
Ширина чековой ленты в пикселях |
384 |
GET kkt/status?device={device}
Запрос: kkt/status
URL: {{HTTPRoot}}/kkt/status?device={device}
Получение расширенного статуса ККТ.
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
device |
+ |
Emu |
Название устройства |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"IsFnPresent": true,
"IsFnError": false,
"IsIsmDisconnected": false,
"IsOfdDisconnected": false,
"Ism": {
"Address": "ism.rbsoft.ru",
"Port": 8888,
"Errors": {
"FnCommandCode": 0,
"DocumentNumber": 0,
"LastSuccessConnectionDateTime": "0001-01-01T00:00:00",
"Fn": {
"Code": 0
},
"Network": {
"Code": 0
},
"Ism": {
"Code": 0,
"Description": ""
}
},
"Backlog": {
"DocumentsCounter": 0,
"DocumentFirstNumber": 0,
"DocumentFirstDateTime": "0001-01-01T00:00:00"
}
},
"Warnings": {
"CriticalError": false,
"MemoryOverflow": false,
"NeedReplacement": false,
"OfdTimeout": false,
"ResourceExhausted": false
},
"ShiftNumber": 0,
"DocNumber": 0,
"DocNumberInShift": 0,
"CashSum": 0,
"TotalSum": 0,
"IsFiscal": true,
"OpenShiftTime": "0001-01-01T00:00:00",
"IsShiftOpened": false,
"IsShiftExpired": false,
"ComputerTime": "2026-05-23T21:54:46.9737064+08:00",
"DeviceTime": "2026-05-23T21:54:46.9737064+08:00",
"IsDrawerOpened": false,
"IsCheckPaperPresent": true,
"IsControlPaperPresent": false,
"IsWaitContinuePrint": false,
"IsCoverOpened": false,
"IsBatteryLow": false,
"IsOpenDocument": false,
"LineLength": 42,
"LineLengthPixels": 512,
"TaskId": "00000000-0000-0000-0000-000000000000",
"Error": 0,
"IsBusy": false,
"ErrorCode": 0,
"ErrorCodeDescription": "OK",
"DriverMode": 0,
"DriverModeDescription": "",
"DriverAdvancedMode": 0,
"DriverAdvancedModeDescription": "",
"LicenseStatus": 0,
"License": {
"code": 0,
"isEndUser": false,
"isActivated": false,
"isBlocked": false,
"blockDate": "0001-01-01T00:00:00",
"date": "0001-01-01T00:00:00",
"expired": "0001-01-01T00:00:00",
"updateExpired": "0001-01-01T00:00:00",
"limitInstalls": 0,
"needObjectActivation": false,
"limitObjects": 0,
"setupTokenIndex": 0,
"licenseUpdated": "0001-01-01T00:00:00"
},
"LicenseUpdated": "0001-01-01T00:00:00"
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект KktStatus
KktStatus
| Имя поля |
Тип |
Назначение |
Пример |
| IsFnPresent |
bool |
Присутствует ли фискальный накопитель |
false |
| IsFnError |
bool |
Находится ли фискальный накопитель в состоянии ошибки |
false |
| IsIsmDisconnected |
bool |
Доступен ли информационной системы маркировки |
false |
| IsOfdDisconnected |
bool |
Доступен ли оператор информационной системы маркировки |
false |
| ShiftNumber |
int |
Смена |
4 |
| DocNumber |
int |
Номер чека |
22 |
| CashSum |
decimal |
Сумма наличных в денежном ящике |
2624.89 |
| TotalSum |
decimal |
Сумма выручки |
110.0 |
| IsFiscal |
bool |
Фискальный |
true |
| OpenShiftTime |
DateTime |
Время открытия кассовой смены |
“2026-05-23T19:50:04.7531056+08:00” |
| IsShiftOpened |
bool |
Смена открыта |
false |
| IsShiftExpired |
bool |
Смена истекла |
false |
| ComputerTime |
DateTime |
Время получения данных |
“2026-05-23T19:50:04.7531056+08:00” |
| DeviceTime |
DateTime |
Время в часах устройства |
“2026-05-23T19:50:04.7531056+08:00” |
| IsDrawerOpened |
bool |
Открыт денежный ящик |
false |
| IsCheckPaperPresent |
bool |
Наличие чековой ленты |
false |
| IsControlPaperPresent |
bool |
Наличие контрольной ленты |
false |
| IsWaitContinuePrint |
bool |
Ожидание продолжения печати |
false |
| IsCoverOpened |
bool |
Открыта ли крышка |
false |
| IsBatteryLow |
bool |
Аккумулятор разряжен |
false |
| IsOpenDocument |
bool |
Открытый документ |
false |
| LineLength |
int |
Ширина чековой ленты |
42 |
| LineLengthPixels |
int |
Ширина чековой ленты в пикселях |
512 |
| TaskId |
Guid |
Идентификатор текущей задачи |
“00000000-0000-0000-0000-000000000000” |
| Error |
int |
Код ошибки |
0 |
| IsBusy |
bool |
Признак занятости устройства |
false |
| ErrorCode |
int |
Код ошибки |
0 |
| ErrorCodeDescription |
string |
Описание ошибки устройства по данным драйвера |
“OK” |
| DriverMode |
int |
Режим по данным драйвера |
0 |
| DriverModeDescription |
string |
Описание режима Mode по данным драйвера |
”“ |
| DriverAdvancedMode |
int |
Специальный режим по данным драйвера |
0 |
| DriverAdvancedModeDescription |
string |
Описание режима AdvancedMode по данным драйвера |
0 |
| LicenseStatus |
enum |
Статус состояния лицензии |
0 |
| LicenseUpdated |
DateTime |
Время последней проверке лицензии |
“0001-01-01T00:00:00” |
Поле Ism
| Имя поля |
Тип |
Назначение |
Пример |
| Address |
string |
Адрес |
“ism.rbsoft.ru” |
| Port |
int |
Порт |
8888 |
Поле Errors
| Имя поля |
Тип |
Назначение |
Пример |
| FnCommandCode |
int |
Код фискального накопителя |
0 |
| DocumentNumber |
int |
Номер документа |
0 |
| LastSuccessConnectionDateTime |
DateTime |
Время последнего успешного подключения |
“0001-01-01T00:00:00” |
Поле Backlog
| Имя поля |
Тип |
Назначение |
Пример |
| DocumentsCounter |
int |
Количество непереданных документов |
0 |
| DocumentFirstNumber |
int |
Номер первого непереданного документ |
0 |
| DocumentFirstDateTime |
DateTime |
Дата и время первого из непереданных документов |
“0001-01-01T00:00:00” |
Поле Warnings
| Имя поля |
Тип |
Назначение |
Пример |
| CriticalError |
bool |
Критическая ошибка ФН |
false |
| MemoryOverflow |
bool |
Память ФН переполнена |
false |
| NeedReplacement |
bool |
Требуется срочная замена ФН |
false |
| OfdTimeout |
bool |
Превышено время ожидания ответа от ОФД |
false |
| ResourceExhausted |
bool |
Исчерпан ресурс ФН |
false |
Поле License
| Имя поля |
Тип |
Назначение |
Пример |
| code |
int |
Код ошибки |
0 |
| isEndUser |
bool |
Признак лицензии на конечного пользователя: true — лицензия выдана конечному пользователю; false — лицензия выдана партнеру для перепродажи |
false |
| isActivated |
bool |
Признак активации |
false |
| isBlocked |
bool |
Признак блокировки |
0 |
| blockDate |
DateTime |
Дата блокировки |
“0001-01-01T00:00:00” |
| date |
DateTime |
Дата продажи |
“0001-01-01T00:00:00” |
| expired |
DateTime |
Дата истечения срока действия |
“0001-01-01T00:00:00” |
| updateExpired |
DateTime |
Дата истечения доступа к обновлениям |
“0001-01-01T00:00:00” |
| limitInstalls |
int |
Количество разрешенных привязок равно числу ККМ, которые можно привязать к одной лицензии |
0 |
| needObjectActivation |
bool |
Признак необходимости привязки объектов лицензирования после привязки. |
0 |
| limitObjects |
int |
Количество объектов привязки на каждую установку |
0 |
| setupTokenIndex |
int |
Индекс установочного токена |
0 |
| LicenseUpdated |
DateTime |
Время последней проверке лицензии |
“0001-01-01T00:00:00” |
Примеры ошибок
-1 — GetDeviceStatus: Не удалось найти устройство по deviceName =
{
"Code": -1,
"Description": "GetDeviceStatus: Не удалось найти устройство по deviceName = {device}",
"Success": false
}
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
GET kkt/shift/status?device={device}
Запрос: kkt/shift/status
URL: {{HTTPRoot}}/kkt/shift/status?device={device}
Получение краткого статуса смены и очереди ОФД.
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
device |
+ |
Emu |
Название устройства |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"ShiftNumber": 0,
"CheckNumber": 0,
"ShiftState": 1,
"Backlog": {
"DocumentsCounter": 0,
"DocumentFirstNumber": 0,
"DocumentFirstDateTime": "0001-01-01T00:00:00"
}
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект ResponseCurrentStatus
ResponseCurrentStatus
| Имя поля |
Тип |
Назначение |
Пример |
| ShiftNumber |
int |
Номер смены |
4 |
| CheckNumber |
int |
Номер последнего ФД |
22 |
| ShiftState |
int |
1 — закрыта, 2 — открыта, 3 — истекла |
2 |
Поле Backlog
| Имя поля |
Тип |
Назначение |
Пример |
| DocumentsCounter |
int |
Количество непереданных документов |
0 |
| DocumentFirstNumber |
int |
Номер первого непереданного документа |
0 |
| DocumentFirstDateTime |
datetime |
Дата первого непереданного документа |
“0001-01-01T00:00:00” |
Примеры ошибок
-1 — GetDeviceStatus: Не удалось найти устройство по deviceName =
{
"Code": -1,
"Description": "GetDeviceStatus: Не удалось найти устройство по deviceName = {device}",
"Success": false
}
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
GET kkt/counters/shift?device={device}
Запрос: kkt/counters/shift
URL: {{HTTPRoot}}/kkt/counters/shift?device={device}
Получение счётчики за смену.
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
device |
+ |
Emu |
Название устройства |
Тело запроса
{
"DeviceName": "{device}"
}
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"ShiftNumber": 40,
"CashDrawer": {
"Sum": 1365.68,
"Count": 0
},
"ShiftIncome": {
"Count": 0,
"Sum": 0
},
"ShiftOutcome": {
"Count": 0,
"Sum": 0
},
"Counters": {
"SumCorrection": 0,
"NumberCorrections": 0,
"Sales": {
"Count": 1,
"Sum": 50,
"Payments": {
"Sum": 0,
"Cash": 50
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {
"TaxVat_5": 2.38
}
},
"SalesReturn": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"SalesCorrection": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"SalesReturnCorrection": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"Purchases": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"PurchasesReturn": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"PurchasesCorrection": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"PurchasesReturnCorrection": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
}
}
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект ResShiftTotal
Поле ResShiftTotal
| Имя поля |
Тип |
Назначение |
Пример |
| ShiftNumber |
double |
Номер смены |
40.0 |
Поле CashDrawer — Детали ленежного ящиика
| Имя поля |
Тип |
Назначение |
Пример |
| Sum |
decimal |
Сумма |
1365.68 |
| Count |
int |
Количество |
0 |
Поле ShiftIncome - Внесение
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.0 |
Поле ShiftOutcome — Выемка
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.0 |
Поле Counters — Счётчики
| Имя поля |
Тип |
Назначение |
Пример |
| SumCorrection |
decimal |
Сумма коррекций |
0.0 |
| NumberCorrections |
int |
Количество коррекций |
0 |
Поле Sales — Чеки прихода
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
50.0 |
Поле SalesReturn — Чеки возврата прихода
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.00 |
Поле SalesCorrection — Чеки прихода
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.00 |
Поле SalesReturnCorrection — Чеки возврата прихода
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.00 |
Поле Purchases — Чеки расхода
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.00 |
Поле PurchasesReturn — Чеки возврата расхода
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
1365.68 |
Поле PurchasesCorrection — Чеки расхода
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.00 |
Поле PurchasesReturnCorrection — Чеки возврата расхода
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.00 |
Поле Payments — Сумма оплат
| Имя поля |
Тип |
Назначение |
Пример |
| Sum |
decimal |
Общая сумма чеков |
50.0 |
| Cash |
decimal |
Сумма оплат наличными |
50.0 |
Поле Discount — Скидки
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.0 |
Поле Adding — Надбавки
| Имя поля |
Тип |
Назначение |
Пример |
| Count |
int |
Количество |
0 |
| Sum |
decimal |
Сумма |
0.0 |
Поле Tax — Сумма НДС
| Имя поля |
Тип |
Назначение |
Пример |
| TaxVat_5 |
decimal |
Налоги |
0.0 |
Примеры ошибок
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
POST kkt/reboot
Запрос: kkt/reboot
URL: {{HTTPRoot}}/kkt/reboot
Перезагрузка устройства.
Тело запроса
{
"DeviceName": "Emu"
}
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| DeviceName |
string |
+ |
Название устройства |
“atol” |
Тело ответа
Успешный ответ (200 OK)
{
"Code": 0,
"Description": "ОК",
"Success": false
}
Примеры ошибок
2 — Не указано имя ККТ
{
"Code": 2,
"Description": "Bad Request",
"Success": false
}
2 — Не найдено устройство
{
"Code": 2,
"Description": "RebootDevice(): Не найдено устройство {device}.",
"Success": false
}
POST kkt/font/setting
Запрос: kkt/font/setting
URL: {{HTTPRoot}}/kkt/font/setting
Редактирование настроек шрифта шаблона для устройства.
Тело запроса
{
"DeviceName": "atol2",
"Settings": {
"Name": "lines2",
"TemplateSettingH1": "1",
"TemplateSettingH2": "1",
"TemplateSettingH3": "2",
"TemplateSettingH4": "2",
"TemplateSettingH5": "2"
}
}
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| DeviceName |
string |
+ |
Название устройства |
“atol2” |
Поле Settings
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| Name |
string |
+ |
Название шаблона |
“lines2” |
| TemplateSettingH1 |
string |
- |
Настройка шрифта блока H1 |
“1” |
| TemplateSettingH2 |
string |
- |
Настройка шрифта блока H2 |
“1” |
| TemplateSettingH3 |
string |
- |
Настройка шрифта блока H3 |
“2” |
| TemplateSettingH4 |
string |
- |
Настройка шрифта блока H4 |
“2” |
| TemplateSettingH5 |
string |
- |
Настройка шрифта блока H5 |
“2” |
Тело ответа
Успешный ответ (200 OK)
{
"Code": 0,
"Description": "OK",
"Success": true
}
Примеры ошибок
709 — Устройство не найдено
{
"Code": 709,
"Description": "Устройство не найдено: Устройство '{device}' не найдено.",
"Success": false
}
GET pool/list
Запрос: pool/list
URL: {{HTTPRoot}}/pool/list
Получение списка всех пулов.
Тело ответа
Успешный ответ (200 OK)
{
"Result": [
"asd"
],
"Code": 0,
"Description": "OK",
"Success": true
}
Поле Result
Тип: массив строк — названия пулов.
| Имя поля |
Тип |
Назначение |
Пример |
| Result |
array |
Название пулов |
“asd”, “dsa” |
Служба
GET service/settings
Запрос: service/settings
URL: {{HTTPRoot}}/service/settings
Получение настроек службы
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"WcfServicePort": 4398,
"WebServicePort": 8866,
"ServiceTimeOut": "00:00:15",
"ProxyServerSettings": {
"IsUseProxy": false,
"IpAddress": "",
"Port": 0,
"Name": "",
"Password": ""
},
"MaxQueueSize": 100,
"RepeatPrintingOnError": false
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект ServiceSettings
ServiceSettings
| Имя поля |
Тип |
Назначение |
Пример |
| WcfServicePort |
int |
Порт WCF-сервиса |
4398 |
| WebServicePort |
int |
Порт веб-сервиса |
8866 |
| ServiceTimeOut |
TimeSpan |
Таймаут обработки запросов |
“00:00:15” |
| MaxQueueSize |
int |
Максимальный размер очереди заданий |
100 |
| RepeatPrintingOnError |
bool |
Повторять печать при ошибке/перезапуске |
false |
Поле ProxyServerSettings
| Имя поля |
Тип |
Назначение |
Пример |
| IsUseProxy |
bool |
Использовать прокси-сервер |
false |
| IpAddress |
string |
IP-адрес прокси |
”“ |
| Port |
int |
Порт прокси |
0 |
| Name |
string |
Логин прокси |
”“ |
| Password |
string |
Пароль прокси |
”“ |
POST service/settings
Запрос: service/settings
URL: {{HTTPRoot}}/service/settings
Сохранение настроек служб
Тело запроса
{
"ServiceSettings": {
"WcfServicePort": 4398,
"WebServicePort": 8888,
"ServiceTimeOut": "00:00:15",
"ProxyServerSettings": {
"IsUseProxy": false,
"IpAddress": "",
"Port": 0,
"Name": "",
"Password": ""
},
"MaxQueueSize": 100,
"RepeatPrintingOnError": false
}
}
Поле ServiceSettings
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| WcfServicePort |
int |
+ |
Порт WCF-сервиса |
4398 |
| WebServicePort |
int |
+ |
Порт веб-сервиса |
8866 |
| ServiceTimeOut |
string |
- |
Таймаут обработки запросов (hh:mm:ss) |
“00:00:15” |
| MaxQueueSize |
int |
+ |
Максимальный размер очереди заданий |
100 |
| RepeatPrintingOnError |
bool |
- |
Повторять печать при ошибке/перезапуске |
false |
ProxyServerSettings
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| IsUseProxy |
bool |
- |
Использовать прокси-сервер |
false |
| IpAddress |
string |
- |
IP-адрес прокси |
”“ |
| Port |
int |
- |
Порт прокси |
0 |
| Name |
string |
- |
Логин прокси |
”“ |
| Password |
string |
- |
Пароль прокси |
”“ |
Тело ответа
Успешный ответ (200 OK)
{
"Code": 0,
"Description": "OK",
"Success": true
}
