Get Fields of the Estimate crm.quote.fields
Choose a tool for developing with an AI agent:
- use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
- use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation
Scope:
crmWho can execute the method: any user
DEPRECATED
Development of this method has been halted. Please use crm.item.fields.
The method crm.quote.fields returns a 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
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
type FieldDescription = {
type: string
isRequired: boolean
isReadOnly: boolean
isImmutable: boolean
isMultiple: boolean
isDynamic: boolean
title: string
statusType?: string
isDeprecated?: boolean
listLabel?: string
formLabel?: string
filterLabel?: string
settings?: Record<string, unknown>
}
// Shape of the payload returned in result (match the "response handling" section of the page)
type QuoteFieldsResult = Record<string, FieldDescription>
try {
const response = await $b24.actions.v2.call.make<QuoteFieldsResult>({
method: 'crm.quote.fields',
params: {},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Quote fields:', Object.keys(result))
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function getQuoteFields() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.quote.fields',
params: {},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Quote fields:', Object.keys(result))
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', getQuoteFields)
</script>
try {
$response = $b24Service
->core
->call(
'crm.quote.fields',
[]
);
$result = $response
->getResponseData()
->getResult();
echo 'Success: ' . print_r($result, true);
// Your data processing logic here
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>';
// client and ctx are already created — see the Go SDK section
res, err := client.Core().Call(ctx, "crm.quote.fields", nil, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.quote.fields: %w", err)
}
keys, ok := b24.Keys(res.Result)
if !ok {
return fmt.Errorf("expected an object in the response")
}
fmt.Println("fields in response:", len(keys))
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 |
Date of the estimate issue |
|
CLOSED |
Flag for the completion of the estimate |
|
CLOSEDATE |
Date of the estimate completion |
|
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 |
Date of the estimate creation. Read-only |
|
DATE_MODIFY |
Date of the estimate modification. 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 the availability of the estimate to everyone |
|
OPPORTUNITY |
Amount of the estimate |
|
PERSON_TYPE_ID |
Payer type |
|
QUOTE_NUMBER |
Estimate number. Read-only |
|
STATUS_ID |
Estimate stage. 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 |
Campaign identifier |
|
UTM_CONTENT |
Content of the advertising campaign. For example, for contextual ads |
|
UTM_MEDIUM |
Type of traffic. 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 retained 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 crm.quote.fields method does not return errors: it takes no parameters and does not check access permissions.
Statuses and System Error Codes
HTTP Status: 4xx, 5xx
The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit |
|
|
|
The request contains no authorization data: neither an access token nor a webhook code was passed |
|
|
|
Methods are called over the HTTPS protocol only |
|
|
|
The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support |
|
|
|
REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — |
|
|
|
No active webhook with the specified user identifier and secret code was found |
|
|
|
No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope |
|
|
|
The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with |
|
|
|
The access token has expired |
|
|
|
The application is installed, but the Bitrix24 administrator has granted access to it only to specific users |
|
|
|
The public part of the site is closed. To open it on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |