Главная / Сервисы и интеграция / MegaCRM / Документация API MegaCRM / Сделки

Сделки ^#3025

Одна из основных сущностей системы. Соcтоит из набора основных и дополнительных полей. Каждая сделка может быть прикреплена к одному или нескольким контактам, а может быть не привязан ни к одному. Каждой сделке может быть задан ответственный для разграничения прав доступа между сотрудниками аккаунта.

Создание сделок

Создаёт одну или несколько сделок.

Запрос

POST https://api.megacrm.ru/v1/deals

Название параметра	Обязательный	Тип и ограничения	Описание
title	Да	Строка не более 200 символов	Название сделки
category_id		Натуральное число	ID воронки
client_id		Натуральное число	ID клиента
currency_id		Натуральное число	ID валюты
doer_id		Натуральное число	ID исполнителя
reject_reason_id		Натуральное число	ID причины отказа
source_id		Натуральное число	ID источника
status_id		Натуральное число	ID статуса сделки
description		Строка не более 65535 байт	Описание сделки
discount_type		Натуральное число	Вид скидки на заказ. 0 - не применяется; 1 - фиксированная сумма в валюте сделки; 2 - процент от стоимости товаров сделки
discount_fixed		Число с плавающей точкой	Скидка на заказ как фиксированная сумма в валюте сделки
discount_percent		Число с плавающей точкой	Скидка на заказ как процент от стоимости товаров сделки
price		Положительное число с плавающей точкой	Стоимость сделки
postpone		Время в unix timestamp	Время, до которого сделка отложена
deleted		Логический	Сделка удалена
custom_fields		Список из объектов дополнительных полей	Значения дополнительных полей
tags		Список из натуральных чисел и строк	Список меток: натуральное число — ID метки; строка — название метки

Ответ

Ответ содержит список ID созданных сделок.

Пример

POST https://api.megacrm.ru/v1/deals
Content-Type: application/json
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: 5038a57fc05fc75b0a48e49f55d21b3f6c20bed36bb85c753bf63dae58b2b334

[
  {
    "title": "Найти мальчика",
    "description": "Пропал мальчик. Зовут дядя Фёдор. Глаза голубые. Рост метр двадцать. Родители его ищут. Нашедшего ждёт премия – велосипед.",
    "doer_id": 123456,
    "client_id": 1,
    "tags": [
      "Срочно",
      "Награда"
    ],
    "custom_fields": [
      {
        "id": 2,
        "values": [
          1.20
        ]
      }
    ]
  }
]

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    45
  ]
}

Изменение сделок

Изменяет одну или несколько сделок.

Запрос

PATCH https://api.megacrm.ru/v1/deals

Название параметра	Обязательный	Тип и ограничения	Описание
id	Да	Натуральное число	ID сделки
title		Строка не более 200 символов	Название сделки
category_id		Натуральное число	ID воронки
client_id		Натуральное число	ID клиента
currency_id		Натуральное число	ID валюты
doer_id		Натуральное число	ID исполнителя
reject_reason_id		Натуральное число	ID причины отказа
source_id		Натуральное число	ID источника
status_id		Натуральное число	ID статуса сделки
description		Строка не более 65535 байт	Описание сделки
discount_type		Натуральное число	Вид скидки на заказ. 0 - не применяется; 1 - фиксированная сумма в валюте сделки; 2 - процент от стоимости товаров сделки
discount_fixed		Число с плавающей точкой	Скидка на заказ как фиксированная сумма в валюте сделки
discount_percent		Число с плавающей точкой	Скидка на заказ как процент от стоимости товаров сделки
price		Положительное число с плавающей точкой	Стоимость сделки
postpone		Время в unix timestamp	Время, до которого сделка отложена
deleted		Логический	Сделка удалена
custom_fields		Список из объектов дополнительных полей	Значения дополнительных полей
tags		Список из натуральных чисел и строк	Список меток: натуральное число — ID метки; строка — название метки

Ответ

Ответ содержит список ID изменённых сделок.

Пример

PATCH https://api.megacrm.ru/v1/deals
Content-Type: application/json
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: 5038a57fc05fc75b0a48e49f55d21b3f6c20bed36bb85c753bf63dae58b2b334

