Внимание! Вы находитесь в тестовой среде. Здесь поддерживаются только тестовые ФН-ы начинающиеся на 9999.
8 800 550 99 11

Бесплатно по РФ 24/7Клиентская поддержка: feedback@ofd.ru

Мы в социальных сетях: 

API для сверки с оператором фискальных данных OFD.RU

Версия 1.3от 03.04.2017

Общая информация

Взаимодействие клиента и API производится путем отправки клиентом HTTP-запросов к серверу. Запросы выполняются методом GET, параметры запроса передаются в URL. Сервер выдает ответ в формате JSON. Кодировка запросов и ответов – UTF-8.

Формат ответов

Базовый формат ответа, если запрос завершился успешно:

В объекте Data передается дополнительная информация в контексте запроса. Свойство Status принимает значение "Success". HTTP-код ответа 200.

Базовый формат ответа, если запрос завершился неуспешно:

В массиве Errors представлен список ошибок, свойство Status принимает значение "Failed". HTTP-код ответа отличен 200 и зависит от конкретной ошибки.

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

POST /api/Authorization/CreateAuthToken

loginлогин для доступа12345
passwordпароль для доступа56789

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

в формате Json

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

в формате UrlEncoded

--- BEGIN ---
POST http://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 ---

Возвращает

В случае успешной авторизации вернет код 200 и токен авторизации

В случае проблем с авторизацией вернёт код 403 и пустой ответ — { }

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

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

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

GET api/integration/v1/inn/<inn>/kkts?AuthToken=123

Список зарегистрированных ККТ

GET api/integration/v1/inn/<inn>/kkts

innИНН организации123123

Возвращает массив с данными ККТ:

  • Регистрационный номер ккт,
  • Заводской номер ккт,
  • Номер ФН,
  • Дата внесения на сайт,
  • Дата оплаты,
  • Дата уведомления ФНС о заключ. контракте,
  • Дата успешной проверки регномера в ФНС,
  • Дата готовности к приёму чеков,
  • Дата подписания КЭП,
  • Дата первого принятого док-а,
  • Дата начала действия контракта,
  • Дата окончания действия контракта.
  • Дата и время последнего документа кассы ( по локальному времени кассы)
  • Дата и время получения последнего документа кассы в ОФД по Utc

Возможные ошибки:

  • InnNotFound — для данного аккаунта организация не найдена

Список z-отчётов (смен) по ККТ за период

GET api/integration/v1/inn/<inn>/kkt/<kktRegId>/zreports?dateFrom=<dateFrom>&dateTo=<dateTo>

Период не должен превышать 30 дней

innИНН организации123123
kktRegIdрегистрационный номер кассы235235232235235
dateFromс даты2016-10-22T12:22:45
dateToпо дату2016-10-25T12:22:45

Возвращает массив смен

Возможные ошибки:

  • InnNotFound — для данного аккаунта организация не найдена
  • KktNotFound — для данного аккаунта касса не найдена
  • InvalidTimeInterval — неверно указан временной интервал
  • TimeIntervalMustNotExceed30Days — указан временной интервал более 30 дней

Список z-отчётов (смен) по всем ККТ за период

GET api/integration/v1/inn/<inn>/zreports?dateFrom=<dateFrom>&dateTo=<dateTo>

Период не должен превышать 30 дней

innИНН организации123123
dateFromс даты2016-10-22T12:22:45
dateToпо дату2016-10-25T12:22:45

Формат ответа аналогичен предыдущему методу

Возможные ошибки:

  • InnNotFound — для данного аккаунта организация не найдена
  • InvalidTimeInterval — неверно указан временной интервал
  • TimeIntervalMustNotExceed30Days — указан временной интервал более 30 дней

Список чеков за период по ККТ

GET api/integration/v1/inn/<inn>/kkt/<kktRegId>/receipts?dateFrom=<dateFrom>&dateTo=<dateTo>

Период не должен превышать 7 дней

innИНН организации123123
kktRegIdрегистрационный номер кассы235235232235235
dateFromс даты2016-10-22T12:22:45
dateToпо дату2016-10-25T12:22:45

Возвращает массив чеков

Возможные ошибки:

  • InnNotFound — для данного аккаунта организация не найдена
  • KktNotFound — для данного аккаунта касса не найдена
  • InvalidTimeInterval — неверно указан временной интервал
  • TimeIntervalMustNotExceed7Days — указан временной интервал более 7 дней

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

GET api/integration/v1/inn/<inn>/kkt/<kktRegId>/receipt/<RawId>
GET api/integration/v1/inn/<inn>/kkt/<kktRegId>/zreport/<ShiftNumber>/receipt/<DocShiftNumber>

innИНН организации123123
kktRegIdрегистрационный номер кассы235235232235235
RawIdУникальный номер фискального документаGUID
ShiftNumberПорядковый номер смены22
DocShiftNumberномер документа в смене4

Возвращает данные по чеку

Возможные ошибки:

  • InnNotFound — для данного аккаунта организация не найдена
  • KktNotFound — для данного аккаунта касса не найдена
  • DocumentNotFound — документ (чек) не найден

Формирование прямой ссылки на электронный чек

Общий вид:

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

Детально

параметрТэг из документа Формат Фискальных ДокументовОписание
inn1018ИНН Владельца кассы на которого она зарегистрирована
kktregnumber1037Регистрационный номер ККТ
fnnumber1041Номер фискального накопителя
docnumber1040Номер фискального документа
decsign1077Фискальный признак документа

Описание API для продукта «Касса в аренду для интернет-магазинов

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