Сделки

Список сделок get

https://userID.aircrm.pro/api/deals

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

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

orderOptional string Отсортируйте запрашиваемые результаты.
Пример: ?order=created_at или ?order=created_at|desc
selectOptional string Выберите только нужные поля (для оптимизации запросов).
Пример: ?select=first_name;id
per_pageOptional integer Укажите количество записей.
Пример: ?per_page=20
pageOptional integer Номер страницы.
Пример: ?page=2
qOptional string Поиск по заданному запросу.
Пример: ?q=Dmitry
search_fieldsOptional string Измените поля, по которым будет выполняться поиск.
Пример:?search_fields=email:like;phones.number:=
search_matchOptional string По умолчанию запросы выполняются с использованием оператора OR для каждого запроса, если вам нужно сопоставить все параметры, используйте AND.
Пример: ?search_match=and

Получить сделку get

https://userID.aircrm.pro/api/deals/{id}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Создать сделку post

https://userID.aircrm.pro/api/deals

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Body

nameRequired string
stage_idRequired integer ID этапа
amountOptional number
expected_close_dateOptional date В формате UTC
user_idOptional integer Ответственный за сделку
statusOptional string Любой из ['open', 'won', 'lost']
lost_reasonOptional string Применимо при статусе как провальной - lost
contactsOptional array Массив ID контактов, с которыми связана сделка
companiesOptional array Массив ID компаний, с которыми связана сделка
...customFieldsOptional mixed Любые дополнительные настраиваемые поля

Редактировать сделку put

https://userID.aircrm.pro/api/deals/{id}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Body

nameRequired string
stage_idRequired integer ID этапа
amountOptional number Не применимо, если в сделке есть товары, поскольку сумма автоматически обновляется на основе общей стоимости всех товаров
expected_close_dateOptional date В формате UTC
user_idOptional integer Ответственный за сделку
statusOptional string Любой из ['open', 'won', 'lost']
lost_reasonOptional string Применимо при статусе как провальной - lost
contactsOptional array Массив ID контактов, с которыми связана сделка
companiesOptional array Массив ID компаний, с которыми связана сделка
...customFieldsOptional mixed Любые дополнительные настраиваемые поля

Удалить сделку delete

https://userID.aircrm.pro/api/deals/{id}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Поиск сделок get

https://userID.aircrm.pro/api/deals/search?q={query}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

qRequired string

Query

takeOptional integer Максимальное количество результатов.
Пример: ?take=1
orderOptional string Отсортируйте запрашиваемые результаты.
Пример: ?order=created_at или ?order=created_at|desc
selectOptional string Выберите только нужные поля (для оптимизации запросов).
Пример: ?select=first_name;id
search_fieldsOptional string Измените поля, по которым будет выполняться поиск.
Пример:?search_fields=email:like;phones.number:=
search_matchOptional string По умолчанию запросы выполняются с использованием оператора OR для каждого запроса, если вам нужно сопоставить все параметры, используйте AND.
Пример: ?search_match=and

Прикрепить ассоциацию к сделке put

https://userID.aircrm.pro/api/associations/deals/{id}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Обязательно укажите хотя бы одну запись.

Body

contactsOptional array Массив ID контактов для прикрепления
companiesOptional array Массив ID компаний для прикрепления
activitiesOptional array Массив ID задач для прикрепления

Отключить ассоциацию от сделки delete

https://userID.aircrm.pro/api/associations/deals/{id}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Обязательно укажите хотя бы одну запись.

Body

contactsOptional array Массив ID контактов для отвязки
companiesOptional array Массив ID компаний для отвязки
activitiesOptional array Массив ID задач для отвязки

Синхронизация ассоциаций для сделки post

https://userID.aircrm.pro/api/associations/deals/{id}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Обязательно укажите хотя бы одну запись.

Body

contactsOptional array Массив ID контактов
companiesOptional array Массив ID компаний
activitiesOptional array Массив ID задач

Изменить статус сделки put

https://userID.aircrm.pro/api/deals/{id}/status/{status}

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи
statusRequired string Любой из ['open', 'won', 'lost']

Body

lost_reasonOptional string Причина потери сделки при пометке сделки как провальной

Продукты в сделке post

https://userID.aircrm.pro/api/deals/{id}/billable

Headers

Content-TypeRequired string application/json
AuthenticationRequired string {token}

Path

idRequired integer ID-записи

Body

productsOptional array Массив продуктов, которые необходимо прикрепить к оплачиваемому объекту
removed_productsOptional array Массив ID оплачиваемых продуктов, которые необходимо удалить из записи
tax_typeOptional string Любой из ['exclusive', 'inclusive', 'no_tax']

Если он не указан, будет использоваться выбранный по умолчанию тип налога в Настройки->Продукты

Product metadata

idOptional integer ID оплачиваемого продукта, используемый для обновления. Вам не нужно предоставлять такое значение при добавлении новых продуктов в оплачиваемый, укажите значение только при обновлении
product_idOptional integer ID продукта из соответствующего раздела. Если не указано, AirCRM будет искать существующий продукт с таким же именем, и если такого продукта нет, создаст новый
nameRequired string Имя продукта (товара или услуги)
descriptionOptional string Описание продукта
unit_priceRequired number Цена за единицу - цена каждой проданной единицы.
qtyOptional number Количество (по умолчанию 1)
discount_typeOptional string Любой из ['percent', 'fixed']
discount_totalOptional number Процент, если discount_type percent, или общая сумма скидки, если discount_type fixed
tax_labelOptional string
tax_rateOptional number
unitOptional string