Renta

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

Введение
1. Общий вид запроса и ответа в процессе использования API
2. Авторизация через AuthToken
3. Описание работы с API ИС «Renta»
Термины и определения, применяемые в пользовательской документации программных продуктов оператора “OFD.ru”
Использованные сокращения
История изменений

Введение

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

1. Общий вид запроса и ответа в процессе использования API

Для работы API ИС “Renta” в запросах и ответах используется кодировка UTF-8. Запросы выполняются методом GET. Параметры передаются в строке запроса.
Ответы выдаются сервером в формате JSON и, в случае успешного ответа согласно его заголовку (код ответа по протоколу HTTP равен 200), данные имеют следующий обобщенный вид:

{
    "Status": "Success",
    "Data": {}
}

Получаем параметры ответа с кодом 200:

Параметр «Status» – состояние обработки запроса;
Параметр «Data» - данные ответа на запрос.

В случае ответа с ошибкой (код ответа по протоколу HTTP не равен 200) ответ имеет следующий вид:

{
    "Status": "Failed",
    "Error": {
        Code: 0,
        Message: "string"
    }
}

В ответе с кодом, не равным 200, могут быть следующие параметры со значениями:

«Status» - «Failed» (обработка запроса не удалась);
«Error» - код ошибки и сообщение об ошибке.
- «Code» - значение не равно 0;
- «Message» - значение выводится в формате String. В значении выводится сообщение с описанием ошибки.

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

Внимание! Доступ к API ИС «Renta» доступен только для аккаунта, указанного первым при прохождении процедуры регистрации ЛК «Renta».
Чтобы неоднократно обращаться к API ИС «Renta» без использования механизма Cookies, вам необходимо воспользоваться методом получения AuthToken. Метод AuthToken - это метод авторизация в OFD.ru с передачей имени и пароля, а также получения кода авторизации для использования в запросах API ИС «Renta». Успешным ответом является возвращение кода авторизации.
Код авторизации - это значение авторизации для обращения к личному кабинету (ЛК).

Вид запроса:

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

Тело запроса представляет собой структуру JSON.

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

POST https://ofd.ru/api/Authorization/CreateAuthToken
Content-Type: application/json

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

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

Login;
Password.

Значения параметров передаются в JSON-структуре внутри запроса.
Ваш логин и пароль от ЛКК OFD.ru являются значениями для запроса получения кода авторизации.

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

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

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

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

Полученный код авторизации необходим в запросах в виде дополнительного параметра. Код авторизации необходим в запросах для обращения к ЛКК.

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


POST https://ofd.ru/api/integration/v1/kkt/registration?AuthToken={Code}

Code – действующий код авторизации.

3. Описание работы с API ИС «Renta»

В инструкции представлено описание запросов, методы вызова, описание параметров запроса и ответа.

3.1. Описание запроса на получение списка чеков по кассе или юридическому лицу за период

Запрос на получение списка чеков за период выполняется по регистрационному номеру касс или по ИНН юридического лица.

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

GET https://ofd.ru/api/renta/v1/kkt/{KKT}/receipts/{DateFrom}/{DateTo}/{rentaInn}/{rentaKpp}?AuthToken={Code}

Запрос на получение списка чеков за период по ИНН юридического лица имеет вид:

GET https://ofd.ru/api/renta/v1/inn/{INN}/receipts/{DateFrom}/{DateTo}/{rentaInn}/{rentaKpp}?AuthToken={Code}

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

INN – ИНН арендатора (владельца кассы);
KKT – регистрационный номер машины (РНМ арендатора);
DateFrom - дата начала периода для получения списка чеков³⁾;
DateTo – дата конца периода для получения списка чеков⁴⁾ Разница DateTo и DateFrom не должна превышать 7 дней;
Code – действующий код авторизации, полученный в результате запроса авторизации;
rentaInn - ИНН арендодателя (параметр для запроса не обязателен. Требуется в случае, если у вас зарегистрировано несколько ЛК Renta);
rentaKpp - КПП арендодателя (параметр для запроса не обязателен. Требуется в случае, если у вас зарегистрировано несколько ЛК Renta).

Пример запроса на получение списка чеков за период по регистрационному номеру кассы:

GET https://ofd.ru/api/renta/v1/kkt/0004863624013100/receipts/2021-11-25/2021-11-28/7801413120/780101003?AuthToken=3979285efc5f44e3a81c728e4c1059f2

Пример запроса на получение списка чеков за период по ИНН юридического лица:

GET https://ofd.ru/api/renta/v1/inn/032304736950/receipts/2021-11-25/2021-11-28/7801413120/780101003?AuthToken=3979285efc5f44e3a81c728e4c1059f2

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

{
  "Status": "Success",
  "Data": [
    {
      "Id": "3a6e3b83-a0b0-4587-bfb3-1b7539b05cf3",
      "IsCorrection": false,
      "CDateUtc": "2016-07-26T09:32:41",
      "Tag": 0,
      "IsBso": false,
      "OperationType": "Income",
      "UserInn": "7802870820",
      "KktAddress": "142000, МО, г. Домодедово, Каширское шоссе, 63",
      "SerialNumber": "44444444444443421132",
      "KktRegNumber": "111222333",
      "FnNumber": "99990789388",
      "DocDateTime": "2016-07-26T12:32:00",
      "TotalSumm": 51360,
      "CashSumm": 51360,
      "ECashSumm": 0,
      "CreditSumm": 0,
      "PrepaidSumm": 0,
      "TaxTotalSumm": 0,
      "Tax10Summ": 0,
      "Tax18Summ": 0,
      "Tax110Summ": 0,
      "Tax118Summ": 0,
      "Tax0Summ": 0,
      "TaxNaSumm": 0,
      "Depth": 3
    }
  ]
}

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

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

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

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

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

3.2. Описание запроса на получение полной информации по чеку

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

GET https://ofd.ru/api/renta/v1/receipt/{Id}/{rentaInn}/{rentaKpp}?AuthToken={Code}

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

