Получить список ККТ

Внимание

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

Возвращает список KKT.

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

GET https://api.ofd.yandex.net/{v1}/cashboxes
 ? [sn=<string>]
 & [fiscal_drive_sn=<string>]
 & [rn=<string>]
 & [company_inncompany_inn=<string>]
 & [company_kpp=<string>]
 & [company_ogrn=<string>]
 & [company_id=<number>]
 & [retail_point_id=<number>]
 & [model_id=<number>]
 & [fiscal_drive_model_id=<number>]
 & [rn_status=<string>]
 & [limit=<integer>]
 & [offset=<integer>]

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

Серийный (заводской) номер ККТ.

Серийный (заводской) номер ФН.

Регистрационный номер ККТ. Выдается ФНС при регистрации кассы.

ОГРН компании.

КПП компании.

ОГРН компании.

Идентификатор компании системе Яндекс ОФД.

Идентификатор точки продаж в системе Яндекс ОФД.

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

Идентификатор модели ФН.

Текущий статус регистрационного номера ККТ в системе Яндекс ОФД. Возможные значения:

-  `missing` — статус неизвестен;
-  `waiting` — ожидает подтверждения;
-  `confirmed` — подтвержден чеком;
-  `duplicate` — является дублем. Перевод в данный статус выполняется сотрудником технической поддержки Яндекс ОФД по запросу клиента.

Максимальное количество объектов, возвращаемое в ответе.

Смещение от начала списка объектов.

  • v1
    Номер версии API ОФД.
  • sn
    Серийный (заводской) номер ККТ.
  • fiscal_drive_sn
    Серийный (заводской) номер ФН.
  • rn
    Регистрационный номер ККТ. Выдается ФНС при регистрации кассы.
  • company_inn
    ИНН компании.
  • company_kpp
    КПП компании.
  • company_ogrn
    ОГРН компании.
  • company_id
    Идентификатор компании системе Яндекс ОФД.
  • retail_point_id
    Идентификатор точки продаж в системе Яндекс ОФД.
  • model_id
    Идентификатор модели ККТ.
  • fiscal_drive_model_id
    Идентификатор модели ФН.
  • rn_status

    Текущий статус регистрационного номера ККТ в системе Яндекс ОФД. Возможные значения:

    • missing — статус неизвестен;
    • waiting — ожидает подтверждения;
    • confirmed — подтвержден чеком;
    • duplicate — является дублем. Перевод в данный статус выполняется сотрудником технической поддержки Яндекс ОФД по запросу клиента.
  • limit
    Максимальное количество объектов, возвращаемое в ответе.
  • offset
    Смещение от начала списка объектов.

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

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

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

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

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

