Получить поля коммерческого предложения crm.quote.fields

Scope: crm

Кто может выполнять метод: любой пользователь

DEPRECATED

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

Метод crm.quote.fields возвращает описание полей коммерческого предложения, в том числе пользовательских.

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

Без параметров.

Примеры кода

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

curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{}' \
             https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.quote.fields  
        
curl -X POST \
             -H "Content-Type: application/json" \
             -H "Accept: application/json" \
             -d '{"auth":"**put_access_token_here**"}' \
             https://**put_your_bitrix24_address**/rest/crm.quote.fields  
        
try
        {
        	const response = await $b24.callMethod(
        		"crm.quote.fields",
        		{}
        	);
        	
        	const result = response.getData().result;
        	console.dir(result);
        }
        catch( error )
        {
        	console.error(error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.quote.fields',
                    []
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            // Нужная вам логика обработки данных
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error fetching quote fields: ' . $e->getMessage();
        }
        
BX24.callMethod(
            "crm.quote.fields",
            {},
            function(result) {
                if (result.error()) {
                    console.error(result.error());
                } else {
                    console.dir(result.data());
                }
            }
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.quote.fields',
            []
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
          "result": {
            "ID": {
              "type": "integer",
              "isRequired": false,
              "isReadOnly": true,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "ID"
            },
            "QUOTE_NUMBER": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": true,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "№ предложения"
            },
            "TITLE": {
              "type": "string",
              "isRequired": true,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Тема"
            },
            "STATUS_ID": {
              "type": "crm_status",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "statusType": "QUOTE_STATUS",
              "title": "Стадия предложения"
            },
            "CURRENCY_ID": {
              "type": "crm_currency",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Валюта"
            },
            "OPPORTUNITY": {
              "type": "double",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Сумма"
            },
            "TAX_VALUE": {
              "type": "double",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Ставка налога"
            },
            "COMPANY_ID": {
              "type": "crm_company",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Компания"
            },
            "MYCOMPANY_ID": {
              "type": "crm_company",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Реквизиты вашей компании"
            },
            "CONTACT_ID": {
              "type": "crm_contact",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "isDeprecated": true,
              "title": "Контакт"
            },
            "CONTACT_IDS": {
              "type": "crm_contact",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": true,
              "isDynamic": false,
              "title": "CONTACT_IDS"
            },
            "BEGINDATE": {
              "type": "date",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Дата выставления"
            },
            "CLOSEDATE": {
              "type": "date",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Срок"
            },
            "ACTUAL_DATE": {
              "type": "date",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "ACTUAL_DATE"
            },
            "OPENED": {
              "type": "char",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Доступно для всех"
            },
            "CLOSED": {
              "type": "char",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Закрыто"
            },
            "COMMENTS": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Комментарий"
            },
            "CONTENT": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Содержание"
            },
            "TERMS": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Условия"
            },
            "CLIENT_TITLE": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Клиент"
            },
            "CLIENT_ADDR": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Адрес"
            },
            "CLIENT_CONTACT": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Контактное лицо"
            },
            "CLIENT_EMAIL": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "E-mail"
            },
            "CLIENT_PHONE": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Телефон"
            },
            "CLIENT_TP_ID": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "ИНН"
            },
            "CLIENT_TPA_ID": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "КПП"
            },
            "ASSIGNED_BY_ID": {
              "type": "user",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Ответственный"
            },
            "CREATED_BY_ID": {
              "type": "user",
              "isRequired": false,
              "isReadOnly": true,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Кем создан"
            },
            "MODIFY_BY_ID": {
              "type": "user",
              "isRequired": false,
              "isReadOnly": true,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Кем изменён"
            },
            "DATE_CREATE": {
              "type": "datetime",
              "isRequired": false,
              "isReadOnly": true,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Дата создания"
            },
            "DATE_MODIFY": {
              "type": "datetime",
              "isRequired": false,
              "isReadOnly": true,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Дата изменения"
            },
            "LEAD_ID": {
              "type": "crm_lead",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Лид"
            },
            "DEAL_ID": {
              "type": "crm_deal",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Сделка"
            },
            "PERSON_TYPE_ID": {
              "type": "integer",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Тип клиента"
            },
            "LOCATION_ID": {
              "type": "location",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Местоположение"
            },
            "UTM_SOURCE": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Рекламная система"
            },
            "UTM_MEDIUM": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Тип трафика"
            },
            "UTM_CAMPAIGN": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Обозначение рекламной кампании"
            },
            "UTM_CONTENT": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Содержание кампании"
            },
            "UTM_TERM": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "Условие поиска кампании"
            },
            "LAST_ACTIVITY_TIME": {
              "type": "datetime",
              "isRequired": false,
              "isReadOnly": true,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "LAST_ACTIVITY_TIME"
            },
            "LAST_ACTIVITY_BY": {
              "type": "user",
              "isRequired": false,
              "isReadOnly": true,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "LAST_ACTIVITY_BY"
            },
            "LAST_COMMUNICATION_TIME": {
              "type": "string",
              "isRequired": false,
              "isReadOnly": true,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": false,
              "title": "LAST_COMMUNICATION_TIME"
            },
            "UF_CRM_6710EFCBAF22C": {
              "type": "date",
              "isRequired": false,
              "isReadOnly": false,
              "isImmutable": false,
              "isMultiple": false,
              "isDynamic": true,
              "title": "UF_CRM_6710EFCBAF22C",
              "listLabel": "Окончание РК",
              "formLabel": "Окончание РК",
              "filterLabel": "Окончание РК",
              "settings": {
                "DEFAULT_VALUE": {
                  "TYPE": "NONE",
                  "VALUE": ""
                }
              }
            }
          },
          "time": {
            "start": 1750416943.169864,
            "finish": 1750416943.26074,
            "duration": 0.09087610244750977,
            "processing": 0.05633091926574707,
            "date_start": "2025-06-20T13:55:43+03:00",
            "date_finish": "2025-06-20T13:55:43+03:00",
            "operating_reset_at": 1750417543,
            "operating": 0
          }
        }

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

