Кассовые cмены
>
СерверККМ V4
>
REST API
>
Работа с ККМ
Дата обновления: 15 июня 2026 г.
POST shift/open
Запрос: shift/open
URL: {{HTTPRoot}}/shift/open
Открытие кассовой смены.
Тело запроса
{
"DeviceName": "{device}",
"Cashier": {
"Name": "Иванов",
"Vatin": ""
}
}
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| DeviceName |
string |
+ |
Имя устройства |
“atol2” |
Поле Cashier
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| Name |
string |
- |
ФИО кассира |
“Иванов” |
| Vatin |
string |
- |
ИНН кассира |
”“ |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"datetime": "2026-05-24T00:11:23.5221437+08:00",
"deviceName": "Emu",
"docId": "7ccfb3d4-bc93-40c7-9e4d-aa1c8b0261b6",
"fnsUrl": "nalog.ru",
"fnNumber": "0123123123123",
"rnNumber": "00031415926",
"fiscalDatetime": "20260524001123",
"shiftNumber": 3,
"outputParameters": {
"NumberOfChecks": 1,
"NumberOfDocuments": 1,
"ResourcesFn": 365,
"ShiftNumber": 3,
"CheckNumber": 5,
"ShiftClosingCheckNumber": 1,
"DateTime": "2026-05-24T00:11:23.5515451+08:00",
"ShiftState": 2,
"CashBalance": 0,
"Backlog": {
"DocumentsCounter": 0,
"DocumentFirstNumber": 0,
"DocumentFirstDateTime": "0001-01-01T00:00:00"
},
"FnWarnings": {
"CriticalError": false,
"MemoryOverflow": false,
"NeedReplacement": false,
"OfdTimeout": false,
"ResourceExhausted": false
},
"FnValidityDate": "2027-05-24T00:11:23.5515451+08:00"
},
"deviceInfo": {
"FfdVersion": "1.2",
"FnFfdVersion": "1.2",
"TimeZone": 7,
"KktLicenses": [],
"IsFiscal": true,
"LineLength": 64,
"LineLengthPixels": 512,
"DeviceClass": 4,
"Model": "РБ-Софт:Эмулятор ККМ",
"SerialNumber": "0020260207",
"FirmwareVersion": "2026",
"ConfigurationVersion": "02.07"
}
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект OpenShiftResult
OpenShiftResult
| Имя поля |
Тип |
Назначение |
Пример |
| datetime |
datetime |
Время операции |
“2026-05-12T18:38:52” |
| deviceName |
string |
Название устройства |
“d83e0030-…” |
| docId |
string |
Идентификатор задания |
“d83e0030-…” |
| fnsUrl |
string |
Адрес сайта уполномоченного органа (ФНС) в сети «Интернет» |
“nalog.ru” |
| fnNumber |
string |
Номер фискального накопителя |
“0123123123123” |
| rnNumber |
string |
РНМ |
“00031415926” |
| fiscalDatetime |
string |
Дата и время документа по часам ФН |
“20260523234515” |
| shiftNumber |
int |
Номер смены |
2 |
Поле OutputParameters
| Имя поля |
Тип |
Назначение |
Пример |
| NumberOfChecks |
int |
Количество кассовых чеков за смену |
1 |
| NumberOfDocuments |
int |
Количество общее ФД за смену |
1 |
| ResourcesFn |
int |
Срок действия ключей фискального признака |
365 |
| ShiftNumber |
int |
Номер открытой смены/Номер закрытой смены |
2 |
| CheckNumber |
int |
Номер последнего фискального документа |
3 |
| ShiftClosingCheckNumber |
int |
Номер последнего чека за смену |
1 |
| DateTime |
DateTime |
Дата и время формирования фискального документа |
“2026-05-23T23:45:15.6391315+08:00” |
| ShiftState |
int |
Состояние смены: 1 — Закрыта; 2 - Открыта; 3 — Истекла |
2 |
| CashBalance |
decimal |
Остаток наличных денежных средств в кассе |
0.0 |
| FnValidityDate |
decimal |
Срок действия ФН |
“2027-05-23T23:45:15.6391315+08:00” |
Поле Backlog
| Имя поля |
Тип |
Назначение |
Пример |
| DocumentsCounter |
int |
Количество непереданных документов |
0 |
| DocumentFirstNumber |
int |
Номер первого непереданного документ |
0 |
| DocumentFirstDateTime |
DateTime |
Дата и время первого из непереданных документов |
“0001-01-01T00:00:00” |
Поле FnWarnings
| Имя поля |
Тип |
Назначение |
Пример |
| CriticalError |
bool |
Критическая ошибка ФН |
false |
| MemoryOverflow |
bool |
Память ФН переполнена |
false |
| NeedReplacement |
bool |
Требуется срочная замена ФН |
false |
| OfdTimeout |
bool |
Превышено время ожидания ответа от ОФД |
false |
| ResourceExhausted |
bool |
Исчерпан ресурс ФН |
false |
Поле deviceInfo
| Имя поля |
Тип |
Назначение |
Пример |
| 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 — Терминал сбора данных <br>7 — Электронные весы; 8 — Электронные весы; 9 — Сканер штрихкодов |
7 |
| SerialNumber |
string |
Заводской номер ККТ |
“0020260207” |
| FirmwareVersion |
string |
Версия прошивки |
“2026” |
| ConfigurationVersion |
string |
Версия конфигурации прошивки устройства |
“02.07” |
Примеры ошибок
103 — Смена открыта, операция невозможна
{
"Code": 103,
"Description": "Смена открыта, операция невозможна",
"Success": false
}
4 — Не указано имя ККТ.
{
"Code": 4,
"Description": "Не указано имя ККТ.",
"Success": false
}
709 — Устройство не найдено
{
"Code": 709,
"Description": "Устройство не найдено: Устройство '{device}' не найдено.",
"Success": false
}
GET shift/open?id={id}
Запрос: shift/open
URL: {{HTTPRoot}}/shift/open?id={id}
Результат открытия смены по идентификатору.
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
id |
+ |
7ccfb3d4-bc93-40c7-9e4d-aa1c8b0261b6 |
идентификатор документа |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"OutputParameters": {
"DepartmentTotals": [],
"NumberOfDocuments": 1,
"Backlog": {
"DocumentsCounter": 1,
"DocumentFirstNumber": 88,
"DocumentFirstDateTime": "2026-05-12T18:39:00+08:00"
},
"Warnings": {
"CriticalError": false,
"MemoryOverflow": false,
"NeedReplacement": false,
"OfdTimeout": false,
"ResourceExhausted": false
},
"ResourcesFn": 457,
"ShiftNumber": 7,
"CheckNumber": 88,
"DateTime": "2026-05-12T18:39:04",
"ShiftState": 2,
"CashBalance": 10757.89,
"FnValidityDate": "2027-08-13T00:00:00",
"DocumentsCounter": 0
},
"ShiftNumber": 6,
"DocNumber": 88,
"DocNumberInShift": 0,
"FiscalSign": "1213640371",
"Fn": "9999078902012910",
"FiscalDate": "2026-05-12T18:39:00+08:00",
"CashierName": "Иванов",
"CashierVatin": "",
"DocumentHeader": {
"OrganizationInfo": "РБ-Софт",
"SerialNumber": "00109325182732",
"Vatin": "0326031413",
"Cashier": "Иванов",
"RnNumber": "0000000001002520",
"Fn": "9999078902012910",
"FnsUrl": "www.nalog.gov.ru",
"ShiftNumber": 6,
"DocNumber": 88,
"OfdOrganizationName": "Один ОФД тест ру 1-ofd-test.ru",
"OfdVatin": "7709364346"
},
"SaleAddress": "Улан-Удэ, Балтахинова, 17",
"SaleLocation": "Офис на 2 этаже",
"FfdVersion": "1.0.5",
"Tlv": "1041,Номер ФН:9999078902012910\r\n1037,Регистрационный номер ККТ:0000000001002520 \r\n1018,ИНН пользователя:0326031413 \r\n1040,Номер ФД:88\r\n1012,Дата, время:12.05.2026 18:39:00\r\n1077,ФПД:23-04-48-56-AE-B3\r\n1038,Номер смены:7\r\n1021,Кассир:Иванов\r\n1209,Номер версии ФФД:2\r\n1189,Версия ФФД ККТ:2\r\n1188,Версия ККТ:293\r\n",
"Before": [],
"After": [],
"TaskType": 11,
"DocId": "d83e0030-6a1d-402d-9ed6-f332b16a19d9",
"Date": "2026-05-12T18:38:52.6535962+08:00",
"TerminalId": "",
"DeviceName": "atol2",
"PoolId": "",
"ResultCode": 0,
"ResultDescription": "OK",
"Processed": true,
"ServerVersion": "4.0.61.427",
"DeviceInfo": {
"FfdVersion": "1.0.5",
"FnFfdVersion": "1.0.5",
"TimeZone": 7,
"Licenses": [],
"IsFiscal": true,
"LineLength": 42,
"LineLengthPixels": 384,
"DeviceClass": 4,
"Model": "АТОЛ 1Ф",
"SerialNumber": "00109325182732",
"FirmwareVersion": "5.8.1",
"ConfigurationVersion": "5.8.17"
}
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект OpenShift
OpenShift
| Имя поля |
Тип |
Назначение |
Пример |
| ShiftNumber |
int |
Номер сессии |
3 |
| DocNumber |
int |
Номер фискального документа |
5 |
| DocNumberInShift |
int |
Номер фискального документа за смену |
1 |
| FiscalSign |
string |
Фискальный признак документа |
“4988644533” |
| Fn |
string |
Серийный номер фискального накопителя |
“0123123123123” |
| FiscalDate |
DateTime |
Время регистрации операции по часам ККМ. |
“2026-05-24T00:11:23.5505769+08:00” |
| CashierName |
string |
Имя кассира |
“Иванов” |
| CashierVatin |
string |
ИНН кассира |
“Иванов” |
| SaleAddress |
string |
Адрес проведения расчетов |
“г.Улан-Удэ, ул.Балтахинова, д17Е, офис 215” |
| SaleLocation |
string |
Место проведения расчетов |
“Офис” |
| FfdVersion |
string |
Версия ФФД |
“1.2” |
| Tlv |
string |
Cтруктура значений тегов документа |
”“ |
| Before |
List |
Заголовок |
”“ |
| After |
List |
Подвал |
”“ |
| TaskType |
enum |
Тип чека |
11 |
| DocId |
guid |
Идентификатор документа |
“7ccfb3d4-bc93-40c7-9e4d-aa1c8b0261b6” |
| Date |
DateTime |
Дата создания документа |
“2026-05-24T00:11:23.5221437+08:00” |
| TerminalId |
string |
Идентификатор терминала, с которго пришел документ |
”“ |
| DeviceName |
string |
Имя устройства |
“Emu” |
| PoolId |
string |
Пул, который назначен чеку |
”“ |
| ResultCode |
enum |
Результат |
0 |
| ResultDescription |
string |
Описания результата |
“OK” |
| Processed |
bool |
Признак удачного завершения обработки |
true |
| ServerVersion |
string |
Версия сервера |
“4.0.62.521” |
Поле OutputParameters
| Имя поля |
Тип |
Назначение |
Пример |
| DepartmentTotals |
object |
Показатели отдела за смену |
|
| NumberOfChecks |
int |
Количество кассовых чеков за смену |
1 |
| NumberOfDocuments |
int |
Количество общее ФД за смену |
1 |
| ResourcesFn |
int |
Срок действия ключей фискального признака |
365 |
| ShiftNumber |
int |
Номер открытой смены/Номер закрытой смены |
2 |
| CheckNumber |
int |
Номер последнего фискального документа |
3 |
| ShiftClosingCheckNumber |
int |
Номер последнего чека за смену |
1 |
| DateTime |
DateTime |
Дата и время формирования фискального документа |
“2026-05-23T23:45:15.6391315+08:00” |
| ShiftState |
int |
Состояние смены: 1 — Закрыта; 2 - Открыта; 3 — Истекла |
2 |
| CashBalance |
decimal |
Остаток наличных денежных средств в кассе |
0.0 |
| FnValidityDate |
decimal |
Срок действия ФН |
“2027-05-23T23:45:15.6391315+08:00” |
| DocumentsCounter |
long |
Количество непереданных документов |
0 |
Поле 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 |
| Имя поля |
Тип |
Назначение |
Пример |
| OrganizationInfo |
string |
Информация об организации |
“”ООО РБ-Софт”“ |
| SerialNumber |
string |
Заводской номер ККТ |
“”0020260207” |
| Vatin |
string |
ИНН Организации |
“0326012345” |
| Cashier |
string |
Кассир |
“Иванов” |
| RnNumber |
string |
Регистрационный номер ККТ |
“00031415926” |
| Fn |
string |
Фискальный накопитель |
“0123123123123” |
| FnsUrl |
string |
Сайт ФНС |
“nalog.ru” |
| ShiftNumber |
int |
Номер смены |
3 |
| DocNumber |
int |
Номер фискального документа |
5 |
| FiscalSign |
string |
Фискальный признак документа |
“4988644533” |
| OfdOrganizationName |
string |
Наименование ОФД |
“Тестовый ОФД” |
| OfdVatin |
string |
ИНН ОФД |
“1234554321” |
Поле deviceInfo
| Имя поля |
Тип |
Назначение |
Пример |
| 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” |
Поле ofdStatus
| Имя поля |
Тип |
Назначение |
Пример |
| IsCompleted |
bool |
Флаг прописывается при инициализации полей описания статуса обмена с ОФД |
true |
| IsConnectedOFD |
bool |
Есть связь с ОФД |
true |
| IsExistDocsToSend |
bool |
Есть команда от ОФД |
false |
| IsWaitRequestFromOFD |
bool |
Ожидание ответного сообщения (квитанции) от ОФД |
false |
| IsExistCommandFromOFD |
bool |
Есть команда от ОФД |
false |
| IsConnectionParametersChanged |
bool |
Изменились настройки соединения с ОФД |
false |
| WaitingForResponseToCommandFromOFD |
bool |
Ожидание ответа на команду от ОФД |
false |
| DocumentsCount |
int |
Количество неотправленных ФД |
0 |
| FirstDocumentNumber |
int |
Номер первого неотправленного ФД |
0 |
| FirstDocumentDate |
DateTime |
Дата и время первого неотправленного ФД |
“0001-01-01T00:00:00” |
| OfdMessageRead |
bool |
Прочитано сообщение ОФД |
false |
Примеры ошибок
91 — Документ не найден
{
"Code": 91,
"Description": "Документ не найден",
"Success": false
}
72 — Не указан id
{
"Code": 72,
"Description": "Не указан id",
"Success": false
}
72 — Некорректный id
{
"Code": 72,
"Description": "Некорректный id",
"Success": false
}
GET shift/open/list?device={device}
Запрос: shift/open/list
URL: {{HTTPRoot}}/shift/open/list?device={device}
Список открытий смен
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
device |
+ |
Emu |
Название устройства |
Тело ответа
Успешный ответ (200 OK)
{
"Result": [
{
"ResultCode": 0,
"ResultDescription": "OK",
"Date": "2026-05-24T00:11:23",
"DocId": "7ccfb3d4-bc93-40c7-9e4d-aa1c8b0261b6",
"ShiftNumber": 3,
"DeviceName": "Emu",
"TerminalId": ""
},
{
"ResultCode": 0,
"ResultDescription": "OK",
"Date": "2026-05-23T23:45:15",
"DocId": "1e8a2198-3ba5-4561-b7d9-f1a086783e7d",
"ShiftNumber": 2,
"DeviceName": "Emu",
"TerminalId": ""
},
{
"ResultCode": 0,
"ResultDescription": "OK",
"Date": "2026-05-23T23:36:57",
"DocId": "6ca91078-7b82-4b96-ad9e-10be35eeee0f",
"ShiftNumber": 1,
"DeviceName": "Emu",
"TerminalId": ""
}
],
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: массив объектов ReportsResponse
ReportsResponse
| Имя поля |
Тип |
Назначение |
Пример |
| ResultCode |
enum |
Результат |
0 |
| ResultDescription |
string |
Описания результата |
“OK” |
| Date |
DateTime |
Дата создания документа |
“2026-05-24T00:11:23.5221437+08:00” |
| DocId |
guid |
Идентификатор документа |
“7ccfb3d4-bc93-40c7-9e4d-aa1c8b0261b6” |
| ShiftNumber |
int |
Номер сессии |
3 |
| DeviceName |
string |
Имя устройства |
“Emu” |
| TerminalId |
string |
Идентификатор терминала, с которго пришел документ |
”“ |
Примеры ошибок
4 — Не указано имя ККТ.
{
"Code": 4,
"Description": "Не указано имя ККТ.",
"Success": false
}
72 — Некорректный интервал
{
"Code": 72,
"Description": "Некорректный интервал",
"Success": false
}
POST shift/open/async
Запрос: shift/open/async
URL: {{HTTPRoot}}/shift/open/async
Открытие кассовой смены асинхронно.
Тело запроса
{
"DeviceName": "{device}",
"Cashier": {
"Name": "Иванов",
"Vatin": ""
}
}
Поле Result
| Имя поля |
Тип |
Назначение |
Пример |
| Result |
string |
Результат |
“321581c0-2ebe-4f4e-bdf8-a932ad758dac” |
Тело ответа
Успешный ответ (200 OK)
{
"Result": "533df3eb-2beb-4a1f-835c-42bad261c21c",
"Code": 0,
"Description": "OK",
"Success": true
}
Примеры ошибок
72 — Некорректный интервал
{
"Code": 72,
"Description": "Некорректный интервал",
"Success": false
}
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
POST shift/z
Запрос: shift/z
URL: {{HTTPRoot}}/shift/z
Закрытие кассовой смены.
Тело запроса
{
"DeviceName": "{device}",
"Cashier": {
"Name": "Иванов",
"Vatin": ""
}
}
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| DeviceName |
string |
+ |
Имя устройства |
“atol2” |
Поле Cashier
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| Name |
string |
- |
ФИО кассира |
“Иванов” |
| Vatin |
string |
- |
ИНН кассира |
”“ |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"datetime": "2026-05-24T01:29:32.7780851+08:00",
"deviceName": "Emu",
"docId": "150cda18-5156-4bc6-9ed2-bcc351b92fd4",
"fnsUrl": "nalog.ru",
"fnNumber": "0123123123123",
"rnNumber": "00031415926",
"fiscalDatetime": "20260524012932",
"shiftNumber": 3,
"outputParameters": {
"NumberOfChecks": 1,
"NumberOfDocuments": 1,
"ResourcesFn": 365,
"ShiftNumber": 3,
"CheckNumber": 6,
"ShiftClosingCheckNumber": 1,
"DateTime": "2026-05-24T01:29:32.8151052+08:00",
"ShiftState": 1,
"CashBalance": 0,
"Backlog": {
"DocumentsCounter": 0,
"DocumentFirstNumber": 0,
"DocumentFirstDateTime": "0001-01-01T00:00:00"
},
"FnWarnings": {
"CriticalError": false,
"MemoryOverflow": false,
"NeedReplacement": false,
"OfdTimeout": false,
"ResourceExhausted": false
},
"FnValidityDate": "2027-05-24T01:29:32.8151052+08:00"
},
"deviceInfo": {
"FfdVersion": "1.2",
"FnFfdVersion": "1.2",
"TimeZone": 7,
"KktLicenses": [],
"IsFiscal": true,
"LineLength": 64,
"LineLengthPixels": 512,
"DeviceClass": 4,
"Model": "РБ-Софт:Эмулятор ККМ",
"SerialNumber": "0020260207",
"FirmwareVersion": "2026",
"ConfigurationVersion": "02.07"
},
"shiftTotal": {
"IsCountersReaded": true,
"ShiftNumber": 3,
"CashDrawer": {
"Sum": 0,
"Count": 0
},
"ShiftIncome": {
"Count": 0,
"Sum": 0
},
"ShiftOutcome": {
"Count": 0,
"Sum": 0
},
"Counters": {
"SumCorrection": 0,
"NumberCorrections": 0
}
},
"overallTotals": {
"DataLoaded": true,
"Sum": 0,
"Count": 0,
"Counters": {
"SumCorrection": 0,
"NumberCorrections": 0
},
"CashDrawer": {
"Sum": 0,
"Count": 0
}
}
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект ReportResult
OpenShiftResult
| Имя поля |
Тип |
Назначение |
Пример |
| datetime |
datetime |
Время операции |
“2026-05-12T18:38:52” |
| deviceName |
string |
Название устройства |
“d83e0030-…” |
| docId |
string |
Идентификатор задания |
“d83e0030-…” |
| fnsUrl |
string |
Адрес сайта уполномоченного органа (ФНС) в сети «Интернет» |
“nalog.ru” |
| fnNumber |
string |
Номер фискального накопителя |
“0123123123123” |
| rnNumber |
string |
РНМ |
“00031415926” |
| fiscalDatetime |
string |
Дата и время документа по часам ФН |
“20260523234515” |
| shiftNumber |
int |
Номер смены |
2 |
Поле OutputParameters
| Имя поля |
Тип |
Назначение |
Пример |
| NumberOfChecks |
int |
Количество кассовых чеков за смену |
1 |
| NumberOfDocuments |
int |
Количество общее ФД за смену |
1 |
| ResourcesFn |
int |
Срок действия ключей фискального признака |
365 |
| ShiftNumber |
int |
Номер открытой смены/Номер закрытой смены |
2 |
| CheckNumber |
int |
Номер последнего фискального документа |
3 |
| ShiftClosingCheckNumber |
int |
Номер последнего чека за смену |
1 |
| DateTime |
DateTime |
Дата и время формирования фискального документа |
“2026-05-23T23:45:15.6391315+08:00” |
| ShiftState |
int |
Состояние смены: 1 — Закрыта; 2 - Открыта; 3 — Истекла |
2 |
| CashBalance |
decimal |
Остаток наличных денежных средств в кассе |
0.0 |
| FnValidityDate |
decimal |
Срок действия ФН |
“2027-05-23T23:45:15.6391315+08:00” |
Поле Backlog
| Имя поля |
Тип |
Назначение |
Пример |
| DocumentsCounter |
int |
Количество непереданных документов |
0 |
| DocumentFirstNumber |
int |
Номер первого непереданного документ |
0 |
| DocumentFirstDateTime |
DateTime |
Дата и время первого из непереданных документов |
“0001-01-01T00:00:00” |
Поле FnWarnings
| Имя поля |
Тип |
Назначение |
Пример |
| CriticalError |
bool |
Критическая ошибка ФН |
false |
| MemoryOverflow |
bool |
Память ФН переполнена |
false |
| NeedReplacement |
bool |
Требуется срочная замена ФН |
false |
| OfdTimeout |
bool |
Превышено время ожидания ответа от ОФД |
false |
| ResourceExhausted |
bool |
Исчерпан ресурс ФН |
false |
Поле deviceInfo
| Имя поля |
Тип |
Назначение |
Пример |
| 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” |
Поле ShiftTotal
| Имя поля |
Тип |
Назначение |
Пример |
| IsCountersReaded |
bool |
Прочитаны ли дополнительные счетчики ККМ |
true |
| ShiftNumber |
double |
Номер смены |
3.0 |
Поле CashDrawer — Детали ленежного ящиика
| Имя поля |
Тип |
Назначение |
Пример |
| Sum |
decimal |
Сумма |
0.0 |
| 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 |
Поле overallTotals — Необнуляемые / сменные итоги
| Имя поля |
Тип |
Назначение |
Пример |
| DataLoaded |
bool |
Все ли данные успешно прочитаны из устройства |
true |
| Sum |
decimal |
Сумма |
1365.68 |
| Count |
int |
Количество |
0 |
Примеры ошибок
709 — Устройство не найдено
{
"Code": 709,
"Description": "Устройство не найдено: Устройство '{device}' не найдено.",
"Success": false
}
4 — Не указано имя ККТ.
{
"Code": 4,
"Description": "Не указано имя ККТ.",
"Success": false
}
600 — Ошибка драйвера
{
"Code": 600,
"Description": "Ошибка драйвера",
"Success": false
}
POST shift/z/async
Запрос: shift/z/async
URL: {{HTTPRoot}}/shift/z/async
Закрытие кассовой смены асинхронно.
Тело запроса
{
"DeviceName": "{device}",
"Cashier": {
"Name": "Иванов",
"Vatin": ""
}
}
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| DeviceName |
string |
+ |
Имя устройства |
“atol2” |
Поле Cashier
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| Name |
string |
- |
ФИО кассира |
“Иванов” |
| Vatin |
string |
- |
ИНН кассира |
”“ |
Тело ответа
Успешный ответ (200 OK)
{
"Result": "eabd4768-8700-484c-85d6-cb907ce61db7",
"Code": 0,
"Description": "OK",
"Success": true
}
Поле Result
| Имя поля |
Тип |
Назначение |
Пример |
| Result |
string |
Результат |
“321581c0-2ebe-4f4e-bdf8-a932ad758dac” |
Примеры ошибок
709 — Устройство не найдено
{
"Code": 709,
"Description": "Устройство не найдено: Устройство '{device}' не найдено.",
"Success": false
}
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
GET shift/z?id={id}
Запрос: shift/z
URL: {{HTTPRoot}}/shift/z?id={id}
Результат открытия смены по идентификатору.
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
id |
+ |
150cda18-5156-4bc6-9ed2-bcc351b92fd4 |
идентификатор документа |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"OutputParameters": {
"DepartmentTotals": [],
"NumberOfChecks": 1,
"NumberOfDocuments": 1,
"Backlog": {
"DocumentsCounter": 0,
"DocumentFirstNumber": 0,
"DocumentFirstDateTime": "0001-01-01T00:00:00"
},
"Warnings": {
"CriticalError": false,
"MemoryOverflow": false,
"NeedReplacement": false,
"OfdTimeout": false,
"ResourceExhausted": false
},
"ResourcesFn": 365,
"ShiftNumber": 3,
"CheckNumber": 6,
"ShiftClosingCheckNumber": 1,
"DateTime": "2026-05-24T01:29:32.8151052+08:00",
"ShiftState": 1,
"CashBalance": 0,
"FnValidityDate": "2027-05-24T01:29:32.8151052+08:00",
"DocumentsCounter": 0
},
"ShiftTotal": {
"IsCountersReaded": true,
"ShiftNumber": 3,
"CashDrawer": {
"Sum": 0,
"Count": 0
},
"ShiftIncome": {
"Count": 0,
"Sum": 0
},
"ShiftOutcome": {
"Count": 0,
"Sum": 0
},
"Counters": {
"SumCorrection": 0,
"NumberCorrections": 0,
"Sales": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"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": {}
}
}
},
"OverallTotals": {
"DataLoaded": true,
"Sum": 0,
"Count": 0,
"Counters": {
"SumCorrection": 0,
"NumberCorrections": 0,
"Sales": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"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": {}
}
},
"CashDrawer": {
"Sum": 0,
"Count": 0
}
},
"AnullatesCount": 0,
"ShiftNumber": 3,
"DocNumber": 6,
"DocNumberInShift": 1,
"FiscalSign": "2691498498",
"Fn": "0123123123123",
"FiscalDate": "2026-05-24T01:29:32.8140935+08:00",
"CashierName": "Иванов",
"CashierVatin": "",
"DocumentHeader": {
"OrganizationInfo": "\"ООО `РБ-Софт`\"",
"SerialNumber": "0020260207",
"Vatin": "0326012345",
"Cashier": "Иванов",
"RnNumber": "00031415926",
"Fn": "0123123123123",
"FnsUrl": "nalog.ru",
"ShiftNumber": 3,
"DocNumber": 6,
"FiscalSign": "2691498498",
"OfdOrganizationName": "Тестовый ОФД",
"OfdVatin": "1234554321"
},
"SaleAddress": "г.Улан-Удэ, ул.Балтахинова, д17Е, офис 215",
"SaleLocation": "Офис",
"FfdVersion": "1.2",
"TaskType": 12,
"DocId": "150cda18-5156-4bc6-9ed2-bcc351b92fd4",
"Date": "2026-05-24T01:29:32.7780851+08:00",
"TerminalId": "",
"DeviceName": "Emu",
"PoolId": "",
"ResultCode": 0,
"ResultDescription": "OK",
"Processed": true,
"ServerVersion": "4.0.62.521",
"DeviceInfo": {
"FfdVersion": "1.2",
"FnFfdVersion": "1.2",
"TimeZone": 7,
"KktLicenses": [],
"IsFiscal": true,
"LineLength": 64,
"LineLengthPixels": 512,
"DeviceClass": 4,
"Model": "РБ-Софт:Эмулятор ККМ",
"SerialNumber": "0020260207",
"FirmwareVersion": "2026",
"ConfigurationVersion": "02.07"
}
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект ReportZ
Поле ReportZ
| Имя поля |
Тип |
Назначение |
Пример |
| AnullatesCount |
int |
Количество аннулирваний |
0 |
| ShiftNumber |
int |
Номер сессии |
3 |
| DocNumber |
int |
Номер фискального документа |
5 |
| DocNumberInShift |
int |
Номер фискального документа за смену |
1 |
| FiscalSign |
string |
Фискальный признак документа |
“4988644533” |
| Fn |
string |
Серийный номер фискального накопителя |
“0123123123123” |
| FiscalDate |
DateTime |
Время регистрации операции по часам ККМ. |
“2026-05-24T00:11:23.5505769+08:00” |
| CashierName |
string |
Имя кассира |
“Иванов” |
| CashierVatin |
string |
ИНН кассира |
“Иванов” |
| SaleAddress |
string |
Адрес проведения расчетов |
“г.Улан-Удэ, ул.Балтахинова, д17Е, офис 215” |
| SaleLocation |
string |
Место проведения расчетов |
“Офис” |
| FfdVersion |
string |
Версия ФФД |
“1.2” |
| Tlv |
string |
Cтруктура значений тегов документа |
”“ |
| Before |
List |
Заголовок |
”“ |
| After |
List |
Подвал |
”“ |
| TaskType |
enum |
Тип чека |
11 |
| DocId |
guid |
Идентификатор документа |
“7ccfb3d4-bc93-40c7-9e4d-aa1c8b0261b6” |
| Date |
DateTime |
Дата создания документа |
“2026-05-24T00:11:23.5221437+08:00” |
| TerminalId |
string |
Идентификатор терминала, с которго пришел документ |
”“ |
| DeviceName |
string |
Имя устройства |
“Emu” |
| PoolId |
string |
Пул, который назначен чеку |
”“ |
| ResultCode |
enum |
Результат |
0 |
| ResultDescription |
string |
Описания результата |
“OK” |
| Processed |
bool |
Признак удачного завершения обработки |
true |
| ServerVersion |
string |
Версия сервера |
“4.0.62.521” |
Поле OutputParameters
| Имя поля |
Тип |
Назначение |
Пример |
| DepartmentTotals |
object |
Показатели отдела за смену |
|
| NumberOfChecks |
int |
Количество кассовых чеков за смену |
1 |
| NumberOfDocuments |
int |
Количество общее ФД за смену |
1 |
| ResourcesFn |
int |
Срок действия ключей фискального признака |
365 |
| ShiftNumber |
int |
Номер открытой смены/Номер закрытой смены |
2 |
| CheckNumber |
int |
Номер последнего фискального документа |
3 |
| ShiftClosingCheckNumber |
int |
Номер последнего чека за смену |
1 |
| DateTime |
DateTime |
Дата и время формирования фискального документа |
“2026-05-23T23:45:15.6391315+08:00” |
| ShiftState |
int |
Состояние смены: 1 — Закрыта; 2 - Открыта; 3 — Истекла |
2 |
| CashBalance |
decimal |
Остаток наличных денежных средств в кассе |
0.0 |
| FnValidityDate |
decimal |
Срок действия ФН |
“2027-05-23T23:45:15.6391315+08:00” |
| DocumentsCounter |
long |
Количество непереданных документов |
0 |
Поле 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 |
| Имя поля |
Тип |
Назначение |
Пример |
| OrganizationInfo |
string |
Информация об организации |
“”ООО РБ-Софт”“ |
| SerialNumber |
string |
Заводской номер ККТ |
“”0020260207” |
| Vatin |
string |
ИНН Организации |
“0326012345” |
| Cashier |
string |
Кассир |
“Иванов” |
| RnNumber |
string |
Регистрационный номер ККТ |
“00031415926” |
| Fn |
string |
Фискальный накопитель |
“0123123123123” |
| FnsUrl |
string |
Сайт ФНС |
“nalog.ru” |
| ShiftNumber |
int |
Номер смены |
3 |
| DocNumber |
int |
Номер фискального документа |
5 |
| FiscalSign |
string |
Фискальный признак документа |
“4988644533” |
| OfdOrganizationName |
string |
Наименование ОФД |
“Тестовый ОФД” |
| OfdVatin |
string |
ИНН ОФД |
“1234554321” |
Поле deviceInfo
| Имя поля |
Тип |
Назначение |
Пример |
| 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” |
Поле ofdStatus
| Имя поля |
Тип |
Назначение |
Пример |
| IsCompleted |
bool |
Флаг прописывается при инициализации полей описания статуса обмена с ОФД |
true |
| IsConnectedOFD |
bool |
Есть связь с ОФД |
true |
| IsExistDocsToSend |
bool |
Есть команда от ОФД |
false |
| IsWaitRequestFromOFD |
bool |
Ожидание ответного сообщения (квитанции) от ОФД |
false |
| IsExistCommandFromOFD |
bool |
Есть команда от ОФД |
false |
| IsConnectionParametersChanged |
bool |
Изменились настройки соединения с ОФД |
false |
| WaitingForResponseToCommandFromOFD |
bool |
Ожидание ответа на команду от ОФД |
false |
| DocumentsCount |
int |
Количество неотправленных ФД |
0 |
| FirstDocumentNumber |
int |
Номер первого неотправленного ФД |
0 |
| FirstDocumentDate |
DateTime |
Дата и время первого неотправленного ФД |
“0001-01-01T00:00:00” |
| OfdMessageRead |
bool |
Прочитано сообщение ОФД |
false |
Поле ShiftTotal
| Имя поля |
Тип |
Назначение |
Пример |
| IsCountersReaded |
bool |
Прочитаны ли дополнительные счетчики ККМ |
true |
| ShiftNumber |
double |
Номер смены |
3.0 |
Поле CashDrawer — Детали ленежного ящиика
| Имя поля |
Тип |
Назначение |
Пример |
| Sum |
decimal |
Сумма |
0.0 |
| 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 |
Поле overallTotals — Накопительные показатели
| Имя поля |
Тип |
Назначение |
Пример |
| DataLoaded |
bool |
Все ли данные успешно прочитаны из устройства |
true |
| Sum |
decimal |
Сумма |
1365.68 |
| Count |
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 |
Примеры ошибок
91 — Документ не найден
{
"Code": 91,
"Description": "Документ не найден",
"Success": false
}
72 — Некорректный id
{
"Code": 72,
"Description": "Некорректный id",
"Success": false
}
72 — Не указан id
{
"Code": 72,
"Description": "Не указан id",
"Success": false
}
GET shift/z/list?device={device}&from={from}&to={to}
Запрос: shift/z/list
URL: {{HTTPRoot}}/shift/z/list?device={device}&from={from}&to={to}
Список закрытий смен
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
device |
+ |
{device} |
название устройства |
from |
+ |
2026-05-29 |
начало даты |
to |
+ |
2026-06-04 |
конец даты |
Тело ответа
Успешный ответ (200 OK)
{
"Result": [
{
"ResultCode": 0,
"ResultDescription": "OK",
"Date": "2026-05-24T01:29:32",
"DocId": "150cda18-5156-4bc6-9ed2-bcc351b92fd4",
"ShiftNumber": 3,
"DeviceName": "Emu",
"TerminalId": ""
},
{
"ResultCode": 0,
"ResultDescription": "OK",
"Date": "2026-05-24T00:11:19",
"DocId": "923f777f-6542-4ca0-89a2-e807e7aae299",
"ShiftNumber": 2,
"DeviceName": "Emu",
"TerminalId": ""
},
{
"ResultCode": 0,
"ResultDescription": "OK",
"Date": "2026-05-23T23:45:08",
"DocId": "988397e3-649d-4637-b156-83ead588ed4b",
"ShiftNumber": 1,
"DeviceName": "Emu",
"TerminalId": ""
}
],
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: массив объектов ReportsResponse
ReportsResponse
| Имя поля |
Тип |
Назначение |
Пример |
| ResultCode |
enum |
Результат |
0 |
| ResultDescription |
string |
Описания результата |
“OK” |
| Date |
DateTime |
Дата создания документа |
“2026-05-24T00:11:23.5221437+08:00” |
| DocId |
guid |
Идентификатор документа |
“7ccfb3d4-bc93-40c7-9e4d-aa1c8b0261b6” |
| ShiftNumber |
int |
Номер сессии |
3 |
| DeviceName |
string |
Имя устройства |
“Emu” |
| TerminalId |
string |
Идентификатор терминала, с которго пришел документ |
”“ |
Примеры ошибок
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
72 — Некорректный интервал
{
"Code": 72,
"Description": "Некорректный интервал",
"Success": false
}
POST shift/x
Запрос: shift/x
URL: {{HTTPRoot}}/shift/x
Получение X-отчёта (без закрытия смены)
Тело запроса
{
"DeviceName": "{device}",
"Cashier": {
"Name": "Иванов",
"Vatin": ""
}
}
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| DeviceName |
string |
+ |
Имя устройства |
“atol2” |
Поле Cashier
| Имя поля |
Тип |
Обяз |
Назначение |
Пример |
| Name |
string |
- |
ФИО кассира |
“Иванов” |
| Vatin |
string |
- |
ИНН кассира |
”“ |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"datetime": "2026-05-24T01:57:54.7405428+08:00",
"deviceName": "Emu",
"docId": "4b161ba3-bb5f-4209-964b-3c3f0e6f43b8",
"fnsUrl": "nalog.ru",
"fnNumber": "0123123123123",
"rnNumber": "00031415926",
"fiscalDatetime": "20260524015754",
"shiftNumber": 3,
"outputParameters": {
"NumberOfChecks": 1,
"NumberOfDocuments": 1,
"ResourcesFn": 365,
"ShiftNumber": 3,
"CheckNumber": 6,
"ShiftClosingCheckNumber": 1,
"DateTime": "2026-05-24T01:57:54.7738055+08:00",
"ShiftState": 1,
"CashBalance": 0,
"Backlog": {
"DocumentsCounter": 0,
"DocumentFirstNumber": 0,
"DocumentFirstDateTime": "0001-01-01T00:00:00"
},
"FnWarnings": {
"CriticalError": false,
"MemoryOverflow": false,
"NeedReplacement": false,
"OfdTimeout": false,
"ResourceExhausted": false
},
"FnValidityDate": "2027-05-24T01:57:54.7738055+08:00"
},
"deviceInfo": {
"FfdVersion": "1.2",
"FnFfdVersion": "1.2",
"TimeZone": 7,
"KktLicenses": [],
"IsFiscal": true,
"LineLength": 64,
"LineLengthPixels": 512,
"DeviceClass": 4,
"Model": "РБ-Софт:Эмулятор ККМ",
"SerialNumber": "0020260207",
"FirmwareVersion": "2026",
"ConfigurationVersion": "02.07"
},
"shiftTotal": {
"IsCountersReaded": true,
"ShiftNumber": 3,
"CashDrawer": {
"Sum": 0,
"Count": 0
},
"ShiftIncome": {
"Count": 0,
"Sum": 0
},
"ShiftOutcome": {
"Count": 0,
"Sum": 0
},
"Counters": {
"SumCorrection": 0,
"NumberCorrections": 0
}
},
"overallTotals": {
"DataLoaded": true,
"Sum": 0,
"Count": 0,
"Counters": {
"SumCorrection": 0,
"NumberCorrections": 0
},
"CashDrawer": {
"Sum": 0,
"Count": 0
}
}
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект ReportResult
ReportResult
| Имя поля |
Тип |
Назначение |
Пример |
| datetime |
datetime |
Время операции |
“2026-05-12T18:38:52” |
| deviceName |
string |
Название устройства |
“d83e0030-…” |
| docId |
string |
Идентификатор задания |
“d83e0030-…” |
| fnsUrl |
string |
Адрес сайта уполномоченного органа (ФНС) в сети «Интернет» |
“nalog.ru” |
| fnNumber |
string |
Номер фискального накопителя |
“0123123123123” |
| rnNumber |
string |
РНМ |
“00031415926” |
| fiscalDatetime |
string |
Дата и время документа по часам ФН |
“20260523234515” |
| shiftNumber |
int |
Номер смены |
2 |
Поле OutputParameters
| Имя поля |
Тип |
Назначение |
Пример |
| NumberOfChecks |
int |
Количество кассовых чеков за смену |
1 |
| NumberOfDocuments |
int |
Количество общее ФД за смену |
1 |
| ResourcesFn |
int |
Срок действия ключей фискального признака |
365 |
| ShiftNumber |
int |
Номер открытой смены/Номер закрытой смены |
2 |
| CheckNumber |
int |
Номер последнего фискального документа |
3 |
| ShiftClosingCheckNumber |
int |
Номер последнего чека за смену |
1 |
| DateTime |
DateTime |
Дата и время формирования фискального документа |
“2026-05-23T23:45:15.6391315+08:00” |
| ShiftState |
int |
Состояние смены: 1 — Закрыта; 2 - Открыта; 3 — Истекла |
2 |
| CashBalance |
decimal |
Остаток наличных денежных средств в кассе |
0.0 |
| FnValidityDate |
decimal |
Срок действия ФН |
“2027-05-23T23:45:15.6391315+08:00” |
Поле Backlog
| Имя поля |
Тип |
Назначение |
Пример |
| DocumentsCounter |
int |
Количество непереданных документов |
0 |
| DocumentFirstNumber |
int |
Номер первого непереданного документ |
0 |
| DocumentFirstDateTime |
DateTime |
Дата и время первого из непереданных документов |
“0001-01-01T00:00:00” |
Поле FnWarnings
| Имя поля |
Тип |
Назначение |
Пример |
| CriticalError |
bool |
Критическая ошибка ФН |
false |
| MemoryOverflow |
bool |
Память ФН переполнена |
false |
| NeedReplacement |
bool |
Требуется срочная замена ФН |
false |
| OfdTimeout |
bool |
Превышено время ожидания ответа от ОФД |
false |
| ResourceExhausted |
bool |
Исчерпан ресурс ФН |
false |
Поле deviceInfo
| Имя поля |
Тип |
Назначение |
Пример |
| 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” |
Поле ShiftTotal
| Имя поля |
Тип |
Назначение |
Пример |
| IsCountersReaded |
bool |
Прочитаны ли дополнительные счетчики ККМ |
true |
| ShiftNumber |
double |
Номер смены |
3.0 |
Поле CashDrawer — Детали ленежного ящиика
| Имя поля |
Тип |
Назначение |
Пример |
| Sum |
decimal |
Сумма |
0.0 |
| 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 |
Поле OverallTotals — Необнуляемые / сменные итоги
| Имя поля |
Тип |
Назначение |
Пример |
| DataLoaded |
bool |
Все ли данные успешно прочитаны из устройства |
true |
| Sum |
decimal |
Сумма |
1365.68 |
| Count |
int |
Количество |
0 |
Примеры ошибок
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
709 — Устройство не найдено
{
"Code": 709,
"Description": "Устройство не найдено: Устройство '{device}' не найдено.",
"Success": false
}
POST shift/x/async
Запрос: shift/x/async
URL: {{HTTPRoot}}/shift/x/async
Формирование X-отчёта и возвращает id.
Тело запроса
{
"DeviceName": "{device}",
"Cashier": {
"Name": "Иванов",
"Vatin": ""
}
}
Поле Result
| Имя поля |
Тип |
Назначение |
Пример |
| Result |
string |
Результат |
“321581c0-2ebe-4f4e-bdf8-a932ad758dac” |
Тело ответа
Успешный ответ (200 OK)
{
"Result": "947cdf22-e112-406b-82c5-bbb74921ac42",
"Code": 0,
"Description": "OK",
"Success": true
}
Примеры ошибок
709 — Устройство не найдено
{
"Code": 709,
"Description": "Устройство не найдено: Устройство '{device}' не найдено.",
"Success": false
}
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
GET shift/x?id={id}
Запрос: shift/x
URL: {{HTTPRoot}}/shift/x?id={id}
Результат X-отчёт по id операции.
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
id |
+ |
4b161ba3-bb5f-4209-964b-3c3f0e6f43b8 |
идентификатор документа |
Тело ответа
Успешный ответ (200 OK)
{
"Result": {
"OutputParameters": {
"DepartmentTotals": [],
"NumberOfChecks": 1,
"NumberOfDocuments": 1,
"Backlog": {
"DocumentsCounter": 0,
"DocumentFirstNumber": 0,
"DocumentFirstDateTime": "0001-01-01T00:00:00"
},
"Warnings": {
"CriticalError": false,
"MemoryOverflow": false,
"NeedReplacement": false,
"OfdTimeout": false,
"ResourceExhausted": false
},
"ResourcesFn": 365,
"ShiftNumber": 3,
"CheckNumber": 6,
"ShiftClosingCheckNumber": 1,
"DateTime": "2026-05-24T01:57:54.7738055+08:00",
"ShiftState": 1,
"CashBalance": 0,
"FnValidityDate": "2027-05-24T01:57:54.7738055+08:00",
"DocumentsCounter": 0
},
"ShiftTotal": {
"IsCountersReaded": true,
"ShiftNumber": 3,
"CashDrawer": {
"Sum": 0,
"Count": 0
},
"ShiftIncome": {
"Count": 0,
"Sum": 0
},
"ShiftOutcome": {
"Count": 0,
"Sum": 0
},
"Counters": {
"SumCorrection": 0,
"NumberCorrections": 0,
"Sales": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"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": {}
}
}
},
"OverallTotals": {
"DataLoaded": true,
"Sum": 0,
"Count": 0,
"Counters": {
"SumCorrection": 0,
"NumberCorrections": 0,
"Sales": {
"Count": 0,
"Sum": 0,
"Payments": {
"Sum": 0
},
"Discount": {
"Count": 0,
"Sum": 0
},
"Adding": {
"Count": 0,
"Sum": 0
},
"Tax": {}
},
"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": {}
}
},
"CashDrawer": {
"Sum": 0,
"Count": 0
}
},
"AnullatesCount": 0,
"ShiftNumber": 3,
"DocNumber": 0,
"DocNumberInShift": 0,
"Fn": "0123123123123",
"FiscalDate": "2026-05-24T01:57:54.7728013+08:00",
"CashierName": "Иванов",
"CashierVatin": "",
"DocumentHeader": {
"OrganizationInfo": "\"ООО `РБ-Софт`\"",
"SerialNumber": "0020260207",
"Vatin": "0326012345",
"Cashier": "Иванов",
"RnNumber": "00031415926",
"Fn": "0123123123123",
"FnsUrl": "nalog.ru",
"ShiftNumber": 3,
"OfdOrganizationName": "Тестовый ОФД",
"OfdVatin": "1234554321"
},
"SaleAddress": "г.Улан-Удэ, ул.Балтахинова, д17Е, офис 215",
"SaleLocation": "Офис",
"FfdVersion": "1.2",
"TaskType": 13,
"DocId": "4b161ba3-bb5f-4209-964b-3c3f0e6f43b8",
"Date": "2026-05-24T01:57:54.7405428+08:00",
"TerminalId": "",
"DeviceName": "Emu",
"PoolId": "",
"ResultCode": 0,
"ResultDescription": "OK",
"Processed": true,
"ServerVersion": "4.0.62.521",
"DeviceInfo": {
"FfdVersion": "1.2",
"FnFfdVersion": "1.2",
"TimeZone": 7,
"KktLicenses": [],
"IsFiscal": true,
"LineLength": 64,
"LineLengthPixels": 512,
"DeviceClass": 4,
"Model": "РБ-Софт:Эмулятор ККМ",
"SerialNumber": "0020260207",
"FirmwareVersion": "2026",
"ConfigurationVersion": "02.07"
}
},
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: объект ReportX
ReportX
| Имя поля |
Тип |
Назначение |
Пример |
| AnullatesCount |
int |
Количество аннулирваний |
0 |
| ShiftNumber |
int |
Номер сессии |
3 |
| DocNumber |
int |
Номер фискального документа |
5 |
| DocNumberInShift |
int |
Номер фискального документа за смену |
1 |
| FiscalSign |
string |
Фискальный признак документа |
“4988644533” |
| Fn |
string |
Серийный номер фискального накопителя |
“0123123123123” |
| FiscalDate |
DateTime |
Время регистрации операции по часам ККМ. |
“2026-05-24T00:11:23.5505769+08:00” |
| CashierName |
string |
Имя кассира |
“Иванов” |
| CashierVatin |
string |
ИНН кассира |
“Иванов” |
| SaleAddress |
string |
Адрес проведения расчетов |
“г.Улан-Удэ, ул.Балтахинова, д17Е, офис 215” |
| SaleLocation |
string |
Место проведения расчетов |
“Офис” |
| FfdVersion |
string |
Версия ФФД |
“1.2” |
| Tlv |
string |
Cтруктура значений тегов документа |
”“ |
| Before |
List |
Заголовок |
”“ |
| After |
List |
Подвал |
”“ |
| TaskType |
enum |
Тип чека |
11 |
| DocId |
guid |
Идентификатор документа |
“7ccfb3d4-bc93-40c7-9e4d-aa1c8b0261b6” |
| Date |
DateTime |
Дата создания документа |
“2026-05-24T00:11:23.5221437+08:00” |
| TerminalId |
string |
Идентификатор терминала, с которго пришел документ |
”“ |
| DeviceName |
string |
Имя устройства |
“Emu” |
| PoolId |
string |
Пул, который назначен чеку |
”“ |
| ResultCode |
enum |
Результат |
0 |
| ResultDescription |
string |
Описания результата |
“OK” |
| Processed |
bool |
Признак удачного завершения обработки |
true |
| ServerVersion |
string |
Версия сервера |
“4.0.62.521” |
Поле OutputParameters
| Имя поля |
Тип |
Назначение |
Пример |
| DepartmentTotals |
object |
Показатели отдела за смену |
|
| NumberOfChecks |
int |
Количество кассовых чеков за смену |
1 |
| NumberOfDocuments |
int |
Количество общее ФД за смену |
1 |
| ResourcesFn |
int |
Срок действия ключей фискального признака |
365 |
| ShiftNumber |
int |
Номер открытой смены/Номер закрытой смены |
2 |
| CheckNumber |
int |
Номер последнего фискального документа |
3 |
| ShiftClosingCheckNumber |
int |
Номер последнего чека за смену |
1 |
| DateTime |
DateTime |
Дата и время формирования фискального документа |
“2026-05-23T23:45:15.6391315+08:00” |
| ShiftState |
int |
Состояние смены: 1 — Закрыта; 2 - Открыта; 3 — Истекла |
2 |
| CashBalance |
decimal |
Остаток наличных денежных средств в кассе |
0.0 |
| FnValidityDate |
decimal |
Срок действия ФН |
“2027-05-23T23:45:15.6391315+08:00” |
| DocumentsCounter |
long |
Количество непереданных документов |
0 |
Поле 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 |
| Имя поля |
Тип |
Назначение |
Пример |
| OrganizationInfo |
string |
Информация об организации |
“”ООО РБ-Софт”“ |
| SerialNumber |
string |
Заводской номер ККТ |
“”0020260207” |
| Vatin |
string |
ИНН Организации |
“0326012345” |
| Cashier |
string |
Кассир |
“Иванов” |
| RnNumber |
string |
Регистрационный номер ККТ |
“00031415926” |
| Fn |
string |
Фискальный накопитель |
“0123123123123” |
| FnsUrl |
string |
Сайт ФНС |
“nalog.ru” |
| ShiftNumber |
int |
Номер смены |
3 |
| DocNumber |
int |
Номер фискального документа |
5 |
| FiscalSign |
string |
Фискальный признак документа |
“4988644533” |
| OfdOrganizationName |
string |
Наименование ОФД |
“Тестовый ОФД” |
| OfdVatin |
string |
ИНН ОФД |
“1234554321” |
Поле deviceInfo
| Имя поля |
Тип |
Назначение |
Пример |
| 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” |
Поле ofdStatus
| Имя поля |
Тип |
Назначение |
Пример |
| IsCompleted |
bool |
Флаг прописывается при инициализации полей описания статуса обмена с ОФД |
true |
| IsConnectedOFD |
bool |
Есть связь с ОФД |
true |
| IsExistDocsToSend |
bool |
Есть команда от ОФД |
false |
| IsWaitRequestFromOFD |
bool |
Ожидание ответного сообщения (квитанции) от ОФД |
false |
| IsExistCommandFromOFD |
bool |
Есть команда от ОФД |
false |
| IsConnectionParametersChanged |
bool |
Изменились настройки соединения с ОФД |
false |
| WaitingForResponseToCommandFromOFD |
bool |
Ожидание ответа на команду от ОФД |
false |
| DocumentsCount |
int |
Количество неотправленных ФД |
0 |
| FirstDocumentNumber |
int |
Номер первого неотправленного ФД |
0 |
| FirstDocumentDate |
DateTime |
Дата и время первого неотправленного ФД |
“0001-01-01T00:00:00” |
| OfdMessageRead |
bool |
Прочитано сообщение ОФД |
false |
Поле ShiftTotal
| Имя поля |
Тип |
Назначение |
Пример |
| IsCountersReaded |
bool |
Прочитаны ли дополнительные счетчики ККМ |
true |
| ShiftNumber |
double |
Номер смены |
3.0 |
Поле CashDrawer — Детали ленежного ящиика
| Имя поля |
Тип |
Назначение |
Пример |
| Sum |
decimal |
Сумма |
0.0 |
| 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 |
Поле overallTotals — Необнуляемые / сменные итоги
| Имя поля |
Тип |
Назначение |
Пример |
| DataLoaded |
bool |
Все ли данные успешно прочитаны из устройства |
true |
| Sum |
decimal |
Сумма |
1365.68 |
| Count |
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 |
Примеры ошибок
72 — Некорректный id
{
"Code": 72,
"Description": "Некорректный id",
"Success": false
}
72 — Не указан id
{
"Code": 72,
"Description": "Не указан id",
"Success": false
}
91 — Документ не найден
{
"Code": 91,
"Description": "Документ не найден",
"Success": false
}
GET shift/x/list?device={device}&from={from}&to={to}
Запрос: shift/x/list
URL: {{HTTPRoot}}/shift/x/list?device={device}&from={from}&to={to}
Тип: список X-отчётов
Параметры запроса
| Параметр |
Обяз |
Пример |
Описание |
device |
+ |
{device} |
название устройства |
from |
+ |
2026-05-29 |
начало даты |
to |
+ |
2026-06-04 |
конец даты |
Тело ответа
Успешный ответ (200 OK)
{
"Result": [
{
"ResultCode": 0,
"ResultDescription": "OK",
"Date": "2026-05-24T02:02:03",
"DocId": "947cdf22-e112-406b-82c5-bbb74921ac42",
"ShiftNumber": 3,
"DeviceName": "Emu",
"TerminalId": ""
},
{
"ResultCode": 0,
"ResultDescription": "OK",
"Date": "2026-05-24T01:57:54",
"DocId": "4b161ba3-bb5f-4209-964b-3c3f0e6f43b8",
"ShiftNumber": 3,
"DeviceName": "Emu",
"TerminalId": ""
}
],
"Code": 0,
"Description": "OK",
"Success": true
}
Тип: массив объектов ReportsResponse
ReportsResponse
| Имя поля |
Тип |
Назначение |
Пример |
| ResultCode |
enum |
Результат |
0 |
| ResultDescription |
string |
Описания результата |
“OK” |
| Date |
DateTime |
Дата создания документа |
“2026-05-24T00:11:23.5221437+08:00” |
| DocId |
guid |
Идентификатор документа |
“7ccfb3d4-bc93-40c7-9e4d-aa1c8b0261b6” |
| ShiftNumber |
int |
Номер сессии |
3 |
| DeviceName |
string |
Имя устройства |
“Emu” |
| TerminalId |
string |
Идентификатор терминала, с которго пришел документ |
”“ |
Примеры ошибок
72 — Некорректный интервал
{
"Code": 72,
"Description": "Некорректный интервал",
"Success": false
}
4 — Не указано имя ККТ
{
"Code": 4,
"Description": "Не указано имя ККТ",
"Success": false
}
