Найти контрагента
counterparties.find
Ищет контрагента по названию или по ИНН и возвращает одно лучшее совпадение. Оба входа необязательны: если ничего не задано — вернётся первый контрагент из списка для выбора. В ответе — признак «найден / не найден», карточка контрагента и число совпавших записей. Только чтение.
Входы
| Ключ | Тип | Описание |
|---|---|---|
| query | string | Название |
| inn | string | ИНН |
Выходы
| Ключ | Тип | Описание |
|---|---|---|
| found | boolean | Найден |
| counterparty | object | Контрагент |
| matchCount | integer | Число совпадений |
Что делает
Нода находит одного контрагента и возвращает его карточку. Искать можно по названию — подойдёт часть полного или краткого наименования либо код — или по ИНН для точного совпадения. Если задать оба входа, приоритет у поиска по ИНН. Когда ни название, ни ИНН не указаны, нода вернёт первого контрагента из списка — это удобно, чтобы предложить вариант для выбора, а не упереться в ошибку.
Когда применять
Типичный сценарий — быстро подтянуть контрагента для документа или письма. Например, пользователь просит ассистента «выставить счёт для «Ромашки»» — ассистент по названию находит контрагента, берёт его идентификатор и реквизиты и передаёт дальше в создание счёта. Если под запрос подошло несколько записей, поле «число совпадений» подскажет, что стоит уточнить — вернётся только первое, лучшее совпадение. Нода только читает данные и ничего не меняет в справочнике контрагентов.
Что приходит в ответе
Признак, найден ли контрагент, и его карточка: идентификатор и код, полное и краткое наименование, тип, ИНН и КПП, электронная почта и телефон, а также признаки — покупатель, поставщик, активен ли контрагент. Отдельно возвращается число совпавших записей: если оно больше единицы, запрос стоит уточнить. Полученный идентификатор можно передать в другие ноды — например, при оформлении заказа, счёта или договора.