1. Overview
1.1. Version information
Version : version 1
1.2. URI scheme
BasePath : /api/1
1.3. Consumes
-
application/json
1.4. Produces
-
application/json
2. Paths
2.1. GET /status
2.1.1. Description
Состояние фискального накопителя
2.1.2. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ok |
Статус операции. |
boolean |
||||||||||||||||||||||||||
fiscal_drive_number |
Номер фискального накопителя. |
string |
||||||||||||||||||||||||||
state |
Фаза жизненного цикла фискального накопителя.
|
integer |
||||||||||||||||||||||||||
document_code |
Код текущего документа.
|
integer |
||||||||||||||||||||||||||
document_data_status |
Состояние данных документа.
|
enum (0, 1) |
||||||||||||||||||||||||||
shift_status |
Состояние смены.
|
enum (0, 1) |
||||||||||||||||||||||||||
alert_flags |
Флаги предупреждения.
|
integer |
||||||||||||||||||||||||||
last_document_datetime |
Дата и время последнего документа. |
string (date-time) |
||||||||||||||||||||||||||
last_document_number |
Номер последнего фискального документа. |
integer |
2.2. POST /settings
2.2.1. Description
Настройки
2.2.2. Parameters
Type | Name | Schema |
---|---|---|
Body |
data |
data
Name | Description | Schema |
---|---|---|
dateTime |
Текущие дата и время. |
string (date-time) |
ofdHost |
Адрес сервера ОФД. |
string |
ofdPort |
Порт сервера ОФД. |
integer |
ofdReconnectionDelay |
Задержка при переподключении к ОФД, в секундах. |
integer |
2.2.3. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
2.3. POST /reset
2.3.1. Description
Сброс фискального накопителя (только в версии для разработчиков)
2.3.2. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
2.4. GET /search/{document_number}/
2.4.1. Description
Поиск фискального документа по номеру
2.4.2. Parameters
Type | Name | Schema |
---|---|---|
Path |
document_number |
string |
2.4.3. Responses
HTTP Code | Schema |
---|---|
200 |
|
404 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
code |
В случае неудачи, содержит код ошибки. |
integer |
message |
В случае неудачи, содержит сообщение об ошибке. |
string |
state |
В случае неудачи из-за неверной фазы жизненного цикла фискального накопителя, содержит фазу. |
integer |
document_number |
В случае успеха, содержит номер документа. |
integer |
document_type |
В случае успеха, содержит тип документа. |
integer |
Response 404
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
document_number |
Содержит запрошенный номер документа. |
integer |
code |
Содержит код ошибки. |
integer |
not_found |
Документ не найден. Всегда |
boolean |
2.5. POST /print/{document_number}/
2.5.1. Description
Печать фискального документа по номеру
2.5.2. Parameters
Type | Name | Schema |
---|---|---|
Path |
document_number |
string |
2.5.3. Responses
HTTP Code | Schema |
---|---|
200 |
|
404 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
code |
В случае неудачи, содержит код ошибки. |
integer |
message |
В случае неудачи, содержит сообщение об ошибке. |
string |
state |
В случае неудачи из-за неверной фазы жизненного цикла фискального накопителя, содержит фазу. |
integer |
Response 404
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
document_number |
Содержит запрошенный номер документа. |
integer |
code |
Содержит код ошибки. |
integer |
not_found |
Документ не найден. Всегда |
boolean |
2.6. POST /printany
2.6.1. Description
Печать произвольных данных
2.6.2. Parameters
Type | Name | Schema |
---|---|---|
Body |
data |
< data > array |
data
Name | Description | Schema | ||||||||
---|---|---|---|---|---|---|---|---|---|---|
left |
Текст, выровненный по левому краю. Может быть указан совместно с right. Символы текста, которые не соответствуют печатным символам кодировки CP866, будут заменены на пробелы. |
string |
||||||||
right |
Текст, выровненный по правому краю. Может быть указан совместно с left. Символы текста, которые не соответствуют печатным символам кодировки CP866, будут заменены на пробелы. |
string |
||||||||
center |
Текст, выровненный по центру. В случае указания, left и right игнорируются. Символы текста, которые не соответствуют печатным символам кодировки CP866, будут заменены на пробелы. |
string |
||||||||
doubleWidth |
Использовать шрифт двойной ширины. |
boolean |
||||||||
doubleHeight |
Использовать шрифт двойной высоты. |
boolean |
||||||||
hr |
Горизонтальная линия. В случае указания, center, left, right игнорируются. |
boolean |
||||||||
feed |
Подача бумаги. В случае указания, center, left, right, hr игнорируются.
Minimum length : |
string |
2.6.3. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
2.7. POST /register
2.7.1. Description
Регистрация и изменение параметров регистрации
2.7.2. Parameters
Type | Name | Schema |
---|---|---|
Body |
data |
data
Name | Description | Schema | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
T1048 |
Наименование пользователя. |
string |
||||||||||||||||
T1018 |
ИНН пользователя. |
string |
||||||||||||||||
T1062 |
Системы налогообложения.
|
< enum (1, 2, 3, 4, 5, 6) > array |
||||||||||||||||
T1037 |
Регистрационный номер ККТ. |
string |
||||||||||||||||
T1002 |
Признак автономного режима. |
boolean |
||||||||||||||||
T1221 |
Признак установки принтера в автомате. |
boolean |
||||||||||||||||
T1110 |
Признак АС БСО. |
boolean |
||||||||||||||||
T1056 |
Признак шифрования. |
boolean |
||||||||||||||||
T1001 |
Признак автоматического режима. |
boolean |
||||||||||||||||
T1108 |
Признак ККТ для расчетов только в Интернет. |
boolean |
||||||||||||||||
T1036 |
Номер автомата. |
string |
||||||||||||||||
T1207 |
Признак торговли подакцизными товарами. |
boolean |
||||||||||||||||
T1109 |
Признак расчетов за услуги. |
boolean |
||||||||||||||||
T1193 |
Признак проведения азартных игр. |
boolean |
||||||||||||||||
T1126 |
Признак проведения лотереи. |
boolean |
||||||||||||||||
T1057 |
Признак агента.
|
< enum (1, 2, 3, 4, 5, 6, 7) > array |
||||||||||||||||
T1021 |
Кассир |
string |
||||||||||||||||
T1203 |
ИНН кассира |
string |
||||||||||||||||
T1009 |
Адрес расчетов. |
string |
||||||||||||||||
T1187 |
Место расчетов. |
string |
||||||||||||||||
T1117 |
Адрес электронной почты отправителя чека. |
string |
||||||||||||||||
T1017 |
ИНН ОФД. |
string |
||||||||||||||||
T1046 |
Наименование ОФД. |
string |
||||||||||||||||
T1190 |
Версия ФФД ФН. |
enum (2, 3) |
||||||||||||||||
T1101 |
Код причины перерегистрации.
|
enum (1, 2, 3, 4) |
2.7.3. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
code |
В случае неудачи, содержит код ошибки. |
integer |
message |
В случае неудачи, содержит сообщение об ошибке. |
string |
state |
В случае неудачи из-за неверной фазы жизненного цикла фискального накопителя, содержит фазу. |
integer |
document_number |
В случае успеха, содержит номер документа. |
integer |
errors |
В случае неудачи из-за ошибок валидации, содержит детальную информацию об ошибочных полях. |
< errors > array |
errors
Name | Description | Schema |
---|---|---|
field |
Наименование поля, которое вызвало ошибку. |
string |
code |
Код ошибки. |
integer |
message |
Сообщение об ошибке. |
string |
2.8. POST /shift/open
2.8.1. Description
Открытие смены
2.8.2. Parameters
Type | Name | Schema |
---|---|---|
Body |
data |
data
Name | Description | Schema |
---|---|---|
T1021 |
Кассир |
string |
T1203 |
ИНН кассира |
string |
2.8.3. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
code |
В случае неудачи, содержит код ошибки. |
integer |
message |
В случае неудачи, содержит сообщение об ошибке. |
string |
state |
В случае неудачи из-за неверной фазы жизненного цикла фискального накопителя, содержит фазу. |
integer |
document_number |
В случае успеха, содержит номер документа. |
integer |
errors |
В случае неудачи из-за ошибок валидации, содержит детальную информацию об ошибочных полях. |
< errors > array |
errors
Name | Description | Schema |
---|---|---|
field |
Наименование поля, которое вызвало ошибку. |
string |
code |
Код ошибки. |
integer |
message |
Сообщение об ошибке. |
string |
2.9. POST /currentstate
2.9.1. Description
Текущее состояние расчетов
2.9.2. Parameters
Type | Name | Schema |
---|---|---|
Body |
data |
object |
2.9.3. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
code |
В случае неудачи, содержит код ошибки. |
integer |
message |
В случае неудачи, содержит сообщение об ошибке. |
string |
state |
В случае неудачи из-за неверной фазы жизненного цикла фискального накопителя, содержит фазу. |
integer |
document_number |
В случае успеха, содержит номер документа. |
integer |
errors |
В случае неудачи из-за ошибок валидации, содержит детальную информацию об ошибочных полях. |
< errors > array |
errors
Name | Description | Schema |
---|---|---|
field |
Наименование поля, которое вызвало ошибку. |
string |
code |
Код ошибки. |
integer |
message |
Сообщение об ошибке. |
string |
2.10. POST /receipt
2.10.1. Description
Кассовый чек (БСО)
2.10.2. Parameters
Type | Name | Schema |
---|---|---|
Body |
data |
data
Name | Description | Schema | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
T1054 |
Признак расчета.
|
enum (1, 2, 3, 4) |
||||||||||||||
T1055 |
Применяемая система налогообложения.
|
enum (1, 2, 3, 4, 5, 6) |
||||||||||||||
T1008 |
Телефон или электронный адрес покупателя. |
string |
||||||||||||||
T1059 |
Предмет расчета. |
< T1059 > array |
||||||||||||||
T1031 |
Сумма по чеку (БСО) наличными. |
integer |
||||||||||||||
T1081 |
Сумма по чеку (БСО) электронными. |
integer |
||||||||||||||
T1215 |
Сумма по чеку (БСО) предоплатой (зачетом аванса и (или) предыдущих платежей). |
integer |
||||||||||||||
T1216 |
Сумма по чеку (БСО) постоплатой (в кредит). |
integer |
||||||||||||||
T1217 |
Сумма по чеку (БСО) встречным предоставлением. |
integer |
||||||||||||||
T1192 |
Дополнительный реквизит чека (БСО). |
string |
||||||||||||||
T1084 |
Дополнительный реквизит пользователя. |
|||||||||||||||
T1021 |
Кассир |
string |
||||||||||||||
T1203 |
ИНН кассира |
string |
T1059
Name | Description | Schema | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
T1214 |
Признак способа расчета.
|
enum (1, 2, 3, 4, 5, 6, 7) |
||||||||||||||||||||||||||||
T1212 |
Признак предмета расчета.
|
enum (1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13) |
||||||||||||||||||||||||||||
T1222 |
Признак агента по предмету расчета.
|
< enum (1, 2, 3, 4, 5, 6, 7) > array |
||||||||||||||||||||||||||||
T1223A |
Данные агента. |
|||||||||||||||||||||||||||||
T1223B |
Данные агента. |
|||||||||||||||||||||||||||||
T1224 |
Данные поставщика. |
|||||||||||||||||||||||||||||
T1226 |
ИНН поставщика. |
string |
||||||||||||||||||||||||||||
T1030 |
Наименование предмета расчета. |
string |
||||||||||||||||||||||||||||
T1197 |
Единица измерения предмета расчета. |
string |
||||||||||||||||||||||||||||
T1162 |
Код товарной номенклатуры. |
string |
||||||||||||||||||||||||||||
T1079 |
Цена за единицу предмета расчета с учетом скидок и наценок. |
integer |
||||||||||||||||||||||||||||
T1023 |
Количество предмета расчета. |
string |
||||||||||||||||||||||||||||
T1199 |
Ставка НДС.
Default : |
enum (1, 2, 3, 4, 5, 6) |
||||||||||||||||||||||||||||
T1191 |
Дополнительный реквизит предмета расчета. |
string |
T1223A
Name | Description | Schema |
---|---|---|
T1073 |
Телефон платежного агента. |
< string > array |
T1074 |
Телефон оператора по приему платежей. |
< string > array |
T1223B
Name | Description | Schema |
---|---|---|
T1044 |
Операция платежного агента. |
string |
T1073 |
Телефон платежного агента. |
< string > array |
T1005 |
Адрес оператора перевода. |
string |
T1016 |
ИНН оператора перевода. |
string |
T1026 |
Наименование оператора перевода. |
string |
T1075 |
Телефон оператора перевода. |
< string > array |
T1224
Name | Description | Schema |
---|---|---|
T1171 |
Телефон поставщика. |
< string > array |
T1225 |
Наименование поставщика. |
string |
T1084
Name | Description | Schema |
---|---|---|
T1085 |
Наименование дополнительного реквизита пользователя. |
string |
T1086 |
Значение дополнительного реквизита пользователя. |
string |
2.10.3. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
code |
В случае неудачи, содержит код ошибки. |
integer |
message |
В случае неудачи, содержит сообщение об ошибке. |
string |
state |
В случае неудачи из-за неверной фазы жизненного цикла фискального накопителя, содержит фазу. |
integer |
errors |
В случае неудачи из-за ошибок валидации, содержит детальную информацию об ошибочных полях. |
< errors > array |
errors
Name | Description | Schema |
---|---|---|
field |
Наименование поля, которое вызвало ошибку. |
string |
code |
Код ошибки. |
integer |
message |
Сообщение об ошибке. |
string |
index |
В случае, если ошибочное поле является массивом, содержит индекс ошибочного элемента в массиве. |
integer |
errors |
В случае, если ошибочное поле является вложенным объектом, содержит детальную информацию об ошибочных полях вложенного объекта. |
< errors > array |
errors
Name | Description | Schema |
---|---|---|
field |
Наименование поля, которое вызвало ошибку. |
string |
code |
Код ошибки. |
integer |
message |
Сообщение об ошибке. |
string |
index |
В случае, если ошибочное поле является массивом, содержит индекс ошибочного элемента в массиве. |
integer |
errors |
В случае, если ошибочное поле является вложенным объектом, содержит детальную информацию об ошибочных полях вложенного объекта. |
< errors > array |
errors
Name | Description | Schema |
---|---|---|
field |
Наименование поля, которое вызвало ошибку. |
string |
code |
Код ошибки. |
integer |
message |
Сообщение об ошибке. |
string |
index |
В случае, если ошибочное поле является массивом, содержит индекс ошибочного элемента в массиве. |
integer |
2.11. POST /correctivereceipt
2.11.1. Description
Кассовый чек (БСО) коррекции
2.11.2. Parameters
Type | Name | Schema |
---|---|---|
Body |
data |
data
Name | Description | Schema | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
T1054 |
Признак расчета.
|
enum (1, 3) |
||||||||||||||
T1055 |
Применяемая система налогообложения.
|
enum (1, 2, 3, 4, 5, 6) |
||||||||||||||
T1173 |
Тип коррекции.
|
enum (0, 1) |
||||||||||||||
T1177 |
Описание коррекции. |
string |
||||||||||||||
T1178 |
Дата документа основания для коррекции. |
string (date) |
||||||||||||||
T1179 |
Номер документа основания для коррекции. |
string |
||||||||||||||
T1020 |
Сумма расчета, указанного в чеке (БСО). |
integer |
||||||||||||||
T1031 |
Сумма по чеку (БСО) наличными. |
integer |
||||||||||||||
T1081 |
Сумма по чеку (БСО) электронными. |
integer |
||||||||||||||
T1215 |
Сумма по чеку (БСО) предоплатой (зачетом аванса и (или) предыдущих платежей). |
integer |
||||||||||||||
T1216 |
Сумма по чеку (БСО) постоплатой (в кредит). |
integer |
||||||||||||||
T1217 |
Сумма по чеку (БСО) встречным предоставлением. |
integer |
||||||||||||||
T1102 |
Сумма НДС чека по ставке 18%. |
integer |
||||||||||||||
T1103 |
Сумма НДС чека по ставке 10%. |
integer |
||||||||||||||
T1104 |
Сумма расчета по чеку с НДС по ставке 0%. |
integer |
||||||||||||||
T1105 |
Сумма расчета по чеку без НДС. |
integer |
||||||||||||||
T1106 |
Сумма НДС чека по расч. ставке 18/118. |
integer |
||||||||||||||
T1107 |
Сумма НДС чека по расч. ставке 10/110. |
integer |
||||||||||||||
T1021 |
Кассир |
string |
||||||||||||||
T1203 |
ИНН кассира |
string |
2.11.3. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
code |
В случае неудачи, содержит код ошибки. |
integer |
message |
В случае неудачи, содержит сообщение об ошибке. |
string |
state |
В случае неудачи из-за неверной фазы жизненного цикла фискального накопителя, содержит фазу. |
integer |
document_number |
В случае успеха, содержит номер документа. |
integer |
errors |
В случае неудачи из-за ошибок валидации, содержит детальную информацию об ошибочных полях. |
< errors > array |
errors
Name | Description | Schema |
---|---|---|
field |
Наименование поля, которое вызвало ошибку. |
string |
code |
Код ошибки. |
integer |
message |
Сообщение об ошибке. |
string |
2.12. POST /shift/close
2.12.1. Description
Закрытие смены
2.12.2. Parameters
Type | Name | Schema |
---|---|---|
Body |
data |
data
Name | Description | Schema |
---|---|---|
T1021 |
Кассир |
string |
T1203 |
ИНН кассира |
string |
2.12.3. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
code |
В случае неудачи, содержит код ошибки. |
integer |
message |
В случае неудачи, содержит сообщение об ошибке. |
string |
state |
В случае неудачи из-за неверной фазы жизненного цикла фискального накопителя, содержит фазу. |
integer |
document_number |
В случае успеха, содержит номер документа. |
integer |
errors |
В случае неудачи из-за ошибок валидации, содержит детальную информацию об ошибочных полях. |
< errors > array |
errors
Name | Description | Schema |
---|---|---|
field |
Наименование поля, которое вызвало ошибку. |
string |
code |
Код ошибки. |
integer |
message |
Сообщение об ошибке. |
string |
2.13. POST /finalize
2.13.1. Description
Закрытие фискального накопителя
2.13.2. Parameters
Type | Name | Schema |
---|---|---|
Body |
data |
data
Name | Description | Schema |
---|---|---|
T1021 |
Кассир |
string |
T1203 |
ИНН кассира |
string |
2.13.3. Responses
HTTP Code | Schema |
---|---|
200 |
Response 200
Name | Description | Schema |
---|---|---|
ok |
Статус операции. |
boolean |
code |
В случае неудачи, содержит код ошибки. |
integer |
message |
В случае неудачи, содержит сообщение об ошибке. |
string |
state |
В случае неудачи из-за неверной фазы жизненного цикла фискального накопителя, содержит фазу. |
integer |
document_number |
В случае успеха, содержит номер документа. |
integer |
errors |
В случае неудачи из-за ошибок валидации, содержит детальную информацию об ошибочных полях. |
< errors > array |
errors
Name | Description | Schema |
---|---|---|
field |
Наименование поля, которое вызвало ошибку. |
string |
code |
Код ошибки. |
integer |
message |
Сообщение об ошибке. |
string |