Контрагенты

API контрагентов и групп контрагентов — поиск, создание и изменение, удаление; скидки и баллы клиентов.

Содержание

Ключ, формат запросов и ответов — в статье Общие правила API. Как работают группы, скидки и баллы — в разделе Контрагенты.

Группы контрагентов

Список групп

GET /api/counterpartiesgroups — страницы по 60.

Параметр	Значение
`page`	Номер страницы
`id`	ИД группы
`title` / `title_like`	Название: точное совпадение / содержит строку
`loyalty_type`	Тип карты клиента: `0` — нет, `1` — скидка, `2` — баллы
`order`	`id` (по умолчанию), `title`, `discount`

Поля группы

Поле	Значение
`id`, `title`	ИД и название
`loyalty_type`	Тип карты клиента: `0` — нет, `1` — скидка, `2` — баллы
`discount`	Скидка, % (для типа `1`)
`loyalty_bonus_type`	Начисление баллов (для типа `2`): `1` — процент от покупки, `2` — за сумму покупки, `3` — не начислять
`bonus`	Стартовые баллы нового клиента
`bonus_pay`	Какую часть покупки, %, можно оплатить баллами
`bonus_discount`	Процент от покупки, начисляемый баллами (начисление `1`)
`bonus_summ`, `bonus_bonus`	За каждые `bonus_summ` рублей покупки начисляется `bonus_bonus` баллов (начисление `2`)
`bonus_add_sets`	`1` — начислять баллы и на покупки, оплаченные баллами
`ignore_max_discount`	`1` — не учитывать максимальную скидку товаров
`default_group`	`1` — группа по умолчанию для новых клиентов
`bonus_add_auto_period`, `bonus_add_auto_sum`	Автоначисление баллов: период (`no`, `day`, `weak` — по понедельникам, `month` — 1-го числа, `year` — 1 января) и количество (`-1` — списать все баллы)
`bonus_pay_auto_period`, `bonus_pay_auto_sum`	Автосписание баллов: период (те же значения) и количество
`date_delete`	Признак удаления

Создание, изменение, удаление группы

POST /api/counterpartiesgroups — создать, POST /api/counterpartiesgroups/<ИД> — изменить, тело JSON с полями из таблицы выше (кроме id и date_delete); title заполняйте обязательно. DELETE /api/counterpartiesgroups/<ИД> — удалить.

{"title": "Постоянные покупатели", "loyalty_type": 2, "loyalty_bonus_type": 1, "bonus_discount": 5, "bonus_pay": 50}

Контрагенты

Список контрагентов

GET /api/counterparties — страницы по 60.

Параметр	Значение
`page`	Номер страницы
`id`	ИД контрагента
`group_id`	ИД группы
`title`	Название
`phone` / `phone_like`	Телефон: точное совпадение / содержит строку
`email`	Электронная почта
`card` / `card_like`	Номер карты клиента: точное совпадение / содержит строку
`address` / `address_like`	Адрес: точное совпадение / содержит строку
`inn`	ИНН
`rs`	Расчётный счёт
`order`	`id` (по умолчанию), `title`, `group_id`, `phone`, `card`, `discount`, `bonus`

Пример: GET /api/counterparties?phone_like=9991234&order=title

Поля контрагента

Поле	Значение
`id`, `created`	ИД и время создания
`title`, `description`	Название (ФИО) и описание
`group_id`, `group_title`, `group_discount`	Группа, её название и скидка
`phone`, `email`, `card`	Телефон, почта, номер карты клиента
`inn`, `kpp`, `ogrn`, `okpo`	Реквизиты
`country_code`, `region_code`, `address`	Код страны, код региона, адрес
`rs`, `bik`, `bank`, `ks`	Банковские реквизиты
`my_org`	`1` — это ваша организация
`ie`	`1` — индивидуальный предприниматель
`ie_serial`, `ie_number`, `ie_issued`, `ie_issued_date`	Свидетельство ИП
`passport_serial`, `passport_number`, `passport_issued`, `passport_issued_date`	Паспорт ИП
`loyalty_type`	Тип карты группы
`discount`	Личная скидка, %
`bonus`	Баллы на счёте
`bonus_pay`, `bonus_discount`, `bonus_summ`, `bonus_bonus`	Личные условия баллов (как у группы)
`bonus_add_sets`	Начислять баллы на покупки баллами: `0` — как в группе, `1` — да, `-1` — нет
`edo_id`	ИД участника ЭДО
`fsrar_id`	ФСРАР ИД (ЕГАИС)
`contracts`	Договоры с контрагентом
`date_update`, `date_delete`	Время изменения и признак удаления

Создание и изменение контрагента

POST /api/counterparties — создать, POST /api/counterparties/<ИД> — изменить. Тело — JSON с полями из таблицы выше (кроме вычисляемых: id, created, group_title, group_discount, loyalty_type, bonus, my_org, contracts, date_update, date_delete). Заполняйте обязательно title и group_id.

Личные условия (discount, bonus_pay, bonus_discount, bonus_summ, bonus_bonus) действуют вместо условий группы; 0 — использовать условия группы.

{
  "title": "ООО «Ромашка»",
  "group_id": "1",
  "phone": "79991234567",
  "email": "info@example.ru",
  "inn": "5003151110",
  "kpp": "500301001",
  "address": "г. Арзамас, ул. Ленина, 1"
}

Ответ: id — ИД контрагента.

Удаление контрагента

DELETE /api/counterparties/<ИД>.

Обновлено: 09.11.2026