Программный интерфейс приложений (API) для работы с ИС «Чеки и ККТ»

Версия 2.04 от 01.08.2022 Открыть pdf-файл

Введение

В документации приведено описание программного интерфейса приложений (API) информационной системы (ИС) «Чеки и ККТ». API ИС «Чеки и ККТ» предоставляет сторонним (клиентским) приложениям использовать данные фискальных документов для сверки. Взаимодействие клиентского приложения и API осуществляется путем отправки приложением HTTP-запросов к серверу и получением ответов. Для отправки запросов и получения ответов используется протокол HTTPS. Максимально количество символов в запросе json, составляет 30000 символов. Максимальный размер для tlv 32 кб. Размер tlv установлен ФНС, согласно протоколу передачи данных. Объем служебной информации в tlv установлен кассой, изменять категорически запрещается. Изменение объема служебной информации будет рассматриваться ФНС как нарушение протокола передачи данных. Частота отправки запроса не должна превышать более 1 запроса в секунду.

1. Авторизация через AuthToken

Для многократного обращения к ИС «Чеки и ККТ», после одной авторизации без использования механизма Cookies реализован механизм AuthToken. После авторизации с передачей имени и пароля система возвращает код авторизации – строку символов. Код авторизации необходимый параметр в API запроса к ИС «Чеки и ККТ». Код авторизации необходим в запросах для обращения личному кабинету (ЛК). HTTP-запрос авторизации выполняется методом POST с передачей дополнительных параметров формате JSON.

Запрос выглядит следующим образом:

POST https://ofd.ru/api/Authorization/CreateAuthToken 

Тело запроса:

{
  "Login": "12345",
  "Password": "56789"
}

В запросе необходимы значения следующих параметров:

  • Login – логин ЛКК OFD.ru;
  • Password – пароль.

На запрос будет получен ответ по протоколу HTTP. Успешный ответ на запрос авторизации будет иметь код равный 200.

Пример успешного ответа на запрос:

{
    "AuthToken": "f3accdfda7574736ba94a78d00e974f4",
    "ExpirationDateUtc": "2017-01-24T14:44:21"
}

В ответе представлены следующие параметры:

  • «AuthToken» – ключ авторизации1);
  • «ExpirationDateUtc» – дата и время действия ключа аутентификации2).

Если после запроса код ответа по протоколу HTTP будет равен 403, данные будут отсутствовать, вам необходимо проверить правильность введенных значений для параметров «Login», «Password».

Полученный код авторизации - это необходимый параметр для выполнения запросов к ИС «Чеки ККТ».

Получение информации по кассам и фискальным данным выполняется с помощью запросов к ИС «Чеки ККТ» с использованием параметра “AuthToken”. Доступ к информации определяется в соответствии с настроенными в ЛК правами доступа к кассам и фискальным данным заданными для пользователя. Права пользователя могут быть заданы одновременно для нескольких ЛК юридических лиц. В ответах на запросы к ИС «Чеки ККТ» будут приходить данные к которым разрешен доступ согласно значению ключа “AuthToken”.

Пример запроса с использованием кода авторизации:

GET https://ofd.ru/api/integration/v1/inn/{INN}/kkts?AuthToken={Code}

Параметры необходимы для выполнения запроса к ИС «Чеки ККТ»:

  • INN – идентификационный номер налогоплательщика (ИНН) юридического лица;
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

2. Запросы к ИС на получение информации по чекам и ККТ

В API ИС «Чеки и ККТ» реализованы необходимые запросы для работы клиентского приложения с фискальными данными и кассами. В запросах и ответах используется кодировка UTF-8. Ответы выдаются сервером в формате JSON. Код успешного ответа, по протоколу HTTP равен 200.

Обобщенный вид ответа с кодом 200:

{
  "Status": "Success",
  "Data": {
    "Prop1": "Val1",
    "Prop2": "Val2",
    ...
    "PropN": "ValN"
  },
  "Elapsed": "чч:мм:сс.ддддддд"
}

Параметр «Status» – это состояние обработки запроса. Параметр имеет значение «Success» (запрос обработан успешно).

Параметр «Data» имеет значение в виде структуры вложенных параметров. Структура вложенных параметров представлена в следующем обобщенном виде, где «Prop1», «Prop2», … «PropN» и «Val1», «Val2», … «ValN» — параметры со значениями в разных виде представления3).

Параметр «Elapsed» — время, затраченное ИС на обработку запроса.

Формат времени — представлен в строковом виде «чч:мм:сс.ддддддд» в формате дата-время со следующей структурой:

  • чч – часы;
  • мм – минуты;
  • сс – секунды;
  • ддддддд – доли секунды.

Если в ответе на запрос код, по протоколу HTTP не равен 200, то запрос к API ИС «Чеки и ККТ» выполнен с ошибкой. Причиной может быть:

  • некорректно написан запрос;
  • допущена ошибка;
  • значения параметров некоректно заданы.

Обобщенный вид неуспешного ответа:

{
  "Status": "Failed",
  "Errors": [
    "Ошибка 1",
    "Ошибка 2",
    ...
    "Ошибка N"
  ],
  "Elapsed": "чч:мм:сс.ддддддд"
}

Параметр «Status» имеет значение «Failed» (обработка запроса не удалась).

Параметр «Errors» представлен в виде одномерного массива с сообщениями об ошибках. В массиве представлены строки в виде, где «Ошибка 1», «Ошибка 2», … «Ошибка N» перечисление сообщений об ошибках.

Параметр «Elapsed» – время затраченное системой на обработку запроса.

2.1. Запрос информации о KKT

В API ИС «Чеки и ККТ» вы можете получить актуальную информацию о ККТ. Запрос выполняет методом GET.

Запрос имеет вид:

GET https://ofd.ru/api/integration/v1/inn/{INN}/kkts?FNSerialNumber={FNumber}&KKTSerialNumber={KKTNumber}&KKTRegNumber={KKTRegNumber}&AuthToken={Code}

Параметры необходимые для запроса:

  • INN – идентификационный номер налогоплательщика (ИНН) юридического лица;
  • FNumber – номер фискального накопителя;
  • KKTNumber – заводской номер кассы;
  • KKTRegNumber – регистрационный номер кассы;
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Успешный ответ равен, по протоколу HTTP коду 200, на запрос возвращается структура данных в формате JSON

Успешный ответ на запрос:

{
  "Status": "Success",
  "Data": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "KktRegId": "9304171212297195",
      "KktName": "Касса 1",
      "SerialNumber": "44444444444443421132",
      "ActivationDate": "2017-01-13T12:15:48",
      "ContractStartDate": "2017-01-13T12:12:47",
      "ContractEndDate": "2018-02-12T12:12:47",
      "CreateDate": "2017-01-13T12:09:51",
      "FnNumber": "0666666666666660",
      "SignDate": "2017-01-14T10:00:00",
      "PaymentDate": "2017-01-13T12:15:43",
      "CheckDate": "2017-01-13T12:12:47",
      "LastDocOnKktDateTime": "2017-02-12T10:12:00",
      "LastDocOnOfdDateTimeUtc": "2017-02-12T07:13:10",
      "FirstDocumentDate": "2017-01-13T14:15:48",
      "FiscalAddress": "https://ofd.ru/",
      "FiscalPlace": "https://ofd.ru/",
      "Path": "/Мои кассы/Список касс 1/",
      "KktModel": "АТОЛ 42ФС",
      "FnEndDate": "2019-10-17T12:47:57"
    },
    ...
  ]
}

Описание параметров ответа представлен в таблице 1.

Таблица 1. Описание параметров ответа на запрос информации о KKT

Параметр Вид значения Описание
Id String Уникальный номер ККТ (кассы)
KktRegId String Регистрационный номер ККТ (кассы)
KktName String Название кассы
SerialNumber String Заводской (серийный) номер ККТ (кассы)
ActivationDate String Дата4) успешной проверки регистрационного номера в ФНС
ContractStartDate String Дата5) начала действия контракта на получение услуг оператора “OFD.ru”
ContractEndDate String Дата6) окончания действия контракта на получение услуг оператора “OFD.ru”
CreateDate String Дата7) регистрации кассы в личном кабинете клиента
FnNumber String Номер фискального накопителя
SignDate String Дата8) подписания договора
PaymentDate String Дата9) оплаты услуг ОФД для кассы
CheckDate String Дата10) подписания КЭП (квалификационной электронной подписью)
LastDocOnKktDateTime String Дата и время11) последнего документа, сгенерированного кассой (по локальному времени кассы)
LastDocOnOfdDateTimeUtc String Дата и время получения последнего документа кассы в ОФД (по времени оператора “OFD.ru” в UTC)
FirstDocumentDate String Дата и время12) генерации кассой первого документа
FiscalAddress String Адрес установки кассы
FiscalPlace String Место расчетов
Path String Иерархия расположения кассы в личном кабинете клиента
KktModel String Модель кассы (ККТ)
FnEndDate String Дата и время13) окончания работы фискального накопителя

В ответ на запрос к ИС возможна следующая ошибка:

  • InnNotFound – для текущей учетной записи не найдено юридическое лицо по заданному ИНН.

2.2. Запрос списка отчетов по смене одной ККТ

В API ИС «Чеки и ККТ» вы может сделать запрос списка отчетов по кассе в указанный вами период . Запрос выполняется методом GET.

Запрос имеет вид:

GET https://ofd.ru/api/integration/v1/inn/{INN}/kkt/{KKT}/zreports?dateFrom={Date1}&dateTo={Date2}&AuthToken={Code}

Параметры необходимые для запроса:

  • INN – идентификационный номер налогоплательщика (ИНН) юридического лица;
  • KKT – регистрационный номер кассы – строка символов;
  • Date1 – начальная дата периода для формирования отчета, значения содержат дату и время в формате ISO. Разница значений Date1 и Date2 не должна превышать 30 дней, дата начала и дата конца периода формирования списка отчетов не должны быть одинаковые.
  • Date2 – конечная дата периода для формирования отчета, значения содержат дату и время в формате ISO. Разница значений Date1 и Date2 не должна превышать 30 дней, дата начала и дата конца периода формирования списка отчетов не должны быть одинаковые.
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Успешный ответ имеет следующий вид:

