Описывается программный интерфейс приложений (API) предоставляющий возможность сторонним (клиентским) приложениям использовать данные фискальных документов из информационной системы (ИС) «Чеки и ККТ» для сверки. Взаимодействие клиентского приложения и API производится путем отправки приложением HTTP-запросов к серверу и получением ответов на них. Для отправки запросов и получения ответов используется протокол HTTPS. Максимально количество символов в запросе json, составляет 30000 символов. Максимальный размер для tlv 32 кб. Размер tlv установлен ФНС, согласно протоколу передачи данных. Объем служебной информации в tlv установлен кассой, изменять категорически запрещается. Изменение объема служебной информации будет рассматриваться ФНС как нарушение протокола передачи данных. Частота отправки запроса не должна превышать более 1 запроса в секунду.
Возможность множественных обращений к ИС «Чеки и ККТ» после одной авторизации без использования механизма 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чч:мм:сс» 1);
здесь
ГГГГ – год даты, 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}&AuthToken={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. Поля данных записи с информацией о ККТ
Идентификатор | Формат поля | Назначение |
---|---|---|
Id | Строка | Уникальный номер ККТ (кассы) |
KktRegId | Строка | Регистрационный номер ККТ (кассы) |
KktName | Строка | Название кассы |
SerialNumber | Строка | Заводской (серийный) номер ККТ (кассы) |
ActivationDate | Дата и время в формате ISO | Дата успешной проверки регистрационного номера в ФНС |
ContractStartDate | Дата и время в формате ISO | Дата начала действия контракта на получение услуг оператора “OFD.ru” |
ContractEndDate | Дата и время в формате ISO | Дата окончания действия контракта на получение услуг оператора “OFD.ru” |
CreateDate | Дата и время в формате ISO 2) | Дата регистрации кассы в личном кабинете клиента |
FnNumber | Строка | Номер фискального накопителя |
SignDate | Дата и время в формате ISO | Дата подписания договора |
PaymentDate | Дата и время в формате ISO | Дата оплаты услуг ОФД для кассы |
CheckDate | Дата и время в формате ISO | Дата подписания КЭП (квалификационной электронной подписью) |
LastDocOnKktDateTime | Дата и время в формате ISO | Дата и время последнего документа, сгенерированного кассой (по локальному времени кассы) |
LastDocOnOfdDateTimeUtc | Дата и время в формате ISO | Дата и время получения последнего документа кассы в ОФД (по времени оператора “OFD.ru” в UTC) |
FirstDocumentDate | Дата и время в формате ISO | Дата и время генерации кассой первого документа |
FiscalAddress | Строка | Адрес установки кассы |
FiscalPlace | Строка | Место расчетов |
Path | Строка | Иерархия расположения кассы в личном кабинете клиента |
KktModel | Строка | Модель кассы (ККТ) |
FnEndDate | Дата и время в формате ISO | Дата и время окончания работы фискального накопителя |
Ошибка в ответе на запрос, обрабатываемая ИС:
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 – действующий код авторизации, полученный в результате запроса авторизации.
Частота отправки запроса не должна превышать более 1 запроса в секунду.
Успешным ответом на запрос (с кодом 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
},
...
]
}
Описание параметров структуры ответа представлен в таблице 2.
Таблица 2. Поля данных записи с информацией о ККТ
Идентификатор | Формат поля | Назначение |
---|---|---|
Id | Строка в формате UUID | Идентификатор смены |
Open_CDateUtc | Дата и время в формате ISO | Дата и время отчета об открытии смены |
Close_CDateUtc | Дата и время в формате ISO | Дата и время отчета о закрытии смены |
UserInn | Строка, 10 или 12 цифр | ИНН владельца кассы |
KktRegNumber | Строка | Регистрационный номер кассы |
FnNumber | Строка | Номер фискального накопителя, установленного в кассу |
ShiftNumber | Целое число | Номер смены по данным кассы |
Operator | Строка | Фамилия, имя, отчество оператора |
Open_DocNumber | Целое число | Фискальный номер документа отчета об открытии смены, присвоенный кассой (уникальный в рамках текущего фискального режима) |
Open_DocDateTime | Дата и время в формате ISO | Дата и время формирования отчета об открытии смены по данным кассы |
Open_DocRawId | Строка в формате UUID | Идентификатор документа отчета об открытии смены, полученного от кассы |
Close_DocNumber | Целое число | Фискальный номер документа отчета о закрытии смены, присвоенный кассой (уникальный в рамках текущего фискального режима) |
Close_DocDateTime | Дата и время в формате ISO | Дата и время формирования отчета о закрытии смены по данным кассы |
Close_DocRawId | Строка в формате UUID | Идентификатор документа отчета о закрытии смены, полученного от кассы |
ShiftDocsCount | Целое число | Общее количество документов за смену |
IncomeSumm | Целое число | Сумма полученных денежных средств за смену в копейках |
IncomeCashSumm | Целое число | Сумма полученных денежных средств за смену наличными в копейках |
IncomeECashSumm | Целое число | Сумма полученных денежных средств за смену безналичными в копейках |
IncomeCount | Целое число | Количество чеков, выданных за смену, соответствующих получению суммы IncomeSumm |
AdvanceSumm | Целое число | Сумма полученных денежных средств авансом в копейках |
CreditSumm | Целое число | Сумма полученных денежных средств кредита в копейках |
ExchangeSumm | Целое число | Сумма полученных денежных средств обмена в копейках |
RefundIncomeSumm | Целое число | Сумма выданных (возвращённых) денежных средств за смену в копейках |
RefundIncomeCashSumm | Целое число | Сумма выданных (возвращенных) денежных средств за смену наличными в копейках |
RefundIncomeCount | Целое число | Количество чеков, выданных за смену, соответствующих возврату суммы RefundIncomeSumm |
ExpenseSumm | Целое число | Сумма расхода за смену |
ExpenseCount | Целое число | Количество чеков расхода за смену |
RefundExpenseSumm | Целое число | Сумма возвратов расхода за смену |
RefundExpenseCount | Целое число | Количество чеков возврата прихода за смену |
RefundAdvanceSumm | Целое число | Сумма возврата аванса |
RefundCreditSumm | Целое число | Сумма возврата кредита |
RefundExchangeSumm | Целое число | Сумма возврата обмена |
TaxTotalSumm | Целое число | Общая сумма удерживаемых налогов, начисленная за смену в копейках |
Tax10Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10 %, начисленная за смену в копейках |
Tax18Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20 %, начисленная за смену в копейках |
Tax110Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10/110, начисленная за смену, в копейках |
Tax118Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20/120, начисленная за смену, в копейках |
TaxNaSumm | Целое число | Сумма по операциям, не облагаемая НДС, накопленная за смену, в копейках |
Tax0Summ | Целое число | Сумма по операциям, облагаемая НДС по ставке 0%, накопленная за смену, в копейках |
Ошибки в ответе на запрос, обрабатываемые ИС:
Запрос на получение списка отчетов по смене (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) является структура данных вида, аналогичного структуре, выдаваемой ИС по запросу списка отчетов по смене для заданной кассы за заданный период.
Ошибки в ответе на запрос, обрабатываемые ИС:
Внимание! В ответе json возвращается информации по сменам для всех ККТ только по текущему ФН.
Запрос на получение списка чеков за период по заданной кассе имеет вид:
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. Ошибки в ответе на запрос, обрабатываемые ИС:
Таблица 3. Поля данных записи со списком документов (чеков)
Идентификатор | Формат поля | Назначение |
---|---|---|
Id | Строка в формате UUID | Уникальный номер фискального документа в ИС, используется в запросе подробной информации по чеку, как RawId |
CDateUtc | Дата и время в формате ISO | Дата и время приема документа в ИС |
Tag | Целое число | Численный признак вида документа: 3 – чек, 31 – чек коррекции, 4 – бланк строгой отчетности, 41 – бланк строгой отчетности коррекции |
IsBso | Логическая переменная | Имеет значение true, если документ является БСО, иначе (если документ является чеком) – false |
IsCorrection | Логическая переменная | Имеет значение true, если чек или бланк строгой отчетности (БСО) является документом коррекции, иначе – false |
OperationType | Строка | Тип операции: «Income» – приход, «Expense» – расход, «Refund income» – возврат прихода, «Refund expense» – возврат расхода. |
UserInn | Строка, 10 или 12 цифр | ИНН владельца кассы |
KktRegNumber | Строка | Регистрационный номер кассы |
FnNumber | Строка | Номер фискального накопителя, установленного в кассу |
DocNumber | Целое число | Фискальный номер документа |
DocDateTime | Дата и время в формате ISO | Дата и время формирования документа по данным кассы |
DocShiftNumber | Целое число | Номер смены (по данным кассы), в которую был сформирован документ |
ReceiptNumber | Целое число | Номер документа в смене (по данным кассы) |
DocRawId | Строка в формате UUID | Уникальный номер фискального документа в ИС, (используется в запросе подробной информации по чеку, как RawId, дублирует поле Id) |
TotalSumm | Целое число | Общая сумма по чеку в копейках |
CashSumm | Целое число | Сумма по чеку (БСО) наличными в копейках |
ECashSumm | Целое число | Сумма по чеку (БСО) электронными в копейках |
PrepaidSumm | Целое число | Сумма по чеку (БСО) предоплатами (авансами) |
CreditSumm | Целое число | Сумма по чеку (БСО) постоплатами (кредитами) |
ProvisionSumm | Целое число | Сумма по чеку (БСО) встречными предоставлениями |
TaxTotalSumm | Целое число | Общая сумма удерживаемых налогов, начисленная за смену в копейках |
Tax10Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10 %, начисленная за смену, в копейках |
Tax18Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20 %, начисленная за смену, в копейках |
Tax110Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10/110, начисленная за смену, в копейках |
Tax118Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20/120, начисленная за смену, в копейках |
TaxNaSumm | Целое число | Сумма по операциям, не облагаемая НДС, накопленная за смену, в копейках |
Tax0Summ | Целое число | Сумма по операциям, облагаемая НДС по ставке 0%, накопленная за смену, в копейках |
Depth | Целое число | Количество товарных позиций в чеке |
Запрос на получение списка за смену по заданной кассе имеет вид:
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
}
}
Описания параметров структуры бланка строгой отчетности представлен в таблице 4.
Таблица 4. Описание параметров бланка строгой отчетности
Идентификатор | Вложенный идентификатор | Формат поля | Назначение | Тег |
---|---|---|---|---|
Tag | Целое число | Численный признак вида документа: 3 – чек, 4 – бланк строгой отчетности |
||
User | Строка | Полное имя или название владельца кассы | 1048 | |
UserInn | Строка, 10 или 12 цифр | ИНН владельца кассы | 1018 | |
Number | Целое число | Номер документа внутри смены | 1042 | |
DateTime | Дата и время в формате ISO | Дата и время формирования документа (чека) | 1012 | |
ShiftNumber | Целое число | Номер смены (по данным кассы), в которую был сформирован документ | 1038 | |
OperationType | Строка | Тип операции: «Income» – приход, «Expence» – расход, «Refund income» – возврат прихода, «Refund expence» – возврат расхода. |
1054 | |
TaxationType | Целое число | Тип налогообложения, смотри п.п.2.6.1 | 1055 | |
Operator | Строка | Должность, фамилия, имя, отчество (фамилия и инициалы) оператора | 1021 | |
KKT_RegNumber | Строка | Регистрационный номера кассы | 1037 | |
FN_FactoryNumber | Строка | Номер фискального накопителя, установленного в кассу | 1041 | |
Items | Структура | Список товарных позиций в чеке | 1059 | |
Name | Строка | Название товарной позиции в чеке | 1030 | |
Price | Целое число | Цена в копейках за единицу измерения товарной позиции | 1079 | |
Quantity | Целое число | Количество единиц товарной позиции | 1023 | |
UnitOfMeasure | Строка | Единица измерения предмета расчета | 1197 | |
OriginCountryCode | Строка | Цифровой код страны происхождения товара в соответствии с Общероссийским классификатором стран мира | 1230 | |
CustomDeclarationNumber | Строка | Номер таможенной декларации в соответствии с форматом, установленным решением Комиссии Таможенного союза от 20.05.2010 N 257 (в ред. 17.12.2019 N 223) «О форме декларации на товары и порядке ее заполнения» | 1231 | |
ProductCheckResultDetails | Число | Результаты проверки товара, подлежащий обязательной маркировке | 2106 | |
ProductUnitOfMeasure | Число | Единицы измерения количества предмета расчета | 2108 | |
ProductCode | Структура | Параметр может принимать одно из следующих значений, описанных в таблице 6 | 1163 | |
Nds18_TotalSumm | Целое число | Сумма НДС по предмету расчета со ставкой 18% в копейках | 1102 | |
Nds10_TotalSumm | Целое число | Сумма НДС по предмету расчета со ставкой 10% в копейках | 1103 | |
Nds00_TotalSumm | Целое число | Сумма НДС по предмету расчета со ставкой 0% в копейках | 1104 | |
NdsNA_TotalSumm | Целое число | Сумма, к которой не применяется НДС в копейках | 1105 | |
Nds18_CalculatedTotalSumm | Целое число | Сумма НДС чека с рассчитанной ставкой 18% | 1106 | |
Nds10_CalculatedTotalSumm | Целое число | Сумма НДС чека с рассчитанной ставкой 10% | 1107 | |
Total | Целое число | Стоимость товарной позиции в копейках | 1043 | |
CalculationMethod | Целое число | Признак способа расчета | 1214 | |
SubjectType | Целое число | Признак предмета расчета | 1212 | |
ProductNomenclature | Массив данных | Код товарной номенклатуры | 1162 | |
NDS_PieceSumm | Целое число | Размер НДС за единицу предмета расчета | 1198 | |
NDS_Rate | Целое число | Ставка НДС принимает значения: 1 - НДС 18%; 2 - НДС 10%; 3 - НДС 18/118; 4 - НДС 10/110; 5 - НДС 0%; 6 - НДС не облагается. |
||
NDS_Summ | Целое число | Общая сумма НДС в копейках | ||
AdditionalRequisite | Строка | Дополнительный реквизит предмета расчета | 1191 | |
RetailPlaceAddress | Строка | Адрес расчётов | 1009 | |
Buyer_Address | Строка | Адрес покупателя (используется службами доставки) | 1008 | |
Sender_Address | Строка | Адрес электронной почты отправителя чека | 1117 | |
PaymentAgent_Phone | Строка | Телефон оператора по приёму платежей | 1074 | |
MoneyOperator_Phone | Строка | Телефон оператора по переводу денежных средств | 1075 | |
BankAgent_Phone | Строка | Телефон платёжного агента | 1073 | |
BankAgent_Operation | Строка | Операция платёжного агента | 1044 | |
MoneyOperator_Name | Строка | Наименование оператора по переводу денежных средств | 1026 | |
MoneyOperator_Address | Строка | Адрес оператора по переводу денежных средств | 1005 | |
MoneyOperator_INN | Строка | ИНН оператора по переводу денежных средств | 1016 | |
Amount_Total | Целое число | Общая сумма по чеку в копейках | 1020 | |
Amount_Cash | Целое число | Сумма наличными по чеку в копейках | 1031 | |
Amount_ECash | Целое число | Сумма, оплаченная картой, в копейках | 1081 | |
Document_Number | Целое число | Фискальный номер документа | 1040 | |
FiscalSign | Строка | Фискальный признак документа | 1077 | |
DecimalFiscalSign | Строка | Фискальный признак документа | ||
KKT_MachineNumber | Строка | Заводской номер автоматического устройства для расчетов | 1036 | |
InternetSign | Целое число | Признак осуществления расчетов только в сети «Интернет», в которой отсутствует устройство для печати фискальных документов в составе ККТ | 1108 | |
Extra | Cтруктура | Дополнительный реквизит пользователя по чеку | 1084 | |
Name | Строка | Наименование дополнительного реквизита по чеку | 1085 | |
Value | Строка | Значение дополнительного реквизита по чеку | 1086 | |
Format_Version | Целое число | Номер версии формата фискальных документов | 1209 | |
Amount_Advance | Целое число | Сумма предоплаты (зачет аванса) | 1215 | |
Amount_Loan | Целое число | Сумма постоплаты (кредита) | 1216 | |
Amount_Granting | Целое число | Сумма встречным предоставлением | 1217 | |
TaxAuthority_Site | Строка | Сайт налогового органа (Адрес сайта ФНС) | 1060 | |
Calculation_Place | Строка | Место расчетов | 1187 | |
Supplier_Phone | Строка | Телефон поставщика | 1171 | |
Operator_INN | Строка | ИНН кассира | 1203 | |
PaymentAgentMode | Строка | Применение платёжными агентами (субагентами) | 1057 | |
AdditionalRequisite | Строка | Дополнительный реквизит чека (БСО) | 1192 | |
ProductCheckResult | Целое число | Результаты проверки маркированных товаров | 2107 |
Таблица 5. Описание параметров чека коррекции
Идентификатор | Вложенный идентификатор | Формат поля | Назначение | Тег |
---|---|---|---|---|
Tag | Целое число | Численный признак вида документа: 31 – чек коррекции, 41 – бланк строгой отчетности коррекции |
||
User | Строка | Полное имя или название владельца кассы | 1048 | |
UserInn | Строка, 10 или 12 цифр | ИНН владельца кассы | 1018 | |
Number | Целое число | Номер документа внутри смены | 1042 | |
DateTime | Дата и время в формате ISO | Дата и время формирования документа (чека) | 1012 | |
ShiftNumber | Целое число | Номер смены (по данным кассы), в которую был сформирован документ | 1038 | |
OperationType | Строка | Тип операции: «Income» – приход, «Expence» – расход, «Refund income» – возврат прихода, «Refund expence» – возврат расхода. |
1054 | |
TaxationType | Целое число | Тип налогообложения, смотри п.п.2.6.1 | 1055 | |
Operator | Строка | Должность, фамилия, имя, отчество (фамилия и инициалы) оператора | 1021 | |
KKT_RegNumber | Строка | Регистрационный номера кассы | 1037 | |
FN_FactoryNumber | Строка | Номер фискального накопителя, установленного в кассу | 1041 | |
Correction_Type | Целое число | Тип коррекции. Принимает значения «1» и «0». 0 - самостоятельно; 1 - по предписанию |
1173 | |
Correction | Cтруктура | Основание для коррекции | 1174 | |
Date | Дата и время в формате ISO | Дата документа основания для коррекции | 1178 | |
DocNumber | Строка | Номер документа основания для коррекции | 1179 | |
Items | Массив структур | Список товарных позиций в чеке | 1059 | |
Name | Строка | Название товарной позиции в чеке | 1030 | |
Price | Целое число | Цена в копейках за единицу измерения товарной позиции | 1079 | |
Quantity | Целое число | Количество единиц товарной позиции | 1023 | |
UnitOfMeasure | Строка | Единица измерения предмета расчета | 1197 | |
OriginCountryCode | Строка | Цифровой код страны происхождения товара в соответствии с Общероссийским классификатором стран мира | 1230 | |
CustomDeclarationNumber | Строка | Номер таможенной декларации в соответствии с форматом, установленным решением Комиссии Таможенного союза от 20.05.2010 N 257 (в ред. 17.12.2019 N 223) «О форме декларации на товары и порядке ее заполнения» | 1231 | |
ProductCheckResultDetails | Число | Результаты проверки товара, подлежащий обязательной маркировке | 2106 | |
ProductUnitOfMeasure | Число | Единицы измерения количества предмета расчета | 2108 | |
ProductCode | Структура | Параметр может принимать одно из следующих значений, описанных в таблице 6 | 1163 | |
Nds18_TotalSumm | Целое число | Сумма НДС по предмету расчета со ставкой 18% в копейках | 1102 | |
Nds10_TotalSumm | Целое число | Сумма НДС по предмету расчета со ставкой 10% в копейках | 1103 | |
Nds00_TotalSumm | Целое число | Сумма НДС по предмету расчета со ставкой 0% в копейках | 1104 | |
NdsNA_TotalSumm | Целое число | Сумма, к которой не применяется НДС в копейках | 1105 | |
Nds18_CalculatedTotalSumm | Целое число | Сумма НДС чека с рассчитанной ставкой 18% | 1106 | |
Nds10_CalculatedTotalSumm | Целое число | Сумма НДС чека с рассчитанной ставкой 10% | 1107 | |
Total | Целое число | Стоимость товарной позиции в копейках | 1043 | |
CalculationMethod | Целое число | Признак способа расчета | 1214 | |
SubjectType | Целое число | Признак предмета расчета | 1212 | |
ProductNomenclature | Массив данных | Код товарной номенклатуры | 1162 | |
NDS_PieceSumm | Целое число | Размер НДС за единицу предмета расчета | 1198 | |
NDS_Rate | Целое число | Ставка НДС принимает значения: 1 - НДС 18%; 2 - НДС 10%; 3 - НДС 18/118; 4 - НДС 10/110; 5 - НДС 0%; 6 - НДС не облагается. |
||
NDS_Summ | Целое число | Общая сумма НДС в копейках | ||
AdditionalRequisite | Строка | Дополнительный реквизит предмета расчета | 1191 | |
RetailPlaceAddress | Строка | Адрес расчётов | 1009 | |
Buyer_Address | Строка | Адрес покупателя (используется службами доставки) | 1008 | |
Sender_Address | Строка | Адрес электронной почты отправителя чека | 1117 | |
PaymentAgent_Phone | Строка | Телефон оператора по приёму платежей | 1074 | |
MoneyOperator_Phone | Строка | Телефон оператора по переводу денежных средств | 1075 | |
BankAgent_Phone | Строка | Телефон платёжного агента | 1073 | |
BankAgent_Operation | Строка | Операция платёжного агента | 1044 | |
MoneyOperator_Name | Строка | Наименование оператора по переводу денежных средств | 1026 | |
MoneyOperator_Address | Строка | Адрес оператора по переводу денежных средств | 1005 | |
MoneyOperator_INN | Строка | ИНН оператора по переводу денежных средств | 1016 | |
Amount_Total | Целое число | Общая сумма по чеку в копейках | 1020 | |
Amount_Cash | Целое число | Сумма наличными по чеку в копейках | 1031 | |
Amount_ECash | Целое число | Сумма, оплаченная картой, в копейках | 1081 | |
Document_Number | Целое число | Фискальный номер документа | 1040 | |
FiscalSign | Строка | Фискальный признак документа | 1077 | |
DecimalFiscalSign | Строка | Фискальный признак документа | ||
KKT_MachineNumber | Строка | Заводской номер автоматического устройства для расчетов | 1036 | |
InternetSign | Целое число | Признак осуществления расчетов только в сети «Интернет», в которой отсутствует устройство для печати фискальных документов в составе ККТ | 1108 | |
Extra | Cтруктура | Дополнительный реквизит пользователя по чеку | 1084 | |
Name | Строка | Наименование дополнительного реквизита по чеку | 1085 | |
Value | Строка | Значение дополнительного реквизита по чеку | 1086 | |
Format_Version | Целое число | Номер версии формата фискальных документов | 1209 | |
Amount_Advance | Целое число | Сумма предоплаты (зачет аванса) | 1215 | |
Amount_Loan | Целое число | Сумма постоплаты (кредита) | 1216 | |
Amount_Granting | Целое число | Сумма встречным предоставлением | 1217 | |
TaxAuthority_Site | Строка | Сайт налогового органа (Адрес сайта ФНС) | 1060 | |
Calculation_Place | Строка | Место расчетов | 1187 | |
Supplier_Phone | Строка | Телефон поставщика | 1171 | |
Operator_INN | Строка | ИНН кассира | 1203 | |
PaymentAgentMode | Строка | Применение платёжными агентами (субагентами) | 1057 | |
AdditionalRequisite | Строка | дополнительный реквизит чека (БСО) | 1192 | |
ProductCheckResult | Целое число | Результаты проверки маркированных товаров | 2107 |
Таблица 6. Возможные значения параметра «ProductCode» (Тег 1163)
Идентификатор | Формат поля | Назначение | Тег |
---|---|---|---|
Code_EAN_8 | Строка | код товара в формате EAN-8 | 1301 |
Code_EAN_13 | Строка | код товара в формате EAN-13 | 1302 |
Code_ITF_14 | Строка | код товара в формате ITF-14 | 1303 |
Code_GS_1 | Строка | код товара в формате GS1, нанесенный на товар, не подлежащий маркировке средствами идентификации | 1304 |
Code_GS_1M | Строка | код товара в формате GS1, нанесенный на товар, подлежащий маркировке средствами идентификации | 1305 |
Code_KMK | Строка | код товара в формате короткого кода маркировки, нанесенный на товар, подлежащий маркировке средствами идентификации | 1306 |
Code_MI | Строка | контрольно-идентификационный знак мехового изделия | 1307 |
Code_F_1 | Строка | код товара в формате Ф.1 | 1320 |
Code_F_6 | Строка | код товара в формате Ф.6 | 1325 |
Ошибки в ответе на запрос, обрабатываемые ИС:
Внимание! Возможные (корректные) значения типа налогообложения ограничиваются значениями, отмеченными, как разрешенные при регистрации кассы. Чтобы изменить список допустимых типов налогообложения, необходимо произвести перерегистрацию кассы.
Прямая ссылка на электронный чек имеет следующий вид:
{Домен}/rec/{inn}/{kktregnumber}/{fnnumber}/{docnumber}/{decsign}
Ниже, в таблице 7 приведен список параметров.
Таблица 7. Параметры ссылки на электронный чек
Параметр | Тег из документа «Приложении 2 к приказу ФНС России от 21 марта 2017 г. № ММВ-7-20/229@» («Формат фискальных документов») | Описание |
---|---|---|
inn | 1018 | ИНН владельца кассы, на которого она зарегистрирована |
kktregnumber | 1037 | Регистрационный номер ККТ |
fnnumber | 1041 | Номер фискального накопителя |
docnumber | 1040 | Номер фискального документа |
decsign | 1077 | Фискальный признак документа |
Запрос на получение списка чеков по кассам клиента с подробной информацией по чеку имеет следующий вид
GET https://ofd.ru/api/integration/v1/inn/{INN}/kkt/{RNM}/receipts-with-fpd-short?dateFrom={Дата начала периода}&dateTo={Дата окончания периода}&AuthToken{Code}
Здесь:
Запрос на получение списка чеков по кассам, можно получить за период не более 90 дней, количество касс, для получения списка чеков не ограничено.
Успешным ответом на запрос (с кодом 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",
"Provider_Inn": "373830353030"
}
],
"Nds00_TotalSumm":0,
"NdsNA_TotalSumm":13000,
"TotalSumm":13000,
"CashSumm":13000,
"ECashSumm":0,
"PrepaidSumm":0,
"CreditSumm":0,
"ProvisionSumm":0,
"TaxTotalSumm":0,
"Tax10Summ":0,
"Tax18Summ":0,
"Tax110Summ":0,
"Tax118Summ":0,
"Tax0Summ":0,
"TaxNaSumm":13000,
"Depth":1
},
{
"Id":"XXXXXXXXXXXXXXXXXXXXX",
"CDateUtc":"2020-10-01T04:55:58",
"Tag":3,
"IsBso":false,
"IsCorrection":false,
"OperationType":"Income",
"UserInn":"XXXXXXXXXXXXXXXXXXXXX",
"KktRegNumber":"XXXXXXXXXXXXXXXXXXXXX",
"FnNumber":"XXXXXXXXXXXXXXXXXXXXX",
"DocNumber": XXXXXXXXXXXXXXXXXXXXX,
"DocDateTime":"2020-10-01T11:50:00",
"DocShiftNumber":476,
"DecimalFiscalSign":"XXXXXXXXXXXXXXXXXXXXX",
"ReceiptNumber":"23",
"DocRawId":"0bc0dec5-6b0c-36b5-9bb6-751e99320f82",
"Items":[
{
"Name":"улитка kрем шоколад",
"Price":10000,
"Quantity":1,
"SubjectType":1,
"Total":10000,
"CalculationMethod":0,
"Barcode":"30303030303030303030303030303030"
}
],
"Nds00_TotalSumm":0,
"NdsNA_TotalSumm":10000,
"TotalSumm":10000,
"CashSumm":10000,
"ECashSumm":0,
"PrepaidSumm":0,
"CreditSumm":0,
"ProvisionSumm":0,
"TaxTotalSumm":0,
"Tax10Summ":0,
"Tax18Summ":0,
"Tax110Summ":0,
"Tax118Summ":0,
"Tax0Summ":0,
"TaxNaSumm":10000,
"Depth":1,
"Buyer_Inn": "4402163409"
}
],
"Elapsed":"00:00:00.3506406"
}
Список полей структуры ответа с описаниями параметров представлен в таблице 8.
Таблица 8. Поля данных записи с подробной информацией о чеке
Идентификатор | Формат поля | Назначение | Тег |
---|---|---|---|
Id | Строка | Строка в формате UUID Уникальный номер фискального документа в ИС, используется в запросе подробной информации по чеку, как RawId | |
CDateUtc | Дата и время в формате ISO | Дата и время приема документа в ИС | |
Tag | Целое число | Численный признак вида документа: 3 – чек, 31 – чек коррекции, 4 – бланк строгой отчетности, 41 – бланк строгой отчетности коррекции |
|
IsBso | Логическая переменная | Имеет значение true, если документ является БСО, иначе (если документ является чеком) – false | |
IsCorrection | Логическая переменная | Имеет значение true, если чек или бланк строгой отчетности (БСО) является документом коррекции, иначе – false | |
OperationType | Строка | Тип операции: «Income» – приход, «Expense» – расход, «Refund income» – возврат прихода, «Refund expense» – возврат расхода. |
|
UserInn | Строка, 10 или 12 цифр | ИНН владельца кассы | |
KktRegNumber | Строка | Регистрационный номер кассы | |
FnNumber | Строка | Номер фискального накопителя, установленного в кассу | |
DocNumber | Целое число | Фискальный номер документа | |
SubjectType | Целое число | Признак предмета расчета | 1212 |
DocDateTime | Дата и время в формате ISO | Дата и время формирования документа по данным кассы | |
DocShiftNumber | Целое число | Номер смены (по данным кассы), в которую был сформирован документ | |
DecimalFiscalSign | Строка | Фискальный признак документа | |
ReceiptNumber | Целое число | Номер документа в смене (по данным кассы) | |
DocRawId | Строка в формате UUID | Уникальный номер фискального документа в ИС, (используется в запросе подробной информации по чеку, как RawId, дублирует поле Id) | |
Items | Массив структур | Список товарных позиций в чеке | 1059 |
Name | Строка | Название товарной позиции в чеке | 1030 |
Price | Целое число | Цена в копейках за единицу измерения товарной позиции | 1079 |
Quantity | Целое число | Количество единиц товарной позиции | 1023 |
Total | Целое число | Стоимость товарной позиции в копейках | 1043 |
CalculationMethod | Целое число | Признак способа расчета | 1214 |
OriginCountryCode | Строка | Цифровой код страны происхождения товара в соответствии с Общероссийским классификатором стран мира | 1230 |
CustomDeclarationNumber | Строка | Номер таможенной декларации в соответствии с форматом, установленным решением Комиссии Таможенного союза от 20.05.2010 N 257 (в ред. 17.12.2019 N 223) «О форме декларации на товары и порядке ее заполнения» | 1231 |
Provider_Inn | Строка | ИНН поставщика | 1226 |
ProductCheckResultDetails | Число | Результаты проверки товара, подлежащий обязательной маркировке | 2106 |
ProductUnitOfMeasure | Число | Единицы измерения количества предмета расчета | 2108 |
ProductCode | Структура | Параметр может принимать одно из следующих значений, описанных в таблице 6 | 1163 |
Nds00_TotalSumm | Целое число | Сумма НДС по предмету расчета со ставкой 0% в копейках | 1104 |
NdsNA_TotalSumm | Целое число | Сумма, к которой не применяется НДС в копейках | 1105 |
TotalSumm | Целое число | Общая сумма по чеку в копейках | |
CashSumm | Целое число | Сумма по чеку (БСО) наличными в копейках | |
ECashSumm | Целое число | Сумма по чеку (БСО) электронными в копейках | |
PrepaidSumm | Целое число | Сумма по чеку (БСО) предоплатами (авансами) | |
CreditSumm | Целое число | Сумма по чеку (БСО) постоплатами (кредитами) | |
ProvisionSumm | Целое число | Сумма по чеку (БСО) встречными предоставлениями | |
TaxTotalSumm | Целое число | Общая сумма удерживаемых налогов, начисленная за смену в копейках | |
Tax10Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10 % в копейках | 1103 |
Tax18Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20 % в копейках (18% до 01.01.2019) | 1102 |
Tax110Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10/110 в копейках | 1107 |
Tax118Summ | Целое число | Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20/120 в копейках (18/118% до 01.01.2019) | 1106 |
TaxNaSumm | Целое число | Сумма по операциям, не облагаемая НДС в копейках | 1105 |
Tax0Summ | Целое число | Сумма по операциям, облагаемая НДС по ставке 0% в копейках | 1104 |
ProductCheckResult | Целое число | Результаты проверки маркированных товаров | 2107 |
Depth | Целое число | Количество товарных позиций в чеке | |
Buyer_Inn | Строка | ИНН покупателя (клиента) | 1228 |
Помимо функций управления кассами и получения информации о кассах и чеках в ИС имеется возможность обработки запросов программного интерфейса на получение информации об организации касс в структуру папок, а также о кассах, имеющих проблемы: неисправных, неоплаченных, отключенных по каким-либо другим причинам и т. д.; ниже описываются такие запросы.
Запрос на получение списка папок с ККТ, находящихся в корневом, либо в явно заданном каталоге текущего ЛКК, имеет следующий вид:
GET https://ofd.ru/api/integration/v1/kktgroup/list?AuthToken={Code}
или
GET https://ofd.ru/api/integration/v1/kktgroup/list?groupId={Id}&AuthToken={Code}
Здесь:
Id1 — идентификатор папки, список дочерних папок которой запрашивается:
Ответ на запрос имеет типовую структуру, описанную в разделе 2. Структура данных имеет формат JSON следующего вида (приведены примеры значений):
{
"Status": "Success",
"Data": [
{
"AgreementId": "1afff828-7ac1-41aa-8282-210c9ffb3df7",
"Groups": [
{
"Id": "26beff999-d454-44aa-8ada-cdc1rf8942fd",
"Name": "Все кассы",
"Path": "/Все кассы/",
"Level": 1
}
]
}
]
}
Список полей этой структуры c их описаниями представлен в таблице 9.
Таблица 9. Поля данных записи с подробной информацией о чеке
Идентификатор | Формат поля | Назначение |
---|---|---|
AgreementId | Строка в формате UUID | Идентификатор личного кабинета, для которого генерируется список каталогов 3) |
Groups | Массив структур | Массив записей с информацией о папках, в которых содержатся кассы |
Id | Строка в формате UUID | Идентификатор папки в ИС «Чеки и ККТ» |
Name | Строка | Имя папки |
Path | Строка | Путь к папке |
Level | Целое число | Уровень вложенности папки (1 — для корневого каталога, 2 — для содержимого папки в корневом каталоге, 3 — для содержимого папки в папке корневого каталога и т. п.) |
Запрос на получение данных о кассах со статусом нефункционирующих, имеет следующий вид:
GET api/integration/v1/kkt/problem/list&AuthToken={Code}
или
GET api/integration/v1/kkt/problem/list/{KKT}&AuthToken={Code}
Здесь:
{KKT} — регистрационный номер кассы.
{Code} - код авторизации.
Ответ на запрос имеет типовую структуру, описанную в разд. 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"
}
Список полей структуры с описаниями представлен в таблице 10. Если запрос произведен с указанием регистрационного номера кассы (KKT1), то массив в ответе будет состоять из одной записи.
Таблица 10. Поля данных записи с подробной информацией о чеке
Идентификатор | Формат поля | Назначение |
---|---|---|
Id | Строка в формате UUID | Идентификатор ККТ |
KktName | Строка | Название ККТ |
KktModel | Строка | Модель ККТ |
KktRegId | Строка | Регистрационный номер ККТ |
SerialNumber | Строка | Заводской номер ККТ |
FnNumber | Строка | Номер фискального накопителя ККТ |
CreateDate | Строка, содержащая дату | Дата и время внесения информации о ККТ |
PaymentDate | Строка, содержащая дату | Дата и время последнего платежа за обслуживание данного ККТ |
CheckDate | Строка, содержащая дату | Дата подписания КЭП (квалификационной электронной подписью) |
ActivationDate | Строка, содержащая дату | Дата и время активации ККТ |
ContractStartDate | Строка, содержащая дату | Дата и время начала действия контракта по предоставлению услуг ОФД для данного ККТ |
ContractEndDate | Строка, содержащая дату | Дата и время окончания контракта по предоставлению услуг ОФД для данного ККТ |
FirstDocumentDate | Строка, содержащая дату | Дата и время генерации кассой первого фискального документа |
LastDocumentDate | Строка, содержащая дату | Дата и время генерации кассой последнего фискального документа |
FiscalAddress | Строка | Адрес установки кассы |
FiscalPlace | Строка | Место установки кассы |
GroupId | Строка в формате UUID | Идентификатор папки, в которой находится касса в ЛКК |
Path | Строка | Путь к папке, в которой находится касса в ЛКК |
Status | Строка | Статус кассы (обозначение) |
StatusMessage | Строка | Статус кассы (полное название) |
Версия 1.3
Выпущена 11 октября 2017 г.
Первая отслеживаемая версия документа.
Версия 1.31
Выпущена 26 января 2018 г.
Версия 1.32
Выпущена 7 февраля 2018 г.
Версия 1.33
Выпущена 15 марта 2018 г.
Добавлена дополнительная форма запроса данных смены и чека.
Версия 1.34
Выпущена 24 мая 2018 г.
Добавлены дополнительные поля в запросе данных чека.
Версия 1.4
Выпущена 16 июля 2018 г.
Версия 1.5
Выпущена 24.08.2018
Версия 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.91
Выпущена 14 мая 2019 г.
В ответ на запрос информации о ККТ был добавлен параметр с названием кассы.
Версия 1.92
Выпущена 09 июля 2020 г.
Обновлен список параметров для метода «Запрос списка отчетов по смене для заданной кассы за заданный период».
Версия 1.93
Выпущена 03 августа 2020 г.
Версия 1.94
Выпущена 04 сентября 2020 г.
Изменена ставка НДС с 18% на 20% в таблицах 2 и 3.
Версия 1.95
Выпущена 23 сентября 2020 г.
Устранены мелкие недочеты по всему объему документа.
Версия 1.96
Выпущена 18 ноября 2020 г.
Добавлен раздел 2.8 Список чеков по кассе с подробной информацией по чеку
Версия 1.97
Выпущена 24 ноября 2020 г.
В разделе 2.8 добавлен фильтр по ККТ и скорректирован фильтр по дате времени.
Версия 1.98
Выпущена 10 февраля 2021 г.
В пункте 2.8 исправлен формат запроса
Версия 1.99
Выпущена 24 марта 2021 г.
В пункте 2.8 исправлен формат запроса
Версия 2.00
Выпущена 08 октября 2021 г.