[
  {
    "id": 45,
    "title": "Найти мальчика",
    "description": "Пропал мальчик. Зовут дядя Фёдор. Глаза голубые. Рост метр двадцать. Родители его ищут. Нашедшего ждёт премия – велосипед.",
    "doer_id": 123456,
    "client_id": 1,
    "tags": [
      "Срочно",
      "Награда"
    ],
    "custom_fields": [
      {
        "id": 2,
        "values": [
          1.20
        ]
      }
    ]
  }
]

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    45
  ]
}

Поиск сделок

Находит сделки.

Запрос

GET https://api.megacrm.ru/v1/deals

Название параметра	Обязательный	Тип и ограничения	Описание
id		Натуральное число или список из натуральных чисел, не более 500 шт	ID сделки или нескольких сделок. Если этот параметр указан, все остальные игнорируются
query		Строка	Поиск по текстовым полям
category_id		Натуральное число или список из натуральных чисел	ID воронки
client_id		Натуральное число или список из натуральных чисел	ID клиента
doer_id		Натуральное число или список из натуральных чисел	ID исполнителя
source_id		Натуральное число или список из натуральных чисел	ID источника
status_id		Натуральное число или список из натуральных чисел	ID статуса
tag_id		Натуральное число или список из натуральных чисел	ID метки
create_time_from		Время в unix timestamp	Начало интервала времени создания
create_time_to		Время в unix timestamp	Конец интервала времени создания
update_time_from		Время в unix timestamp	Начало интервала времени изменения
update_time_to		Время в unix timestamp	Конец интервала времени изменения
done_time_from		Время в unix timestamp	Начало интервала времени успешного завершения
done_time_to		Время в unix timestamp	Конец интервала времени успешного завершения
postpone_time_from		Время в unix timestamp	Начало интервала времени провала
postpone_time_to		Время в unix timestamp	Конец интервала времени провала
done		Логический	Сделка завершена
postponed		Логический	Сделка отложена
custom_fields		Массив значений дополнительных полей	Значения дополнительных полей. Ключ массива — ID дополнительного поля. Значение массива — искомое значение или объект диапазона значений.
page		Натуральное число	Страница
limit		Натуральное число не более 500. По умолчанию 100	Количество элементов на странице

Ответ

Ответ содержит параметр «result», в котором находится список объектов сделки:

Название параметра	Тип	Описание
id	Натуральное число	ID сделки
ui_id	Натуральное число	Номер клиента
creator_id	Натуральное число	ID пользователя, который создал сделку. Может отсутствовать, если сделка создана без участия пользователя
doer_id	Натуральное число	ID исполнителя
client_id	Натуральное число	ID клиента
title	Строка	Название
description	Строка	Описание
discount_type	Натуральное число	Вид скидки на заказ. 0 - не применяется; 1 - фиксированная сумма в валюте сделки; 2 - процент от стоимости товаров сделки
discount_fixed	Число с плавающей точкой	Скидка на заказ как фиксированная сумма в валюте сделки
discount_percent	Число с плавающей точкой	Скидка на заказ как процент от стоимости товаров сделки
price	Число с плавающей точкой	Стоимость сделки
price_total	Число с плавающей точкой	Итоговая стоимость сделки с учетом НДС
price_vat	Число с плавающей точкой	Сумма НДС, которая включена в итоговую стоимость сделки
created	Время в unix timestamp	Время создания сделки
updated	Время в unix timestamp	Время последнего изменения сделки
postpone	Время в unix timestamp	Время, до которого сделка отложена
finished	Время в unix timestamp	Время, когда сделка была завершена
deleted	Логический	Сделка удалена
currency	Объект валюты	Валюта
reject_reason	Объект причины отклонения	Причина отклонения
source	Объект источника	Источник
status	Объект статуса	Статус
tags	Список объектов меток	Метки
custom_fields	Список объектов значений доп. полей	Значения дополнительных полей
category	Объект категории	Воронка

Пример