Id – идентификатор чека. Получить Id чека можно с помощью запроса на получение списка чеков (см. п. на получение списка чеков);
Code – действующий код авторизации, полученный в результате запроса авторизации;
rentaInn - ИНН арендодателя (параметр для запроса не обязателен. Требуется в случае, если у вас зарегистрировано несколько ЛК Renta);
rentaKpp - КПП арендодателя (параметр для запроса не обязателен. Требуется в случае, если у вас зарегистрировано несколько ЛК Renta).

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

https://ofd.ru/api/renta/v1/receipt/c9a65e37-ebae-d7a9-a18a-16a104f79731/7801413122/780101001?AuthToken=3979285efc5f44e3a81c728e4c1059f2

Пример успешного ответа на запрос имеет вид следующей JSON-структуры:

{
  "Status": "Success",
  "Data": {
    "Id": "3a6e3b83-a0b0-4587-bfb3-1b7539b05",
    "IsCorrection": false,
    "IsBso": false,
    "OperationType": "Income",
    "UserInn": "0123456789",
    "UserName": "ООО \"Компания и КО\"",
    "KktAddress": "105064,г.Москва,ул.Московская,д.111",
    "SerialNumber": "01234560087654321",
    "kktRegNumber": "0000123456789012",
    "FnNumber": "4321000100012345",
    "Items": [
      {
        "Name": "Брюки Размер-38-34",
        "CustomName": "Брюки Размер-38-34",
        "Price": 349500,
        "NomenFullName":string,
        "NomenSerialNumber":string,
        "Quantity": 1,
        "Total": 349500,
        "CalculationMethod": 4,
        "SubjectType": 1,
        "NDS_Rate": 1,
        "NDS_Summ": 58250
      }
    ],
    "DocDateTime": "2016-07-26T09:32:41",
    "TotalSumm": 349500,
    "CashSumm": 0,
    "ECashSumm": 349500,
    "CreditSumm": 0,
    "PrepaidSumm": 0,
    "TaxTotalSumm": 58250,
    "Tax10Summ": 0,
    "Tax18Summ": 58250
  },
}

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

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

Параметр	Вложенный параметр	Вид значения	Описание
Id		String¹⁰⁾	Уникальный номер фискального документа в ИС
IsCorrection		Boolean	Признак чека коррекции. Параметр принимает следующие значения:
			true - чек или бланк строгой отчетности (БСО) является документом коррекции;
			false - чек или бланк строгой отчетности (БСО) не является документом коррекции.
IsBso		Boolean	Признак бланк строгой отчетности (БСО) принимает следующие значения:
			true - документ является бланком строгой отчетности (БСО);
			false - документ не является бланком строгой отчетности (БСО).
OperationType		String	Тип операции:
			«Income» – приход;
			«Expense» – расход;
			«Refund income» – возврат прихода;
			«Refund expense» – возврат расхода.
UserInn		String	ИНН юридического лица
UserName		String	Название юридического лица
KktAddress		String	Место установки кассы
SerialNumber		String	Заводской номер кассы
kktRegNumber		String	Регистрационный номер кассы
FnNumber		String	Номер фискального накопителя, установленного в кассу
Items		Object	Информация о проданном товаре
	Name	String	Название товара по чеку
	CustomName	String	Название товара из кастомного справочника пользователя, если справочник был загружен пользователем
	Price	Integer	Цена с НДС
	NomenFullName	String	Дополнительно название номенклатуры
	NomenSerialNumber	String	Код номенклатуры
	Quantity	Integer	Количество товара в товарной позиции
	Total	Integer	Стоимость товарной позиции в копейках
	CalculationMethod	Integer	Признак способа расчета Может принимать следующие значения
			1 – предоплата 100%;
			2 – предоплата;
			3 – аванс;
			4 – полный расчет;
			5 – частичный расчет;
			6 – передача в кредит;
			7 – оплата в кредит.
	SubjectType	Integer	Признак предмета расчета. Возможные значения представлены в разделе 3.2.1.
	NDS_Rate	Integer	Ставка НДС принимает значения:
			1 - НДС 20%¹¹⁾;
			2 - НДС 10%;
			3 - НДС 20/120¹²⁾;
			4 - НДС 10/110;
			5 - НДС 0%;
			6 - НДС не облагается.
	NDS_Summ	Integer	Общая сумма НДС в копейках
DocDateTime		String	Дата и время¹³⁾ формирования документа по данным кассы
TotalSumm		Integer	Общая сумма по чеку в копейках
CashSumm		Integer	Сумма по чеку (БСО) наличными в копейках
ECashSumm		Integer	Сумма по чеку (БСО) электронными в копейках
CreditSumm		Integer	Сумма по чеку (БСО) постоплатами (кредитами)
PrepaidSumm		Integer	Сумма по чеку (БСО) предоплатами (авансами)
TaxTotalSumm		Integer	Общая сумма удерживаемых налогов, начисленная за смену в копейках
Tax10Summ		Integer	Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10 %, начисленная за смену в копейках
Tax18Summ		Integer	Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20%, начисленная за смену в копейках ¹⁴⁾
Tax110Summ		Integer	Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10/110, начисленная за смену в копейках
Tax118Summ		Integer	Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20/120, начисленная за смену в копейках ¹⁵⁾
TaxNaSumm		Integer	Сумма по операциям, не облагаемая НДС, накопленная за смену в копейках
Tax0Summ		Integer	Сумма по операциям, облагаемая НДС по ставке 0%, накопленная за смену в копейках

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

Need to add INN and KPP - в запросе необходимо добавить параметры ИНН и КПП ЛК «Renta»;
RentaNotFound - не найден ЛК «Renta»;
AccessDenied - доступ запрещен, арендатор ограничил выдачу данных в соответствии с выданным распоряжением;
DataNotFound - данные не найдены.

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

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

3.3. Описание запрос на получение списка юридических лиц подключенных к ИС “Renta”

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

GET https://ofd.ru/api/renta/v1/legal-entities/{rentaInn}/{rentaKpp}?AuthToken=Code

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

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

Пример запроса на получение сведений о юридических лицах имеет вид:

https://ofd.ru/api/renta/v1/legal-entities/7801413120/780101003?AuthToken=3979285efc5f44e3a81c728e4c1059f2

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

