Add Estimate crm.quote.add
Scope:
crmWho can execute the method: a user with the "add" access permission for estimates
Method development halted
The method crm.quote.add continues to function, but there is a more relevant alternative: crm.item.add
The method crm.quote.add creates an estimate.
If you need to explicitly specify the details of the buyer and seller in the estimate, use the method crm.requisite.link.register.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
fields* |
An object with fields of the estimate in the following format:
where:
The list of required and main fields is provided below. A complete list of available fields and their types can be obtained using the method crm.quote.fields |
|
params |
An object of additional parameters (detailed description) |
Parameter fields
Required parameters are marked with *
|
Name |
Description |
|
TITLE* |
Subject of the estimate Length restriction — up to If a value longer than |
|
STATUS_ID |
Stage of the estimate Pass the value explicitly in each request. The list of available stages can be obtained using the method crm.status.list with the filter |
|
CURRENCY_ID |
Currency of the estimate amount |
|
OPPORTUNITY |
Amount of the estimate Pass a numeric value along with |
|
ASSIGNED_BY_ID |
Identifier of the responsible person |
|
COMPANY_ID |
Identifier of the client company |
|
CONTACT_IDS |
Array of identifiers of client contacts |
|
MYCOMPANY_ID |
Identifier of "your company" for seller requisites |
|
OPENED |
Is the estimate available to everyone? Possible values:
|
|
PERSON_TYPE_ID |
Identifier of the payer type |
|
BEGINDATE |
Date of issuance |
|
CLOSEDATE |
Expiration date of the estimate |
|
CLIENT_TITLE |
Client name, up to |
|
CLIENT_ADDR |
Client address, up to |
|
CLIENT_EMAIL |
Client email, up to |
|
CLIENT_PHONE |
Client phone, up to |
|
COMMENTS |
Comment |
Method feature
Some incorrect values in the fields may not lead to a 400 error: values are normalized, truncated, or replaced with default values.
Parameter params
|
Name |
Description |
|
IMPORT |
Import mode. Possible values:
|
Import
These fields are available for filling when the parameter IMPORT = 'Y' is passed in the params.
|
Name |
Description |
|
DATE_CREATE |
Creation date |
|
DATE_MODIFY |
Modification date |
|
CREATED_BY_ID |
Created by |
|
MODIFY_BY_ID |
Modified by |
Code Examples
How to Use Examples in Documentation
Example of creating an estimate:
- subject —
Estimate for furniture supply - buyer — company with
id = 1 - seller — your company with
id = 3
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TITLE":"Estimate for furniture supply","STATUS_ID":"DRAFT","OPENED":"Y","ASSIGNED_BY_ID":1,"CURRENCY_ID":"USD","OPPORTUNITY":150000,"COMPANY_ID":1,"MYCOMPANY_ID":3,"COMMENTS":"Prepared upon client request","BEGINDATE":"2026-03-13T10:00:00+01:00","CLOSEDATE":"2026-03-20T18:00:00+01:00"},"params":{"IMPORT":"N"}}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.quote.add
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"fields":{"TITLE":"Estimate for furniture supply","STATUS_ID":"DRAFT","OPENED":"Y","ASSIGNED_BY_ID":1,"CURRENCY_ID":"USD","OPPORTUNITY":150000,"COMPANY_ID":1,"MYCOMPANY_ID":3,"COMMENTS":"Prepared upon client request","BEGINDATE":"2026-03-13T10:00:00+01:00","CLOSEDATE":"2026-03-20T18:00:00+01:00"},"params":{"IMPORT":"N"},"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.quote.add
try
{
const response = await $b24.callMethod(
'crm.quote.add',
{
fields: {
TITLE: 'Estimate for furniture supply',
STATUS_ID: 'DRAFT',
OPENED: 'Y',
ASSIGNED_BY_ID: 1,
CURRENCY_ID: 'USD',
OPPORTUNITY: 150000,
COMPANY_ID: 1,
MYCOMPANY_ID: 3,
COMMENTS: 'Prepared upon client request',
BEGINDATE: '2026-03-13T10:00:00+01:00',
CLOSEDATE: '2026-03-20T18:00:00+01:00',
},
params: {
IMPORT: 'N',
},
}
);
const result = response.getData().result;
console.info(result);
}
catch( error )
{
console.error('Error:', error);
}
try {
$response = $b24Service
->core
->call(
'crm.quote.add',
[
'fields' => [
'TITLE' => 'Estimate for furniture supply',
'STATUS_ID' => 'DRAFT',
'OPENED' => 'Y',
'ASSIGNED_BY_ID' => 1,
'CURRENCY_ID' => 'USD',
'OPPORTUNITY' => 150000,
'COMPANY_ID' => 1,
'MYCOMPANY_ID' => 3,
'COMMENTS' => 'Prepared upon client request',
'BEGINDATE' => '2026-03-13T10:00:00+01:00',
'CLOSEDATE' => '2026-03-20T18:00:00+01:00',
],
'params' => [
'IMPORT' => 'N',
],
]
);
$result = $response
->getResponseData()
->getResult();
echo 'Created quote ID: ' . $result;
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error creating quote: ' . $e->getMessage();
}
BX24.callMethod(
'crm.quote.add',
{
fields: {
TITLE: 'Estimate for furniture supply',
STATUS_ID: 'DRAFT',
OPENED: 'Y',
ASSIGNED_BY_ID: 1,
CURRENCY_ID: 'USD',
OPPORTUNITY: 150000,
COMPANY_ID: 1,
MYCOMPANY_ID: 3,
COMMENTS: 'Prepared upon client request',
BEGINDATE: '2026-03-13T10:00:00+01:00',
CLOSEDATE: '2026-03-20T18:00:00+01:00',
},
params: {
IMPORT: 'N',
},
},
(result) => {
result.error()
? console.error(result.error())
: console.info(result.data())
;
},
);
require_once('crest.php');
$result = CRest::call(
'crm.quote.add',
[
'fields' => [
'TITLE' => 'Estimate for furniture supply',
'STATUS_ID' => 'DRAFT',
'OPENED' => 'Y',
'ASSIGNED_BY_ID' => 1,
'CURRENCY_ID' => 'USD',
'OPPORTUNITY' => 150000,
'COMPANY_ID' => 1,
'MYCOMPANY_ID' => 3,
'COMMENTS' => 'Prepared upon client request',
'BEGINDATE' => '2026-03-13T10:00:00+01:00',
'CLOSEDATE' => '2026-03-20T18:00:00+01:00',
],
'params' => [
'IMPORT' => 'N',
],
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP status: 200
{
"result": 43,
"time": {
"start": 1773396937,
"finish": 1773396937.557957,
"duration": 0.5579569339752197,
"processing": 0,
"date_start": "2026-03-13T13:15:37+01:00",
"date_finish": "2026-03-13T13:15:37+01:00",
"operating_reset_at": 1773397537,
"operating": 0.5224320888519287
}
}
Returned Data
|
Name |
Description |
|
result |
Root element of the response. Contains the identifier of the created estimate |
|
time |
Information about the request execution time |
Error Handling
HTTP status: 400
{
"error": "",
"error_description": "Parameter 'fields' must be array."
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
|
|
|
|
|
|
|
|
|
The user does not have permission to add estimates |
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
- Update Commercial Estimate crm.quote.update
- Get an Estimate by ID: crm.quote.get
- Get a List of Estimates by Filter crm.quote.list
- Delete Estimate crm.quote.delete
- Get Fields of the Estimate crm.quote.fields
- Set Product Rows for the Quote crm.quote.productrows.set
- Get Product Rows of the Quote crm.quote.productrows.get