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

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

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

--- BEGIN ---
POST https://ofd.ru/api/Authorization/CreateAuthToken HTTP/1.1
Content-Length: 38
Content-Type: application/json; charset=utf-8 {"Login": "12345", "Password": "56789"}
--- END ---

В данном запросе присутствуют примеры значений: передаваемое имя пользователя – «12345» и пароль – «56789»; они задаются как значения в JSON-структуре внутри запроса с ключами «Login» и «Password» соответственно.
Другой формат запроса, обрабатываемый ИС «Чеки и ККТ»: HTTP-запрос авторизации в формате URLEncoded:

--- BEGIN ---
POST https://ofd.ru/api/Authorization/CreateAuthToken HTTP/1.1
Content-Length: 26
Content-Type: application/x-www-form-urlencoded; charset=utf-8
Login=12345&Password=56789
--- END ---

На данный запрос будет получен ответ по протоколу HTTP, который в случае успешной авторизации будет иметь код равный 200 и содержать структуру, подобную следующей (приведены примеры значений):

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

Здесь с ключом «AuthToken» – код авторизации: строка символов AuthToken, представляет собой 32-значную последовательность шестнадцатеричных цифр, используемую для повторной аутентификации, а ключ «ExpirationDateUtc» – строка, описывающая момент времени (дату и время в формате UTC), до которого будет действовать данный код авторизации, в результате применения ключа «AuthToken».
Момент времени задается в формате «ГГГГ-ММ-ДДTчч:мм:сс» ¹⁾; здесь
ГГГГ – год даты, 4 цифры,
ММ – месяц даты, 2 цифры,
ДД – день даты 2 цифры,
T – заглавная латинская буква “T”, используется как разделитель даты и времени,
чч – часы, 2 цифры,
мм – минуты, 2 цифры,
сс – секунды, 2 цифры.

В случае проблем с авторизацией (код ответа по протоколу HTTP будет равен 403) данные будут отсутствовать, JSON-структура будет пустой (будет иметь вид «{}»). Полученный код авторизации используется в виде дополнительного параметра в запросах документов для сверки, где необходима авторизация.
Доступ к кассам по полученному ключу “AuthToken” происходит в соответствии с правами доступа, заданными для пользователя, чьи имя и пароль были использованы в процессе генерации ключа “AuthToken”. Права пользователя могут быть заданы одновременно для ЛКК нескольких юридических лиц, при этом функции описываемого здесь программного интерфейса приложений (API), связанные со сбором данных по ККТ будут возвращать данные только по тем единицам ККТ, доступ к которым разрешен согласно используемому значению ключа “AuthToken”.
Пример запроса с использованием кода авторизации:

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

Здесь:
INN – идентификационный номер налогоплательщика (ИНН) юридического лица, о котором производится запрос. Строка состоит из 10 цифр от 0 до 9.
Code – действующий код авторизации, полученный в результате запроса авторизации.

Запросы (функции) программного интерфейса приложений ИС «Чеки и ККТ» реализуют функции, необходимые в процессе работы различных ИС, использующих кассы и работающих с кассовыми документами. Большинство запросов имеет схожий формат и особенности структуры входных и выходных данных, если входные и выходные данные будут отличаться, это будет описываться дополнительно. Обобщенно формат запроса и ответа описан ниже.
С помощью запросов программного интерфейса приложений ИС «Чеки и ККТ» можно получать информацию о чеках и ККТ. Кодировка, в запросах и ответах – UTF-8. Ответы выдаются сервером в формате JSON, и, в случае успешности ответа, согласно его заголовку (код ответа по протоколу HTTP равен 200), данные имеют следующий обобщенный вид:

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

Здесь параметр «Status» – состояние обработки запроса, в данном случае имеет значение «Success» (запрос обработан успешно).
Ключу «Data» соответствует структура, где «Prop1», «Prop2», … «PropN» и «Val1», «Val2», … «ValN» — ключи передаваемых параметров с их значениями (см. описания параметров ниже; значениями параметров могут являться массивы и структуры).
Параметр «Elapsed» — время, затраченное системой на обработку запроса: от получения запроса системой до выдачи ответа.
Формат времени — строка вида «чч:мм:сс.ддддддд», в которой:
чч – часы,
мм – минуты,
сс – секунды,
ддддддд – доли секунды.
В случае неуспешного ответа (код ответа по протоколу HTTP не равен 200) данные имеют следующий обобщенный вид:

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

Здесь параметр «Status» в данном случае имеет значение «Failed» (обработка запроса не удалась).
Ключу «Errors» соответствует одномерный массив, в котором присутствуют строки с сообщениями об ошибках, возникших при обработке данных.
На месте строк «Ошибка 1», «Ошибка 2», … «Ошибка N» перечислены сообщения об ошибках, возникших при обработке переданных данных.
Параметр «Elapsed» – так же, как и в случае успешного ответа, время, затраченное системой на обработку запроса.
Формат представления времени тот же.

Запрос на получение информации по ККТ имеет вид:

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

Здесь:
INN – идентификационный номер налогоплательщика (ИНН) юридического лица, о котором производится запрос. Строка состоит из 10 цифр от 0 до 9.
FNumber – номер фискального накопителя.
KKTNumber – заводской номер кассы.
KKTRegNumber – регистрационный номер кассы.
Code – действующий код авторизации, полученный в результате запроса авторизации.
Успешным ответом на запрос возвращается структура данных 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"
    },
    ...
  ]
}

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

Таблица 1. Поля данных записи с информацией о ККТ

Ошибка в ответе на запрос, обрабатываемая ИС:
InnNotFound – для текущей учетной записи не найдено юридическое лицо по заданному ИНН.

Запрос на получение списка отчетов по смене (z-отчетов) по заданной кассе за период имеет вид:

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

Здесь:
INN – ИНН юридического лица, на которое зарегистрирована касса, по данным которой генерируется отчет. Строка состоит из 10 цифр от 0 до 9.
KKT – регистрационный номер кассы – строка символов.
Date1 и Date2 – начальная и конечная даты периода, для которого требуется сгенерировать отчет по открытым и закрытым сменам для заданной кассы – строка символов, содержащая дату и время в формате ISO. Разность Date2 и Date1 не должна превышать 30 дней.
Code – действующий код авторизации, полученный в результате запроса авторизации.
Успешным ответом на запрос (с кодом HTTP равным 200) является структура данных JSON следующего вида (приведены примеры значений, многоточие означает многократно повторяющуюся структуру такого же вида):

{
  "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
    },
    ...
  ]
}

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

Таблица 2. Поля данных записи с информацией о ККТ

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

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

Запрос на получение списка отчетов по смене (z-отчетов) для всех ККТ, зарегистрированной на определенного владельца, за период имеет вид:

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

Здесь:
INN – ИНН юридического лица, на которое зарегистрирована касса, по данным которой генерируется отчет. Строка состоит из 10 цифр от 0 до 9.
Date1 и Date2 – начальная и конечная даты периода, для которого требуется сгенерировать отчет по открытым и закрытым сменам для заданной кассы – строка символов, содержащая дату и время в формате ISO. Разность Date2 и Date1 не должна превышать 30 дней.
Code – действующий код авторизации, полученный в результате запроса авторизации.
Успешным ответом на запрос (с кодом HTTP равным 200) является структура данных вида, аналогичного структуре, выдаваемой ИС по запросу списка отчетов по смене для заданной кассы за заданный период.

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

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

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

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

Здесь:
INN – ИНН юридического лица, на которое зарегистрирована касса, по данным которой генерируется отчет. Строка состоит из 10 цифр от 0 до 9.
KKT – регистрационный номер кассы – строка символов.
Date1 и Date2 – начальная и конечная даты периода, для которого требуется сгенерировать отчет по открытым и закрытым сменам для заданной кассы – строка символов, содержащая дату и время в формате ISO. Разность Date2 и Date1 не должна превышать 7 дней.
Code – действующий код авторизации, полученный в результате запроса авторизации.
Успешным ответом на запрос (с кодом HTTP равным 200) является структура данных JSON следующего вида (приведены примеры значений, многоточие означает многократно повторяющуюся структуру такого же вида):

{
  "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
    },
    ...
  ]
}

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

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

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

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

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

Здесь:
{INN} – ИНН юридического лица, на которое зарегистрирована касса, по данным которой генерируется отчет. Строка состоит из 10 цифр от 0 до 9.
{KKT} – регистрационный номер кассы – строка символов.
{Shift} – номер смены, по которой требуется сгенерировать отчет.
{Fn} – номер фискального накопителя, установленного в кассу.
{Code} – действующий код авторизации, полученный в результате запроса авторизации.
Успешным ответом на запрос (с кодом HTTP равным 200) является структура данных JSON, аналогичная структуре, приведенной в п. 2.4. Описание полей структуры см. в Таблице 3, описание ошибок, см. в п. 2.4.

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

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 – действующий код авторизации, полученный в результате запроса авторизации.
Успешным ответом на запрос (с кодом HTTP равным 200) является структура данных JSON следующего вида (приведены примеры значений):