{
  "Status": "Success",
  "Data": [
    {
      "UserInn": "7802870820",
      "UserKpp": "780901001",
      "UserName": "ООО \"НАДЕЖДА\"",
      "KktRergistered": 20,
      "KktOnline": 14
    }
  ]
}

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

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

Параметр	Вид значения	Описание
UserInn	String	ИНН юридического лица, подключившего свои кассы в текущем ЛК “Renta”
UserKpp	String	КПП юридического лица, подключившего свои кассы в текущем ЛК “Renta”
UserName	String	Название юридического лица или имя ИП, подключившего свои кассы в текущем ЛК “Renta”
KktRegistered	integer	Количество касс, зарегистрированных у данного юридического лица
KktOnline	integer	Количество касс, зарегистрированных у данного юридического лица, работающих в текущий момент

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

Need to add INN and KPP - в запросе необходимо добавить параметры ИНН и КПП ЛК «Renta»;
RentaNotFound - не найден ЛК «Renta»;
AccessDenied - доступ запрещен, арендатор ограничил выдачу данных в соответствии с выданным распоряжением.

3.4. Описание запроса на получение сведений о кассах подключенных к ИС "Renta"

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

GET https://ofd.ru/api/renta/v1/kkts/rentaInn/{rentaInn}/rentaKpp/{rentaKpp}/{INN}?AuthToken=Code

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

GET https://ofd.ru/api/renta/v1/kkts?AuthToken=Code1

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

INN – ИНН арендатора (владельца кассы);
KKT – регистрационный номер машины (РНМ арендатора);
Code – действующий код авторизации, полученный в результате запроса авторизации;
rentaInn - ИНН арендодателя (параметр для запроса не обязателен. Требуется в случае, если у вас зарегистрировано несколько ЛК Renta);
rentaKpp - КПП арендодателя (параметр для запроса не обязателен. Требуется в случае, если у вас зарегистрировано несколько ЛК Renta).

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


GET https://ofd.ru/api/renta/v1/kkts/rentaInn/7801413120/rentaKpp/780101003/032304736950?AuthToken=3979285efc5f44e3a81c728e4c1059f2

Пример запроса без параметра INN:

GET https://ofd.ru/api/renta/v1/kkts/rentaInn/7801413120/rentaKpp/780101003?AuthToken=3979285efc5f44e3a81c728e4c1059f2

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

{
  "Status": "Success",
  "Data": [
    {
      "UserInn": "7802870820",
      "UserKpp": "780901001",
      "UserName": "ООО \"НАДЕЖДА\"",
      "KktAdress": "МО, г. Домодедово, Каширское шоссе, 68",
      "KktPlace": "Торговый зал № 2",
      "KktSerialNumber": "111222333444",
      "KktRegNumber": "111222333",
      "FnNumber": "99990789388",
      "Rnm": "0004727371036889",
      "DateFrom": "2023-03-20T00:00:00",
      "DateTo": "2023-03-21T23:59:00",
      "AvailableReports": [
          "KktWorkingTime",
          "KktOperations",
          "KktReceipts",
          "NomenclatureSales"
      ]
    }
  ]
}

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

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

Параметр	Вид значения	Описание
UserInn	String	ИНН юридического лица, зарегистрированного в текущем ЛК “Renta”
UserKpp	String	КПП юридического лица, зарегистрированного в текущем ЛК “Renta”
UserName	String	Название юридического лица или имя ИП, зарегистрированного в текущем ЛК “Renta”
KktAddress	String	Адрес установки кассы
KktPlace	String	Зарегистрированное название места установки кассы
KktSerialNumber	String	Заводской номер кассы
KktRegNumber	String	Регистрационный номер кассы
FnNumber	String	Номер фискального накопителя кассы
Rnm	String	Регистрационный номер кассы
DateFrom	String	Дата начала периода действий распоряжений по ККТ. Значения содержат дату и время в формате ISO
DateTo	String	Дата окончания периода действий распоряжений по ККТ. Значения содержат дату и время в формате ISO
AvailableReports	Array	Доступные отчеты Представлен полный список возможных отчетов:
		KktWorkingTime - Время работы касс;
		KktOperations - Операции по кассам (приход/возврат);
		KktReceipts - Чеки (сверка);
		NomenclatureSales - Продажи по номенклатуре;
		KktOracleReceipts - Чеки (сверка) из Оракл;
		UnaccountedRevenue - Неучтенная выручка;
		KktMonitoring - Мониторинг передачи данных;
		RentaForTenantReport - Отчет для арендатора Renta;
		RentaCloseShiftReport - Отчет по сменам для клиентов Renta (арендодателей)

Разница между значениями DateTo и DateFrom не должна превышать 7 дней.

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

InnNotFound - для учетной записи не найдена организация;
Need to add INN and KPP - в запросе необходимо добавить параметры ИНН и КПП ЛК «Renta»;
RentaNotFound - не найден ЛК «Renta»;
AccessDenied - доступ запрещен, арендатор ограничил выдачу данных в соответствии с выданным распоряжением.

3.5. Описание запроса на получение агрегированных данных за период

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

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

GET https://ofd.ru/api/renta/v1/kkt-full-data?DateFrom={DateFrom}&DateTo={DateTo}&Rnms={Rnms}&AuthToken={Code}&RentaInn={rentaInn}&RentaKpp={rentaKpp}

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

GET https://ofd.ru/api/renta/v1/kkt-full-data?DateFrom={DateFrom}&DateTo={DateTo}&Rnms={Rnms}&Rnms={Rnms}&Rnms={Rnms}&...&AuthToken={Code}&RentaInn={rentaInn}&RentaKpp={rentaKpp}

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

Rnms – регистрационный номер машины (РНМ арендатора);
DateFrom - дата начала периода для получения списка чеков¹⁶⁾;
DateTo – дата конца периода для получения списка чеков¹⁷⁾ Разница DateTo и DateFrom не должна превышать 7 дней;
Code – действующий код авторизации, полученный в результате запроса авторизации;
rentaInn - ИНН арендодателя (параметр для запроса не обязателен. Требуется в случае, если у вас зарегистрировано несколько ЛК Renta);
rentaKpp - КПП арендодателя (параметр для запроса не обязателен. Требуется в случае, если у вас зарегистрировано несколько ЛК Renta).

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