{
  "Status": "Success",
  "Data": [
    {
      "Id": "fc6562fc-e8b9-4ce2-a7c1-461a02171a98",
      "Open_CDateUtc": "2016-07-26T09:28:54",
      "Close_CDateUtc": "2016-07-27T15:47:36",
      "UserInn": "7802870820",
      "KktRegNumber": "111222333",
      "FnNumber": "99990789388",
      "ShiftNumber": 1,
      "Operator": "Администратор",
      "Open_DocNumber": 2,
      "Open_DocDateTime": "2016-07-26T12:28:00",
      "Open_DocRawId": "7e66f625-2cf6-428f-bf98-be37077daf55",
      "Close_DocNumber": 9,
      "Close_DocDateTime": "2016-07-27T18:47:00",
      "Close_DocRawId": "cc3110c0-f1ca-49d1-9d3c-1f880e28957f",
      "ShiftDocsCount": 9,
      "IncomeSumm": 375420,
      "IncomeCashSumm": 0,
      "IncomeECashSumm": 0,
      "IncomeCount": 5,
      "AdvanceSumm": 0,
      "CreditSumm": 0,
      "ExchangeSumm": 0,
      "RefundIncomeSumm": 6360,
      "RefundIncomeCashSumm": 0,
      "RefundIncomeCount": 1,
      "ExpenseSumm": 0,
      "ExpenseCount": 0,
      "RefundExpenseSumm": 0,
      "RefundExpenseCount": 0,
      "RefundAdvanceSumm": 0,
      "RefundCreditSumm": 0,
      "RefundExchangeSumm": 0,
      "TaxTotalSumm": 0,
      "Tax10Summ": 0,
      "Tax18Summ": 0,
      "Tax110Summ": 0,
      "Tax118Summ": 0,
      "TaxNaSumm": 0,
      "Tax0Summ": 0
    },
    ...
  ]
}

Описание параметров ответа представлен в таблице 2.

Таблица 2. Описание параметров ответа на запрос списка отчетов по смене для заданной кассы за период

Параметр Вид значения Описание
Id String14) Идентификатор смены
Open_CDateUtc String Дата и время15) отчета об открытии смены
Close_CDateUtc String Дата и время16) отчета о закрытии смены
UserInn String ИНН владельца кассы
KktRegNumber String Регистрационный номер кассы
FnNumber String Номер фискального накопителя, установленного в кассу
ShiftNumber Integer Номер смены по данным кассы
Operator String Фамилия, имя, отчество оператора
Open_DocNumber Integer Фискальный номер документа отчета об открытии смены,
присвоенный кассой (уникальный в рамках текущего фискального режима)
Open_DocDateTime String Дата и время17) формирования отчета об открытии смены по данным кассы
Open_DocRawId String18) Идентификатор документа отчета об открытии смены,
полученного от кассы
Close_DocNumber Integer Фискальный номер документа отчета о закрытии смены,
присвоенный кассой (уникальный в рамках текущего фискального режима)
Close_DocDateTime String Дата и время19) формирования отчета о закрытии смены по данным кассы
Close_DocRawId String20) Идентификатор документа отчета о закрытии смены,
полученного от кассы
ShiftDocsCount Integer Общее количество документов за смену
IncomeSumm Integer Сумма полученных денежных средств за смену в копейках
IncomeCashSumm Integer Сумма полученных денежных средств за смену наличными в копейках
IncomeECashSumm Integer Сумма полученных денежных средств за смену безналичными в копейках
IncomeCount Integer Количество чеков, выданных за смену, соответствующих получению суммы IncomeSumm
AdvanceSumm Integer Сумма полученных денежных средств авансом в копейках
CreditSumm Integer Сумма полученных денежных средств кредита в копейках
ExchangeSumm Integer Сумма полученных денежных средств обмена в копейках
RefundIncomeSumm Integer Сумма выданных (возвращённых) денежных средств за смену в копейках
RefundIncomeCashSumm Integer Сумма выданных (возвращенных) денежных средств за смену наличными в копейках
RefundIncomeCount Integer Количество чеков, выданных за смену, соответствующих возврату суммы RefundIncomeSumm
ExpenseSumm Integer Сумма расхода за смену
ExpenseCount Integer Количество чеков расхода за смену
RefundExpenseSumm Integer Сумма возвратов расхода за смену
RefundExpenseCount Integer Количество чеков возврата прихода за смену
RefundAdvanceSumm Integer Сумма возврата аванса
RefundCreditSumm Integer Сумма возврата кредита
RefundExchangeSumm Integer Сумма возврата обмена
TaxTotalSumm Integer Общая сумма удерживаемых налогов,
начисленная за смену в копейках
Tax10Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10%,
начисленная за смену в копейках
Tax18Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20%,
начисленная за смену в копейках 21)
Tax110Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10/110,
начисленная за смену, в копейках
Tax118Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20/120,
начисленная за смену, в копейках 22)
TaxNaSumm Integer Сумма по операциям, не облагаемая НДС, накопленная за смену, в копейках
Tax0Summ Integer Сумма по операциям, облагаемая НДС по ставке 0%,
накопленная за смену в копейках

В ответ на запрос к ИС возможны следующие ошибки:

  • InnNotFound – для текущей учетной записи не найдена организация;
  • KktNotFound – для текущей учетной записи не найдена касса с заданным номером;
  • InvalidTimeInterval – неверно указан временной интервал;
  • TimeIntervalMustNotExceed30Days – временной интервал более 30 дней.

2.3. Запрос списка отчетов по смене для всех ККТ за период

Запрос на получение списка отчетов по смене для всех ККТ за период выполняется методом GET.

Запрос имеет вид:

GET https://ofd.ru/api/integration/v1/inn/{INN}/zreports?dateFrom={Date1}&dateTo={Date2}&AuthToken={Code}

Параметры необходимые для запроса:

  • INN – идентификационный номер налогоплательщика (ИНН) юридического лица;
  • KKT – регистрационный номер кассы – строка символов.
  • Date1 – начальная дата периода для формирования отчета, значения содержат дату и время в формате ISO. Разница значений Date1 и Date2 не должна превышать 30 дней, дата начала и дата конца периода формирования списка отчетов не должны быть одинаковые.
  • Date2 – конечная дата периода для формирования отчета, значения содержат дату и время в формате ISO. Разница значений Date1 и Date2 не должна превышать 30 дней, дата начала и дата конца периода формирования списка отчетов не должны быть одинаковые.
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Пример успешного ответа и описание параметров ответа представлено в разделе 2.2

В ответ на запрос к ИС возможны следующие ошибки:

  • InnNotFound – для текущей учетной записи не найдена организация;
  • InvalidTimeInterval – неверно указан временной интервал;
  • TimeIntervalMustNotExceed30Days – временной интервал более 30 дней.

Внимание! В ответе на запрос возвращается информации по сменам для всех ККТ только по текущему ФН.

2.4. Список чеков за период по заданной кассе

Запрос на получение списка чеков за период по заданной кассе выполняется методом GET.

Запрос имеет вид:

GET https://ofd.ru/api/integration/v1/inn/{INN}/kkt/{KKT}/receipts?dateFrom={Date1}&dateTo={Date2}&AuthToken={Code}

Параметры необходимые для запроса:

  • INN – идентификационный номер налогоплательщика (ИНН) юридического лица;
  • KKT – регистрационный номер кассы – строка символов.
  • Date1 – начальная дата периода для формирования отчета, значения содержат дату и время в формате ISO. Разница значений Date1 и Date2 не должна превышать 30 дней, дата начала и дата конца периода формирования списка отчетов не должны быть одинаковые.
  • Date2 – конечная дата периода для формирования отчета, значения содержат дату и время в формате ISO. Разница значений Date1 и Date2 не должна превышать 30 дней, дата начала и дата конца периода формирования списка отчетов не должны быть одинаковые.
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Успешный ответ имеет следующий вид:

{
  "Status": "Success",
  "Data": [
    {
      "Id": "3a6e3b83-a0b0-4587-bfb3-1b7539b05cf3",
      "CDateUtc": "2016-07-26T09:32:41",
      "Tag": 0,
      "IsBso": false,
      "IsCorrection": false,
      "OperationType": "Income",
      "UserInn": "7802870820",
      "KktRegNumber": "111222333",
      "FnNumber": "99990789388",
      "DocNumber": 3,
      "DocDateTime": "2016-07-26T12:32:00",
      "DocShiftNumber": 1,
      "ReceiptNumber": 1,
      "DocRawId": "3a6e3b83-a0b0-4587-bfb3-1b7539b05cf3",
      "TotalSumm": 0,
      "CashSumm": 0,
      "ECashSumm": 0,
      "PrepaidSumm": 0,
      "CreditSumm": 0,
      "ProvisionSumm": 0,
      "TaxTotalSumm": 0,
      "Tax10Summ": 0,
      "Tax18Summ": 0,
      "Tax110Summ": 0,
      "Tax118Summ": 0,
      "Tax0Summ": 0,
      "TaxNaSumm": 0,
      "Depth": 3
    },
    ...
  ]
}

Описание параметров ответа представлено в таблице 3.

Таблица 3. Описание параметров ответа на запрос списка чеков за период по заданной кассе

Параметр Вид значения Описание
Id String23) Уникальный номер фискального документа в ИС, используется в запросе подробной информации по чеку, как RawId
CDateUtc String Дата и время24) приема документа в ИС
Tag Integer Численный признак вида документа:
3 – чек;
31 – чек коррекции;
4 – бланк строгой отчетности;
41 – бланк строгой отчетности коррекции
IsBso Boolean Имеет значение true, если документ является БСО, иначе (если документ является чеком) – false
IsCorrection Boolean Имеет значение true, если чек или бланк строгой отчетности (БСО) является документом коррекции, иначе – false
OperationType String Тип операции:
«Income» – приход;
«Expense» – расход;
«Refund income» – возврат прихода;
«Refund expense» – возврат расхода.
UserInn String ИНН владельца кассы
KktRegNumber String Регистрационный номер кассы
FnNumber String Номер фискального накопителя, установленного в кассу
DocNumber Integer Фискальный номер документа
DocDateTime String Дата и время25) формирования документа по данным кассы
DocShiftNumber Integer Номер смены (по данным кассы), в которую был сформирован документ
ReceiptNumber Integer Номер документа в смене (по данным кассы)
DocRawId String26) Уникальный номер фискального документа в ИС, (используется в запросе подробной информации по чеку, как RawId, дублирует поле Id)
TotalSumm Integer Общая сумма по чеку в копейках
CashSumm Integer Сумма по чеку (БСО) наличными в копейках
ECashSumm Integer Сумма по чеку (БСО) электронными в копейках
PrepaidSumm Integer Сумма по чеку (БСО) предоплатами (авансами)
CreditSumm Integer Сумма по чеку (БСО) постоплатами (кредитами)
ProvisionSumm Integer Сумма по чеку (БСО) встречными предоставлениями
TaxTotalSumm Integer Общая сумма удерживаемых налогов, начисленная за смену в копейках
Tax10Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10%, начисленная за смену, в копейках
Tax18Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20%, начисленная за смену, в копейках27)
Tax110Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10/110, начисленная за смену, в копейках
Tax118Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20/120, начисленная за смену, в копейках28)
TaxNaSumm Integer Сумма по операциям, не облагаемая НДС, накопленная за смену, в копейках
Tax0Summ Integer Сумма по операциям, облагаемая НДС по ставке 0%, накопленная за смену, в копейках
Depth Integer Количество товарных позиций в чеке

