Get Fields of the Estimate crm.quote.fields
Scope:
crmWho can execute the method: any user
Method Development Stopped
The method crm.quote.fields continues to function, but there is a more relevant alternative crm.item.fields.
The method crm.quote.fields returns the description of the fields of the estimate, including custom fields.
Method Parameters
No parameters.
Code Examples
How to Use Examples in Documentation
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);
// Your logic for processing data
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>';
Response Handling
HTTP status: 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": "Estimate Number"
},
"TITLE": {
"type": "string",
"isRequired": true,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Subject"
},
"STATUS_ID": {
"type": "crm_status",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"statusType": "QUOTE_STATUS",
"title": "Estimate Stage"
},
"CURRENCY_ID": {
"type": "crm_currency",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Currency"
},
"OPPORTUNITY": {
"type": "double",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Amount"
},
"TAX_VALUE": {
"type": "double",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Tax Rate"
},
"COMPANY_ID": {
"type": "crm_company",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Company"
},
"MYCOMPANY_ID": {
"type": "crm_company",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Your Company Details"
},
"CONTACT_ID": {
"type": "crm_contact",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"isDeprecated": true,
"title": "Contact"
},
"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": "Issue Date"
},
"CLOSEDATE": {
"type": "date",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Deadline"
},
"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": "Available to Everyone"
},
"CLOSED": {
"type": "char",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Closed"
},
"COMMENTS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Comment"
},
"CONTENT": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Content"
},
"TERMS": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Terms"
},
"CLIENT_TITLE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Client"
},
"CLIENT_ADDR": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Address"
},
"CLIENT_CONTACT": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Contact Person"
},
"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": "Phone"
},
"CLIENT_TP_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Tax ID"
},
"CLIENT_TPA_ID": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "KPP"
},
"ASSIGNED_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Responsible"
},
"CREATED_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Created By"
},
"MODIFY_BY_ID": {
"type": "user",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modified By"
},
"DATE_CREATE": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Creation Date"
},
"DATE_MODIFY": {
"type": "datetime",
"isRequired": false,
"isReadOnly": true,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Modification Date"
},
"LEAD_ID": {
"type": "crm_lead",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Lead"
},
"DEAL_ID": {
"type": "crm_deal",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Deal"
},
"PERSON_TYPE_ID": {
"type": "integer",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Client Type"
},
"LOCATION_ID": {
"type": "location",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Location"
},
"UTM_SOURCE": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Advertising System"
},
"UTM_MEDIUM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Traffic Type"
},
"UTM_CAMPAIGN": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Campaign Identifier"
},
"UTM_CONTENT": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Campaign Content"
},
"UTM_TERM": {
"type": "string",
"isRequired": false,
"isReadOnly": false,
"isImmutable": false,
"isMultiple": false,
"isDynamic": false,
"title": "Campaign Search Condition"
},
"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": "End of RK",
"formLabel": "End of RK",
"filterLabel": "End of RK",
"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+02:00",
"date_finish": "2025-06-20T13:55:43+02:00",
"operating_reset_at": 1750417543,
"operating": 0
}
}
Returned Data
|
Name |
Description |
|
result |
Object with the description of the fields of the estimate in the format crm_rest_field_description |
|
time |
Information about the execution time of the request |
Main Fields
|
Name |
Description |
|
ASSIGNED_BY_ID |
Responsible |
|
BEGINDATE |
Issue date of the estimate |
|
CLOSED |
Flag for completion of the estimate |
|
CLOSEDATE |
Completion date of the estimate |
|
COMMENTS |
Comment |
|
COMPANY_ID |
Identifier of the company associated with the estimate |
|
CONTACT_IDS |
Identifiers of contacts associated with the estimate. Multiple |
|
CONTENT |
Content of the estimate |
|
CREATED_BY_ID |
Identifier of the user who created the estimate. Read-only |
|
CURRENCY_ID |
Currency of the estimate |
|
DATE_CREATE |
Creation date of the estimate. Read-only |
|
DATE_MODIFY |
Modification date of the estimate. Read-only |
|
DEAL_ID |
Identifier of the deal associated with the estimate |
|
ID |
Identifier of the estimate. Read-only |
|
LEAD_ID |
Identifier of the lead associated with the estimate |
|
LOCATION_ID |
Client's location |
|
MODIFY_BY_ID |
Identifier of the user who modified the estimate. Read-only |
|
MYCOMPANY_ID |
Identifier of the company making the estimate |
|
OPENED |
Flag for availability of the estimate to everyone |
|
OPPORTUNITY |
Amount of the estimate |
|
PERSON_TYPE_ID |
Payer type |
|
QUOTE_NUMBER |
Estimate number. Read-only |
|
STATUS_ID |
Stage of the estimate. You can get the values of the directory using the method crm.status.list with the filter |
|
TAX_VALUE |
Tax rate |
|
TERMS |
Terms of the estimate |
|
TITLE |
Title of the estimate |
|
UTM_CAMPAIGN |
dvertising campaign identifier |
|
UTM_CONTENT |
Content of the advertising campaign. For example, for contextual ads |
|
UTM_MEDIUM |
Traffic type. For example, CPC for ads or CPM for banners |
|
UTM_SOURCE |
Advertising system. For example, Google Ads |
|
UTM_TERM |
Campaign search condition. For example, keywords for contextual advertising |
|
LAST_ACTIVITY_TIME |
Time of the last activity. Read-only |
|
LAST_ACTIVITY_BY |
Identifier of the user who performed the last activity. Read-only |
|
LAST_COMMUNICATION_TIME |
Time of the last communication. Read-only |
|
UF_... |
Custom fields. For example, You can add a custom field to the estimate using the method crm.quote.userfield.add |
Deprecated Fields
The following fields are kept only for compatibility and are not recommended for use.
|
Name |
Description |
|
CLIENT_ADDR |
Client's address |
|
CLIENT_CONTACT |
Client's contact person |
|
CLIENT_EMAIL |
Client's email |
|
CLIENT_PHONE |
Client's phone |
|
CLIENT_TITLE |
Client's name |
|
CLIENT_TP_ID |
Client's Tax ID |
|
CLIENT_TPA_ID |
Client's KPP |
|
CONTACT_ID |
Identifier of the contact associated with the estimate |
Error Handling
The method does not return errors.
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred, please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not allowed to be called using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The methods must be called using the HTTPS protocol |
|
|
|
The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support |
|
|
|
The REST API is available only on commercial plans |
|
|
|
The user whose access token or webhook was used to call the method lacks permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |
Continue Learning
- Add Estimate crm.quote.add
- Get an Estimate by ID: crm.quote.get
- Update Commercial Estimate crm.quote.update
- Delete Estimate crm.quote.delete
- Create a Custom Field for Estimates crm.quote.userfield.add