API ОФД

В документации приведено описание программного интерфейса приложений (API) информационной системы (ИС) «ОФД» (далее - API «ОФД»). API ИС «ОФД» позволяет сторонним (клиентским) приложениям возможность взаимодействовать с данными фискальных документов и отчетности о контрольно-кассовой технике (ККТ). Взаимодействие происходит через отправку HTTP-запросов к серверу и получение ответов в формате JSON, что обеспечивает удобный и структурированный обмен информацией.

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

Для получения токена авторизации, который будет использоваться для выполнения запросов, пользователю необходимо обратиться в раздел «Настройки» в Личном кабинете клиента.

Далее пользователь переходит на вкладку «Управление передачей данных» и попадает в блок создания заявки на получение доступа к использованию API 2.0.

• Ключ доступа к API 2.0 (API KEY) предоставляется на личный кабинет организации (уникальную пару ИНН и КПП);
• Имеется возможность настройки доступа на конкретный список касс в интерфейсе личного кабинета;
• Имеется возможность блокировки ключа доступа в интерфейсе личного кабинета в случае компрометации;
• Срок действия ключа доступа - от 1 года;
• Право на выделение ключа доступа есть у пользователей с полными правами ко всем кассам в ЛКК.

После успешного заполнения заявки и обработки запроса, сгенерированный ключ появляется на соответствующей вкладке «Ключи доступа к API 2.0».

Созданный ключ доступа будет иметь указания данных о датах создания и последней активности, статусе ключа и значения, которое будет использоваться в запросах API 2.0.

Используемое обозначение параметра ключа доступа в запросах - AuthToken={Code}

В 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» — параметры со значениями в разных видах представления.

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

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

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

Если в ответе на запрос код по протоколу HTTP не равен 200, то запрос к API ИС «ОФД» выполнен с ошибкой. Возможные причины:

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

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

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

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

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

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

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

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

GET https://ofd.ru/api/integration/v2/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

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

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

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

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

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

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

• INN – идентификационный номер налогоплательщика (ИНН юридического лица);
• KKT – регистрационный номер кассы (строка символов);
• Date1 – начальная дата периода для формирования отчета. Значения содержат дату и время в формате ISO;
• 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. Описание параметров ответа на запрос списка отчетов по смене для заданной кассы за период

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

• INN – идентификационный номер налогоплательщика (ИНН юридического лица);
• KKT – регистрационный номер кассы (строка символов);
• Date1 – начальная дата периода для формирования отчета. Значения содержат дату и время в формате ISO;
• 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. Описание параметров ответа на запрос списка чеков за период по заданной кассе

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

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

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

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

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

Здесь:

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

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

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

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

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

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

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

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

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

GET https://ofd.ru/api/integration/v2/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. Описание параметров бланка строгой отчетности

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

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

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

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

• 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 — о реализуемом товаре, подлежащем маркировке средством идентификации, имеющем код маркировки, за исключением подакцизного товара — «ТМ» или может не печататься.

Параметр «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» — Применяется при использовании иных единиц измерения

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

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

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

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

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

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

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

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

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

• INN - идентификационный номер налогоплательщика (ИНН);
• RNM - регистрационный номер кассы;
• Date1 – начальная дата периода для формирования отчета. Значения содержат дату и время в формате ISO;
• 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",
         "KKT_MachineNumber": "XXXXXXXXXXXXXXXXXXXXXXXXXXXX",
         "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,
         "Extra": [
            {
                "Name": "Name",
                "Value": "Value"
            },
            {
                "Name": "Name",
                "Value": "Value"
            }
         ],
         "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. Описание параметров ответа на запрос списка чеков по кассе с подробной информацией

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

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

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

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

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

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

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