В ответе на запрос к ИС возможны следующие сообщения об ошибке:

  • InnNotFound – для текущей учетной записи не найдена организация;
  • KktNotFound – для текущей учетной записи не найдена касса с заданным номером;
  • InvalidTimeInterval – неверно указан временной интервал;
  • TimeIntervalMustNotExceed7Days – временной интервал более 7 дней.

2.5. Список чеков за смену по заданной кассе

Запрос на получение списка за смену по заданной кассе выполняется методом GET

Запрос имеет вид:

GET https://ofd.ru/api/integration/v1/inn/{INN}/kkt/{KKT}/receipts?ShiftNumber={Shift}&FnNumber={Fn}&AuthToken={Code}

Здесь:

  • INN – ИНН юридического лица;
  • KKT – регистрационный номер кассы – строка символов;
  • Shift – номер смены, по которой требуется сгенерировать отчет;
  • Fn – номер фискального накопителя, установленного в кассу;
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Пример успешного ответа приведен в разделе 2.4. Описание параметров ответа представлено в Таблице 3, описание возможных ошибок, приведено в разделе 2.4.

2.6. Подробная информация по чеку

Запрос на получение подробной информации по конкретному чеку может быть получен двумя способами:

  • по уникальному номеру фискального документа;
  • по порядковому номеру смены и номеру документа в смене.

Запрос выполняется методом GET

Запрос, по уникальному номеру фискального документа имеет вид:

GET https://ofd.ru/api/integration/v1/inn/{INN}/kkt/{KKT}/receipt/{RawId}?AuthToken={Code}

Запрос, по порядковому номеру смены и номеру документа в смене имеет вид:

GET https://ofd.ru/api/integration/v1/inn/{INN}/kkt/{KKT}/zreport/{ShiftNumber}/receipt/{DocShiftNumber}?AuthToken={Code}

Необходимые параметры для запросов:

  • INN – ИНН юридического лица Строка состоит из 10 цифр от 0 до 9.
  • KKT – регистрационный номер кассы – строка символов.
  • RawId – уникальный номер фискального документа в ИС «Чеки и ККТ» (строка в формате UUID).
  • ShiftNumber – номер смены, в течение которой был сгенерирован документ.
  • DocShiftNumber – номер документа внутри смены.
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Успешный ответ имеет следующий вид:

{
    "Status": "Success",
    "Data": {
        "Tag": 3,
        "User": "ООО МКАС СПб",
        "UserInn": "7802870820 ",
        "Number": 1,
        "DateTime": "2016-07-26T12:32:00",
        "ShiftNumber": 1,
        "OperationType": 1,
        "TaxationType": 1,
        "Operator": "Администратор",
        "KKT_RegNumber": "111222333",
        "FN_FactoryNumber": "99990789388",
        "Items": [
           {
               "Name": "Услуги",
               "Price": 599000,
               "Quantity": 12,
               "Total": 599000,
               "CalculationMethod": 4,
               "SubjectType": 1,
               "NDS_Rate": 1,
               "NDS_Summ": 99833,
               "Nds00_TotalSumm": 0
           }
        ],
        "Buyer_Address": "",
        "Nds18_TotalSumm": 99833,
        "Amount_Total": 599000,
        "Amount_Cash": 0,
        "Amount_ECash": 599000,
        "Document_Number": 3,
        "FiscalSign": "MQTLUGn8",
        "DecimalFiscalSign": "3393623696",
        "KKT_MachineNumber": "1",
        "InternetSign": 1,
        "Extra": [
            {
                "Name": "Name",
                "Value": "Value"
            },
            {
                "Name": "Name",
                "Value": "Value"
            }
        ],
        "Format_Version": 2,
        "Amount_Advance": 0,
        "Amount_Loan": 0,
        "Amount_Granting": 0
    }
}

Описания параметров структуры бланка строгой отчетности представлен в таблице 4.

Таблица 4. Описание параметров бланка строгой отчетности

Параметр Вложенный параметр Вид значения Описание Тег
Tag Integer Численный признак вида документа:
3 – чек;
4 – бланк строгой отчетности
User String Полное имя или название владельца кассы 1048
UserInn String ИНН владельца кассы 1018
Number Integer Номер документа внутри смены 1042
DateTime String Дата и время29) формирования документа (чека) 1012
ShiftNumber Integer Номер смены (по данным кассы), в которую был сформирован документ 1038
OperationType String Тип операции: 1054
«Income» – приход;
«Expence» – расход;
«Refund income» – возврат прихода;
«Refund expence» – возврат расхода.
TaxationType Integer Внимание! Возможные (корректные) значения типа налогообложения ограничиваются значениями выбранными при регистрации кассы. Чтобы изменить список допустимых типов налогообложения, необходимо выполнить перерегистрацию кассы.
Тип налогообложения:
1055
«1» — общая система налогообложения;
«2» — упрощенная система налогообложения (доход);
«4» — упрощенная система налогообложения (доход минус расход);
«8» — единый налог на вмененный доход;
«16» — единый сельскохозяйственный налог;
«32» — патентная система налогообложения.
Operator String Должность, фамилия, имя, отчество (фамилия и инициалы) оператора 1021
KKT_RegNumber String Регистрационный номера кассы 1037
FN_FactoryNumber String Номер фискального накопителя, установленного в кассу 1041
Items Array Список товарных позиций в чеке 1059
Object
Name String Название товарной позиции в чеке 1030
Price Integer Цена в копейках за единицу измерения товарной позиции 1079
Quantity Integer Количество единиц товарной позиции 1023
Total Integer Стоимость товарной позиции в копейках 1043
CalculationMethod Integer Признак способа расчета.
Может принимать следующие значения
1214
1 – предоплата 100%;
2 – предоплата;
3 – аванс;
4 – полный расчет;
5 – частичный расчет;
6 – передача в кредит;
7 – оплата в кредит.
SubjectType Integer Признак предмета расчета.
Возможные значения представлены в разделе 2.6.1.
1212
NDS_Rate Integer Ставка НДС принимает значения:
1 - НДС 20% 30);
2 - НДС 10%;
3 - НДС 20/120 31);
4 - НДС 10/110;
5 - НДС 0%;
6 - НДС не облагается.
NDS_Summ Integer Общая сумма НДС в копейках
UnitOfMeasure String Единица измерения предмета расчета 1197
OriginCountryCode String Цифровой код страны происхождения товара в соответствии с Общероссийским классификатором стран мира 1230
CustomDeclarationNumber String Номер таможенной декларации в соответствии с форматом, установленным решением Комиссии Таможенного союза от 20.05.2010 N 257 (в ред. 17.12.2019 N 223) «О форме декларации на товары и порядке ее заполнения» 1231
ProductCheckResultDetails Integer Результаты проверки товара с обязательной маркировкой
Параметр может принимать следующие значения:
2106
0 - [М] Проверка КП КМ не выполнена, статус товара ОИСМ не проверен
1 - [М-] Проверка КП КМ выполнена в ФН с отрицательным результатом, статус товара ОИСМ не проверен
3 - [М] Проверка КП КМ выполнена с положительным результатом, статус товара ОИСМ не проверен
16 - [М] Проверка КП КМ не выполнена, статус товара ОИСМ не проверен (ККТ функционирует в автономном режиме)
17 - [М-] Проверка КП КМ выполнена в ФН с отрицательным результатом, статус товара ОИСМ не проверен (ККТ функционирует в автономном режиме)
19 - [М] Проверка КП КМ выполнена в ФН с положительным результатом, статус товара ОИСМ не проверен (ККТ функционирует в автономном режиме)
5 - [М-] Проверка КП КМ выполнена с отрицательным результатом, статус товара у ОИСМ некорректен
7 - [М-] Проверка КП КМ выполнена с положительным результатом, статус товара у ОИСМ некорректен
15 - [М+] Проверка КП КМ выполнена с положительным результатом, статус товара у ОИСМ корректен
Nds18_TotalSumm Integer Сумма НДС по предмету расчета со ставкой 20% в копейках 32) 1102
Nds10_TotalSumm Integer Сумма НДС по предмету расчета со ставкой 10% в копейках 1103
Nds00_TotalSumm Integer Сумма НДС по предмету расчета со ставкой 0% в копейках 1104
NdsNA_TotalSumm Integer Сумма, к которой не применяется НДС в копейках 1105
Nds18_CalculatedTotalSumm Integer Сумма НДС чека с рассчитанной ставкой 20% 33) 1106
Nds10_CalculatedTotalSumm Integer Сумма НДС чека с рассчитанной ставкой 10% 1107
ProductNomenclature Array Код товарной номенклатуры 1162
NDS_PieceSumm Integer Размер НДС за единицу предмета расчета 1198
ProductAdditionalRequisite String Дополнительный реквизит предмета расчета 1191
RetailPlaceAddress String Адрес расчётов 1009
Buyer_Address String Адрес покупателя (используется службами доставки) 1008
Sender_Address String Адрес электронной почты отправителя чека 1117
PaymentAgent_Phone String Телефон оператора по приёму платежей 1074
MoneyOperator_Phone String Телефон оператора по переводу денежных средств 1075
BankAgent_Phone String Телефон платёжного агента 1073
BankAgent_Operation String Операция платёжного агента 1044
MoneyOperator_Name String Наименование оператора по переводу денежных средств 1026
MoneyOperator_Address String Адрес оператора по переводу денежных средств 1005
MoneyOperator_INN String ИНН оператора по переводу денежных средств 1016
Amount_Total Integer Общая сумма по чеку в копейках 1020
Amount_Cash Integer Сумма наличными по чеку в копейках 1031
Amount_ECash Integer Сумма, оплаченная картой, в копейках 1081
Document_Number Integer Фискальный номер документа 1040
FiscalSign String Фискальный признак документа 1077
DecimalFiscalSign String Фискальный признак документа
KKT_MachineNumber String Заводской номер автоматического устройства для расчетов 1036
InternetSign Integer Признак осуществления расчетов только в сети «Интернет», в которой отсутствует устройство для печати фискальных документов в составе ККТ 1108
Extra Array Дополнительный реквизит пользователя по чеку 1084
Object
Name String Наименование дополнительного реквизита по чеку 1085
Value String Значение дополнительного реквизита по чеку 1086
Format_Version Integer Номер версии формата фискальных документов 1209
Amount_Advance Integer Сумма предоплаты (зачет аванса) 1215
Amount_Loan Integer Сумма постоплаты (кредита) 1216
Amount_Granting Integer Сумма встречным предоставлением 1217
TaxAuthority_Site String Сайт налогового органа (Адрес сайта ФНС) 1060
Calculation_Place String Место расчетов 1187
Supplier_Phone String Телефон поставщика 1171
Operator_INN String ИНН кассира 1203
PaymentAgentMode String Применение платёжными агентами (субагентами) 1057
ReceiptAdditionalRequisite String Дополнительный реквизит чека (БСО) 1192
ProductCheckResult Integer Результаты проверки маркированных товаров 2107
ProductUnitOfMeasure Integer Единицы измерения количества предмета расчета.
Параметр может принимать значения описанные в раздел 2.6.2.
2108
ProductCode Object Код маркировки.
Параметр может иметь в составе один из параметров описанных в таблице 6 со значением кода маркировки

