Загрузить подписанный отчет о регистрации

Отправляет в Яндекс.ОФД файл с электронной подписью отчета о регистрации ККТ.

Примечание. Предварительно скачайте отчет о регистрации ККТ и подпишите его, используя КЭП.

Требования к подписи отчета:

  • Вид: отделенная электронная подпись.
  • Формат файла: pkcs#7.
  • Название файла:
    • sign_base64 — если подпись передается в кодировке base64;
    • sign — если подпись передается в формате xml.
  1. Формат запроса
  2. Формат ответа
  3. Коды ответа
  4. Пример запроса

Формат запроса

POST https://api.ofd.yandex.net/{v1}/cashboxes/{cashbox_id}/registration/{registration_id}/report/upload_sign
Path-параметры
v1Номер версии API ОФД.
cashbox_idИдентификатор ККТ.
registration_idИдентификатор регистрации.

Заголовок запроса

Заголовки запроса должны содержать ключи (см. раздел Доступ к API):

Заголовок Описание

X-Yandex-Key

<аутентификационный ключ>

X-OFD-Key

<авторизационный ключ>

Content-Type

multipart/form-data и application/octet-stream

Тело запроса

Укажите в теле запроса путь к загружаемому файлу.

Общий формат ответа приведен ниже. В реальном ответе порядок следования элементов может отличаться, а некоторые элементы могут отсутствовать. Также в ответе могут находиться служебные параметры, которые не описаны в документе.

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

{
   "error_description": "{string}",
   "error_reason_doc_id": {number},
   "need_pin_code": {boolean},
   "rnm": "{string}",
   "sign_id": {number},
   "cloud_sign_id": {number},
   "signer": {
      "name": {
         "first": "{string}",
         "middle": "{string}",
         "last": "{string}"
      },
      "position": "{string}",
      "address": "{string}",
      "email": "{string}",
      "phone": "{string}"
   },
   "irud_client": "{string}",
   "error_code": {number},
   "id": {number},
   "error_message": "{string}",
   "status": "{string}",
   "rnm_card_pdf_doc_id": {number},
   "kkt_card_pdf_doc_id": {number},
   "rnm_card_xml_doc_id": {number}
 }
error_description

Причина возврата заявления со статусом error.

error_reason_doc_id

Идентификатор документа от ФНС с сообщением об отказе (ошибке).

need_pin_code

Признак необходимости отправить пин-код.

rnm

Регистрационный номер ККТ в ФНС.

sign_id

Идентификатор КСКПЭП.

cloud_sign_id

Идентификатор КСКПЭП. Значение соответствует параметру sign_id.

signer

Данные подписанта.

name

ФИО.

first

Имя.

middle

Отчество.

last

Фамилия

position

Занимаемая должность подписанта.

address

Юридический адрес компании.

email

Адрес электронной почты подписанта.

phone

Номер телефона подписанта. Используется для получения пароля активации сессий электронной подписи.

irud_client

Идентификатор регистрации в ИРУД.

error_code

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

id

Идентификатор регистрации ККТ в ФНС.

error_message

Текст сообщения об ошибке.

Возможные значения
Код Сообщение Описание
1 IRUD error Ошибка ИРУД (ошибка проверка подписей или ошибка регистрации пользователей в ИРУД).
2 Rejected to accept declaration Заявление на регистрацию кассы не принято ЭДО (система электронного документооборота).
3 Rejected to register Заявление на регистрацию отклонено отделением ФНС.
4 Rejected to accept Документ не принят ЭДО.
5 Wrong report В ЭДО передан некорректный тип документа.
6 Wrong fiscal sign error У отчета о регистрации указан невалидный фискальный признак.
status
Статус регистрации. Возможные значения:
  • wait_decl_sign — ожидание подписи заявления на регистрацию;
  • wait_irud — ожидание ответа от ИРУД (Информационный реестр участников документооборота);
  • wait_rnm — ожидание ответа от ФНС о присвоении РНМ;
  • wait_report — ожидание отчета о регистрации, сформированного посредством ККТ;
  • wait_report_sign — ожидание подписи отчета о регистрации;
  • wait_final_response — ожидание финального ответа от ФНС с карточкой ККТ;
  • finished — карточка ККТ получена;
  • error — ошибка. Описание ошибки содержится в параметре error_description.
rnm_card_pdf_doc_id

Идентификатор карточки РНМ в формате pdf.

kkt_card_pdf_doc_id

Идентификатор карточки ККТ в формате pdf.

rnm_card_xml_doc_id

Идентификатор карточки РНМ в формате xml.

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

Метод и адрес:

POST https://api.ofd.yandex.net/v1/cashboxes/1029/registration/742/report/upload_sign
Заголовки:
x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Content-Type: application/json
Пример запроса в формате cURL
curl -X POST \
  https://api.ofd.yandex.net/v1/cashboxes/1029/registration/742/report/upload_sign \
  -H 'Content-Type: application/octet-stream' \
  -H 'content-type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -F 'file=@C:\Work\ofd\sign.xml.sign'

Ответ:

{
    "error_description": null,
    "error_reason_doc_id": null,
    "need_pin_code": true,
    "rnm": null,
    "cloud_sign_id": 245,
    "rnm_card_pdf_doc_id": 1112,
    "irud_client": 55,
    "error_code": null,
    "signer": {
        "phone": "79876543210",
        "position": "Бухгалтер",
        "address": "{'addr_building': '2', 'addr_region_code': 77, 'addr_house': '16', 'addr_street': 'ул Льва Толстого', 'addr_city': 'Москва', 'addr_postal_code': '119034'}",
        "email": "mail@example.com",
        "name": {
            "first": "Мария",
            "middle": "Ивановна",
            "last": "Иванова"
        }
    },
    "id": 742,
    "error_message": null,
    "kkt_card_pdf_doc_id": null,
    "sign_id": 245,
    "status": "wait_final_response",
    "rnm_card_xml_doc_id": 1113
}