GET https://ofd.ru/api/renta/v1/kkt-full-data?DateFrom=2021-11-25&DateTo=2021-11-27&Rnms=0004863624013100&AuthToken=4dcfdf59134e4d16b5ea48508186f5e0&RentaInn=7801413120&RentaKpp=780101006

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

{
  "Status": "Success",
  "Data": [
    {
      "name": "ООО \"КОЛБАСНЫЙ ЦЕХ А\"",
      "inn": "7716872968",
      "rnm": "0004321088009033",
      "zn": "00106900125570",
      "incomeSumm": 12948411.73,
      "incomeCount": 4310,
      "cashlessIncomeCount": 4306,
      "cashIncomeCount": 9,
      "prepaidIncomeCount": 0,
      "creditIncomeCount": 0,
      "corIncomeCount": 0,
      "cashIncomeSumm": 18217,
      "cashlessIncomeSumm": 12930194.73,
      "prepaidIncomeSumm": 0,
      "creditIncomeSumm": 0,
      "refundIncomeSumm": 0,
      "refundIncomecount": 0,
      "correRundIncomecount": 0,
      "refundCashIncomeSumm": 0,
      "refundCashlessIncomeSumm": 0,
      "refundPrepaidIncomeSumm": 0,
      "refundCreditIncomeSumm": 0,
      "nds20": 2158068.6,
      "nds10": 0,
      "nds00": 0,
      "ndsNot": 0,
      "nds20_120": 0,
      "nds10_110": 0,
      "ndsAll": 2158068.6,
      "expenseSumm": 0,
      "refundExpenseSumm": 0,
      "storeInfo": {
        "storeId": "91b8f2d3-95fd-7d67-e055-f52432649acd",
        "storeName": "Ресторан \"Магадан\"",
        "brand": "Ресторан \"Магадан\"",
        "uDate": "2021-05-27T16:00:59",
        "categories": [
          {
            "categoryId": "91b8dfa7-85d3-925f-e055-f52432649acd",
            "categoryName": "Терминал",
            "categoryValues": [
              {
                "Id": "91b8f2d3-94d8-7d67-e055-f52432649acd",
                "Value": "B"
              }
            ]
          },
          {
            "categoryId": "91b8dfa7-85d7-925f-e055-f52432649acd",
            "categoryName": "Формат",
            "categoryValues": [
              {
                "Id": "91b94844-cfb0-b6dd-e055-f52432649acd",
                "Value": "Общепит - Ресторан"
              }
            ]
          },
          {
            "categoryId": "c34fc11b-bdac-7fc8-e055-b2262856b0f2",
            "categoryName": "Вид деятельности",
            "categoryValues": [
              {
                "Id": "c34fc11b-bdad-7fc8-e055-b2262856b0f2",
                "Value": "Общепит"
              }
            ]
          }
        ]
      },
      "restrInfo": {
        "restrCode": "411180001",
        "orderDiffSumm": 388963.81,
        "preorderSumm": 10655942.3,
        "deletedSumm": 0,
        "discountedSumm": 375933.81,
        "cancelledSumm": 0,
        "ordersNdsSumm": 0,
        "preorderCount": 3393
      },
      "uniqueItemsCount": 3278,
      "itemsQtySumm": 21476.23
    }
  ],
  "Elapsed": "00:00:03.4243016"
}

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

Таблица 5. Описание параметров ответа на запрос агрегированных данных за период

Параметр	Вложенный параметр	Вид значения	Описание
name		String	Наименование организации
inn		String	ИНН организации
rnm		String	Регистрационный номер кассы
zn		String	Заводской (серийный) номер кассы
incomeSumm		Integer	Сумма прихода, руб.
incomeCount		Integer	Количество чеков прихода, шт.
cashlessIncomeCount		Integer	Кол-во чеков прихода безналичными, шт.
cashIncomeCount		Integer	Кол-во чеков прихода наличными, шт.
prepaidIncomeCount		Integer	Кол-во чеков прихода аванс, шт.
creditIncomeCount		Integer	Кол-во чеков прихода в кредит, шт.
corIncomeCount		Integer	Кол-во чеков коррекции приход, шт.
cashIncomeSumm		Integer	Сумма прихода наличными, руб.
cashlessIncomeSumm		Integer	Сумма прихода безналичными, руб.
prepaidIncomeSumm		Integer	Сумма прихода аванс, руб.
creditIncomeSumm		Integer	Сумма прихода в кредит, руб.
refundIncomeSumm		Integer	Сумма возвратов, руб.
refundIncomecount		Integer	Количество чеков возврата, шт.
correRundIncomecount		Integer	Количество чеков коррекции возврата, шт.
refundCashIncomeSumm		Integer	Возврат прихода наличными, руб.
refundCashlessIncomeSumm		Integer	Возврат прихода безналичными, руб.
refundPrepaidIncomeSumm		Integer	Возврат аванса, руб.
refundCreditIncomeSumm		Integer	Возврат кредита, руб.
nds20		Integer	НДС 20%
nds10		Integer	НДС 10%
nds00		Integer	НДС 0%
ndsNot		Integer	НДС не облагается
nds20_120		Integer	НДС 20/120
nds10_110		Integer	НДС 10/110
ndsAll		Integer	Общая сумма НДС в копейках, руб.
expenseSumm		Integer	Сумма расхода, руб.
refundExpenseSumm		Integer	Возврат расхода, руб.
storeInfo		Object	Торговая точка
	storeId	String	Идентификатор торговой точки
	storeName	String	Название торговой точки
	brand	String	Название торговой сети
	uDate	String	Дата последнего изменения и обновления данных
	categories	Array	Категория торговой точки
restrInfo		Object	Информация о ресторане
	restrCode	String	Код ресторана
	orderDiffSumm	Integer	Расхождение суммы по чеку, руб.
	preorderSumm	Integer	Общая сумма пречеков (с НДС), руб.
	deletedSumm	Integer	Удаления блюд, руб.
	discountedSumm	Integer	Скидки, руб.
	cancelledSumm	Integer	Отмены, руб.
	ordersNdsSumm	Integer	Сумма НДС по пречекам, руб.
	preorderCount	Integer	Количество пречеков, шт.