Таблица 5. Описание параметров чека коррекции

Параметр Вложенный параметр Вид значения Описание Тег
Tag Integer Численный признак вида документа:
31 – чек коррекции;
41 – бланк строгой отчетности коррекции
User String Полное имя или название владельца кассы 1048
UserInn String ИНН владельца кассы 1018
Number Integer Номер документа внутри смены 1042
DateTime String Дата и время34) формирования документа (чека) 1012
ShiftNumber Integer Номер смены (по данным кассы), в которую был сформирован документ 1038
OperationType String Тип операции: 1054
«Income» – приход;
«Expence» – расход;
«Refund income» – возврат прихода;
«Refund expence» – возврат расхода.
TaxationType Integer Внимание! Возможные (корректные) значения типа налогообложения ограничиваются значениями выбранными при регистрации кассы. Чтобы изменить список допустимых типов налогообложения, необходимо выполнить перерегистрацию кассы.
Тип налогообложения:
1055
«1» — общая система налогообложения;
«2» — упрощенная система налогообложения (доход);
«4» — упрощенная система налогообложения (доход минус расход);
«8» — единый налог на вмененный доход;
«16» — единый сельскохозяйственный налог;
«32» — патентная система налогообложения.
Operator String Должность, фамилия, имя, отчество (фамилия и инициалы) оператора 1021
KKT_RegNumber String Регистрационный номера кассы 1037
FN_FactoryNumber String Номер фискального накопителя, установленного в кассу 1041
Correction_Type Integer Тип коррекции принимает значения: 1173
0 - самостоятельно;
1 - по предписанию
Correction Object Основание для коррекции 1174
Date String Дата35) документа основания для коррекции 1178
DocNumber String Номер документа основания для коррекции 1179
Items Array Список товарных позиций в чеке 1059
Object
Name String Название товарной позиции в чеке 1030
Price Integer Цена в копейках за единицу измерения товарной позиции 1079
Quantity Integer Количество единиц товарной позиции 1023
Total Integer Стоимость товарной позиции в копейках 1043
CalculationMethod Integer Признак способа расчета.
Может принимать следующие значения
1214
1 – предоплата 100%;
2 – предоплата;
3 – аванс;
4 – полный расчет;
5 – частичный расчет;
6 – передача в кредит;
7 – оплата в кредит.
SubjectType Integer Признак предмета расчета.
Возможные значения представлены в разделе 2.6.1.
1212
NDS_Rate Integer Ставка НДС принимает значения:
1 - НДС 20% 36);
2 - НДС 10%;
3 - НДС 20/120 37);
4 - НДС 10/110;
5 - НДС 0%;
6 - НДС не облагается.
NDS_Summ Integer Общая сумма НДС в копейках
UnitOfMeasure String Единица измерения предмета расчета 1197
OriginCountryCode String Цифровой код страны происхождения товара в соответствии с Общероссийским классификатором стран мира 1230
CustomDeclarationNumber String Номер таможенной декларации в соответствии с форматом, установленным решением Комиссии Таможенного союза от 20.05.2010 N 257 (в ред. 17.12.2019 N 223) «О форме декларации на товары и порядке ее заполнения» 1231
ProductCheckResultDetails Integer Результаты проверки товара с обязательной маркировкой
Параметр может принимать следующие значения:
2106
0 - [М] Проверка КП КМ не выполнена, статус товара ОИСМ не проверен
1 - [М-] Проверка КП КМ выполнена в ФН с отрицательным результатом, статус товара ОИСМ не проверен
3 - [М] Проверка КП КМ выполнена с положительным результатом, статус товара ОИСМ не проверен
16 - [М] Проверка КП КМ не выполнена, статус товара ОИСМ не проверен (ККТ функционирует в автономном режиме)
17 - [М-] Проверка КП КМ выполнена в ФН с отрицательным результатом, статус товара ОИСМ не проверен (ККТ функционирует в автономном режиме)
19 - [М] Проверка КП КМ выполнена в ФН с положительным результатом, статус товара ОИСМ не проверен (ККТ функционирует в автономном режиме)
5 - [М-] Проверка КП КМ выполнена с отрицательным результатом, статус товара у ОИСМ некорректен
7 - [М-] Проверка КП КМ выполнена с положительным результатом, статус товара у ОИСМ некорректен
15 - [М+] Проверка КП КМ выполнена с положительным результатом, статус товара у ОИСМ корректен
Nds18_TotalSumm Integer Сумма НДС по предмету расчета со ставкой 20% в копейках 38) 1102
Nds10_TotalSumm Integer Сумма НДС по предмету расчета со ставкой 10% в копейках 1103
Nds00_TotalSumm Integer Сумма НДС по предмету расчета со ставкой 0% в копейках 1104
NdsNA_TotalSumm Integer Сумма, к которой не применяется НДС в копейках 1105
Nds18_CalculatedTotalSumm Integer Сумма НДС чека с рассчитанной ставкой 20% 39) 1106
Nds10_CalculatedTotalSumm Integer Сумма НДС чека с рассчитанной ставкой 10% 1107
ProductNomenclature Array Код товарной номенклатуры 1162
NDS_PieceSumm Integer Размер НДС за единицу предмета расчета 1198
ProductAdditionalRequisite String Дополнительный реквизит предмета расчета 1191
RetailPlaceAddress String Адрес расчётов 1009
Buyer_Address String Адрес покупателя (используется службами доставки) 1008
Sender_Address String Адрес электронной почты отправителя чека 1117
PaymentAgent_Phone String Телефон оператора по приёму платежей 1074
MoneyOperator_Phone String Телефон оператора по переводу денежных средств 1075
BankAgent_Phone String Телефон платёжного агента 1073
BankAgent_Operation String Операция платёжного агента 1044
MoneyOperator_Name String Наименование оператора по переводу денежных средств 1026
MoneyOperator_Address String Адрес оператора по переводу денежных средств 1005
MoneyOperator_INN String ИНН оператора по переводу денежных средств 1016
Amount_Total Integer Общая сумма по чеку в копейках 1020
Amount_Cash Integer Сумма наличными по чеку в копейках 1031
Amount_ECash Integer Сумма, оплаченная картой, в копейках 1081
Document_Number Integer Фискальный номер документа 1040
FiscalSign String Фискальный признак документа 1077
DecimalFiscalSign String Фискальный признак документа
KKT_MachineNumber String Заводской номер автоматического устройства для расчетов 1036
InternetSign Integer Признак осуществления расчетов только в сети «Интернет», в которой отсутствует устройство для печати фискальных документов в составе ККТ 1108
Extra Array Дополнительный реквизит пользователя по чеку 1084
Object
Name String Наименование дополнительного реквизита по чеку 1085
Value String Значение дополнительного реквизита по чеку 1086
Format_Version Integer Номер версии формата фискальных документов 1209
Amount_Advance Integer Сумма предоплаты (зачет аванса) 1215
Amount_Loan Integer Сумма постоплаты (кредита) 1216
Amount_Granting Integer Сумма встречным предоставлением 1217
TaxAuthority_Site String Сайт налогового органа (Адрес сайта ФНС) 1060
Calculation_Place String Место расчетов 1187
Supplier_Phone String Телефон поставщика 1171
Operator_INN String ИНН кассира 1203
PaymentAgentMode String Применение платёжными агентами (субагентами) 1057
ReceiptAdditionalRequisite String дополнительный реквизит чека (БСО) 1192
ProductCheckResult Integer Результаты проверки маркированных товаров 2107
ProductUnitOfMeasure Integer Единицы измерения количества предмета расчета.
Параметр может принимать значения описанные в раздел 2.6.2.
2108
ProductCode Object Код маркировки.
Параметр может иметь в составе один из параметров описанных в таблице 6 со значением кода маркировки

Таблица 6. Возможные значения параметра «ProductCode» (Тег 1163)

Параметр Вид значения Описание Тег
Code_EAN_8 String код товара в формате EAN-8 1301
Code_EAN_13 String код товара в формате EAN-13 1302
Code_ITF_14 String код товара в формате ITF-14 1303
Code_GS_1 String код товара в формате GS1, нанесенный на товар, не подлежащий маркировке средствами идентификации 1304
Code_GS_1M String код товара в формате GS1, нанесенный на товар, подлежащий маркировке средствами идентификации 1305
Code_KMK String код товара в формате короткого кода маркировки, нанесенный на товар, подлежащий маркировке средствами идентификации 1306
Code_MI String контрольно-идентификационный знак мехового изделия 1307
Code_F_1 String код товара в формате Ф.1 1320
Code_F_6 String код товара в формате Ф.6 1325

