Получить информацию по документу

Возвращает мета-информацию по указанному документу перерегистрации.

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

GET https://api.ofd.yandex.net/{v1}/cashboxes/{cashbox_id}/fiscal_corrections/{correction_id}/documents/{doc_id}

• v1

  Номер версии API ОФД.

• cashbox_id

  Идентификатор ККТ.

• correction_id

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

• doc_id

  Идентификатор документа по перерегистрации.

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

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

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

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

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

• registration_id

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

• direction

  Направление движения документа. Возможные значения:

  • in — входящий;
  • out — исходящий.

• doctype_code

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

• signed

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

• received_at

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

• id

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

• created_at

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

• filename

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

• content_type

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

• doctype_text

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

• knd

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

Коды ответаКоды ответа

Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.

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

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

GET https://api.ofd.yandex.net/v1/cashboxes/1032/fiscal_corrections/319/documents/118015

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

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae

curl -X GET \
  https://api.ofd.yandex.net/v1/cashboxes/1032/fiscal_corrections/319/documents/118015 \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca'

Ответ:

{
    "registration_id": 746,
    "direction": "out",
    "doctype_code": null,
    "signed": true,
    "received_at": null,
    "id": 118015,
    "created_at": "2019-03-03T10:46:06.604407+00:00",
    "filename": "KO_ZVLREGKKT_1414_1414_5252002693525201001_20190220_002c5a1a350811e9a602212363d7c876.xml",
    "content_type": "xml",
    "doctype_text": null,
    "knd": "1110061"
}