uniqueItemsCount		Integer	Количество товаров (суммарное количество проданных товаров), шт.
itemsQtySumm		Integer	Количество позиций в чеках (номенклатуры), шт.

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

UserAccountNotFound - не найден пользователь;
IncorrectDateSpan - некорректная дата;
ValidationError - в запросе отсутствуют значения РНМ и ККТ;
Need to add INN and KPP - в запросе необходимо добавить параметры ИНН и КПП ЛК «Renta».

3.6. Описание запроса на получение данных за смену по кассе

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

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

GET https://ofd.ru/api/renta/v1/shift-list?authToken={Code}&dateFrom={DateFrom}&dateTo={DateTo}&kktRegNumber={Rnms}&rentaInn={rentaInn}&rentaKpp={rentaKpp}&accounting={account}

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

Rnms – регистрационный номер машины (РНМ арендатора);
DateFrom - дата начала периода для получения списка чеков¹⁸⁾;
DateTo – дата конца периода для получения списка чеков¹⁹⁾ Разница DateTo и DateFrom не должна превышать 7 дней;
Code – действующий код авторизации, полученный в результате запроса авторизации;
rentaInn - ИНН арендодателя (параметр для запроса не обязателен, требуется в случае если у вас зарегистрировано несколько ЛК Renta);
rentaKpp - КПП арендодателя (параметр для запроса не обязателен, требуется в случае если у вас зарегистрировано несколько ЛК Renta);
account - признак смены. Параметр может принимать следующие значения:
- byOpen - Открытая смена;
- byClose - Закрытая смена.

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

GET https://ofd.ru/api/renta/v1/shift-list?authToken=7a46401dc55f4f3cbefd4a06bce981ae&dateFrom=2022-04-01&dateTo=2022-04-15&kktRegNumber=0001871008008840&accounting=byOpen

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

{
    "Status": "Success",
    "Data": [
        {
            "Id": "422ea476-3564-4e89-8546-2f0214c0aa5d",
            "Open_CDateUtc": "2022-04-01T04:31:00",
            "Close_CDateUtc": "2022-04-02T02:55:00",
            "UserInn": "7716872968",
            "KktRegNumber": "0004321088009033",
            "FnNumber": "9960440300281635",
            "ShiftNumber": 395,
            "Operator": "Лютов Кирилл",
            "Open_DocNumber": 147086,
            "Open_DocDateTime": "2022-04-01T04:31:00",
            "Open_DocRawId": "963c653a-e0d7-51ef-cd2a-341403f5963a",
            "Close_DocNumber": 147520,
            "Close_DocDateTime": "2022-04-02T02:55:00",
            "Close_DocRawId": "422ea476-3564-4e89-8546-2f0214c0aa5d",
            "IncomeSumm": 1172649720,
            "IncomeCashSumm": 4398280,
            "IncomeECashSumm": 1168251440,
            "AdvanceSumm": 0,
            "CreditSumm": 0,
            "ExchangeSumm": 0,
            "IncomeCount": 1870,
            "IncomeCountCash": 13,
            "IncomeCountECash": 1864,
            "IncomeCountCredit": 0,
            "IncomeCountPrepaid": 0,
            "RefundIncomeSumm": 0,
            "RefundIncomeCashSumm": 0,
            "RefundAdvanceSumm": 0,
            "RefundCreditSumm": 0,
            "RefundExchangeSumm": 0,
            "RefundIncomeCount": 0,
            "ExpenseSumm": 0,
            "ExpenseCount": 0,
            "RefundExpenseSumm": 0,
            "RefundExpenseCount": 0,
            "TaxTotalSumm": 195441647,
            "Tax10Summ": 0,
            "Tax18Summ": 0,
            "Tax110Summ": 0,
            "Tax118Summ": 0,
            "TaxNaSumm": 0,
            "Tax0Summ": 0,
            "CorrrectionCount": 0,
            "PaymentPlace": "Ресторан"
        },
        {
            "Id": "486cf312-b952-c879-5be9-043a8394191e",
            "Open_CDateUtc": "2022-04-02T04:30:00",
            "Close_CDateUtc": "2022-04-03T02:59:00",
            "UserInn": "7716872968",
            "KktRegNumber": "0004321088009033",
            "FnNumber": "9960440300281635",
            "ShiftNumber": 396,
            "Operator": "Кассир 3350",
            "Open_DocNumber": 147521,
            "Open_DocDateTime": "2022-04-02T04:30:00",
            "Open_DocRawId": "850de908-19e2-79ee-cb16-b90b66c5dcac",
            "Close_DocNumber": 147832,
            "Close_DocDateTime": "2022-04-03T02:59:00",
            "Close_DocRawId": "486cf312-b952-c879-5be9-043a8394191e",
            "IncomeSumm": 779465800,
            "IncomeCashSumm": 0,
            "IncomeECashSumm": 779465800,
            "AdvanceSumm": 0,
            "CreditSumm": 0,
            "ExchangeSumm": 0,
            "IncomeCount": 1429,
            "IncomeCountCash": 0,
            "IncomeCountECash": 1429,
            "IncomeCountCredit": 0,
            "IncomeCountPrepaid": 0,
            "RefundIncomeSumm": 0,
            "RefundIncomeCashSumm": 0,
            "RefundAdvanceSumm": 0,
            "RefundCreditSumm": 0,
            "RefundExchangeSumm": 0,
            "RefundIncomeCount": 0,
            "ExpenseSumm": 0,
            "ExpenseCount": 0,
            "RefundExpenseSumm": 0,
            "RefundExpenseCount": 0,
            "TaxTotalSumm": 129910967,
            "Tax10Summ": 0,
            "Tax18Summ": 0,
            "Tax110Summ": 0,
            "Tax118Summ": 0,
            "TaxNaSumm": 0,
            "Tax0Summ": 0,
            "CorrrectionCount": 0,
            "PaymentPlace": "Ресторан"
        },
      ...
        {
            "Id": "a9f9f63a-0f59-03c9-cf82-62ec9f25c22c",
            "Open_CDateUtc": "2022-04-14T05:11:00",
            "Close_CDateUtc": "2022-04-15T02:55:00",
            "UserInn": "7716872968",
            "KktRegNumber": "0004321088009033",
            "FnNumber": "9960440300281635",
            "ShiftNumber": 408,
            "Operator": "Кассир 3350",
            "Open_DocNumber": 151441,
            "Open_DocDateTime": "2022-04-14T05:11:00",
            "Open_DocRawId": "56e6b169-c2ea-b941-bbe3-d3fb903f0c20",
            "Close_DocNumber": 151880,
            "Close_DocDateTime": "2022-04-15T02:55:00",
            "Close_DocRawId": "a9f9f63a-0f59-03c9-cf82-62ec9f25c22c",
            "IncomeSumm": 967734910,
            "IncomeCashSumm": 5884000,
            "IncomeECashSumm": 961850910,
            "AdvanceSumm": 0,
            "CreditSumm": 0,
            "ExchangeSumm": 0,
            "IncomeCount": 1906,
            "IncomeCountCash": 34,
            "IncomeCountECash": 1893,
            "IncomeCountCredit": 0,
            "IncomeCountPrepaid": 0,
            "RefundIncomeSumm": 0,
            "RefundIncomeCashSumm": 0,
            "RefundAdvanceSumm": 0,
            "RefundCreditSumm": 0,
            "RefundExchangeSumm": 0,
            "RefundIncomeCount": 0,
            "ExpenseSumm": 0,
            "ExpenseCount": 0,
            "RefundExpenseSumm": 0,
            "RefundExpenseCount": 0,
            "TaxTotalSumm": 161289107,
            "Tax10Summ": 0,
            "Tax18Summ": 0,
            "Tax110Summ": 0,
            "Tax118Summ": 0,
            "TaxNaSumm": 0,
            "Tax0Summ": 0,
            "CorrrectionCount": 0,
            "PaymentPlace": "Ресторан"
        }
    ],
    "Elapsed": "00:00:05.1566284"
}

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

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