Ошибки в ответе на запрос, обрабатываемые ИС:

  • InnNotFound – для текущей учетной записи не найдена организация;
  • KktNotFound – для текущей учетной записи не найдена касса с заданным номером;
  • DocumentNotFound – документ (чек) не найден.

2.6.1. Возможные значения признака предмета расчета

  • 1 — о реализуемом товаре, за исключением подакцизного товара (наименование и иные сведения, описывающие товар) – «ТОВАР» или «Т»;
  • 2 — о реализуемом подакцизном товаре (наименование и иные сведения, описывающие товар) – «ПОДАКЦИЗНЫЙ ТОВАР» или «АТ»;
  • 3 — о выполняемой работе (наименование и иные сведения, описывающие работу) – «РАБОТА» или «Р»;
  • 4 — об оказываемой услуге (наименование и иные сведения, описывающие услугу) – «УСЛУГА» или «У» или может не печататься;
  • 5 — о приеме ставок при осуществлении деятельности по проведению азартных игр – «СТАВКА АЗАРТНОЙ ИГРЫ» или «СТАВКА ИГРЫ» или «СА»;
  • 6 — о выплате денежных средств в виде выигрыша при осуществлении деятельности по проведению азартных игр – «ВЫИГРЫШ АЗАРТНОЙ ИГРЫ» или «ВЫИГРЫШ АИ» или «ВА»;
  • 7 — о приеме денежных средств при реализации лотерейных билетов, электронных лотерейных билетов, приеме лотерейных ставок при осуществлении деятельности по проведению лотерей – «ЛОТЕРЕЙНЫЙ БИЛЕТ» или «СТАВКА ЛОТЕРЕИ» или «СЛ»;
  • 8 — о выплате денежных средств в виде выигрыша при осуществлении деятельности по проведению лотерей – «ВЫИГРЫШ ЛОТЕРЕИ» или «ВЫИГРЫШ ЛОТЕРЕИ» или «ВЛ»;
  • 9 — о предоставлении прав на использование результатов интеллектуальной деятельности или средств индивидуализации – «ПРЕДОСТАВЛЕНИЕ РИД» или «РИД» (в ред. Приказа ФНС России от 22.10.2018 N ММВ-7-20/605@) (см. текст в предыдущей редакции);
  • 10 — об авансе, задатке, предоплате, кредите, взносе в счет оплаты, пени, штрафе, вознаграждении, бонусе и ином аналогичном предмете расчета – «ПЛАТЕЖ» или «П», «ВЫПЛАТА» или «В»;
  • 11 — о вознаграждении пользователя, являющегося платежным агентом (субагентом), банковским платежным агентом (субагентом), комиссионером, поверенным или иным агентом – «АГЕНТСКОЕ ВОЗНАГРАЖДЕНИЕ» или «АВ»;
  • 12 — о предмете расчета, состоящем из предметов, каждому из которых может быть присвоено значение от «1» до «11» – «СОСТАВНОЙ ПРЕДМЕТ РАСЧЕТА» или «СПР»;
  • 13 — о предмете расчета, не относящемуся к предметам расчета, которым может быть присвоено значение от «1» до «12» и от «14» до «18» – «ИНОЙ ПРЕДМЕТ РАСЧЕТА» или «ИПР»;
  • 14 — о передаче имущественных прав – «ИМУЩЕСТВЕННОЕ ПРАВО»;
  • 15 — о внереализационным доходе – «ВНЕРЕАЛИЗАЦИОННЫЙ ДОХОД» или может не печататься;
  • 16 — о суммах расходов, уменьшающих сумму налога (авансовых платежей) в соответствии с пунктом 3.1 статьи 346.21 Налогового кодекса Российской Федерации – «СТРАХОВЫЕ ВЗНОСЫ»;
  • 17 — о суммах уплаченного торгового сбора – «ТОРГОВЫЙ СБОР»;
  • 18 — о курортном сборе – «КУРОРТНЫЙ СБОР»;
  • 19 — о залоге – «ЗАЛОГ».
  • 20 — о суммах произведенных расходов в соответствии со статьей 346.16 Налогового кодекса Российской Федерации, уменьшающих доход —
  • 21 — о страховых взносах на обязательное пенсионное страхование, уплачиваемых ИП, не производящими выплаты и иные вознаграждения физическим лицам — «ВЗНОСЫ НА ОБЯЗАТЕЛЬНОЕ ПЕНСИОННОЕ СТРАХОВАНИЕ ИП» или «ВЗНОСЫ НА ОПС ИП» или может не печататься
  • 22 — о страховых взносах на обязательное пенсионное страхование, уплачиваемых организациями и ИП, производящими выплаты и иные вознаграждения физическим лицам — «ВЗНОСЫ НА ОБЯЗАТЕЛЬНОЕ ПЕНСИОННОЕ СТРАХОВАНИЕ» или «ВЗНОСЫ НА ОПС» или может не печататься
  • 23 — о страховых взносах на обязательное медицинское страхование, уплачиваемых ИП, не производящими выплаты и иные вознаграждения физическим лицам — «ВЗНОСЫ НА ОБЯЗАТЕЛЬНОЕ МЕДИЦИНСКОЕ СТРАХОВАНИЕ ИП» или «ВЗНОСЫ НА ОМС ИП» или может не печататься
  • 24 — о страховых взносах на обязательное медицинское страхование, уплачиваемые организациями и ИП, производящими выплаты и иные вознаграждения физическим лицам — «ВЗНОСЫ НА ОБЯЗАТЕЛЬНОЕ МЕДИЦИНСКОЕ СТРАХОВАНИЕ» или «ВЗНОСЫ НА ОМС» или может не печататься
  • 25 — о страховых взносах на обязательное социальное страхование на случай временной нетрудоспособности и в связи с материнством, на обязательное социальное страхование от несчастных случаев на производстве и профессиональных заболеваний — «ВЗНОСЫ НА ОБЯЗАТЕЛЬНОЕ СОЦИАЛЬНОЕ СТРАХОВАНИЕ» или «ВЗНОСЫ НА ОСС» или может не печататься
  • 26 — о приеме и выплате денежных средств при осуществлении казино и залами игровых автоматов расчетов с использованием обменных знаков игорного заведения — «ПЛАТЕЖ КАЗИНО» или «ПК» или может не печататься
  • 27 — о выдаче денежных средств банковским платежным агентом — «ВЫДАЧА ДЕНЕЖНЫХ СРЕДСТВ» или «ВЫДАЧА ДС»

или может не печататься

  • 30 — о реализуемом подакцизном товаре, подлежащем маркировке средством идентификации, не имеющем кода маркировки — «АТНМ» или может не печататься
  • 31 — о реализуемом подакцизном товаре, подлежащем маркировке средством идентификации, имеющем код маркировки — «АТМ» или может не печататься
  • 32 — о реализуемом товаре, подлежащем маркировке средством идентификации, не имеющем кода маркировки, за исключением подакцизного товара — «ТНМ» или может не печататься
  • 33 — о реализуемом товаре, подлежащем маркировке средством идентификации, имеющем код маркировки, за исключением подакцизного товара — «ТМ» или может не печататься

2.6.2. Возможные значения параметра "ProductUnitOfMeasure"

Параметр «ProductUnitOfMeasure» может принимать следующие значения:

  • «PIECE» — Применяется для предметов расчета, которые могут быть реализованы поштучно или единицами
  • «GRAM» — Грамм
  • «KILOGRAM» — Килограмм
  • «TON» — Тонна
  • «CENTIMETER» — Сантиметр
  • «DECIMETER» — Дециметр
  • «METER» — Метр
  • «SQUARE_CENTIMETER» — Квадратный сантиметр
  • «SQUARE_DECIMETER» — Квадратный дециметр
  • «SQUARE_METER» — Квадратный метр
  • «MILLILITER» — Миллилитр
  • «LITER» — Литр
  • «CUBIC_METER» — Кубический метр
  • «KILOWATT_HOUR» — Киловатт час
  • «GIGACALORIE» — Гигакалория
  • «DAY» — Сутки (день)
  • «HOUR» — Час
  • «MINUTE» — Минута
  • «SECOND» — Секунда
  • «KILOBYTE» — Килобайт
  • «MEGABYTE» — Мегабайт
  • «GIGABYTE» — Гигабайт
  • «TERABYTE» — Терабайт
  • «OTHER» — Применяется при использовании иных единиц измерения

2.7. Просмотр электронного чека

Запрос на просмотр электронного чека выполняется методом GET

Запрос имеет следующий вид:

GET https://ofd.ru/api/v1/integration/rec/{inn}/{kktregnumber}/{fnnumber}/{docnumber}/{decsign}

В таблице 7 приведен список параметров необходимых для запроса просмотра электронного чека .

Таблица 7. Параметры запроса на просмотр электронного чека

Параметр Описание Тег
inn ИНН владельца кассы 1018
kktregnumber Регистрационный номер ККТ 1037
fnnumber Номер фискального накопителя 1041
docnumber Номер фискального документа 1040
decsign Фискальный признак документа 1077

Успешным ответом на запрос является загрузка страницы в браузере с электронном чеком.

2.8. Список чеков по кассе с подробной информацией

Запрос на получение списка чеков по кассам клиента с подробной информацией по чеку имеет следующий вид

GET https://ofd.ru/api/integration/v1/inn/{INN}/kkt/{RNM}/receipts-with-fpd-short?dateFrom={Data1}&dateTo={Data2}&AuthToken={Code}

Необходимые параметры для запроса:

  • INN - идентификационный номер налогоплательщика ИНН
  • RNM - регистрационный номер кассы
  • Date1 – начальная дата периода для формирования отчета, значения содержат дату и время в формате ISO. Разница значений Date1 и Date2 не должна превышать 30 дней, дата начала и дата конца периода формирования списка отчетов не должны быть одинаковые.
  • Date2 – конечная дата периода для формирования отчета, значения содержат дату и время в формате ISO. Разница значений Date1 и Date2 не должна превышать 30 дней, дата начала и дата конца периода формирования списка отчетов не должны быть одинаковые.
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Запрос на получение списка чеков по кассам, можно получить за период не более 90 дней, количество касс для получения списка чеков не ограничено.

