Контрагенты¶

Получение списка контагентов¶

Метод: GET
URL: https://beta.api.gigma.ru/counterparties
Авторизация: Bearer token

Параметры запроса¶

is_company - флаг "это компания"
counterparty_type_id[] - массив для фильтрации контрагентов по ID типа
manager_id[] - массив для фильтрации контрагентов по ID менеджера
query - поисковая строка
date_from - "дата с..." (от даты добавления в систему)
date_to - "дата по..." (от даты добавления в систему)
credit_gt - минимальная задолженность "задолженность больше..."
credit_lt - максимальная задолженность "задолженность меньше..."
credit - задолженность равна... (целочисленное значение, int)

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

https://beta.api.gigma.ru/counterparties?counterparty_type_id[]=2

Ответ¶

При успешном действии возвращается HTTP код 200.

{
    "counterparties": [
        {
            "id": 1,
            "is_company": true,
            "counterparty_type_id": 2,
            "name": "ОБЩЕСТВО С ОГРАНИЧЕННОЙ ОТВЕТСТВЕННОСТЬЮ \"АЙТЕКО\"",
            "inn": 5403057658,
            "kpp": 540301001,
            "head": "Снегирёв Алексей Игоревич",
            "registered_at": "2020-04-02",
            "phone_1": "79999999999",
            "phone_2": "78888888888",
            "email": "support@itecho.ru",
            "legal_address": "630073, Новосибирская область, город Новосибирск, Новогодняя ул., д. 20/1, кв. 26"
        }
    ]
}

Описание полей ответа¶

id - первичный ключ
type - объект с информацией о типе контрагента. Информацию о возвращаемых полях см. в запросе
manager - объект с информацией о менеджере. Информацию о возвращаемых полях см. в запросе
name - название компании
avatar - объект, содержащий информацию об аватаре пользователя. Для информации о полях объекта file см. запрос
registered_at - дата регистрации
inn - ИНН компании
head - директор
legal_address - юридический адрес
phone_1 - контактный номер телефона 1
phone_2 - контактный номер телефона 2
email - электронная почта
created_at - дата и время добавления
updated_at - дата и время обновления