Получить список перерегистраций по компании или ККТ
Внимание
Новые ключи временно не выпускаются в связи с обновлением продукта.
Возвращает список перерегистраций в ФНС, которые выполнялись для заданной компании или ККТ.
Формат запроса
GET https://api.ofd.yandex.net/{v1}/{object_name}/{object_id}/fiscal_corrections
? [reason=<enum>]
& [status=<enum>]
Номер версии API ОФД.
Объект, по которому выполняется запрос о перерегистрации ККТ. Возможные значения:
companies
— компания;cashboxes
— ККТ.
Идентификатор объекта, по которому выполняется запрос о перерегистрациях.
Причина перерегистрации. Можно указать несколько значений в рамках одного запроса. Возможные значения:
reason_ofd
— смена ОФД;reason_fn
— смена ФНС;reason_address
— смена адреса;reason_to_automated
— переход ККТ в автоматический режим;reason_to_offline
— переход ККТ в автономный (оффлайн) режим;reason_to_online
— переход ККТ в обычный (онлайн) режим;reason_user
— смена пользователя ККТ;reason_other
— другая причина.
Статус перерегистрации. Можно указать несколько значений в рамках одного запроса. Возможные значения:
new
— новая перерегистрация, над ней не выполнялось никаких действий;proceeding
— выполняется инициализация по созданию новой отправки;wait_sign
— ожидается подписание документов по перерегистрации;wait_fns
— ожидание ответа от ФНС на отправленные документы;finished
— перерегистрация успешно завершена;error
— перерегистрация завершена с ошибкой;cancelled
— перерегистрация отменена (удалена) пользователем.
-
- v1
- Номер версии API ОФД.
-
- object_name
- Объект, по которому выполняется запрос о перерегистрации ККТ. Возможные значения:
companies
— компания;cashboxes
— ККТ.
-
- object_id
- Идентификатор объекта, по которому выполняется запрос о перерегистрациях.
-
- reason
- Причина перерегистрации. Можно указать несколько значений в рамках одного запроса. Возможные значения:
reason_ofd
— смена ОФД;reason_fn
— смена ФНС;reason_address
— смена адреса;reason_to_automated
— переход ККТ в автоматический режим;reason_to_offline
— переход ККТ в автономный (оффлайн) режим;reason_to_online
— переход ККТ в обычный (онлайн) режим;reason_user
— смена пользователя ККТ;reason_other
— другая причина.
-
- status
-
Статус перерегистрации. Можно указать несколько значений в рамках одного запроса. Возможные значения:
new
— новая перерегистрация, над ней не выполнялось никаких действий;proceeding
— выполняется инициализация по созданию новой отправки;wait_sign
— ожидается подписание документов по перерегистрации;wait_fns
— ожидание ответа от ФНС на отправленные документы;finished
— перерегистрация успешно завершена;error
— перерегистрация завершена с ошибкой;cancelled
— перерегистрация отменена (удалена) пользователем.
Заголовок запроса
Заголовки запроса должны содержать ключи (см. раздел Доступ к API):
Заголовок | Значение |
---|---|
X-Yandex-Key |
<аутентификационный ключ> |
X-OFD-Key |
<авторизационный ключ> |
Общий формат ответа приведен ниже. В реальном ответе порядок следования элементов может отличаться, а некоторые элементы могут отсутствовать. Также в ответе могут находиться служебные параметры, которые не описаны в документе.
Формат ответа
[
{
"cashbox_id": {number},
"error_reason_doc_id": {number},
"error_message": "{string}",
"dialogue": {
"error_message": "{string}",
"error_code": {number},
"error_reason_doc_id": {number},
"signer": {
"name": {
"first": "{string}",
"middle": "{string}",
"last": "{string}"
},
"position": "{string}",
"address": "{string}",
"email": "{string}",
"phone": "{string}"
},
"irud_client": "{string}",
"reasons": {
"reason_ofd": {boolean},
"reason_fn": {boolean},
"reason_address": {boolean},
"reason_to_automated": {boolean},
"reason_to_offline": {boolean},
"reason_to_online": {boolean},
"reason_user": {boolean},
"reason_other": {boolean}
},
"kkt_card_pdf_doc_id": {boolean},
"id": {number},
"cloud_sign_id": {number},
"error_description": "{string}",
"need_pin_code": {boolean},
"status": "{string}",
"sign_id": {number}
},
"status": "{string}",
"correction_doc": {
"datetime": "string",
"doc_number": {number},
"fiscal_sign": {number}
},
"id": {number},
"reasons": {
"reason_ofd": {boolean},
"reason_fn": {boolean},
"reason_address": {boolean},
"reason_to_automated": {boolean},
"reason_to_offline": {boolean},
"reason_to_online": {boolean},
"reason_user": {boolean},
"reason_other": {boolean}
},
"cashbox": {
"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}"
},
"сlosed_fn": {
"datetime": "string",
"doc_number": {number},
"fiscal_sign": {number}
},
"installed_fn": {
"datetime": "string",
"doc_number": {number},
"fiscal_sign": {number}
}
}
]
-
- cashbox_id
- Идентификатор ККТ, по которому идет перерегистрация.
-
- error_reason_doc_id
- Идентификатор документа от ФНС с сообщением об отказе (ошибке).
-
- error_message
-
Текст сообщения об ошибке.
Возможные значенияКод Сообщение Описание 1 IRUD error Ошибка ИРУД (ошибка проверка подписей или ошибка регистрации пользователей в ИРУД). 2 Rejected to accept declaration Заявление на регистрацию кассы не принято ЭДО (система электронного документооборота). 3 Rejected to register Заявление на регистрацию отклонено отделением ФНС. 4 Rejected to accept Документ не принят ЭДО. 5 Wrong report В ЭДО передан некорректный тип документа. 6 Wrong fiscal sign error У отчета о регистрации указан невалидный фискальный признак.
-
- dialogue
-
Информация о регистрации /перерегистрации ККТ на момент запроса.
-
- error_message
-
Текст сообщения об ошибке.
Возможные значенияКод Сообщение Описание 1 IRUD error Ошибка ИРУД (ошибка проверка подписей или ошибка регистрации пользователей в ИРУД). 2 Rejected to accept declaration Заявление на регистрацию кассы не принято ЭДО (система электронного документооборота). 3 Rejected to register Заявление на регистрацию отклонено отделением ФНС. 4 Rejected to accept Документ не принят ЭДО. 5 Wrong report В ЭДО передан некорректный тип документа. 6 Wrong fiscal sign error У отчета о регистрации указан невалидный фискальный признак. -
- error_code
- Код ошибки. Возможные значения см. в описании параметра
error_message
.
-
- error_reason_doc_id
- Идентификатор документа от ФНС с сообщением об отказе (ошибке).
-
- signer
- Данные подписанта.
-
- name
- ФИО.
-
- first
- Имя.
-
- middle
- Отчество.
-
- last
- Фамилия
-
-
- position
- Занимаемая должность подписанта.
-
- address
- Юридический адрес компании.
-
- Адрес электронной почты подписанта.
-
- phone
- Номер телефона подписанта. Используется для получения пароля активации сессий электронной подписи.
-
- irud_client
- Идентификатор регистрации в ИРУД.
-
- reasons
- Причины перерегистрации.
-
- reason_fn
- Смена ФН.
-
- reason_address
- Смена адреса.
-
- reason_to_automated
- Переход ККТ в автоматический режим.
-
- reason_to_offline
- Переход ККТ в автономный (оффлайн) режим.
-
- reason_to_online
- Переход ККТ в обычный (онлайн) режим.
-
- reason_user
- Смена пользователя ККТ.
-
- reason_other
- Другая причина.
-
-
- kkt_card_pdf_doc_id
- Идентификатор карточки ККТ в формате
pdf
.
-
- id
- Идентификатор регистрации ККТ в ФНС.
-
- cloud_sign_id
- Идентификатор КСКПЭП. Значение соответствует параметру
sign_id
.
-
- error_description
- Причина возврата заявления со статусом
error
.
-
- need_pin_code
- Признак необходимости отправить пин-код.
-
- status
-
Статус регистрации. Возможные значения:
wait_decl_sign
— ожидание подписи заявления на регистрацию;wait_irud
— ожидание ответа от ИРУД (Информационный реестр участников документооборота);wait_rnm
— ожидание ответа от ФНС о присвоении РНМ;wait_report
— ожидание отчета о регистрации, сформированного посредством ККТ;wait_report_sign
— ожидание подписи отчета о регистрации;wait_final_response
— ожидание финального ответа от ФНС с карточкой ККТ;finished
— карточка ККТ получена;error
— ошибка. Описание ошибки содержится в параметреerror_description
.
-
- sign_id
- Идентификатор КСКПЭП.
-
-
- status
-
Статус перерегистрации. Возможные значения:
new
— новая перерегистрация, над ней не выполнялось никаких действий;proceeding
— выполняется инициализация по созданию новой отправки;wait_sign
— ожидается подписание документов по перерегистрации;wait_fns
— ожидание ответа от ФНС на отправленные документы;finished
— перерегистрация успешно завершена;error
— перерегистрация завершена с ошибкой;cancelled
— перерегистрация отменена (удалена) пользователем.
-
- correction_doc
- Данные чека перерегистрации.
-
- datetime
- Дата и время пробития документа.
-
- doc_number
- Номер документа.
-
- fiscal_sign
- Фискальный признак документа(int64).
-
-
- id
- Идентификатор перерегистрации.
-
- reasons
- Причины новой перерегистрации.
-
- reason_ofd
- Смена ОФД.
-
- reason_fn
- Смена ФН.
-
- reason_address
- Смена адреса.
-
- reason_to_automated
- Переход ККТ в автоматический режим.
-
- reason_to_offline
- Переход ККТ в автономный (оффлайн) режим.
-
- reason_to_online
- Переход ККТ в обычный (онлайн) режим.
-
- reason_user
- Смена пользователя ККТ.
-
- reason_other
- Другая причина.
-
-
- cashbox
- Информация о ККТ.
-
- 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
— является дублем. Перевод в данный статус выполняется сотрудником технической поддержки Яндекс ОФД по запросу клиента.
-
- payment_status
- Статус оплаты ККТ. Возможные значения:
paid
— оплачен;unpaid
— неоплачен.
-
- version_text
- Служебный параметр. Используется для обратной совместимости.
-
- usage_status
-
Статус использования ККТ.
new
— новый;used
— в работе.
-
- client_id
- Идентификатор клиента, зарегистрировавшего компанию в системе Яндекс ОФД.
-
- promo_status
-
Статус промопериода для ККТ. Во время промопериода ККТ работает в штатном режиме.
before_promo
— промопериод не активирован.promo
— для ККТ действует промопериод.after_promo
— промопериод завершен.
-
- paid_at
- Дата оплаты ККТ.
-
- alias
- Название ККТ, которое будет отображаться в Личном кабинете. Если параметр не задан, в Личном кабинете отображаются последние четыре цифры серийного номера KKT (sn).
-
-
- installed_fn
- Данные отчета об установке нового ФН. Параметр возвращается, если причина перерегистрации — смена ФН (
"reason_fn": true
).-
- datetime
- Дата и время пробития документа.
-
- doc_number
- Номер документа.
-
- fiscal_sign
- Фискальный признак документа(int64).
-
-
- closed_fn
- Данные чека закрытия ФН. Параметр возвращается, если причина перерегистрации — смена ФН (
"reason_fn": true
).-
- datetime
- Дата и время пробития документа.
-
- doc_number
- Номер документа.
-
- fiscal_sign
- Фискальный признак документа (int64).
-
Коды ответа
Список кодов, которые поддерживаются в API ОФД см. в разделе Коды ответов и ошибки.
Пример запроса
Метод и адрес:
GET https://api.ofd.yandex.net/v1/cashboxes/1032/fiscal_corrections
Заголовки запроса:
x-yandex-key: 74f...e8ca x-ofd-key: eka...b17eae
Пример запроса в формате cURLcurl -X GET \ https://api.ofd.yandex.net/v1/cashboxes/1032/fiscal_corrections \ -H 'x-ofd-key: eka...b17eae' \ -H 'x-yandex-key: 74f...e8ca'
Ответ:
[ { "cashbox_id": 1032, "error_reason_doc_id": null, "error_message": null, "dialogue": { "error_message": null, "error_code": 1, "error_reason_doc_id": null, "signer": { "position": "Генеральный директор", "email": "kogladun@yandex-team.ru", "name": { "first": "Ольга", "middle": "Александровна", "last": "Кузина" }, "address": "{'addr_street': 'Жуковского', 'addr_postal_code': '300001', 'addr_region_code': 71, 'addr_building': '', 'addr_block': '', 'addr_settlement': '', 'addr_city': 'Тула', 'addr_flat': '209', 'addr_house': '58', 'addr_area': ''}", "phone": "79112918996" }, "irud_client": null, "reasons": { "reason_user": true, "reason_address": true }, "kkt_card_pdf_doc_id": null, "id": 746, "cloud_sign_id": 41, "error_description": "IRUD error", "need_pin_code": true, "status": "error", "sign_id": 41 }, "status": "error", "correction_doc": { "datetime": "2019-02-20T15:05:45", "doc_number": 2, "fiscal_sign": 2 }, "id": 319, "reasons": { "reason_to_offline": false, "reason_user": true, "reason_fn": false, "reason_to_online": false, "reason_to_automated": false, "reason_address": true, "reason_ofd": false, "reason_other": false }, "cashbox": { "is_bank_payment_agent": false, "fiscal_drive_sn": "3435436456576586", "paid_at": "2019-02-20T14:40:52.159017+00:00", "model_id": 14, "version_text": null, "rn_status": "confirmed", "is_conduct_of_gambling": false, "is_excise": false, "retail_point_id": 826, "usage_status": "new", "is_service_only": false, "terminal_sn": "", "alias": null, "payment_status": "paid", "promo_status": "after_promo", "rn": "0000000010048732", "is_lottery": false, "id": 1032, "company_id": 713, "is_autonomous_only": false, "client_id": 76, "sn": "43546456457576867876", "is_payment_agent": false, "fiscal_drive_model_id": 143 } } ]
-