Успешный ответ на запрос:

{
   "Status":"Success",
   "Data":[
      {
         "Id":"XXXXXXXXXXXXXXXXXXXXX",
         "CDateUtc":"2020-10-01T02:29:12",
         "Tag":3,
         "IsBso":false,
         "IsCorrection":false,
         "OperationType":"Income",
         "UserInn":"XXXXXXXXXXXXXXXXXXXXX",
         "KktRegNumber":"XXXXXXXXXXXXXXXXXXXXX",
         "FnNumber":"XXXXXXXXXXXXXXXXXXXXX",
         "DocNumber": XXXXXXXXXXXXXXXXXXXXX,
         "DocDateTime":"2020-10-01T09:28:00",
         "DocShiftNumber":476,
         "DecimalFiscalSign":"XXXXXXXXXXXXXXXXXXXXX",
         "ReceiptNumber":"5",
         "DocRawId":"XXXXXXXXXXXXXXXXXXXXX",
         "Items":[
            {
               "Name":"двойной эспрессо 80 мл",
               "Price":13000,
               "Quantity":1,
               "Total":13000,
               "CalculationMethod":0,
               "Barcode":"30303030303030303030303030303030",
               "Provider_Inn": "373830353030"
            }
         ],
         "Nds00_TotalSumm":0,
         "NdsNA_TotalSumm":13000,
         "TotalSumm":13000,
         "CashSumm":13000,
         "ECashSumm":0,
         "PrepaidSumm":0,
         "CreditSumm":0,
         "ProvisionSumm":0,
         "TaxTotalSumm":0,
         "Tax10Summ":0,
         "Tax18Summ":0,
         "Tax110Summ":0,
         "Tax118Summ":0,
         "Tax0Summ":0,
         "TaxNaSumm":13000,
         "Depth":1
      },
      {
         "Id":"XXXXXXXXXXXXXXXXXXXXX",
         "CDateUtc":"2020-10-01T04:55:58",
         "Tag":3,
         "IsBso":false,
         "IsCorrection":false,
         "OperationType":"Income",
         "UserInn":"XXXXXXXXXXXXXXXXXXXXX",
         "KktRegNumber":"XXXXXXXXXXXXXXXXXXXXX",
         "FnNumber":"XXXXXXXXXXXXXXXXXXXXX",
         "DocNumber": XXXXXXXXXXXXXXXXXXXXX,
         "DocDateTime":"2020-10-01T11:50:00",
         "DocShiftNumber":476,
         "DecimalFiscalSign":"XXXXXXXXXXXXXXXXXXXXX",
         "ReceiptNumber":"23",
         "DocRawId":"0bc0dec5-6b0c-36b5-9bb6-751e99320f82",
         "Items":[
            {
               "Name":"улитка kрем шоколад",
               "Price":10000,
               "Quantity":1,
               "SubjectType":1,
               "Total":10000,
               "CalculationMethod":0,
               "Barcode":"30303030303030303030303030303030"
            }
         ],
         "Nds00_TotalSumm":0,
         "NdsNA_TotalSumm":10000,
         "TotalSumm":10000,
         "CashSumm":10000,
         "ECashSumm":0,
         "PrepaidSumm":0,
         "CreditSumm":0,
         "ProvisionSumm":0,
         "TaxTotalSumm":0,
         "Tax10Summ":0,
         "Tax18Summ":0,
         "Tax110Summ":0,
         "Tax118Summ":0,
         "Tax0Summ":0,
         "TaxNaSumm":10000,
         "Depth":1,
         "Buyer_Inn": "4402163409"
      }
   ],
   "Elapsed":"00:00:00.3506406"
}

Описание параметров ответа представлены в таблице 8.

Таблица 8. Описание параметров ответа на запрос списка чеков по кассе с подробной информацией

Параметр Вложенный параметр Вложенный параметр Вид значения Описание Тег
Status String Статус выполнения запроса. Параметр может принимать следующие значения:
Success - Успешно;
Failed - Неуспешно.
Data Array Массив данных ответа на запрос
Object Структура с параметрами ответа на запрос
Id String40) Уникальный номер фискального документа в ИС, используется в запросе подробной информации по чеку, как RawId
CDateUtc String Дата и время41) приема документа в ИС
Tag Integer Численный признак вида документа:
3 – чек;
31 – чек коррекции;
4 – бланк строгой отчетности;
41 – бланк строгой отчетности коррекции.
IsBso Bollean Имеет значение true, если документ является БСО, иначе (если документ является чеком) – false
IsCorrection Bollean Имеет значение true, если чек или бланк строгой отчетности (БСО) является документом коррекции, иначе – false
OperationType String Тип операции:
«Income» – приход;
«Expense» – расход;
«Refund income» – возврат прихода;
«Refund expense» – возврат расхода.
UserInn String ИНН владельца кассы
KktRegNumber String Регистрационный номер кассы
FnNumber String Номер фискального накопителя, установленного в кассу
DocNumber Integer Фискальный номер документа
SubjectType Integer Признак предмета расчета.
Возможные значения представлены в разделе 2.6.1.
1212
DocDateTime String Дата и время42) формирования документа по данным кассы
DocShiftNumber Integer Номер смены (по данным кассы), в которую был сформирован документ
DecimalFiscalSign String Фискальный признак документа
ReceiptNumber Integer Номер документа в смене (по данным кассы)
DocRawId String43) Уникальный номер фискального документа в ИС, (используется в запросе подробной информации по чеку, как RawId, дублирует поле Id)
Items Array Список товарных позиций в чеке 1059
Name String Название товарной позиции в чеке 1030
Price Integer Цена в копейках за единицу измерения товарной позиции 1079
Quantity Integer Количество единиц товарной позиции 1023
Total Integer Стоимость товарной позиции в копейках 1043
CalculationMethod Integer Признак способа расчета.
Может принимать следующие значения
1214
1 – предоплата 100%;
2 – предоплата;
3 – аванс;
4 – полный расчет;
5 – частичный расчет;
6 – передача в кредит;
7 – оплата в кредит.
OriginCountryCode String Цифровой код страны происхождения товара в соответствии с Общероссийским классификатором стран мира 1230
CustomDeclarationNumber String Номер таможенной декларации в соответствии с форматом, установленным решением Комиссии Таможенного союза от 20.05.2010 N 257 (в ред. 17.12.2019 N 223) «О форме декларации на товары и порядке ее заполнения» 1231
Provider_Inn String ИНН поставщика 1226
ProductCheckResultDetails Integer Результаты проверки товара с обязательной маркировкой
Параметр может принимать следующие значения:
2106
0 - [М] Проверка КП КМ не выполнена, статус товара ОИСМ не проверен
1 - [М-] Проверка КП КМ выполнена в ФН с отрицательным результатом, статус товара ОИСМ не проверен
3 - [М] Проверка КП КМ выполнена с положительным результатом, статус товара ОИСМ не проверен
16 - [М] Проверка КП КМ не выполнена, статус товара ОИСМ не проверен (ККТ функционирует в автономном режиме)
17 - [М-] Проверка КП КМ выполнена в ФН с отрицательным результатом, статус товара ОИСМ не проверен (ККТ функционирует в автономном режиме)
19 - [М] Проверка КП КМ выполнена в ФН с положительным результатом, статус товара ОИСМ не проверен (ККТ функционирует в автономном режиме)
5 - [М-] Проверка КП КМ выполнена с отрицательным результатом, статус товара у ОИСМ некорректен
7 - [М-] Проверка КП КМ выполнена с положительным результатом, статус товара у ОИСМ некорректен
15 - [М+] Проверка КП КМ выполнена с положительным результатом, статус товара у ОИСМ корректен
ProductUnitOfMeasure Integer Единицы измерения количества предмета расчета.
Параметр может принимать значения описанные в раздел 2.6.2.
2108
ProductCode Object Код маркировки.
Параметр может иметь в составе один из параметров описанных в таблице 6 со значением кода маркировки
Nds00_TotalSumm Integer Сумма НДС по предмету расчета со ставкой 0% в копейках 1104
NdsNA_TotalSumm Integer Сумма, к которой не применяется НДС в копейках 1105
TotalSumm Integer Общая сумма по чеку в копейках
CashSumm Integer Сумма по чеку (БСО) наличными в копейках
ECashSumm Integer Сумма по чеку (БСО) электронными в копейках
PrepaidSumm Integer Сумма по чеку (БСО) предоплатами (авансами)
CreditSumm Integer Сумма по чеку (БСО) постоплатами (кредитами)
ProvisionSumm Integer Сумма по чеку (БСО) встречными предоставлениями
TaxTotalSumm Integer Общая сумма удерживаемых налогов, начисленная за смену в копейках
Tax10Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10 % в копейках 1103
Tax18Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20 % в копейках44) 1102
Tax110Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10/110 в копейках 1107
Tax118Summ Integer Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20/120 в копейках45) 1106
TaxNaSumm Integer Сумма по операциям, не облагаемая НДС в копейках 1105
Tax0Summ Integer Сумма по операциям, облагаемая НДС по ставке 0% в копейках 1104
ProductCheckResult Integer Результаты проверки маркированных товаров 2107
Depth Integer Количество товарных позиций в чеке
Buyer_Inn String ИНН покупателя (клиента) 1228
FnsStatus String Статус передачи чека (БСО) в ФНС
Success - Чек (БСО) принят ФНС
Failed - Чек (БСО) не принят ФНС
FnsError String Ответ ФНС об отказе принять чек
FnsTime String46) Дата и время получения уведомления от ФНС о получении чека (БСО)

3. Получение информации о папках и кассах

В API разработаны запросы на получение информации структуры папок с ККТ, а также запросы по кассам с сообщениями об ошибках.

3.1. Запрос на получение списка папок с ККТ

Запрос на получение списка папок с ККТ можно выполнить по следующим параметрам:

  • корневого каталога;
  • родительского каталога.

Запрос на получения списка папок с ККТ корневого каталога имеет вид:

GET https://ofd.ru/api/integration/v1/kktgroup/list?AuthToken={Code}