Параметр	Вид значения	Описание
Id	String²⁰⁾	Идентификатор смены
Open_CDateUtc	String	Дата и время²¹⁾ отчета об открытии смены
Close_CDateUtc	String	Дата и время²²⁾ отчета о закрытии смены
UserInn	String	ИНН владельца кассы
KktRegNumber	String	Регистрационный номер кассы
FnNumber	String	Номер фискального накопителя, установленного в кассу
ShiftNumber	String	Номер смены по данным кассы
Operator	String	Фамилия, имя, отчество оператора
Open_DocNumber	Integer	Фискальный номер документа отчета об открытии смены, присвоенный кассой (уникальный в рамках текущего фискального режима)
Open_DocDateTime	String	Дата и время²³⁾ формирования отчета об открытии смены по данным кассы
Open_DocRawId	String²⁴⁾	Идентификатор документа отчета об открытии смены, полученного от кассы
Close_DocNumber	Integer	Фискальный номер документа отчета о закрытии смены, присвоенный кассой (уникальный в рамках текущего фискального режима)
Close_DocDateTime	String	Дата и время²⁵⁾ формирования отчета о закрытии смены по данным кассы
Close_DocRawId	String²⁶⁾	Идентификатор документа отчета о закрытии смены, полученного от кассы
IncomeSumm	Integer	Сумма полученных денежных средств за смену в копейках
IncomeCashSumm	Integer	Сумма полученных денежных средств за смену наличными в копейках
IncomeECashSumm	Integer	Сумма полученных денежных средств за смену безналичными в копейках
AdvanceSumm	Integer	Сумма полученных денежных средств авансом в копейках
CreditSumm	Integer	Сумма полученных денежных средств кредита в копейках
ExchangeSumm	Integer	Сумма полученных денежных средств обмена в копейках
IncomeCount	Integer	Количество чеков, выданных за смену, соответствующих получению суммы IncomeSumm
IncomeCountCash	Integer	Количество чеков с признаком расчета наличным способом
IncomeCountECash	Integer	Количество чеков с признаком расчета безналичным способом
IncomeCountCredit	Integer	Количество чеков с признаком расчета в кредит
IncomeCountPrepaid	Integer	Количество чеков с признаком расчета аванс
RefundIncomeSumm	Integer	Сумма выданных (возвращённых) денежных средств за смену в копейках
RefundIncomeCashSumm	Integer	Сумма выданных (возвращенных) денежных средств за смену наличными в копейках
RefundAdvanceSumm	Integer	Сумма возврата аванса
RefundCreditSumm	Integer	Сумма возврата кредита
RefundExchangeSumm	Integer	Сумма возврата обмена
RefundIncomeCount	Integer	Количество чеков, выданных за смену, соответствующих возврату суммы RefundIncomeSumm
ExpenseSumm	Integer	Сумма расхода за смену
ExpenseCount	Integer	Количество чеков расхода за смену
RefundExpenseSumm	Integer	Сумма возвратов расхода за смену
RefundExpenseCount	Integer	Количество чеков возврата прихода за смену
TaxTotalSumm	Integer	Общая сумма удерживаемых налогов, начисленная за смену в копейках
Tax10Summ	Integer	Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10 %, начисленная за смену, в копейках
Tax18Summ	Integer	Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20%, начисленная за смену в копейках ²⁷⁾
Tax110Summ	Integer	Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке 10/110, начисленная за смену, в копейках
Tax118Summ	Integer	Сумма удерживаемого налога на добавленную стоимость (НДС) по ставке в 20/120, начисленная за смену, в копейках ²⁸⁾
TaxNaSumm	Integer	Сумма по операциям, не облагаемая НДС, накопленная за смену в копейках
Tax0Summ	Integer	Сумма по операциям, облагаемая НДС по ставке 0%, накопленная за смену в копейках
CorrrectionCount	Integer	Количество чеков коррекции
PaymentPlace	String	Место расчета

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

UserAccountNotFound - не найден пользователь;
IncorrectDateSpan - некорректная дата;
ValidationError - в запросе отсутствуют значения РНМ и ККТ;
Need to add INN and KPP - в запросе необходимо добавить параметры ИНН и КПП ЛК «Renta»;
InternalError - неизвестная ошибка;
RentaAgreementNotFound - не найден пользователь по ИНН.

