Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Создать новую сделку crm.deal.add». Вы узнаете экспертные методики работы с crm.deal.add и научитесь избегать типичных ошибок начинающих разработчиков.
Создать новую сделку crm.deal.add
> Scope: crm
>
> Кто может выполнять метод: любой пользователь с правом «добавления» сделок
Метод crm.deal.add создает новую сделку.
Параметры метода
Названиетип | Описание |
|---|---|
fieldsobject | Объект формата:где: Список доступных полей описан ниже |
paramsobject | Объект, содержащий дополнительный набор параметров (подробное описание) |
Параметр fields {#fields}
Названиетип | Описание |
|---|---|
TITLEstring | Название сделки. По умолчанию генерируется по шаблону |
TYPE_IDcrm_status | Строковый идентификатор типа сделки. Список доступных типов сделки можно узнать с помощью метода crm.status.list, применив фильтр По умолчанию — первый доступный тип сделки |
CATEGORY_IDcrm_category | Идентификатор воронки. Обязательно больше или равен 0. Список доступных воронок можно узнать с помощью метода crm.category.list, передав По умолчанию — идентификатор воронки по умолчанию |
STAGE_IDcrm_status | Стадия сделки. Список доступных стадий можно узнать с помощью метода crm.status.list, применив фильтр: По умолчанию — первая доступная стадия относительно воронки |
IS_RECURRINGchar | Является ли сделка шаблоном регулярной сделки. Возможные значения: — Y — да— N — нетПо умолчанию |
IS_RETURN_CUSTOMERchar | Является ли сделка повторной. Возможные значения: — Y — да— N — нетПо умолчанию |
IS_REPEATED_APPROACHchar | Является ли сделка повторным обращением. Возможные значения: — Y — да— N — нетПо умолчанию |
PROBABILITYinteger | Вероятность, % |
CURRENCY_IDcrm_currency | Валюта. Список доступных валют можно узнать с помощью метода crm.currency.list |
OPPORTUNITYdouble | Сумма. По умолчанию |
IS_MANUAL_OPPORTUNITYchar | Включен ли режим ручного подсчета суммы. Возможные значения: — Y — да— N — нетПо умолчанию |
TAX_VALUEdouble | Сумма налога. По умолчанию |
COMPANY_IDcrm_company | Идентификатор компании, привязанной к сделке. Список компаний можно узнать с помощью метода crm.item.list, передав |
CONTACT_IDcrm_contact | Контакт. Устаревшее |
CONTACT_IDScrm_contact[] | Список привязанных к сделке контактов. Список контактов можно узнать с помощью метода crm.item.list, передав |
BEGINDATEdate | Дата начала. По умолчанию — дата создания сделки |
CLOSEDATEdate | Дата завершения. По умолчанию — дата создания сделки плюс 7 дней |
OPENEDchar | Доступна ли сделка для всех. Возможные значения: — Y — да— N — нетПо умолчанию |
CLOSEDchar | Является ли сделка закрытой. Возможные значения: — Y — да— N — нетПо умолчанию |
COMMENTSstring | Комментарий. Поддерживает bb-коды |
ASSIGNED_BY_IDuser | Ответственный. По умолчанию — пользователь, вызывающий данный метод |
SOURCE_IDcrm_status | Строковый идентификатор типа источника. Список доступных источников можно узнать с помощью метода crm.status.list, применив фильтр По умолчанию — первый доступный тип источника |
SOURCE_DESCRIPTIONstring | Дополнительно об источнике |
ADDITIONAL_INFOstring | Дополнительная информация |
LOCATION_IDlocation | Местоположение клиента. Служебное поле |
ORIGINATOR_IDstring | Идентификатор источника данных. Используется только для привязки к внешнему источнику |
ORIGIN_IDstring | Идентификатор элемента в источнике данных. Используется только для привязки к внешнему источнику |
UTM_SOURCEstring | Рекламная система (Google-Adwords и другие) |
UTM_MEDIUMstring | Тип трафика. Возможные значения: — CPC — объявления— CPM — баннеры |
UTM_CAMPAIGNstring | Обозначение рекламной кампании |
UTM_CONTENTstring | Содержание кампании. Например, для контекстных объявлений |
UTM_TERMstring | Условие поиска кампании. Например, ключевые слова контекстной рекламы |
TRACEstring | Информация для сквозной аналитики — подробнее читайте в статье [](../../../tutorials/crm/how-to-use-analitycs/info-to-analitics) |
| UF_CRM_… | Пользовательские поля. Например, UF_CRM_25534736.В зависимости от настроек портала у сделок может быть набор пользовательских полей определенных типов. Добавить пользовательское поле в сделку можно с помощью метода crm.deal.userfield.add |
PARENT_ID_…crm_entity | Поля связей. Если на портале есть смарт-процессы, связанные со сделками, для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и сделкой. Само поле хранит идентификатор элемента такого смарт-процесса. Например, поле |
Параметр params {#params}
Названиетип | Описание |
|---|---|
REGISTER_SONET_EVENT boolean | Зарегистрировать ли событие добавления сделки в живой ленте. Возможные значения: — Y — да— N — нетПо умолчанию |
Примеры кода
- cURL (Webhook)
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FIELDS":{"TITLE":"Новая сделка #1","TYPE_ID":"COMPLEX","CATEGORY_ID":0,"STAGE_ID":"PREPARATION","IS_RECURRING":"N","IS_RETURN_CUSTOMER":"Y","IS_REPEATED_APPROACH":"Y","PROBABILITY":99,"CURRENCY_ID":"EUR","OPPORTUNITY":1000000,"IS_MANUAL_OPPORTUNITY":"Y","TAX_VALUE":0.10,"COMPANY_ID":9,"CONTACT_IDS":[84,83],"BEGINDATE":"'"$(date --iso-8601=seconds)"'","CLOSEDATE":"'"$(date --iso-8601=seconds --date='+10 days')"'", "OPENED":"Y","CLOSED":"N","COMMENTS":"Пример комментария","SOURCE_ID":"CALLBACK","SOURCE_DESCRIPTION":"Дополнительно об источнике","ADDITIONAL_INFO":"Дополнительная информация","UTM_SOURCE":"google","UTM_MEDIUM":"CPC","PARENT_ID_1220":22,"UF_CRM_1721244482250":"Привет мир!"},"PARAMS":{"REGISTER_SONET_EVENT":"N"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/crm.deal.add- cURL (OAuth)
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"FIELDS":{"TITLE":"Новая сделка #1","TYPE_ID":"COMPLEX","CATEGORY_ID":0,"STAGE_ID":"PREPARATION","IS_RECURRING":"N","IS_RETURN_CUSTOMER":"Y","IS_REPEATED_APPROACH":"Y","PROBABILITY":99,"CURRENCY_ID":"EUR","OPPORTUNITY":1000000,"IS_MANUAL_OPPORTUNITY":"Y","TAX_VALUE":0.10,"COMPANY_ID":9,"CONTACT_IDS":[84,83],"BEGINDATE":"'"$(date --iso-8601=seconds)"'","CLOSEDATE":"'"$(date --iso-8601=seconds --date='+10 days')"'", "OPENED":"Y","CLOSED":"N","COMMENTS":"Пример комментария","SOURCE_ID":"CALLBACK","SOURCE_DESCRIPTION":"Дополнительно об источнике","ADDITIONAL_INFO":"Дополнительная информация","UTM_SOURCE":"google","UTM_MEDIUM":"CPC","PARENT_ID_1220":22,"UF_CRM_1721244482250":"Привет мир!"},"PARAMS":{"REGISTER_SONET_EVENT":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.deal.add- JS
try
{
const day = 60 * 60 * 24 * 1000;
const now = new Date();
const after10Days = new Date(now.getTime() + 10 * day);
const response = await $b24.callMethod(
'crm.deal.add',
{
fields: {
TITLE: "Новая сделка #1",
TYPE_ID: "COMPLEX",
CATEGORY_ID: 0,
STAGE_ID: "PREPARATION",
IS_RECURRING: "N",
IS_RETURN_CUSTOMER: "Y",
IS_REPEATED_APPROACH: "Y",
PROBABILITY: 99,
CURRENCY_ID: "EUR",
OPPORTUNITY: 1000000,
IS_MANUAL_OPPORTUNITY: "Y",
TAX_VALUE: 0.10,
COMPANY_ID: 9,
CONTACT_IDS: [84, 83],
BEGINDATE: now.toISOString(),
CLOSEDATE: after10Days.toISOString(),
OPENED: "Y",
CLOSED: "N",
COMMENTS: "[B]Пример комментария[/B]",
SOURCE_ID: "CALLBACK",
SOURCE_DESCRIPTION: "Дополнительно об источнике",
ADDITIONAL_INFO: "Дополнительная информация",
UTM_SOURCE: "google",
UTM_MEDIUM: "CPC",
PARENT_ID_1220: 22,
UF_CRM_1721244482250: "Привет мир!",
},
params: {
REGISTER_SONET_EVENT: "N",
},
}
);
const result = response.getData().result;
result.error()
? console.error(result.error())
: console.info(result)
;
}
catch( error )
{
console.error('Error:', error);
}- PHP
try {
$fields = [
'TITLE' => 'New Deal',
'TYPE_ID' => 'GIG',
'CATEGORY_ID' => '1',
'STAGE_ID' => 'C1:NEW',
'CURRENCY_ID' => 'USD',
'OPPORTUNITY' => '10000',
'BEGINDATE' => (new DateTime())->format(DateTime::ATOM),
'CLOSEDATE' => (new DateTime('+1 month'))->format(DateTime::ATOM),
'COMMENTS' => 'This is a test deal.',
];
$params = [
'REGISTER_SONET_EVENT' => 'Y',
];
$result = $serviceBuilder
->getCRMScope()
->deal()
->add($fields, $params);
print($result->getId());
} catch (Throwable $e) {
print('Error: ' . $e->getMessage());
}- BX24.js
const day = 60 * 60 * 24 * 1000;
const now = new Date();
const after10Days = new Date(now.getTime() + 10 * day);
BX24.callMethod(
'crm.deal.add',
{
fields: {
TITLE: "Новая сделка #1",
TYPE_ID: "COMPLEX",
CATEGORY_ID: 0,
STAGE_ID: "PREPARATION",
IS_RECURRING: "N",
IS_RETURN_CUSTOMER: "Y",
IS_REPEATED_APPROACH: "Y",
PROBABILITY: 99,
CURRENCY_ID: "EUR",
OPPORTUNITY: 1000000,
IS_MANUAL_OPPORTUNITY: "Y",
TAX_VALUE: 0.10,
COMPANY_ID: 9,
CONTACT_IDS: [84, 83],
BEGINDATE: now.toISOString(),
CLOSEDATE: after10Days.toISOString(),
OPENED: "Y",
CLOSED: "N",
COMMENTS: "[B]Пример комментария[/B]",
SOURCE_ID: "CALLBACK",
SOURCE_DESCRIPTION: "Дополнительно об источнике",
ADDITIONAL_INFO: "Дополнительная информация",
UTM_SOURCE: "google",
UTM_MEDIUM: "CPC",
PARENT_ID_1220: 22,
UF_CRM_1721244482250: "Привет мир!",
},
params: {
REGISTER_SONET_EVENT: "N",
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);- PHP CRest
require_once('crest.php');
$result = CRest::call(
'crm.deal.add',
[
'FIELDS' => [
'TITLE' => 'Новая сделка #1',
'TYPE_ID' => 'COMPLEX',
'CATEGORY_ID' => 0,
'STAGE_ID' => 'PREPARATION',
'IS_RECURRING' => 'N',
'IS_RETURN_CUSTOMER' => 'Y',
'IS_REPEATED_APPROACH' => 'Y',
'PROBABILITY' => 99,
'CURRENCY_ID' => 'EUR',
'OPPORTUNITY' => 1000000,
'IS_MANUAL_OPPORTUNITY' => 'Y',
'TAX_VALUE' => 0.10,
'COMPANY_ID' => 9,
'CONTACT_IDS' => [84, 83],
'BEGINDATE' => (new DateTime())->format(DateTime::ATOM),
'CLOSEDATE' => (new DateTime('+10 days'))->format(DateTime::ATOM),
'OPENED' => 'Y',
'CLOSED' => 'N',
'COMMENTS' => 'Пример комментария',
'SOURCE_ID' => 'CALLBACK',
'SOURCE_DESCRIPTION' => 'Дополнительно об источнике',
'ADDITIONAL_INFO' => 'Дополнительная информация',
'UTM_SOURCE' => 'google',
'UTM_MEDIUM' => 'CPC',
'PARENT_ID_1220' => 22,
'UF_CRM_1721244482250' => 'Привет мир!',
],
'PARAMS' => [
'REGISTER_SONET_EVENT' => 'N',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';Обработка ответа
HTTP-статус: 200
{
"result": 394,
"time": {
"start": 1725013197.635808,
"finish": 1725013198.580873,
"duration": 0.9450650215148926,
"processing": 0.6822988986968994,
"date_start": "2024-08-30T12:19:57+02:00",
"date_finish": "2024-08-30T12:19:58+02:00",
"operating": 0
}
}Возвращаемые данные
Названиетип | Описание |
|---|---|
resultinteger | Корневой элемент ответа, содержит идентификатор созданной сделки |
timetime | Информация о времени выполнения запроса |
Обработка ошибок
HTTP-статус: 400
{
"error": "",
"error_description": "Parameter 'fields' must be array."
}Возможные коды ошибок
| Код | Описание | Значение |
|---|---|---|
- | Parameter 'fields' must be array | В параметр fields передан не объект |
- | Parameter 'params' must be array | В Параметр params передан не объект |
- | Access denied | У пользователя нет прав на «добавление» сделок |
- | Исчерпан выделенный дисковый ресурс | > |
- | Неверное значение поля «Валюта» | > |
- [](./crm-deal-update)
- [](./crm-deal-get)
- [](./crm-deal-list)
- [](./crm-deal-delete)
- [](./crm-deal-fields)
- [](../../../tutorials/crm/how-to-add-crm-objects/how-to-add-deal-with-choice-of-requisite)
💡 Экспертное мнение и рекомендации
Ключевые выводы по теме «Создать новую сделку crm.deal.add»:
Использование современных стандартов D7 при работе с crm.deal.add позволяет писать чистый, масштабируемый и безопасный код. Не забывайте обрабатывать исключения (try/catch) и проверять права доступа текущего пользователя перед выполнением критических операций.
Похожая задача в бизнесе?
Помогу автоматизировать процессы и внедрить ИИ
Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.
или на почту: gorandvas@yandex.ru