{
    "Status": "Success",
    "Data": [
   {
   "Id": "ee19889a-11b4-428d-83be-3dc9065dc28c",
            "CDateUtc": "2022-10-01T11:16:08",
            "Tag": 3,
            "IsBso": false,
            "IsCorrection": false,
            "OperationType": "Income",
            "UserInn": "2632811590",
            "KktRegNumber": "0005956962031875",
            "FnNumber": "9960440301019864",
            "DocNumber": 8773,
            "DocDateTime": "2022-10-01T11:16:00",
            "Operator": "Мордасов Евгений Александрович",
            "DocShiftNumber": 325,
            "DecimalFiscalSign": "1018061843",
            "ReceiptNumber": "1",
            "DocRawId": "ee19889a-11b4-428d-83be-3dc9065dc28c",
            "Items": [
                {
                    "Name": "тм001/019r пропитка б/цветн, thoma|всесезонная|1",
                    "Price": 59900,
                    "Quantity": 1,
                    "Total": 59900,
                    "CalculationMethod": 4,
                    "SubjectType": 1,
                    "ProductCode": {},
                    "NDS_Rate": 1
                },
                {
                    "Name": "234-048a-3102 ботинки женские нат.кожа/м|зима|39",
                    "Price": 799000,
                    "Quantity": 1,
                    "Total": 799000,
                    "CalculationMethod": 4,
                    "SubjectType": 33,
                    "ProductCode": {
                        "Code_GS_1M": "0104660184311215215osnRMP5'IfoF"
                    },
                    "NDS_Rate": 1,
                    "ProductCheckResultDetails": 15,
                    "ProductUnitOfMeasure": "0"
                },
                {
                    "Name": "нжг-0023тм_o2_р.23-25_бел носк|всесезонная|23/25",
                    "Price": 16700,
                    "Quantity": 1,
                    "Total": 16700,
                    "CalculationMethod": 4,
                    "SubjectType": 1,
                    "ProductCode": {},
                    "NDS_Rate": 1
                },
                {
                    "Name": "нжг-0023тм_o2_р.23-25_бел носк|всесезонная|23/25",
                    "Price": 16700,
                    "Quantity": 1,
                    "Total": 16700,
                    "CalculationMethod": 4,
                    "SubjectType": 1,
                    "ProductCode": {},
                    "NDS_Rate": 1
                },
                {
                    "Name": "нжг-0023тм_o2_р.23-25_черн нос|всесезонная|23/25",
                    "Price": 16600,
                    "Quantity": 1,
                    "Total": 16600,
                    "CalculationMethod": 4,
                    "SubjectType": 1,
                    "ProductCode": {},
                    "NDS_Rate": 1
                },
                {
                    "Name": "sc_40_d_tm носки жен. полиамид-эла|всесезонная|1",
                    "Price": 15000,
                    "Quantity": 1,
                    "Total": 15000,
                    "CalculationMethod": 4,
                    "SubjectType": 1,
                    "ProductCode": {},
                    "NDS_Rate": 1
                }
            ],
            "Nds00_TotalSumm": 0,
            "NdsNA_TotalSumm": 0,
            "TotalSumm": 923900,
            "CashSumm": 0,
            "ECashSumm": 923900,
            "PrepaidSumm": 0,
            "CreditSumm": 0,
            "ProvisionSumm": 0,
            "TaxTotalSumm": 153983,
            "Tax10Summ": 0,
            "Tax18Summ": 153983,
            "Tax110Summ": 0,
            "Tax118Summ": 0,
            "Tax0Summ": 0,
            "TaxNaSumm": 0,
            "Depth": 6,
            "FnsStatus": "Success",
            "ProductCheckResult": "00"
        }
    ],
    "Elapsed": "00:00:00.0982635"
}

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

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

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

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

GET https://ofd.ru/api/integration/v2/receipts/json-doc?KktAgreementId=[id кассы]&DocNumber=[номер ФД]&CustomFnNumber=[номер ФН]&AuthToken={Code}

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