[
  {
    "company_id": {number},
    "retail_point_id": {number},
    "model_id": {number},
    "sn": "{string}",
    "fiscal_drive_model_id": {number},
    "fiscal_drive_sn": "{string}",
    "terminal_sn": "{string}",
    "is_autonomous_only": {boolean},
    "is_excise": {boolean},
    "is_bank_payment_agent": {boolean},
    "is_lottery": {boolean},
    "is_conduct_of_gambling": {boolean},
    "is_service_only": {boolean},
    "is_payment_agent": {boolean},
    "id": {number},
    "rn": "{string}",
    "rn_status": "{string}",
    "payment_status": "{string}",
    "version_text": "{string}",
    "usage_status": "{string}",
    "client_id": {number},
    "promo_status": "{string}",
    "paid_at": "{string}",
    "alias": "{string}"
  }
]
  • company_id
    Идентификатор компании системе Яндекс ОФД.
  • retail_point_id
    Идентификатор точки продаж в системе Яндекс ОФД.
  • model_id
    Идентификатор модели ККТ.
  • sn
    Серийный (заводской) номер ККТ.
  • fiscal_drive_model_id
    Идентификатор модели ФН.
  • fiscal_drive_sn
    Серийный (заводской) номер ФН.
  • terminal_sn
    Серийный (заводской) номер автоматического устройства для расчетов (если ККТ является частью данного устройства).
  • is_autonomous_only
    Применяется в составе автоматического устройства для расчетов.
  • is_excise
    Используется при продаже подакцизных товаров.
  • is_bank_payment_agent
    Используется при осуществлении деятельности банковского платежного агента (субагента).
  • is_lottery
    Используется при приеме денежных средств при реализации лотерейных билетов, электронных лотерейных билетов, приеме лотерейных ставок и выплате денежных средств в виде выиграша при осуществлении деятельности по организации и проведению лотерей.
  • is_conduct_of_gambling
    Используется при приеме ставок и выплате денежных средств в виде выигрыша при осуществлении деятельности по организации и проведению азартных игр.
  • is_service_only
    Используется только при оказании услуг (в случае регистрации автоматизированной системы для бланков строгой отчетности).
  • is_payment_agent
    Используется при осуществлении деятельности платежного агента (субагента).
  • id
    Идентификатор ККТ в системе Яндекс ОФД.
  • rn
    Регистрационный номер ККТ. Выдается ФНС при регистрации кассы.
  • rn_status

    Текущий статус регистрационного номера ККТ в системе Яндекс ОФД. Возможные значения:

    • missing — статус неизвестен;
    • waiting — ожидает подтверждения;
    • confirmed — подтвержден чеком;
    • duplicate — является дублем. Перевод в данный статус выполняется сотрудником технической поддержки Яндекс ОФД по запросу клиента.
  • rn_status

    Текущий статус регистрационного номера ККТ в системе Яндекс ОФД. Возможные значения:

    • missing — статус неизвестен;
    • waiting — ожидает подтверждения;
    • confirmed — подтвержден чеком;
    • duplicate — является дублем. Перевод в данный статус выполняется сотрудником технической поддержки Яндекс ОФД по запросу клиента.
  • payment_status

    Статус оплаты ККТ. Возможные значения:

    • paid — оплачен;
    • unpaid — неоплачен.
  • version_text
    Служебный параметр. Используется для обратной совместимости.
  • usage_status
    Статус использования ККТ.
    • new — новый;
    • used — в работе.
  • client_id
    Идентификатор клиента, зарегистрировавшего компанию в системе Яндекс ОФД.
  • promo_status
    Статус промопериода для ККТ. Во время промопериода ККТ работает в штатном режиме.
    • before_promo — промопериод не активирован.
    • promo — для ККТ действует промопериод.
    • after_promo — промопериод завершен.
  • paid_at
    Дата оплаты ККТ.
  • alias
    Название ККТ, которое будет отображаться в Личном кабинете. Если параметр не задан, в Личном кабинете отображаются последние четыре цифры серийного номера KKT (sn).

Коды ответа

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

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

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

GET https://api.ofd.yandex.net/v1/cashboxes

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

x-yandex-key: 74f...e8ca
x-ofd-key: eka...b17eae
Пример запроса в формате cURL
curl -X GET \
  https://api.ofd.yandex.net/v1/cashboxes \
  -H 'x-ofd-key: eka...b17eae' \
  -H 'x-yandex-key: 74f...e8ca' \
  -d '{
  "company_id": 587,
  "sn": "00000000381007926490",
  "fiscal_drive_sn": "8710000100875130"
}'

Ответ:

[
  {
        "is_payment_agent": false,
        "rn_status": "missing",
        "promo_status": "before_promo",
        "is_autonomous_only": false,
        "fiscal_drive_model_id": null,
        "company_id": 587,
        "version_text": null,
        "is_conduct_of_gambling": false,
        "is_bank_payment_agent": false,
        "is_service_only": false,
        "usage_status": "new",
        "sn": "00000000381007926499",
        "fiscal_drive_sn": "8710000100875131",
        "payment_status": "unpaid",
        "terminal_sn": null,
        "retail_point_id": null,
        "is_lottery": false,
        "id": 902,
        "rn": null,
        "model_id": null,
        "alias": null,
        "client_id": 88,
        "paid_at": null,
        "is_excise": false
  }
]
Предыдущая
Удалить точку продаж
Следующая
Создать новый ККТ