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

Возвращает информацию о документах, которые были отправлены и получены в процессе постановки ККТ на учет в ФНС.

  1. Формат запроса
  2. Формат ответа
  3. Коды ответа
  4. Пример запроса

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

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

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

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

Заголовок Значение
X-Yandex-Key <аутентификационный ключ>
X-OFD-Key <авторизационный ключ>

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

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

[
   {
    "signed": {boolean},
    "knd": "{string}",
    "doctype_code": "{string}",
    "doctype_text": "{string}",
    "registration_id": {number},
    "filename": "{string}",
    "id": {number},
    "created_at": "{string}",
    "content_type": "{string}",
    "direction": "{string}",
    "received_at": "{string}"
    }
]
signed

Наличие подписи на документе.

knd

Внутренний код типа документа.

doctype_code

Код типа документа по классификации ЭДО (система электронного документооборота).

doctype_text

Тип документа по классификации ЭДО (система электронного документооборота).

registration_id

Идентификатор регистрации KKT.

filename

Имя файла документа.

id

Идентификатор документа.

created_at

Дата загрузки документа.

content_type

Формат документа.

direction
Направление движения документа. Возможные значения:
  • in — входящий;
  • out — исходящий.
received_at

Дата получения документа.

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

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

GET https://api.ofd.yandex.net/v1/cashboxes/1029/registration/742/documents
Заголовки запроса:
x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Пример запроса в формате cURL
curl -X GET \
  https://api.ofd.yandex.net/v1/cashboxes/1029/registration/742/documents \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca'

Ответ:

[
    {
        "signed": true,
        "knd": "1110061",
        "doctype_code": null,
        "doctype_text": null,
        "registration_id": 742,
        "filename": "KO_ZVLREGKKT_1414_1414_5252002693525201001_20190215_ef02dca8313511e9a276458f848ed8ef.xml",
        "id": 118009,
        "created_at": "2019-02-22T14:10:10.106816+00:00",
        "content_type": "xml",
        "direction": "out",
        "received_at": null
    }
]