Запрос на получения списка папок с ККТ родительского каталога имеет вид:

GET https://ofd.ru/api/integration/v1/kktgroup/list?groupId={Id}&AuthToken={Code}

Необходимые параметры для запросов:

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Успешный ответ на запрос имеет следующий вид:

{
    "Status": "Success",
    "Data": [
        {
            "AgreementId": "1afff828-7ac1-41aa-8282-210c9ffb3df7",
            "Groups": [
                {
                    "Id": "26beff999-d454-44aa-8ada-cdc1rf8942fd",
                    "Name": "Все кассы",
                    "Path": "/Все кассы/",
                    "Level": 1
                }
            ]
        }
    ]
}

Описание параметров ответа на запрос получение списка ККТ представлен в таблице 9.

Таблица 9. Описание параметров ответа на запрос получение списка ККТ

Параметр Вид значения Описание
AgreementId String47) Идентификатор личного кабинета, для которого генерируется список каталогов 48)
Groups Array Массив записей с информацией о папках, в которых содержатся кассы
Id String49) Идентификатор папки в ИС «Чеки и ККТ»
Name String Имя папки
Path String Путь к папке
Level Integer Уровень вложенности папки (1 — для корневого каталога, 2 — для содержимого папки в корневом каталоге, 3 — для содержимого папки в папке корневого каталога и т. п.)

В ответ на запрос выдается список дочерних папок в следующих условиях:

  • если параметр «Id» отсутствует, в ответ на запрос возвращается список папок корневого каталога касс для текущей учетной записи;
  • если пользователь, по значению AuthToken является доверенным лицом (дополнительным пользователем), в ответ придет список папок доступных для просмотра в соответствии с предоставленными правами.

3.2. Запрос на получение списка касс

Запрос на получение списка касс выполняется методом GET.

Запрос на получение списка касс имеет следующий вид:

GET  https://ofd.ru/api/integration/v1/kkts?AuthToken={Code}

Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Успешный ответ на запрос имеет следующий вид:

{
    "Status": "Success",
    "Data": [
        {
            "Id": "01af8c89-b680-41a8-886d-60e90f784a4b",
            "KktRegId": "0001646625010123",
            "KktName": "касса наша",
            "SerialNumber": "00107203143008",
            "FnNumber": "9286000100023892",
            "INN": "7841465198",
            "GroupId": "c67d87b0-0166-4966-adcc-3be825cf05e6",
            "CreateDate": "2018-02-02T14:04:43",
            "CheckDate": "2018-02-02T14:09:46",
            "ActivationDate": "2018-02-02T14:09:46",
            "FirstDocumentDate": "2018-02-07T20:02:00",
            "ContractStartDate": "2018-02-02T00:00:00",
            "LastDocOnKktDateTime": "2018-02-22T18:06:00",
            "LastDocOnOfdDateTimeUtc": "2018-02-22T15:07:15",
            "FiscalAddress": "115280 Москва Москва Ленинская Слобода 26А ",
            "FiscalPlace": "Москва, Ленинская Слобода, дом 26",
            "Path": "/Мои кассы/",
            "KktModel": "АТОЛ 90Ф",
            "FnEndDate": "2019-05-18T14:31:24"
        },
        ...
        {
            "Id": "6a417709-e1fa-4133-b45a-1ea8b96820d8",
            "KktRegId": "0001846260032153",
            "KktName": "",
            "SerialNumber": "00107701210362",
            "FnNumber": "9286000100009011",
            "INN": "7841465198",
            "GroupId": "7a2e9b3c-3ef6-43d9-8169-538f97e78f31",
            "CreateDate": "2018-05-16T07:58:26",
            "CheckDate": "2018-07-06T13:00:34",
            "ActivationDate": "2018-07-06T10:15:23",
            "FirstDocumentDate": "2018-05-16T10:58:00",
            "ContractStartDate": "2018-07-06T00:00:00",
            "ContractEndDate": "2019-02-15T13:24:00",
            "LastDocOnKktDateTime": "2019-01-31T16:24:00",
            "LastDocOnOfdDateTimeUtc": "2019-01-31T13:25:49",
            "FiscalAddress": "115280 Москва Москва Ленинская Слобода 19 1 ",
            "Path": "/Мои кассы/123/",
            "KktModel": "АТОЛ 42ФС",
            "FnEndDate": "2019-09-29T10:15:49"
        },
        ...
        {
            "Id": "b090f949-c46a-4527-9e55-71b6a08dfd3a",
            "KktRegId": "0000000010032176",
            "SerialNumber": "9968982437",
            "FnNumber": "9960440301863751",
            "INN": "7841465198",
            "GroupId": "b4449693-d81f-487a-a9f2-f62cdafaa6ff",
            "CreateDate": "2022-02-25T11:10:09",
            "CheckDate": "2022-02-25T11:10:10",
            "ActivationDate": "2022-02-25T11:10:10",
            "FirstDocumentDate": "2022-02-25T14:10:00",
            "ContractStartDate": "2022-02-25T00:00:00",
            "LastDocOnKktDateTime": "2022-05-28T03:09:00",
            "LastDocOnOfdDateTimeUtc": "2022-05-28T00:09:15",
            "FiscalAddress": "Москва, Ленинская Слобода, 19",
            "FiscalPlace": "ofd.ru",
            "Path": "/Мои кассы/Новые кассы/",
            "KktModel": "Не определена",
            "FnEndDate": "2023-05-21T11:10:12"
        }
    ],
    "Elapsed": "00:00:00.1424993"
}

Описание параметров ответа представлено в таблице 9.

Таблица 10. Описание параметров ответа на запрос списка касс

Параметр Вложенный параметр Вид значения Описание
Status String Статус выполнения запроса. Параметр может принимать следующие значения:
Success - Успешно;
Failed - Неуспешно.
Data Array Массив данных ответа на запрос
Object Структура с параметрами ответа на запрос
Id String Идентификатор кассы
KktRegId String Регистрационный номер ККТ (кассы)
SerialNumber String Заводской (серийный) номер ККТ (кассы)
FnNumber String Номер фискального накопителя
INN String Идентификационный налоговый номер
GroupId String Идентификатор группы папок
CreateDate String Дата50) регистрации кассы в личном кабинете клиента
CheckDate String Дата51) подписания КЭП (квалификационной электронной подписью)
ActivationDate String Дата52) успешной проверки регистрационного номера в ФНС
FirstDocumentDate String Дата и время53) генерации кассой первого документа
ContractStartDate String Дата54) начала действия контракта на получение услуг оператора “OFD.ru”
LastDocOnKktDateTime String Дата и время55) последнего документа, сгенерированного кассой (по локальному времени кассы)
LastDocOnOfdDateTimeUtc String Дата и время получения последнего документа кассы в ОФД (по времени оператора “OFD.ru” в UTC)
FiscalAddress String Адрес установки кассы
FiscalPlace String Место расчетов
Path String Иерархия расположения кассы в личном кабинете клиента
KktModel String Модель кассы (ККТ)
FnEndDate String Дата и время56) окончания работы фискального накопителя
Elapsed String Время выполнения запроса

4. Управление учетными записями пользователей ЛКК

В разделе представлены описание методов для управления учетными записями пользователей ЛКК

4.1 Запрос на получение списка учетных записей пользователей ЛКК 

Запрос на получение списка учетных записей пользователей ЛКК выполняется методом GET.

Запрос представлен в следующем виде:

GET https://ofd.ru/api/integration/v1/users?Inn={INN}&Kpp={KPP}&AuthToken={Code}

Параметры необходимые для запроса:

  • INN – идентификационный номер налогоплательщика (ИНН) юридического лица;
  • KPP - идентификационный код причины постановки на учет (КПП) юридического лица (в запросе не обязателен ИП);
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Пример запроса на получение списка:

GET https://ofd.ru/api/integration/v1/users?Inn=7841465198&Kpp=772501001&AuthToken=cd0e2064a23b423c8c9790f75e6e3254

Пример успешного ответа на запрос:

{
    "Data": [
        {
            "FullName": "111",
            "Email": "son.kentavious@thtt.us",
            "Phone": "1111111111"
        },
        {
            "FullName": "Греф Герман Оскарович",
            "Email": "dfsdfsds@mail.ru"
        },
        ...
        {
            "FullName": "Jhon Dow",
            "Email": "yascher@ofd.ru",
            "Phone": "1112223457"
        }
    ],
    "Success": true
}

Параметры ответа на запрос представлены в таблице 11.

Таблица 11. Описание параметров ответа на запрос

Параметр Вложенный параметр Формат значения Описание
Data Array Список учетных записей ЛКК
Object
FullName String Имя пользователя учетной записи
Email String Электронная почта пользователя учётной записи
Phone String Телефон пользователя учётной записи
Success Boolean Статус выполнения запроса

4.2 Удаление учетной записи пользователя ЛКК 

Запрос на удаление учетной записи пользователя ЛКК выполняется методом DELETE.

Запрос:

DELETE https://ofd.ru/api/integration/v1/user/delete?Inn={INN}&Kpp={KPP}&Email={email}&AuthToken={Code}

Параметры необходимые для запроса:

  • INN – идентификационный номер налогоплательщика (ИНН) юридического лица;
  • KPP - идентификационный код причины постановки на учет (КПП) юридического лица (в запросе не обязателен ИП);
  • email - электронный адрес учетной записи пользователя ЛКК;
  • Code – действующий код авторизации, полученный в результате запроса авторизации.

Частота отправки запроса не должна превышать более 1 запроса в секунду.

Пример запроса на удаление учетной записи пользователя ЛКК:

DELETE https://ofd.ru/api/integration/v1/user/delete?Inn=7841465198&Kpp=772501001&Email=efwfw@we.fr&AuthToken=cd0e2064a23b423c8c9790f75e6e3254

Пример успешного ответа на запрос:

{
    "Data": true,
    "Success": true
}

Описание параметров ответа на запрос:

  • Data - Статус выполнения запроса, формат значение параметра ответа «Boolean»
  • Success - Статус успеха запроса, формат значение ответа «Boolean»

5. Порядок тестирования

В разделе представлено описание тестового контура ИС «Чеки и ККТ». В тестировании используется демонстрационный личный кабинет клиента (ЛКК), кассовый аппарат с установленным тестовым фискальным накопителем ФН МГМ.

5.1. Тестовый кабинет OFD.ru