GET https://api.megacrm.ru/v1/deals?custom_fields[2][from]=1.10&custom_fields[2][to]=1.30
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: a5ffac52f57d9596ce492d9771f200e47943dbe08958904374f05308f5449f53

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 45,
      "ui_id": 45,
      "creator_id": 0,
      "doer_id": 123456,
      "client_id": 1,
      "title": "Найти мальчика",
      "description": "Пропал мальчик. Зовут дядя Фёдор. Глаза голубые. Рост метр двадцать. Родители его ищут. Нашедшего ждёт премия – велосипед.",
      "price": 0,
      "price_total": 0,
      "price_vat": 0,
      "created": 252450000,
      "updated": 252450000,
      "postpone": null,
      "finished": null,
      "deleted": false,
      "currency": {
        "id": 39,
        "code": "RUB",
        "num": 643,
        "name": "Российский рубль",
        "short_name": "руб."
      },
      "reject_reason": null,
      "source": {
        "id": 2,
        "ui_id": 2,
        "name": "CRM"
      },
      "status": {
        "id": 1,
        "category_id": 1,
        "name": "Новые",
        "position": 1,
        "bg_color": "#8a539a",
        "deletable": false
      },
      "tags": [
        {
          "id": 3,
          "name": "Срочно",
          "position": 0,
          "bg_color": "#000000",
          "deleted": false
        },
        {
          "id": 4,
          "name": "Награда",
          "position": 1,
          "bg_color": "#000000",
          "deleted": false
        }
      ],
      "category": {
        "id": 1,
        "name": "Основная",
        "position": 1,
        "deletable": false
      },
      "custom_fields": [
        {
          "id": 2,
          "alias": "code",
          "values": [
            {
              "displayValue": "1.20",
              "value": "1.20"
            }
          ]
        }
      ]
    }
  ]
}

Получение сделки

Получает одну сделку.

Запрос

GET http://api.megacrm.ru/v1/deals/<ID сделки>

Ответ

Ответ содержит объект сделки:

Название параметра	Тип	Описание
id	Натуральное число	ID сделки
ui_id	Натуральное число	Номер клиента
creator_id	Натуральное число	ID пользователя, который создал сделку. Может отсутствовать, если сделка создана без участия пользователя
doer_id	Натуральное число	ID исполнителя
client_id	Натуральное число	ID клиента
title	Строка	Название
description	Строка	Описание
discount_type	Натуральное число	Вид скидки на заказ. 0 - не применяется; 1 - фиксированная сумма в валюте сделки; 2 - процент от стоимости товаров сделки
discount_fixed	Число с плавающей точкой	Скидка на заказ как фиксированная сумма в валюте сделки
discount_percent	Число с плавающей точкой	Скидка на заказ как процент от стоимости товаров сделки
price	Число с плавающей точкой	Стоимость сделки
price_total	Число с плавающей точкой	Итоговая стоимость сделки с НДС
price_vat	Число с плавающей точкой	Сумма НДС, которая включена в итоговую стоимость сделки
created	Время в unix timestamp	Время создания сделки
updated	Время в unix timestamp	Время последнего изменения сделки
postpone	Время в unix timestamp	Время, до которого сделка отложена
finished	Время в unix timestamp	Время, когда сделка была завершена
deleted	Логический	Сделка удалена
currency	Объект валюты	Валюта
reject_reason	Объект причины отклонения	Причина отклонения
source	Объект источника	Источник
status	Объект статуса	Статус
tags	Список объектов меток	Метки
custom_fields	Список объектов значений доп. полей	Значения дополнительных полей
category	Объект категории	Воронка

Пример

GET https://api.megacrm.ru/v1/deals/45
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: a5ffac52f57d9596ce492d9771f200e47943dbe08958904374f05308f5449f53

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 45,
      "ui_id": 45,
      "creator_id": 0,
      "doer_id": 123456,
      "client_id": 1,
      "title": "Найти мальчика",
      "description": "Пропал мальчик. Зовут дядя Фёдор. Глаза голубые. Рост метр двадцать. Родители его ищут. Нашедшего ждёт премия – велосипед.",
      "price": 0,
      "price_total": 0,
      "price_vat": 0,
      "created": 252450000,
      "updated": 252450000,
      "postpone": null,
      "finished": null,
      "deleted": false,
      "currency": {
        "id": 39,
        "code": "RUB",
        "num": 643,
        "name": "Российский рубль",
        "short_name": "руб."
      },
      "reject_reason": null,
      "source": {
        "id": 2,
        "ui_id": 2,
        "name": "CRM"
      },
      "status": {
        "id": 1,
        "category_id": 1,
        "name": "Новые",
        "position": 1,
        "bg_color": "#8a539a",
        "deletable": false
      },
      "tags": [
        {
          "id": 3,
          "name": "Срочно",
          "position": 0,
          "bg_color": "#000000",
          "deleted": false
        },
        {
          "id": 4,
          "name": "Награда",
          "position": 1,
          "bg_color": "#000000",
          "deleted": false
        }
      ],
      "category": {
        "id": 1,
        "name": "Основная",
        "position": 1,
        "deletable": false
      },
      "custom_fields": [
        {
          "id": 2,
          "alias": "code",
          "values": [
            {
              "displayValue": "1.20",
              "value": "1.20"
            }
          ]
        }
      ]
    }
  ]
}