Название
тип

Описание

result
array

Объект с описанием полей коммерческого предложения в формате crm_rest_field_description

time
time

Информация о времени выполнения запроса

Основные поля

Название
тип

Описание

ASSIGNED_BY_ID
integer

Ответственный

BEGINDATE
date

Дата выставления предложения

CLOSED
char

Флаг завершения предложения

CLOSEDATE
date

Дата завершения предложения

COMMENTS
string

Комментарий

COMPANY_ID
integer

Идентификатор компании, связанной с предложением

CONTACT_IDS
integer

Идентификаторы контактов, связанных с предложением. Множественное

CONTENT
string

Содержание предложения

CREATED_BY_ID
integer

Идентификатор пользователя, создавшего предложение. Только для чтения

CURRENCY_ID
crm_currency

Валюта предложения

DATE_CREATE
datetime

Дата создания предложения. Только для чтения

DATE_MODIFY
datetime

Дата изменения предложения. Только для чтения

DEAL_ID
integer

Идентификатор сделки, связанной с предложением

ID
integer

Идентификатор предложения. Только для чтения

LEAD_ID
integer

Идентификатор лида, связанного с предложением

LOCATION_ID
integer

Местоположение клиента

MODIFY_BY_ID
integer

Идентификатор пользователя, изменившего предложение. Только для чтения

MYCOMPANY_ID
integer

Идентификатор компании, от которой делается предложение

OPENED
char

Флаг доступности предложения для всех

OPPORTUNITY
double

Сумма предложения

PERSON_TYPE_ID
integer

Тип плательщика

QUOTE_NUMBER
string

Номер предложения. Только для чтения

STATUS_ID
crm_status

Стадия предложения. Получить значения справочника можно с помощью метода crm.status.list с фильтром по ENTITY_ID=QUOTE_STATUS

TAX_VALUE
double

Ставка налога

TERMS
string

Условия предложения

TITLE
string

Название предложения

UTM_CAMPAIGN
string

Обозначение рекламной кампании

UTM_CONTENT
string

Содержание рекламной кампании. Например, для контекстных объявлений

UTM_MEDIUM
string

Тип трафика. Например, CPC для объявлений или CPM для баннеров

UTM_SOURCE
string

Рекламная система. Например, Yandex-Direct

UTM_TERM
string

Условие поиска кампании. Например, ключевые слова контекстной рекламы

LAST_ACTIVITY_TIME
datetime

Время последней активности. Только для чтения

LAST_ACTIVITY_BY
integer

Идентификатор пользователя, выполнившего последнюю активность. Только для чтения

LAST_COMMUNICATION_TIME
string

Время последней коммуникации. Только для чтения

UF_...

Пользовательские поля. Например, UF_CRM_25534736.

Добавить пользовательское поле в предложение можно с помощью метода crm.quote.userfield.add

Устаревшие поля

Следующие поля сохраняются только для совместимости и не рекомендуются к использованию.

Название
тип

Описание

CLIENT_ADDR
string

Адрес клиента

CLIENT_CONTACT
string

Контактное лицо клиента

CLIENT_EMAIL
string

Email клиента

CLIENT_PHONE
string

Телефон клиента

CLIENT_TITLE
string

Название клиента

CLIENT_TP_ID
string

ИНН клиента

CLIENT_TPA_ID
string

КПП клиента

CONTACT_ID
integer

Идентификатор контакта, связанного с предложением

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

не возвращает ошибки.

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

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

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

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

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