Для настройки своих сервисов и проверки работы с контурами OFD.ru вам необходимо создать демо кабинет.

5.2. Настройки тестового стенда OFD.ru

Подключение к демо стенду OFD.ru осуществляется касс с тестовым фискальным накопителем, который не зарегистрирован в ФНС.

Чтобы подключить тестовую кассу к демо стенду OFD.ru, в настройках драйвера кассы необходимо ввести следующие параметры:

  • ИНН ОФД - 7841465198;
  • Наименование ОФД - ООО ПС СТ;
  • Адрес ОФД для версии ФФД 1.1 - testgate.ofd.ru;
  • Адрес ОФД для версии ФФД 1.2 - testcrpt.ofd.ru;
  • Порт ОФД для версии ФФД 1.1 - 4001;
  • Порт ОФД для версии ФФД 1.2 - 7001;
  • DNS ОФД - 8.8.8.8;
  • Канал обмена - Ethernet (Интернет).

Тестовые URL-адреса для работы с API ИС «Чеки и ККТ»:

https://lk-demo.ofd.ru/api/
https://demo.ofd.ru/api/integration

История изменений

Версия 1.3
Выпущена 11 октября 2017 г.
Первая отслеживаемая версия документа.

Версия 1.31
Выпущена 26 января 2018 г.

  1. Добавлены дополнительные поля в структуры данных смены и чека.
  2. Устранены мелкие недочеты по всему объему документа.

Версия 1.32
Выпущена 7 февраля 2018 г.

  1. Добавлена дополнительная форма запроса подробной информации по чеку.
  2. Устранены мелкие недочеты по всему объему документа.

Версия 1.33
Выпущена 15 марта 2018 г.
Добавлена дополнительная форма запроса данных смены и чека.

Версия 1.34
Выпущена 24 мая 2018 г.
Добавлены дополнительные поля в запросе данных чека.

Версия 1.4
Выпущена 16 июля 2018 г.

  1. Изменено название документа на «Программный интерфейс приложений (API) интеграции ИС пользователей с АИС “OFD.ru”»
  2. Изменен стиль оформления документа, обновлен логотип кампании.
  3. Добавлены функции работы с пользовательскими отчетами.
  4. Введена новая структура разделов, функции поделены на группы.
  5. Устранены фактические ошибки в существующих описаниях вызовов API.

Версия 1.5
Выпущена 24.08.2018

  1. Изменено название документа на «Программный интерфейс приложений (API) для работы с ИС «Чеки и ККТ»
  2. Подраздел «Работа с пользовательскими отчетами» выделен в документ «Программный интерфейс приложений (API) для работы с ИС «Отчеты»

Версия 1.6
Выпущена 12.09.2018 В раздел 1 («Авторизация через AuthToken») добавлена информация о разграничении прав доступа к ККТ в зависимости от заданных прав для учетной записи.

Версия 1.7
Выпущена 17.10.2018
Добавлен раздел «Запросы к ИС на получение информации о папках и кассах с ошибками» (раздел 3); в разделе находится описание двух функций.

Версия 1.8
Выпущена 14.11.2018
Исправлены ошибки в описании структуры ответа на запрос списка касс: уточнен состав полей и их назначение (поле CheckDate вместо SignDate и добавление поля FirstDocumentDate).

Версия 1.9
Выпущена 10.04.2019

  1. Визуально поправлен текст, исправлены ошибки в тексте и запросах;
  2. В раздел 1 («Авторизация через AuthToken») добавлена информация о разграничении прав доступа к ККТ в зависимости от заданных прав для учетной записи;
  3. Во всех примерах API-запросов был добавлен домен и, где необходимо, параметр AuthToken;
  4. Исправлен пример запроса имеющий обобщенный вид в разделе 2 на актуальный;
  5. В примере запроса списка зарегистрированных KKT добавлены параметры: NSerialNumber, KKTSerialNumber, KKTRegNumber;
  6. В примере ответа на запрос списка зарегистрированных KKT добавлены параметры: Id, CheckDate, FirstDocumentDate, Path, KktModel, FnEndDate;
  7. В примере ответа на запрос списка отчетов по смене для заданной кассы за заданный период добавлены параметры Id, Open_CDateUtc, Open_DocRawId, Close_DocRawId, IncomeCashSumm, RefundIncomeCashSumm;
  8. В примере ответа на запрос списка чеков за период по заданной кассе добавлены параметры: IsCorrection, DocRawId, PrepaidSumm;
  9. В примере ответа на запрос подробной информации по чеку добавлены параметры: Total, CalculationMethod, SubjectType, NDS_Rate, NDS_Summ, DecimalFiscalSign, KKT_MachineNumber, InternetSign, Format_Version, Amount_Advance, Amount_Loan, Amount_Granting;
  10. В таблицы с описанием полей были добавлены виды документов и типы операций;
  11. Добавлены типы налогообложений.

Версия 1.91
Выпущена 14 мая 2019 г.
В ответ на запрос информации о ККТ был добавлен параметр с названием кассы.

Версия 1.92
Выпущена 09 июля 2020 г.
Обновлен список параметров для метода «Запрос списка отчетов по смене для заданной кассы за заданный период».

Версия 1.93
Выпущена 03 августа 2020 г.

  1. В запрос на получение информации о KKT добавлен параметр SignDate;
  2. В запрос на получение списка отчетов по смене для заданной кассы за период добавлены параметры: ShiftDocsCount, IncomeECashSumm;
  3. В ответ на запрос на получение подробной информации по чеку добавлены параметры: BankAgent_Comission, MoneyOperator_Name, MoneyOperator_Address, MoneyOperator_INN, Nds10_TotalSumm, Nds00_TotalSumm, NdsNA_TotalSumm, PaymentSubAgent_Phone, PaymentOperator_Phone, PaymentAgent_Comission, BankSubAgent_Phone, BankSubAgent_Operation, DiscountMarkup, DiscountName, MarkupName, DiscountRate, MarkupRate, DiscountSumm, MarkupSumm, Correction_Type, Correction, TaxAuthority_Site, Calculation_Place, UnitOfMeasure, ProductNomenclature, NDS_PieceSumm, AdditionalRequisite;
  4. В ответе на запрос на получение подробной информации по чеку параметры ExtraProperty, ExtraProperty_Name, ExtraProperty_Value были заменены на Extra, Name, Value.

Версия 1.94
Выпущена 04 сентября 2020 г.
Изменена ставка НДС с 18% на 20% в таблицах 2 и 3.

Версия 1.95
Выпущена 23 сентября 2020 г.
Устранены мелкие недочеты по всему объему документа.

Версия 1.96
Выпущена 18 ноября 2020 г.
Добавлен раздел 2.8 Список чеков по кассе с подробной информацией по чеку

Версия 1.97
Выпущена 24 ноября 2020 г.
В разделе 2.8 добавлен фильтр по ККТ и скорректирован фильтр по дате времени.

Версия 1.98
Выпущена 10 февраля 2021 г.
В пункте 2.8 исправлен формат запроса

Версия 1.99
Выпущена 24 марта 2021 г.
В пункте 2.8 исправлен формат запроса

Версия 2.00
Выпущена 08 октября 2021 г.

  • В разделе 2.6 сделаны две таблицы
  • В разделе 2.8 таблица дополнена описанием тегов 1163, 2106, 1230, 1231, 2108

Версия 2.01
Выпущена 27 января 2022 г.
Устранены мелкие недочеты по всему документу

Версия 2.02
Выпущена 22 апреля 2022 г.

  • Устранены мелкие недочеты по всему документу
  • Добавлен новый раздел 4. Порядок тестирования
  • Изменено названия тегов 1191 и 1192

Версия 2.03
Выпущена 12 июля 2022 г.
Добавлен новый метод получение списка касс

Версия 2.04
Выпущена 1 августа 2022 г.
Добавлен новый раздел 4. Управление учетными записями пользователей ЛКК

1)
Значение параметра «AuthToken» представлено в строковом виде, представляет собой 32-значную последовательность шестнадцатеричных цифр, используется в запросах к ИС «Чеки и ККТ»
2)
Значение параметра «ExpirationDateUtc» представлено в строковом виде в формате даты и времени (UTC+3, МОСКОВСКОЕ ВРЕМЯ).
Время представлено в формате «ГГГГ-ММ-ДДTчч:мм:сс». Формат даты и времени соответствует международному стандарту ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601).
Формат представления времени выводится без смещения часовых поясов (Time Zone Offset) и интервалов. Формат даты и времени имеет следующую структуру:
ГГГГ - год;
ММ - месяц;
ДД - день;
T - используется как разделитель даты и времени;
чч - часы;
мм - минуты;
сс - секунды.
3)
значениями параметров могут являться массив и структура со вложенными параметрами
4) , 5) , 6) , 7) , 8) , 9) , 10) , 11) , 12) , 13) , 19) , 24) , 25) , 29) , 34) , 35) , 41) , 42) , 46) , 50) , 51) , 52) , 53) , 54) , 55) , 56)
Дата и время в формате стандарта ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601). Здесь используется только формат представления времени без задания смещения часовых поясов (Time Zone Offset) и интервалов.
14) , 18) , 20) , 23) , 26) , 40) , 43) , 47) , 49)
в формате UUID
15) , 16) , 17)
Дата и время в формате стандарта ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601).
Здесь используется только формат представления времени без задания смещения часовых поясов (Time Zone Offset) и интервалов.
21) , 27) , 44)
до 01.01.2019 сумма налога начислялась по ставке 18%
22) , 28) , 45)
до 01.01.2019 сумма налога начислялась по ставке 18/118
30) , 36)
до 01.01.2019 18%
31) , 37)
до 01.01.2019 18/118
32) , 38)
до 01.01.2019 сумма НДС предмета расчета рассчитывалась со ставкой 18%
33) , 39)
до 01.01.2019 сумма НДС чека рассчитывалась со ставкой 18%
48)
Если определено несколько личных кабинетов для одной учетной записи (один и тот же человек зарегистрировал в OFD.ru несколько юридических лиц, или один и тот же работник головной компании имеет доступ к учетным записям нескольких филиалов), то массив структур содержит несколько записей с различными «AgreementId», если же учетной записи соответствует один ЛКК, то есть, одно юридическое лицо, массив будет состоять из одного элемента.