3.7. Описание запроса на получение списка кабинетов сервиса "Renta"

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

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

GET https://ofd.ru/api/renta/v3/companies?authToken={Code}

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

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

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

GET https://ofd.ru/api/renta/v3/companies?authToken=7a46401dc55f4f3cbefd4a06bce981ae

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

{
    "Data": [
        {
            "Id": "1c548455-538c-435b-8545-c91c30af49d5",
            "Inn": "7728115183",
            "Kpp": "503243002",
            "Name": "АО \"КРОКУС\"",
            "CreateDate": "2022-04-14T09:09:27",
            "Status": "Test",
            "DateFrom": "2022-04-14T00:00:00",
            "DateTo": "2023-01-04T00:00:00",
            "ActiveKktCount": 49,
            "ActiveRenterCount": 21,
            "AwaitingRequestCount": 0
        },
        {
            "Id": "3a07f3cf-ae70-4c09-b2e4-d985fe28ca25",
            "Inn": "5003069521",
            "Kpp": "500301001",
            "Name": "АО \"КАШИРСКИЙ МОЛЛ\"",
            "CreateDate": "2022-04-14T10:08:49",
            "Status": "Test",
            "DateFrom": "2022-04-14T00:00:00",
            "DateTo": "2023-01-04T00:00:00",
            "ActiveKktCount": 49,
            "ActiveRenterCount": 24,
            "AwaitingRequestCount": 0
        },
        {
            "Id": "f5f23db5-156c-4d6c-a171-52ba980a0e77",
            "Inn": "7728115183",
            "Kpp": "502443002",
            "Name": "АО \"КРОКУС\"",
            "CreateDate": "2022-04-14T08:19:58",
            "Status": "Test",
            "DateFrom": "2022-04-14T00:00:00",
            "DateTo": "2023-01-04T00:00:00",
            "ActiveKktCount": 74,
            "ActiveRenterCount": 32,
            "AwaitingRequestCount": 0
        },
        {
            "Id": "7764d3d7-fd57-4dc2-b7c6-adb7bae9d425",
            "Inn": "7728115183",
            "Kpp": "502403002",
            "Name": "АО \"КРОКУС\"",
            "CreateDate": "2022-04-13T16:52:24",
            "Status": "Test",
            "DateFrom": "2022-04-13T00:00:00",
            "DateTo": "2023-01-04T00:00:00",
            "ActiveKktCount": 12,
            "ActiveRenterCount": 8,
            "AwaitingRequestCount": 0
        }
    ],
    "Status": "Success"
}

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

Таблица 7. Описание параметров ответа на запрос получение списка кабинетов сервиса «Renta»

Параметр	Вложенный параметр	Вид значения	Описание
Data		Array	Массив данных со список кабинетов сервиса «Renta» (далее ЛК)
		Object
	Id	String²⁹⁾	Идентификатор ЛК
	Inn	String	Идентификационный номер налогоплательщика
	Kpp	String	Идентификационный номер
	Name	String	Наименование организации
	CreateDate	String	Дата и время³⁰⁾ создания ЛК
	Status	String	Тип кабинета ЛК Может принимать следующие значения:
			«Test» - тестовый
			«Commercial» - коммерческий
	DateFrom	String	Дата и время.³¹⁾ Период действия тестового кабинета (начало периода)
	DateTo	String	Дата и время.³²⁾ Период действия тестового кабинета (конец периода)
	ActiveKktCount	String	Количество касс с активными распоряжениями
	ActiveRenterCount	String	Количество арендаторов с активными распоряжениями
	AwaitingRequestCount	String	Количество распоряжений в статусе «Принять распоряжение»

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

UserAccountNotFound - не найден пользователь;
InternalError - неизвестная ошибка;
RentaAgreementNotFound - не найден пользователь по ИНН.

Термины и определения, применяемые в пользовательской документации программных продуктов оператора “OFD.ru”

Аутентификация — установление достоверности подключения пользователя с заданным идентификатором с целью предотвращения использования данного идентификатора другими пользователями.
Баланс — сумма денег, перечисленная оператору “OFD.ru”, не израсходованная на получение услуг оператора “OFD.RU” и доступная для их оплаты. Значение баланса отображается в интерфейсе ЛКК.
Заводской номер кассы — номер, идентифицирующий определенную кассу присвоенный заводом-изготовителем после ее изготовления и контроля, перед её реализацией (продажей, передачей, и т. п.).
Идентификация — указание информационной системе, какой именно пользователь с ней взаимодействует.
Касса — аппаратно-программное средство для автоматизации кассовых операций, учета и регистрации перемещений денежных средств и материальных ценностей, генерации и печати кассовых документов; касса также может иметь (имеет) возможность передачи данных о кассовых операциях и сопутствующих им данных в налоговые органы (таких, как ФНС) посредством операторов фискальных данных (таких, как “OFD.RU”). Также кассу можно определить, как «инструмент контроля со стороны государства за налично-денежным оборотом, полнотой и своевременностью оприходования предприятиями наличной выручки» ³³⁾.
Контрольно-кассовая техника — множество касс, множество разновидностей касс; здесь также данный термин может употребляться в значении «касса» (см. «Касса»).
Номер фискального накопителя — последовательность десятичных цифр, идентифицирующая определенный фискальный накопитель, присвоенный заводом-изготовителем после его изготовления и контроля, перед его реализацией (продажей, передачей и т.п.).
Профиль пользователя — совокупность данных о пользователе ИС.
Рабочее поле — область окна браузера, в которой отображается текущий раздел данных, заданный закладками или пунктами меню пользователя. Имеет наибольший размер относительно других частей страницы.
Регистрационный номер кассы — последовательность символов, идентифицирующая кассу в ФНС в процессе обработки отчетных данных кассы. Присваивается в процессе регистрации кассы.
Учетная запись — совокупность данных, связанных с определенным пользователем ИС. Включает в себя также данные идентификации и аутентификации. Доступ к учетной записи может получить только пользователь, прошедший процедуру идентификации и аутентификации.
Фискальный накопитель — аппаратно-программное средство, с энергонезависимым запоминающим устройством, подключающееся к кассе и предназначенное для сбора и хранения сгенерированных кассой документов для последующей передачи для хранения в ФНС. Для возможности использования кассы фискальный накопитель должен быть обязательно установлен в кассу. После окончания периода эксплуатации фискального накопителя (см. Фискальный режим) он хранится у налогоплательщика в течение 5 лет.