• Id кассы — идентификационный номер кассы (Пример b7edf803-7eoa-46f9-9d73-cb1d9cac2575);
• Номер ФД – номер фискального документа, по которому нужно получить чек;
• Номер ФН – номер фискального накопителя.
• Code – действующий код авторизации, полученный при авторизации.

Примером успешного ответа на запрос (с кодом HTTP равным 200) является генерация структуры данных в JSON:

{
    "Data": {
        "RawId": "3829eb50-34ac-3fd6-c2a9-e2d99cf99c1b",
        "Container": {
            "Version": 3,
            "DocumentFormat": "1.2",
            "Document": {
                "Tag": 3,
                "User": "ООО \"Петер-Сервис Спецтехнологии\"",
                "UserInn": "7849999198",
                "Number": 29,
                "DateTime": "2024-11-01T18:30:00",
                "ShiftNumber": 453,
                "OperationType": 1,
                "TaxationType": 1,
                "Operator": "СИС. АДМИНИСТРАТОР",
                "KKT_RegNumber": "0007605959049999    ",
                "FN_FactoryNumber": "7281440501049999",
                "Items": [
                    {
                        "Name": "Предоплата за услуги оператора фискальных данных",
                        "Price": 30000,
                        "Quantity": 1.0,
                        "Total": 30000,
                        "CalculationMethod": 3,
                        "SubjectType": 10,
                        "NDS_PieceSumm": 5000,
                        "NDS_Rate": 3,
                        "NDS_Summ": 5000,
                        "ProductUnitOfMeasure": 0
                    }
                ],
                "RetailPlaceAddress": "г. Москва, Остаповский проезд, д.22, стр.16",
                "Buyer_Address": "client@ofd.ru",
                "Sender_Address": "noreply@ofd.ru",
                "Nds18_CalculatedTotalSumm": 5000,
                "Amount_Total": 30000,
                "Amount_Cash": 0,
                "Amount_ECash": 30000,
                "Document_Number": 59721,
                "FiscalSign": "MQQcqqbQ",
                "DecimalFiscalSign": "480945872",
                "InternetSign": 1,
                "Format_Version": 4,
                "Amount_Advance": 0,
                "Amount_Loan": 0,
                "Amount_Granting": 0,
                "TaxAuthority_Site": "nalog.gov.ru",
                "Calculation_Place": "https://ofd.ru/",
                "BuyerInn": "772599990876"
            },
            "Tag": 3,
            "UserInn": "7841469999",
            "KktRegNumber": "0007605959049999",
            "FnNumber": "7281440501049999",
            "DocNumber": 59799,
            "DocDateTime": "2024-11-01T18:30:00",
            "DocFiscalSign": "MQQcbbbQ",
            "DecimalFiscalSign": "480949999",
            "CDateUtc": "2024-11-01T15:30:18"
        },
        "TlvDictionary": {
            "1209": 4,
            "1041": "7281440501049999",
            "1037": "0007605959049999    ",
            "1018": "7841469999  ",
            "1040": 59799,
            "1012": "2024-11-01T18:30:00",
            "1077": "MQQcbbbQ",
            "1038": 453,
            "1042": 29,
            "1054": 1,
            "1020": 30000,
            "1108": 1,
            "1048": "ООО \"Петер-Сервис Спецтехнологии\"",
            "1256": {
                "1228": "772583359999",
                "1227": "ИП Тестовый Тест Тестович"
            },
            "1055": 1,
            "1021": "СИС. АДМИНИСТРАТОР",
            "1009": "г. Москва, Остаповский проезд, д.22, стр.16",
            "1187": "https://ofd.ru/",
            "1008": "client@ofd.ru",
            "1059": [
                {
                    "2108": 0,
                    "1214": 3,
                    "1212": 10,
                    "1030": "Предоплата за услуги оператора фискальных данных",
                    "1079": 30000,
                    "1199": 3,
                    "1023": 1.0,
                    "1198": 5000,
                    "1043": 30000,
                    "1200": 5000
                }
            ],
            "1031": 0,
            "1081": 30000,
            "1215": 0,
            "1216": 0,
            "1217": 0,
            "1106": 5000,
            "1117": "noreply@ofd.ru",
            "1060": "nalog.gov.ru"
        }
    },
    "Success": true
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

GET  https://ofd.ru/api/integration/v2/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",
            "ContractEndDate": "2019-02-15T13:24: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",
            "ContractEndDate": "2019-02-15T13:24: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"
}

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

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

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

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

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

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

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

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

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

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

