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

Если вы разрабатываете интеграции для Битрикс24 с помощью AI-инструментов (Codex, Claude Code, Cursor), подключите MCP-сервер, чтобы ассистент использовал официальную REST-документацию.

Scope: crm

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

DEPRECATED

Развитие метода остановлено. Используйте crm.item.get.

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

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

Обязательные параметры отмечены *

Название
тип

Описание

id*
integer

Идентификатор сделки.

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

Связанные методы и темы

Получить настройки шаблона регулярной сделки по id crm.deal.recurring.get

Примеры кода

Как использовать примеры в документации

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_webhook_here**/crm.deal.get
        
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
        
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);
        }
        
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.callMethod(
            'crm.deal.get',
            {
                id: 410,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
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

Название
тип

Описание

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."
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

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

Код

Описание

Значение

-

ID is not defined or invalid

В параметр id либо не передано значение, либо оно является не целым числом больше нуля

-

Access denied

У пользователя нет прав на «чтение» данной сделки

-

Not found

Сделки с переданным id не существует

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус

Код
Текст ошибки

Описание

500

INTERNAL_SERVER_ERROR
Internal server error

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24

503

QUERY_LIMIT_EXCEEDED
Too many requests

Превышен лимит на интенсивность запросов

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

Текущий метод не разрешен для вызова с помощью batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

Превышена максимальная длина параметров, переданных в метод batch

401

NO_AUTH_FOUND
Wrong authorization data

Неверный access-токен или код вебхука

400

INVALID_REQUEST
Https required

Для вызовов методов требуется использовать протокол HTTPS

503

OVERLOAD_LIMIT
REST API is blocked due to overload

REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24

403

ACCESS_DENIED
REST API is available only on commercial plans

REST API доступен только на коммерческих планах

403

INVALID_CREDENTIALS
Invalid request credentials

У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

Манифест недоступен

403

insufficient_scope
The request requires higher privileges than provided by the webhook token

Запрос требует более высоких привилегий, чем предоставляет токен вебхука

401

expired_token
The access token provided has expired

Предоставленный access-токен доступа истек

403

user_access_error
The user does not have access to the application

Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям

500

PORTAL_DELETED
Portal was deleted

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Предыдущая
Изменить сделку
Следующая
Получить список сделок