Получить информацию по текущему ФН
Внимание
Новые ключи временно не выпускаются в связи с обновлением продукта.
Возвращает подробную информацию о ФН, установленном в ККТ на момент запроса.
Формат запроса
GET https://api.ofd.yandex.net/{v1}/cashboxes/{id}/fiscal_drive
Номер версии API ОФД.
Идентификатор ККТ.
-
- v1
- Номер версии API ОФД.
-
- id
- Идентификатор ККТ.
Заголовок запроса
Заголовки запроса должны содержать ключи (см. раздел Доступ к API):
Заголовок | Значение |
---|---|
X-Yandex-Key |
<аутентификационный ключ> |
X-OFD-Key |
<авторизационный ключ> |
Общий формат ответа приведен ниже. В реальном ответе порядок следования элементов может отличаться, а некоторые элементы могут отсутствовать. Также в ответе могут находиться служебные параметры, которые не описаны в документе.
Формат ответа
{
"sn": "{string}",
"model_id": {number},
"status": "{string}",
"status_updated_at": "{string}",
"working_since": "{string}",
"working_until": "{string}",
"close_doc": {
"timestamp": {integer},
"fiscal_sign": {integer},
"number": {integer}
}
}
-
- sn
- Серийный (заводской) номер ФН.
-
- model_id
- Идентификатор модели ФН.
-
- status
-
Статус ФН. Возможные значения:
ok
— ФН в рабочем состоянии;30days
— до завершения срока действия ФН осталось 30 дней;3days
— до завершения срока действия ФН осталось 3 дня;expired
— ФН заполнен на 99%;closed
— ФН закрыт.
-
- status_updated_at
- Дата изменения статуса фискального накопителя (ФН).
-
- working_since
- Дата начала действия ФН.
-
- working_until
- Дата окончания действия ФН.
-
- close_doc
- Чек закрытия ФН.
-
- timestamp
- Дата и время пробития чека.
-
- fiscal_sign
- Фискальный признак чека (int64).
-
- number
- Номер чека.
-
Коды ответа
Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.
Пример запроса
Метод и адрес:
GET https://api.ofd.yandex.net/v1/cashboxes/903/fiscal_drive
Заголовки запроса:
x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Пример запроса в формате cURL
curl -X GET \
https://api.ofd.yandex.net/v1/cashboxes/903/fiscal_drive \
-H 'x-ofd-key: eka...b17eae' \
-H 'x-yandex-key: 74f...e8ca'
Ответ:
{
"status": "ok",
"close_doc": {
"timestamp": null,
"fiscal_sign": null,
"number": null
},
"working_until": null,
"sn": "8710000100875131",
"model_id": null,
"status_updated_at": null,
"working_since": "2018-12-25T10:10:56.776883+00:00"
}