{
    "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
    }
}

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

Таблица 4. Поля данных записи с подробной информацией о чеке

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

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

• «Common» или «0» — общая система налогообложения;
• «SimpleIn» или «1» — упрощенная система налогообложения (доход);
• «SimpleInOut» или «2» — упрощенная система налогообложения (доход минус расход);
• «Unified» или «3» — единый налог на вмененный доход;
• «UnifiedAgricultural» или «4» — единый сельскохозяйственный налог;
• «Patent» или «5» — патентная система налогообложения.

Внимание! Возможные (корректные) значения типа налогообложения ограничиваются значениями, отмеченными, как разрешенные при регистрации кассы. Для того, чтобы изменить список допустимых типов налогообложения, необходимо произвести перерегистрацию кассы.

Прямая ссылка на электронный чек имеет следующий вид:

{Домен}/rec/{inn}/{kktregnumber}/{fnnumber}/{docnumber}/{decsign}

Ниже, в таблице 5 приведен список параметров.

Таблица 5. Параметры ссылки на электронный чек

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

GET /ofd.ru/api/integration/v1/inn/{ИНН}/kkt/{РНМ}/DateFrom/{Дата начала периода}/DateTo/{Дата окончания периода}/receipts-with-fpd-short

Здесь:
Дата начала периода – дата начала от которой формируется список чеков в формате YYYY-MM-DDThh:mm:ss (ISO)
Дата окончания периода – дата окончания на которую формируется список чеков в формате YYYY-MM-DDThh:mm:ss (ISO)
РНМ - регистрационный номер кассы

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

{
   "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"
            }
         ],
         "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
      }
   ],
   "Elapsed":"00:00:00.3506406"
}

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

Таблица 5. Поля данных записи с подробной информацией о чеке

Помимо функций управления кассами и получения информации о кассах и чеках в ИС имеется возможность обработки запросов программного интерфейса на получение информации об организации касс в структуру папок, а также о кассах, имеющих проблемы: неисправных, неоплаченных, отключенных по каким-либо другим причинам и т. д.; ниже описываются такие запросы.

Запрос на получение списка папок с ККТ, находящихся в корневом, либо в явно заданном каталоге текущего ЛКК, имеет следующий вид:

GET https://ofd.ru/api/integration/v1/kktgroup/list

или

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

Здесь:
Id1 — идентификатор папки, список дочерних папок которой запрашивается:

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

Ответ на запрос имеет типовую структуру, описанную в разделе 2. Структура данных имеет формат JSON следующего вида (приведены примеры значений):

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

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

Таблица 6. Поля данных записи с подробной информацией о чеке

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

GET api/integration/v1/kkt/problem/list

или

GET api/integration/v1/kkt/problem/list/{KKT}

Здесь:
KKT — регистрационный номер кассы.
Ответ на запрос имеет типовую структуру, описанную в разд. 2, идентификатору «Data» соответствует массив структур; структура имеет следующий вид (приведены примеры значений):

{
  "Id": "00000000-0000-0000-0000-000000000000",
  "KktName": "string",
  "KktModel": "string",
  "KktRegId": "string",
  "SerialNumber": "string",
  "FnNumber": "string",
  "CreateDate": "2001-09-11T08:46:26.0000000",
  "PaymentDate": "2001-09-11T08:46:26.0000000",
  "CheckDate": "2001-09-11T08:46:26.0000000",
  "ActivationDate": "2001-09-11T08:46:26.0000000",
  "ContractStartDate": "2001-09-11T08:46:26.0000000",
  "ContractEndDate": "2001-09-111T08:46:26.0000000",
  "FirstDocumentDate": "2001-09-11T08:46:26.0000000",
  "LastDocumentDate": "2001-09-11T08:46:26.0000000",
  "FiscalAddress": "string",
  "FiscalPlace": "string",
  "GroupId": "00000000-0000-0000-0000-000000000000",
  "Path": "string",
  "Status": "string",
  "StatusMessage": "string"
}

Список полей этой структуры c их описаниями представлен в таблице 7. Если запрос произведен с указанием регистрационного номера кассы (KKT1), то массив в ответе будет состоять из одной записи.

Таблица 7. Поля данных записи с подробной информацией о чеке

Версия 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. В примере ответа на запрос cписка чеков за период по заданной кассе добавлены параметры: 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 добавлен фильтр по ККТ и скорректирован фильтр по дате времени.