Заменить текущий ФН

Внимание

Новые ключи временно не выпускаются в связи с обновлением продукта.

Заменяет текущий ФН. При замене текущий ФН помещается в архив (историю).

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

POST https://api.ofd.yandex.net/{v1}/cashboxes/{id}/fiscal_drive
  • v1
    Номер версии API ОФД.
  • id
    Идентификатор ККТ.

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

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

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

Тело запроса

{
    "sn": "{string}",
    "model_id": {number}
}
  • sn *
    Серийный (заводской) номер ФН.
  • model_id *
    Идентификатор модели ФН.

* Обязательный параметр.

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

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

{
   "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 ОФД см. в разделе Коды ответов и ошибки.

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

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

POST https://api.ofd.yandex.net/v1/cashboxes/903/fiscal_drive

Заголовки:

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Content-Type: application/json

Тело:

{
  "sn": "00000000381007926499",
  "model_id": 1
}
Пример запроса в формате cURL
curl -X POST \
  https://api.ofd.yandex.net/v1/cashboxes/903/fiscal_drive \
  -H 'Content-Type: application/json' \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -d '{
  "sn": "00000000381007926499",
  "model_id": 1
}'

Ответ:

{
  "sn": "00000000381007926499",
  "model_id": 1,
  "status": "ok",
  "status_updated_at": "2017-11-23 14:43",
  "working_since": "2017-11-23 14:43",
  "working_until": "2017-11-23 14:43",
  "close_doc": {
      "timestamp": null,
      "fiscal_sign": null,
      "number": null
  },
}