Блог Горошко Андрея Bitrix24,PHP Получить сделку по Id crm.deal.get

Получить сделку по Id crm.deal.get

При разработке и поддержке проектов на платформе 1С-Битрикс критически важно использовать современные стандарты D7 API. В этом руководстве мы детально изучим тему «Получить сделку по Id crm.deal.get», разберем архитектурные особенности и предоставим готовые к интеграции примеры кода.

Получить сделку по Id crm.deal.get

> Scope: crm
>
> Кто может выполнять метод: любой пользователь с правом «чтения» сделок

Метод crm.deal.get возвращает сделку по идентификатору.

Параметры метода

Название
тип
Описание
id*
integer
Идентификатор сделки.

Идентификатор можно получить с помощью методов crm.deal.list или crm.deal.add

[](./recurring-deals/crm-deal-recurring-get)

Примеры кода

  • cURL (Webhook)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"ID":410}' \
    https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webbhook_here**/crm.deal.get
  • cURL (OAuth)
    curl -X POST \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"ID":410,"auth":"**put_access_token_here**"}' \
    https://**put_your_bitrix24_address**/rest/crm.deal.get
  • JS
    try
    {
    	const response = await $b24.callMethod(
    		'crm.deal.get',
    		{
    			id: 410,
    		}
    	);
    	
    	const result = response.getData().result;
    	result.error()
    		? console.error(result.error())
    		: console.info(result)
    	;
    }
    catch( error )
    {
    	console.error('Error:', error);
    }
  • PHP
    try {
        $response = $b24Service
            ->core
            ->call(
                'crm.deal.get',
                [
                    'id' => 410,
                ]
            );
    
        $result = $response
            ->getResponseData()
            ->getResult();
    
        if ($result->error()) {
            echo 'Error: ' . $result->error();
        } else {
            echo 'Deal data: ' . print_r($result->data(), true);
        }
    
    } catch (Throwable $e) {
        error_log($e->getMessage());
        echo 'Error getting deal: ' . $e->getMessage();
    }
  • BX24.js
    BX24.callMethod(
        'crm.deal.get',
        {
            id: 410,
        },
        (result) => {
            result.error()
                ? console.error(result.error())
                : console.info(result.data())
            ;
        },
    );
  • PHP CRest
    require_once('crest.php');

    $result = CRest::call(
        'crm.deal.get',
        [
            'ID' => 410
        ]
    );

    echo '<PRE>';
    print_r($result);
    echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
    "result": {
        "ID": "410",
        "TITLE": "Новая сделка #1",
        "TYPE_ID": "COMPLEX",
        "STAGE_ID": "PREPARATION",
        "PROBABILITY": "99",
        "CURRENCY_ID": "EUR",
        "OPPORTUNITY": "1000000.00",
        "IS_MANUAL_OPPORTUNITY": "Y",
        "TAX_VALUE": "0.00",
        "LEAD_ID": null,
        "COMPANY_ID": "9",
        "CONTACT_ID": "84",
        "QUOTE_ID": null,
        "BEGINDATE": "2024-08-30T02:00:00+02:00",
        "CLOSEDATE": "2024-09-09T02:00:00+02:00",
        "ASSIGNED_BY_ID": "1",
        "CREATED_BY_ID": "1",
        "MODIFY_BY_ID": "1",
        "DATE_CREATE": "2024-08-30T14:29:00+02:00",
        "DATE_MODIFY": "2024-08-30T14:29:00+02:00",
        "OPENED": "Y",
        "CLOSED": "N",
        "COMMENTS": "[B]Пример комментария[\/B]",
        "ADDITIONAL_INFO": "Дополнительная информация",
        "LOCATION_ID": null,
        "CATEGORY_ID": "0",
        "STAGE_SEMANTIC_ID": "P",
        "IS_NEW": "N",
        "IS_RECURRING": "N",
        "IS_RETURN_CUSTOMER": "N",
        "IS_REPEATED_APPROACH": "N",
        "SOURCE_ID": "CALLBACK",
        "SOURCE_DESCRIPTION": "Дополнительно об источнике",
        "ORIGINATOR_ID": null,
        "ORIGIN_ID": null,
        "MOVED_BY_ID": "1",
        "MOVED_TIME": "2024-08-30T14:29:00+02:00",
        "LAST_ACTIVITY_TIME": "2024-08-30T14:29:00+02:00",
        "UTM_SOURCE": "google",
        "UTM_MEDIUM": "CPC",
        "UTM_CAMPAIGN": null,
        "UTM_CONTENT": null,
        "UTM_TERM": null,
        "PARENT_ID_1220": "22",
        "LAST_ACTIVITY_BY": "1",
        "UF_CRM_1721244482250": "Привет мир!"
    },
    "time": {
        "start": 1725020945.541275,
        "finish": 1725020946.179076,
        "duration": 0.637800931930542,
        "processing": 0.21427488327026367,
        "date_start": "2024-08-30T14:29:05+02:00",
        "date_finish": "2024-08-30T14:29:06+02:00",
        "operating": 0
    }
}

