Add Estimate crm.quote.add

Scope: crm

Who 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
type

Description

fields*
object

An object with fields of the estimate in the following format:

{
            "field_1": "value_1",
            "field_2": "value_2",
            "...": "..."
        }
        

where:

  • field_n — field name
  • value_n — field value

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
object

An object of additional parameters (detailed description)

Parameter fields

Required parameters are marked with *

Name
type

Description

TITLE*
string

Subject of the estimate

Length restriction — up to 255 characters.

If a value longer than 255 is provided, the system will truncate it to 255 characters

STATUS_ID
crm_status

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 ENTITY_ID = QUOTE_STATUS

CURRENCY_ID
crm_currency

Currency of the estimate amount

OPPORTUNITY
double

Amount of the estimate

Pass a numeric value along with CURRENCY_ID

ASSIGNED_BY_ID
user

Identifier of the responsible person

COMPANY_ID
crm_company

Identifier of the client company

CONTACT_IDS
crm_contact[]

Array of identifiers of client contacts

MYCOMPANY_ID
crm_company

Identifier of "your company" for seller requisites

OPENED
char

Is the estimate available to everyone? Possible values:

  • Y — yes
  • N — no

PERSON_TYPE_ID
integer

Identifier of the payer type

BEGINDATE
date

Date of issuance

CLOSEDATE
date

Expiration date of the estimate

CLIENT_TITLE
string

Client name, up to 255 characters

CLIENT_ADDR
string

Client address, up to 255 characters

CLIENT_EMAIL
string

Client email, up to 255 characters

CLIENT_PHONE
string

Client phone, up to 255 characters

COMMENTS
string

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
type

Description

IMPORT
boolean

Import mode. Possible values:

  • Y — yes
  • N — no

Import

These fields are available for filling when the parameter IMPORT = 'Y' is passed in the params.

Name
type

Description

DATE_CREATE
datetime

Creation date

DATE_MODIFY
datetime

Modification date

CREATED_BY_ID
user

Created by

MODIFY_BY_ID
user

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
type

Description

result
integer

Root element of the response. Contains the identifier of the created estimate

time
time

Information about the request execution time

Error Handling

HTTP status: 400

{
            "error": "",
            "error_description": "Parameter 'fields' must be array."
        }
        

Name
type

Description

error
string

String error code. It may consist of digits, Latin letters, and underscores

error_description
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

-

Parameter 'fields' must be array.

fields is not an object

-

Parameter 'params' must be array.

params is not an object

-

Access denied.

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
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

An internal server error has occurred, please contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

405

ERROR_BATCH_METHOD_NOT_ALLOWED
Method is not allowed for batch usage

The current method is not allowed to be called using batch

400

ERROR_BATCH_LENGTH_EXCEEDED
Max batch length exceeded

The maximum length of parameters passed to the batch method has been exceeded

401

NO_AUTH_FOUND
Wrong authorization data

Invalid access token or webhook code

400

INVALID_REQUEST
Https required

The methods must be called using the HTTPS protocol

503

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support

403

ACCESS_DENIED
REST API is available only on commercial plans

The REST API is available only on commercial plans

403

INVALID_CREDENTIALS
Invalid request credentials

The user whose access token or webhook was used to call the method lacks permissions

404

ERROR_MANIFEST_IS_NOT_AVAILABLE
Manifest is not available

The manifest is not available

403

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

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

401

expired_token
The access token provided has expired

The provided access token has expired

403

user_access_error
The user does not have access to the application

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

500

PORTAL_DELETED
Portal was deleted

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