GET https://ofd.ru/api/integration/v2/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
}

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

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

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

Запрос:

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

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

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

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

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

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

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

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

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

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

В разделе представлены описания методов для отображения касс и чеков с ошибками за период.

Запрос на отображение касс с ошибками за период выполняется методом GET.

Важно! Период определяется по дате возникновения ошибки.

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

GET https://ofd.ru/api/integration/v2/kkts/errors?DateFrom={DateFrom}&DateTo={DateTo}&AuthToken={Code}

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

• AuthToken – Значение токена авторизации;
• DateFrom - Начальная дата периода для формирования отчета. Значения содержат дату и время в формате ISO;
• DateTo – Конечная дата периода для формирования отчета. Значения содержат дату и время в формате ISO. Разница значений DateFrom и DateTo должна быть не более суток.

Пример запроса:

GET https://ofd.ru/api/integration/v2/kkts/errors?DateFrom=2023-03-20T00:00:00&DateTo=2023-03-20T00:00:00&AuthToken=cd0e2064a23b423c8c9790f75e6e3254

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

{
   "Status":"Success",
    "Data":[
   {
        "RegNumber":"0004727371036889",
        "ZnNumber":"9936516799",
        "Address":"603127 гор. Нижний Новгород ул. Федосеенко д. 51 каб. 1",
        "Service": "Ofd",
        "Services": [
          "Ofd",
          "NoFerma"
        ],
        "RegDate":"2020-09-07T14:58:00",
        "LastReceiptDate":"2023-09-06T22:29:00",
        "LastShiftOpenDate":"2023-09-06T20:20:00",
        "LastShiftCloseDate":"2023-09-06T04:00:00",
        "IsEncrypted":true,
        "RegState":"Reg",
        "Errors":[{
          "Code":"420",
          "Count":143}],
        "LastError":{
          "Code":"420",
          "Description":"Нарушен формат обязательного реквизита (тега)"}}],
      "Elapsed":"00:00:00.1768264"
}

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

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

Запрос на отображение чеков с ошибками по РНМ за период выполняется методом GET.

Важно! Период определяется по дате пробития чека.

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

GET https://ofd.ru/api/integration/v2/kkt/{rnm}/receipts/errors?DateFrom={DateFrom}&DateTo={DateTo}&AuthToken={Code}

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

• AuthToken - Действующий токен авторизации;
• RNM – Регистрационный номер кассы (РНМ) клиента;
• DateFrom - Начальная дата периода для формирования отчета. Значения содержат дату и время в формате ISO;
• DateTo – Конечная дата периода для формирования отчета. Значения содержат дату и время в формате ISO. Разница значений DateFrom и DateTo должна быть не более суток.

Пример запроса:

GET https://ofd.ru/api/integration/v2/kkt/0004727371036889/receipts/errors?DateFrom=2023-03-20T00:00:00&DateTo=2023-03-20T00:00:00&AuthToken=cd0e2064a23b423c8c9790f75e6e3254

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

