Список контрагентов
counterparties.list
Возвращает постраничный список контрагентов с фильтрами. Все входы необязательны: без фильтров вернётся первая страница всех контрагентов. Можно искать по названию или ИНН и отбирать по признакам покупателя, поставщика и активности. В ответе — массив контрагентов, общее число под фильтром и количество на текущей странице. Только чтение.
Входы
| Ключ | Тип | Описание |
|---|---|---|
| query | string | Название |
| inn | string | ИНН |
| isCustomer | boolean | Покупатель |
| isSupplier | boolean | Поставщик |
| isActive | boolean | Активен |
| pageSize | integer | Размер страницы |
| page | integer | Страница |
Выходы
| Ключ | Тип | Описание |
|---|---|---|
| items | array | Контрагенты |
| total | integer | Всего |
| count | integer | На странице |
Что делает
Нода возвращает список контрагентов — в отличие от «Найти контрагента», которая отдаёт одно совпадение, здесь приходит целый массив записей. Список можно сузить фильтрами: по названию (полное или краткое наименование, код), по ИНН, а также по признакам — покупатель, поставщик, активный. Результат выдаётся постранично: можно задать размер страницы и её номер, чтобы пройти по всей базе частями.
Когда применять
Сценарий — когда нужен не один контрагент, а подборка. Например, ассистента просят «показать всех активных поставщиков» или «перечислить покупателей, чтобы выбрать нужного» — нода отбирает записи по фильтрам и отдаёт список. Также подходит для массовых сценариев автоматизации: пройти по всем контрагентам страница за страницей, например для рассылки или сверки. Нода только читает данные и ничего не меняет.
Что приходит в ответе
Массив контрагентов текущей страницы — по каждому приходит компактная карточка: идентификатор и код, полное и краткое наименование, тип, ИНН и КПП, электронная почта и телефон, признаки покупателя, поставщика и активности. Дополнительно возвращается общее число контрагентов под фильтром и количество записей на текущей странице — по ним удобно понять, есть ли следующие страницы, и организовать перебор.