Возвращаемые данные

Название
тип
Описание
result
deal
Корневой элемент ответа. Содержит информацию о полях сделки. Структура описана ниже
time
time
Информация о времени выполнения запроса

Тип deal {#deal}

Название
тип
Описание
ID
integer
Идентификатор сделки
TITLE
string
Название
TYPE_ID
crm_status
Строковый идентификатор типа сделки.

Узнать подробнее о полученном типе сделки можно с помощью метода crm.status.list, передав в фильтр:

{
    ENTITY_ID: 'DEAL_TYPE',
    STATUS_ID: TYPE_ID,
}
CATEGORY_ID
crm_category
Воронка. Узнать подробнее об этой воронке можно с помощью метода crm.category.get, передав entityTypeId = 2 и id = CATEGORY_ID
STAGE_ID
crm_status
Строковый идентификатор стадии сделки.

Узнать подробнее о полученной стадии можно с помощью метода crm.status.list, передав в фильтр:

{
    ENTITY_ID: entityId,
    STATUS_ID: statusId,
}

где:
— entityId равен:
— DEAL_STAGE в случае, когда сделка находится в общей воронке (CATEGORY_ID = 0)
— DEAL_STAGE_{categoryId}, где categoryId = CATEGORY_ID
— statusId равен STAGE_ID

STAGE_SEMANTIC_ID
string
Группа стадии. Возможные значения:
— P — в работе
— S — успешная
— F — неуспешная
IS_NEW
char
Является ли сделка новой. Возможные значения:
— Y — да
— N — нет
IS_RECURRING
char
Является ли сделка регулярной. Возможные значения:
— Y — да
— N — нет
IS_RETURN_CUSTOMER
char
Является ли сделка повторной. Возможные значения:
— Y — да
— N — нет
IS_REPEATED_APPROACH
char
Является ли обращение повторным. Возможные значения:
— Y — да
— N — нет
PROBABILITY
integer
Вероятность, %
CURRENCY_ID
crm_currency
Валюта
OPPORTUNITY
double
Сумма
IS_MANUAL_OPPORTUNITY
char
Включен ли ручной режим подсчета суммы. Возможные значения:
— Y — да
— N — нет
TAX_VALUE
double
Ставка налога
COMPANY_ID
crm_company
Идентификатор компании.

Узнать подробнее о компании можно с помощью метода crm.item.get, передав entityTypeId = 4 и id = COMPANY_ID

CONTACT_ID
crm_contact
Идентификатор контакта. Устаревшее.

Чтобы получить список всех контактов сделки, используйте метод crm.deal.contact.items.get или универсальный метод crm.item.get

QUOTE_ID
crm_quote
Идентификатор коммерческого предложения, на основе которого была создана сделка.

Узнать подробнее о коммерческом предложении можно с помощью метода crm.item.get, передав entityTypeId = 7 и id = QUOTE_ID

BEGINDATE
date
Дата начала
CLOSEDATE
date
Дата завершения
OPENED
char
Доступна ли сделка для всех. Возможные значения:
— Y — да
— N — нет
CLOSED
char
Закрыта ли сделка. Возможные значения:
— Y — да
— N — нет
COMMENTS
string
Комментарий
ASSIGNED_BY_ID
user
Ответственный
CREATED_BY_ID
user
Кем создана
MODIFY_BY_ID
user
Кем изменена
MOVED_BY_ID
user
Идентификатор пользователя, который последним поменял стадию
DATE_CREATE
datetime
Дата создания
DATE_MODIFY
datetime
Дата изменения
MOVED_TIME
datetime
Дата последнего изменения стадии
SOURCE_ID
crm_status
Источник.

Узнать подробнее о полученном источнике можно с помощью метода crm.status.list, передав в фильтр:

{
    ENTITY_ID: 'SOURCE',
    STATUS_ID: SOURCE_ID,
}
SOURCE_DESCRIPTION
string
Дополнительно об источнике
LEAD_ID
crm_lead
Идентификатор лида, на основании которого создана сделка.

Узнать подробнее о лиде можно с помощью метода crm.item.get, передав entityTypeId = 1 и id = LEAD_ID

ADDITIONAL_INFO
string
Дополнительная информация
LOCATION_ID
location
Местоположение. Служебное поле
ORIGINATOR_ID
string
Внешний источник
ORIGIN_ID
string
Идентификатор элемента во внешнем источнике
UTM_SOURCE
string
Рекламная система
UTM_MEDIUM
string
Тип трафика
UTM_CAMPAIGN
string
Обозначение рекламной кампании
UTM_CONTENT
string
Содержание кампании
UTM_TERM
string
Условие поиска кампании
LAST_ACTIVITY_TIME
datetime
Дата последней активности в таймлайне
LAST_ACTIVITY_BY
user
Автор последней активности в таймлайне
UF_CRM_…
any
Пользовательские поля. Например, UF_CRM_25534736.

В зависимости от настроек портала у сделок может быть набор пользовательских полей определенных типов. Подробнее читайте в разделе о пользовательских полях

PARENT_ID_…
crm_entity
Поля связей.

Если на портале есть смарт-процессы, связанные со сделками, для каждого такого смарт-процесса существует поле, хранящее связь между этим смарт-процессом и сделкой. Само поле хранит идентификатор элемента такого смарт-процесса.

Например, поле PARENT_ID_153 — связь со смарт-процессом entityTypeId=153, хранит идентификатор элемента этого смарт-процесса, связанного с текущей сделкой

Обработка ошибок

HTTP-статус: 400

{
    "error": "",
    "error_description": "Parameter 'fields' must be array."
}

Возможные коды ошибок

КодОписаниеЗначение
-ID is not defined or invalidВ параметр id либо не передано значение, либо оно является не целым числом больше нуля
-Access deniedУ пользователя нет прав на «чтение» данной сделки
-Not foundСделки с переданным id не существует
  • [](./crm-deal-add)
  • [](./crm-deal-update)
  • [](./crm-deal-list)
  • [](./crm-deal-delete)
  • [](./crm-deal-fields)

💡 Экспертное мнение и рекомендации

Практические рекомендации:

  • При написании кастомных компонентов для «Получить сделку по Id crm.deal.get» всегда разделяйте бизнес-логику и представление (шаблон).
  • Используйте отладку SQL-запросов через конструкцию $wpdb->last_query или стандартный трекер Битрикса, чтобы контролировать нагрузку.

Похожая задача в бизнесе?

Помогу автоматизировать процессы и внедрить ИИ

Меня зовут Андрей Горошко. Я Full-stack разработчик и эксперт по 1С-Битрикс. Настраиваю CRM Битрикс24, разрабатываю защищенные API и создаю умных ИИ-агентов для автоматизации рутины.

Related Post

Разработка B2B-портала для оптовых поставщиков автохимии и смазочных материаловРазработка B2B-портала для оптовых поставщиков автохимии и смазочных материалов

Разработка и внедрение профессионального B2B-портала и дилерского кабинета на 1С-Битрикс позволяет кардинально сократить издержки отдела оптовых продаж, перевести дилеров на самообслуживание 24/7 и исключить ошибки ручного ввода заказов. Услуга «Разработка

Как использовать метод SDK crm.item.details.configuration.reset в Битрикс24Как использовать метод SDK crm.item.details.configuration.reset в Битрикс24

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Как использовать метод SDK crm.item.details.configuration.reset в Битрикс24». Вы узнаете экспертные методики работы с

Получить список действий над задачей task.item.getallowedactionsПолучить список действий над задачей task.item.getallowedactions

Эффективная интеграция и кастомизация функционала в Битрикс24 часто требует работы на уровне API. Сегодня мы подробно рассмотрим «Получить список действий над задачей task.item.getallowedactions». Вы узнаете экспертные методики работы с task.item.getallowedactions