{
   "Status":"Success",
    "Data":[
   {
        "FnNumber":"9287440300720244",
        "DocNumber":"124300",
        "RecType":"1",
        "DocDate":"2023-03-20T20:01:00",
        "OfdDate":"2023-03-20T20:43:32",
        "Errors":[
          {
            "Code":"420",
            "Name":"Нарушен формат обязательного реквизита (тега) nds18",
            "Description":"Отсутствует обязательный реквизит НДС "сумма НДС чека по расч. ставке 20/\120": 1106, возможно:\n1. Ошибка приёма на стороне ФНС.\n2. Ошибка возникает в ККТ с текущей версией прошивки.",
            "Solution":"1. На данный фискальный документ нужно отправить чек коррекции. "}],
      "Elapsed":"00:00:00.1768264"
}

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

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

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

Для настройки своих сервисов и проверки работы с контурами 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

Запрос на генерацию пользовательского отчета (на заказ отчета) имеет вид:

POST https://ofd.ru/api/integration/v2/reports/create?AuthToken={Code}

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

{

  "CustomReportId": null,
  "Name": "Сверка",
  "DateFrom": "2024-10-01T00:00:00.000+03:00",
  "DateTo": "2024-10-02T23:59:59.000+03:00",
  "EmailsToNotify": "test@ofd.ru",
  "FfdType": 0,
  "GroupsList": [],
  "KktList": [],
  "ReportType": "ReceiptReport",
  "SelectAllKkts": true,
  "UseXlsxFile": true

}

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

Таблица 17. Параметры запроса на генерацию пользовательского отчета

Успешным ответом на запрос является ответ с кодом 200, содержащий структуру данных. Параметры запроса приведены в таблице 18.
Ошибки, обрабатываемые запросом, приведены в п. 7.1.2.
Пример успешного ответа на запрос (с кодом HTTP равным 200) является генерация структуры данных в JSON:

{
    "Data": {
        "Id": "9b999a56-3c2d-4c25-b722-6244fa59f0c9",
        "CDateUtc": "2024-11-01T13:32:07",
        "ReportTypeName": "Сверка",
        "ReportType": "ReceiptReport",
        "DateFrom": "2024-10-01T00:00:00",
        "DateTo": "2024-10-02T23:59:59",
        "ExpiredDate": "2024-11-08T13:32:07",
        "KktCount": 17,
        "Status": "Todo",
        "AccountEmail": "test@ofd.ru",
        "AccountName": "Георгий",
        "Name": "Сверка",
        "EmailsToNotify": [
            "test@ofd.ru"
        ],
        "FileFormat": "Xlsx",
        "IsAutoReport": false,
        "AssumptiveCompleteTime": "2024-11-01T13:33:07",
        "DownloadUrl": "/api/customer/reports/9b814a56-3c2d-4c25-b722-6244fa59f0c9?OfdAgreementId=d62222c5-61b8-4ed9-b729-9bd7cde127db",
        "DeleteUrl": "/api/customer/reports/9b814a56-3c2d-4c25-b722-6244fa59f0c9?ofdAgreementId=d62222c5-61b8-4ed9-b729-9bd7cde127db",
        "CancelUrl": "/api/customer/reports/9b814a56-3c2d-4c25-b722-6244fa59f0c9/cancel?ofdAgreementId=d62222c5-61b8-4ed9-b729-9bd7cde127db"
    },
    "Success": true
}

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

• KKTReport — Отчет по подключенным ККТ;
• CloseShiftReport — Смены (Premium);
• ReceiptReport — Сверка;
• FiscalDocumentReport — Список фискальных документов;
• RentReport — Арендаторам;
• EReceiptReport — Статистика отправки чеков покупателям;
• OpenShift24Report — Список касс со сменами, открытыми более 24 часов;
• MyKktReport — Мониторинг ККТ и ФН (Premium);
• FnScheduleReport — График смены ФН.

• DateFromGreaterThanDateTo — Конечная дата больше начальной, ошибка в задании диапазона дат;
• AccessDenied — Доступ заблокирован;
• ReportSizeError — Запрошен отчет на слишком большое количество записей;
• LimitExhausted — Исчерпан лимит свободного дискового пространства пользователя личным кабинетом клиента;
• InternalError — Внутренняя ошибка ИС «ОФД».

Запрос на получение списка отчетов (сгенерированных и генерирующихся) для текущего пользователя имеет вид:

GET https://ofd.ru/api/integration/v2/reports/list?AuthToken={Code}&inn={INN}&kpp={INN}

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

Пользователь, для которого должен загружаться список сгенерированных отчетов, определяется обязательным параметром AuthToken. Успешным ответом на запрос (с кодом HTTP равным 200) является структура данных JSON следующего вида (приведены примеры значений):

{
    "Data": {
        "OfdAgreementLimit": 500000,
        "ConsumedLimit": 0,
        "List": [
        {
             "Id": "9b814a56-3c2d-4c25-b722-6244fa59f0c9",
             "CDateUtc": "2024-11-01T13:32:07",
             "ReportType": "ReceiptReport",
             "DateFrom": "2024-10-01T00:00:00",
             "DateTo": "2024-10-02T23:59:59",
             "ExpiredDate": "2024-11-02T13:32:07",
             "KktCount": 17,
             "ReportSize": 8,
             "Status": "Done",
             "AccountEmail": "test@ofd.ru"
            },
             ...
          ],
        "TotalCount": 0
    },
    "Success": true
}

Список полей этой структуры с их описаниями представлен в таблице 19. Ошибки, обрабатываемые запросом, приведены в п. 7.2.2.

Таблица 19. Параметры запроса списка отчетов

• Todo — Отчет ожидает генерации;
• Done — Отчет готов;
• Deleted — Отчет удален;
• Processing — Отчет генерируется;
• Error — Генерация отчета совершена с ошибкой.

• AccessDenied — Доступ заблокирован;
• InternalError — Внутренняя ошибка ИС «ОФД».

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

DELETE https://ofd.ru/api/integration/v2/reports/delete?Id={ID}&AuthToken={Code}

• ID – идентификатор отчета, генерируемый ИС «ОФД», который имеет вид UUID;
• Code – действующий код авторизации, полученный при авторизации.

Пример успешного ответа на запрос (с кодом HTTP равным 200) является генерация структуры данных в JSON:

{
    "Data": {
        "Id": "fd8c44f4-1dad-42ba-9816-ccbbe54a4e19",
        "CDateUtc": "2024-11-08T08:40:23",
        "ReportTypeName": "Сверка",
        "ReportType": "ReceiptReport",
        "DateFrom": "2024-10-01T00:00:00",
        "DateTo": "2024-10-02T23:59:59",
        "ExpiredDate": "2024-11-15T08:40:23",
        "KktCount": 17,
        "Status": "Deleted",
        "AccountEmail": "test@ofd.ru",
        "AccountName": "Генадий",
        "Name": "Сверка",
        "EmailsToNotify": [
            "test@ofd.ru"
        ],
        "FileFormat": "Xlsx",
        "IsAutoReport": false,
        "DownloadUrl": "/api/customer/reports/fd1c04f2-1dad-12ba-9816-ccbbe54a4e19",
        "DeleteUrl": "/api/customer/reports/fd1c04f2-1dad-12ba-9816-ccbbe54a4e19",
        "CancelUrl": "/api/customer/reports/fd1c04f2-1dad-12ba-9816-ccbbe54a4e19/cancel"
    },
    "Success": true
}

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

Таблица 20. Описание параметров ответа на запрос удаления файла сгенерированного пользовательского отчета

• AccessDenied — Доступ заблокирован;
• ReportNotFound — Удаляемый документ не найден;
• InternalError — Внутренняя ошибка ИС «ОФД».

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

GET https://ofd.ru/api/integration/v2/reports/download?Id={id}&AuthToken={Code}

• id – Идентификатор отчета, генерируемый ИС «ОФД» (имеет вид UUID);
• Code – действующий код авторизации, полученный при авторизации.

Успешным ответом на запрос (с кодом HTTP равным 200) является ответ, содержащий файл запрошенного отчета. Ошибки, обрабатываемые запросом, приведены в пункте 9.1.1.

• ReportNotDone — Отчет не сгенерирован или не существует;
• InternalError — Внутренняя ошибка ИС «ОФД».

Запрос списка шаблонов базовых отчетов с указанием их структуры имеет вид:

GET https://ofd.ru/api/integration/v2/reports/custom/templates?AuthToken={Code}

Code – действующий код авторизации, полученный при авторизации. Пользователь, для которого должен загружаться список сгенерированных отчетов, определяется обязательным параметром AuthToken. Успешным ответом на запрос (с кодом HTTP равным 200) является структура данных JSON следующего вида (приведены примеры значений):

{
    "Data": [
        {
            "ReportType": "RentReport",
            "DisplayName": "Арендаторам",
            "Description": "Информация о выручке арендодателям.",
            "IsRentaReport": false,
            "IsCustomReport": false,
            "IsPartnerReport": false,
            "IsPaidReport": true,
            "Locked": false,
            "ReportGrade": "Standard",
            "ReportGradeLabel": "Standard",
            "Fields": [
                    {
                        "Name": "OrgInn",
                        "DisplayField": "ИНН компании",
                        "Optional": true
                },
],
            "Filters": [
                "DateTimeFilter",
                "IsDailyDetailed"
            ],
            "Tags": [
                "Ofd",
                "Ferma"
            ]
        }
    ],
    "Success": true
}

Список полей этой структуры с их описаниями представлен в таблице 21.

Таблица 21. Поля данных записи с описанием типов базовых отчетов и их структуры

Таблица 22. Описание параметра Filters

Таблица 23. Описание параметра Tags

• InternalError — Внутренняя ошибка ИС «ОФД».

Запрос на получение списка сгенерированных отчетов для текущего пользователя имеет вид:

GET https://ofd.ru/api/integration/v2/reports/custom/list?AuthToken={Code}

Code – действующий код авторизации, полученный при авторизации. Пример успешного ответа на запрос (с кодом HTTP равным 200) является генерация структуры данных в JSON:

{
    "Data": [
        {
            "Id": "3e6b8866-8172-42e0-b5d0-0443d3d01993",
            "CDateUtc": "2024-11-02T14:49:36",
            "UDateUtc": "2024-11-02T14:49:36",
            "Name": "test",
            "Fields": [
                …
            ],
            "BaseReportType": "Sales",
            "IsRentaReport": false
        },
    …
    ],
    "Success": true
}

Список полей этой структуры с их описаниями представлен в таблице 24.

Таблица 24. Поля данных списка шаблонов отчетов, созданных пользователем

Таблица 25. Значения полей параметра «Fields»

• AccessDenied — Доступ заблокирован;
• InternalError — Внутренняя ошибка ИС «ОФД».

Запрос на сохранение модифицированного шаблона отчета для текущего пользователя имеет вид:

GET https://ofd.ru/api/integration/v2/reports/custom?id={id}&AuthToken={Code}

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

Пример успешного ответа на запрос (с кодом HTTP равным 200) является генерация структуры данных в JSON:

{
    "Data": {
        "Id": "0000ebf0-d69a-46bd-bc1d-955f649e0cf6",
        "CDateUtc": "2024-11-05T13:16:01",
        "UDateUtc": "2024-11-05T13:16:01",
        "Name": "V15",
        "Fields": [
            "Tax120Summ",
            "TaxTotalSumm"
        ],
        "BaseReportType": "ReceiptReport",
        "IsRentaReport": false
    },
    "Success": true
}

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

Таблица 26. Параметры запроса на сохранение шаблона с внесенными изменениями

Успешным ответом на запрос (с кодом HTTP равным 200) является структура данных JSON содержащая только поле «Status» с указанием значения «Elapsed».

• AccessDenied — Доступ заблокирован;
• InternalError — Внутренняя ошибка ИС «ОФД».

Запрос для текущего пользователя шаблона отчета по заданному идентификатору шаблона имеет вид:

POST https://ofd.ru/api/integration/v2/reports/custom/create&AuthToken={Code}

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

{ 
"CustomReportId": null,
 "Name": "Сверка",
 "DateFrom": "2024-10-01T00:00:00.000+03:00",
 "DateTo": "2024-10-02T23:59:59.000+03:00",
 "EmailsToNotify": "fomenkov@ofd.ru",
 "FfdType": 0,
 "GroupsList": [],
 "Fields": [
     "KktSerialNumber",
     "KKTRegNumber",
     "FNSerialNumber",
     "PlaceAddress"
 ],
 "KktList": [],
 "ReportType": "ReceiptReport",
 "SelectAllKkts": true,
 "UseXlsxFile": true
}

Список полей этой структуры с их описаниями представлен в таблице 27.

Пример успешного ответа на запрос (с кодом HTTP равным 200) является генерация структуры данных в JSON: {

  "Data": {
      "Id": "0da84772-01a3-4444-b9e8-f1dd3428d14a",
      "CDateUtc": "2024-11-05T12:29:17",
      "UDateUtc": "2024-11-05T12:29:17",
      "Name": "Сверка",
      "Fields": [
          "KktSerialNumber",
          "KKTRegNumber",
          "FNSerialNumber",
          "PlaceAddress"
      ],
      "BaseReportType": "Undefined",
      "IsRentaReport": false
  },
  "Success": true

}

Список полей этой структуры с их описаниями представлен в таблице 28.

Таблица 28. Описание параметров ответа запроса на генерацию пользовательского отчета.

• InternalError — Внутренняя ошибка ИС «ОФД».

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

PUT https://ofd.ru/api/integration/v2/reports/custom/edit?Id={id}&AuthToken={Code}

Code – действующий код авторизации, полученный при авторизации. Параметры запроса передаются списком в формате запросов команды PUT. Параметры запроса приведены в таблице 29.

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

{
   "id": "3760ebf0-d69a-46bd-bc1d-955f649e0cf6",
   "Name": "V15",
   "Fields": [
            "Tax120Summ",
            "TaxTotalSumm"
        ]
}

Таблица 29. Параметры запроса на сохранение шаблона пользовательского отчета

Пример успешного ответа на запрос (с кодом HTTP равным 200) является генерация структуры данных в JSON:

{
    "Data": {
        "Id": "3760ebf0-d69a-46bd-bc1d-955f649e0cf6",
        "CDateUtc": "2024-11-05T13:16:01",
        "UDateUtc": "2024-11-05T13:26:19",
        "Name": "V15",
        "Fields": [
            "Tax120Summ",
            "TaxTotalSumm",
        ],
        "BaseReportType": "ReceiptReport",
        "IsRentaReport": false
    },
    "Success": true
}

Список полей этой структуры c их описаниями представлен в таблице 30.

Таблица 30. Описание параметров ответа запроса на сохранение шаблона отчета по идентификатору.

• AccessDenied — Доступ заблокирован;
• InternalError — Внутренняя ошибка ИС «ОФД».

Запрос на удаление шаблона отчета для текущего пользователя по заданному идентификатору шаблона имеет вид:

DELETE https://ofd.ru/api/integration/v2/reports/custom/delete?{id}&AuthToken={Code}

• id – идентификатор отчета, генерируемый ИС «ОФД» (имеет вид UUID).
• Code – действующий код авторизации, полученный при авторизации.

Успешным ответом на запрос (с кодом HTTP равным 200) является структура данных JSON, содержащая поля «Status» и «Data» со значением «true».

• AccessDenied — Доступ заблокирован;
• InternalError — Внутренняя ошибка ИС «ОФД».

Версия 1.0

Выпущена 10.10.2024 г.
Первая версия документа. Объединены документы «Чеки и ККТ» и «Отчеты».

Версия 1.1

Выпущена 14.11.2024
Обновлены методы и их описание с пункта 7.1 по 10.5.1. Добавлен пункт «10.1.1 Описание полей параметра Fields»