Список причин отклонения

Получает список причин отклонения сделок.

Запрос

GET http://api.megacrm.ru/v1/deals/reject-reasons

Ответ

Ответ содержит параметр «result», в котором находится список объектов причин отклонения:

Название параметра	Тип	Описание
id	Натуральное число	ID причины отклонения
name	Строка	Название
position	Целое число	Порядок следования причины отклонения в общем списке
deletable	Логический	Причину отклонения можно удалить

Пример

GET https://api.megacrm.ru/v1/deals/reject-reasons
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: e2e4866043d09b8e171237b3784599c95cb744ec3417e8959d25461185fd5bd2

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 1,
      "name": "Не назвал причину",
      "position": 1,
      "deletable": false
    },
    {
      "id": 2,
      "name": "Дорого",
      "position": 2,
      "deletable": false
    },
    {
      "id": 3,
      "name": "Ушел к конкурентам",
      "position": 3,
      "deletable": false
    },
    {
      "id": 4,
      "name": "Не подошли условия",
      "position": 4,
      "deletable": false
    }
  ]
}

Список источников

Получает список источников сделок.

Запрос

GET http://api.megacrm.ru/v1/deals/sources

Ответ

Ответ содержит параметр «result», в котором находится список объектов источников:

Название параметра	Тип	Описание
id	Натуральное число	ID причины отклонения
ui_id	Натуральное число	Номер источника
name	Строка	Название

Пример

GET https://api.megacrm.ru/v1/deals/sources
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: ac48cf7947a9a06d0a3c3abb2e1dfa01b1e9bb2c1e57bd46dca9f5a28ac915ba

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 1,
      "ui_id": 1,
      "name": "Звонок"
    },
    {
      "id": 2,
      "ui_id": 2,
      "name": "CRM"
    }
  ]
}

Список меток

Получает список меток сделок.

Запрос

GET http://api.megacrm.ru/v1/deals/tags

Ответ

Ответ содержит параметр «result», в котором находится список объектов меток:

Название параметра	Тип	Описание
id	Натуральное число	ID метки
name	Строка	Название
position	Целое число	Порядок следования метки в общем списке
bg_color	Строка	Фоновый цвет в формате #RRGGBB
deleted	Логический	Метка удалена

Пример

GET https://api.megacrm.ru/v1/deals/tags
X-MegaCrm-ApiAccount: 12345678
X-MegaCrm-ApiSignature: d88742e3c287363e1859de6e0c138e364af879fa523a106300ee76fdc0c6dbca

HTTP/1.1 200 OK
Content-Type: application/json; charset=UTF-8

{
  "result": [
    {
      "id": 3,
      "name": "Срочно",
      "position": 0,
      "bg_color": "#000000",
      "deleted": false
    },
    {
      "id": 4,
      "name": "Награда",
      "position": 1,
      "bg_color": "#000000",
      "deleted": false
    }
  ]
}

Воронки и статусы сделок

Список воронок

Список статусов

Была ли статья вам полезна?

Да

Нет

Укажите, пожалуйста, почему?

Рекомендации не помогли
Нет ответа на мой вопрос
Содержание статьи не соответствует заголовку
Другая причина

Комментарий

Сделки #3025

Создание сделок

Запрос

Ответ

Пример

Изменение сделок

Запрос

Ответ

Пример

Поиск сделок

Запрос

Ответ

Пример

Получение сделки

Запрос

Ответ

Пример

Список причин отклонения

Запрос

Ответ

Пример

Список источников

Запрос

Ответ

Пример

Список меток

Запрос

Ответ

Пример

Воронки и статусы сделок

Сделки ^#3025