Использованные сокращения

БД — база данных;
ЕГРЮЛ — единый государственный реестр юридических лиц;
ИНН — идентификационный номер налогоплательщика;
ИС — информационная система;
ККТ — контрольно-кассовая техника;
ЛКК — личный кабинет клиента;
ЛКП — личный кабинет партнера;
НДС — налог на добавленную стоимость;
ОГРН — основной государственный регистрационный номер;
ОФД — оператор фискальных данных;
РН (РНМ) — регистрационный номер (в данном случае — регистрационный номер кассы);
ФД — фискальный документ;
ФН — фискальный накопитель.

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

Версия 1.0
Выпущена 20 февраля 2018 г.
Первая версия документа.

Версия 1.1
Выпущена 27 апреля 2018 г.

Изменен формат данных JSON-ответа функции получения сведений о кассовых чеках за заданный период по кассе или юридическому лицу.
Для оформления документа использован новый шаблон

Версия 1.11
Выпущена 22 мая 2018 г.
Добавлены функции «Получение сведений о юридических лицах, подключивших свои кассы к ИС “Renta”» и «Получение сведений о кассах юридических лиц, подключенных к ИС “Renta”».

Версия 1.12
Выпущена 06 июня 2018 г.
Добавлены функции «Подключение касс к услуге ИС “Renta”» и «Отключение касс от услуги ИС “Renta”».

Версия 1.13
Выпущена 21 августа 2018 г.
Исправлены ошибки в описаниях входных параметрах функций.

Версия 1.14
Выпущена 21 августа 2018 г.
Изменено название документа на «Программный интерфейс приложений (API) для работы с ИС “Renta”»

Версия 1.15
Выпущена 19 сентября 2018 г.
Добавлен входной параметр к функции подключения касс к ИС “Renta”

Версия 1.16
Выпущена 23 апреля 2019 г.
Добавлен метод получения полной информации по чеку

Версия 1.17
Выпущена 03 апреля 2020 г.
Добавлен метод получения отчёта по номенклатуре

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

Версия 1.19
Выпущена 23 октября 2020 г.

Исправлена ошибка в описании метода 3.1 Получение списка чеков со сведениями о них за заданный период по кассе или юридическому лицу;
Добавлена информация по доступным отчетам в методе 3.4. Получение сведений о кассах юридических лиц, подключенных к ИС “Renta”;
Устранены мелкие недочеты по всему объему документа.

Версия 1.20
Выпущена 02 мая 2021 г.

Добавлен новый метод 3.8 Отчёт по базовому тарифу.

Версия 1.21
Выпущена 09 сентября 2021 г.

Обновлен 3.8 Отчёт по базовому тарифу.

Версия 2.0
Выпущена 23 декабря 2021 г.

Добавлено описание дополнительных параметров для запросов.
Изменена структура.
Исключены разделы:
- 3.5. Подключение касс к ИС «Renta»;
- 3.6. Отключение касс от ИС «Renta»;
- 3.7 Отчет по номенклатуре.
В документации добавлены примеры запросов.

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

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

Добавлены разделы:
- 3.2.1. Возможные значения признака предмета расчета
- 3.6. Описание запроса на получение данных за смену по кассе
Устранены мелкие недочеты по всему объему документа.

Версия 2.3
Выпущена 26 декабря 2022 г.

Добавлен новый раздел 3.7

Версия 2.4
Выпущена 13 февраля 2024 г.

Добавлено уточнение ответа запроса в пункте 3.4.

¹⁾

Значение параметра AuthToken имеет формат строки символов. Код авторизации представляет собой 32-значную последовательность шестнадцатеричных цифр, требуется для аутентификации ЛК OFD.ru

²⁾

Значение параметра «ExpirationDateUtc» представлено в строковом виде в формате даты и времени (UTC+3, МОСКОВСКОЕ ВРЕМЯ).
Время представлено в формате «ГГГГ-ММ-ДДTчч:мм:сс». Формат даты и времени соответствует международному стандарту ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601).
Формат представления времени выводится без смещения часовых поясов (Time Zone Offset) и интервалов. Формат даты и времени имеет следующую структуру:
ГГГГ - год;
ММ - месяц;
ДД - день;
T - используется как разделитель даты и времени;
чч - часы;
мм - минуты;
сс - секунды.

³⁾ , ⁴⁾ , ¹⁶⁾ , ¹⁷⁾ , ¹⁸⁾ , ¹⁹⁾

дата задается в формате ISO YYYY-MM-DD. Разница DateTo и DateFrom не должна превышать 7 дней

⁵⁾ , ¹⁰⁾ , ²⁰⁾ , ²⁴⁾ , ²⁶⁾ , ²⁹⁾

В формате UUID

⁶⁾ , ⁷⁾ , ¹³⁾ , ²³⁾ , ²⁵⁾

Дата и время в формате стандарта ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601).
Здесь используется только формат представления времени без задания смещения часовых поясов (Time Zone Offset) и интервалов.

⁸⁾ , ¹⁴⁾ , ²⁷⁾

до 01.01.2019 сумма налога начислялась по ставке 18%

⁹⁾ , ¹⁵⁾ , ²⁸⁾

до 01.01.2019 сумма налога начислялась по ставке 18/118

¹¹⁾

до 01.01.2019 18%

¹²⁾

до 01.01.2019 18/118

²¹⁾ , ²²⁾ , ³⁰⁾ , ³¹⁾ , ³²⁾

Дата и время в формате стандарта ISO 8601 (https://en.wikipedia.org/wiki/ISO_8601). Здесь используется только формат представления времени без задания смещения часовых поясов (Time Zone Offset) и интервалов.

³³⁾

Взято из https://ru.wikipedia.org/wiki/Контрольно-кассовая_машина#В_Российской_Федерации