Estimate Fields in REST 3.0

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

These fields belong to REST 3.0 methods. The call specifics and response format of the new API version are described in the REST 3.0 overview.

Estimate fields are returned by the crm.quote.get and crm.quote.list methods and accepted by the crm.quote.add and crm.quote.update methods. The list of fields with their attributes is returned by the crm.quote.field.list method.

Some fields exist in two forms: as an ID and as a related object, for example, assignedById and assignedBy. The ID can be passed when writing data, while the related object can only be requested in select.

Which Fields the Methods Accept and Return

Method

Accepts

Returns

crm.quote.add

Fields of the Estimate Object table that can be edited, and custom fields. There are no required fields: an estimate is created even with an empty fields object

ID of the created estimate id

crm.quote.update

Estimate id and the same fields as add. Fields not included in fields keep their current values

Success flag true

crm.quote.get

Estimate id and select

Without select, only id. With select, only the listed fields; id is not added automatically. A whole related object, for example, assignedBy, returns all of its fields, while a dot-notation path, for example, assignedBy.firstName, returns only the selected ones. For details, see the Related Objects section

crm.quote.list

select, filter, order, pagination

Without select, only the id of each estimate. Fields and related objects are requested in select the same way as in get

The add and update methods do not accept fields marked "read-only" and return the BITRIX_REST_V3_EXCEPTION_VALIDATION_DTOVALIDATIONEXCEPTION error with the message 'Field "personTypeId" is read-only.' Related objects, for example, deal and stage, are also read-only: to write data, pass the ID — dealId, stageId.

The method validates fields with values from reference lists when writing data. If the value is not in the reference list, the method returns the error 'Field value is not one of the possible values'. For the stage and currency, the error message lists the allowed values.

Boolean fields accept and return true or false. The values Y, N, 1, and 0 are not accepted: the method returns the error 'This request requires data type "bool" in field "opened"'.

Fields of the date type accept and return a date in the YYYY-MM-DD format, for example, 2026-12-01. Such a field does not accept a date with time or a date in the 01.12.2026 format. Fields of the datetime type are returned in ISO 8601 format, for example, 2026-11-03T14:48:50+03:00. In a filter by a datetime field, also pass a date with time: the method does not accept the value 2026-11-03.

You can filter and sort only by the fields whose description says so. For other fields, the list method returns an error stating that the field 'requires attribute "Filterable"' or '"Sortable"'. Dot notation lets you filter by fields of linked CRM items and of the lastCommunication and utm objects, for example, ["deal.title", "=", "Equipment supply"]. Filtering by fields of employees and stage, for example, assignedBy.id or stage.semanticId, is not supported: the method returns the BITRIX_REST_V3_EXCEPTION_INVALIDFILTEREXCEPTION error. The filter format is described on the crm.<type>.list page and in the REST API 3.0 Overview article.

The movedTime, movedById, movedBy, stageSemanticId, and stageSemantic fields are present in the crm.quote.field.list response, but the get and list methods do not accept them. For such a field in select, filter, or order, the method returns the BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION error. You can retrieve the stage group from the semanticId field of the stage object: "select": ["stage.semanticId"].

Estimate Object

Name
type

Description

title
string

Estimate subject, up to 255 characters. If the subject is not passed on creation, Bitrix24 sets it to Estimate #<id>.

Can be edited, filtered, and sorted

actualTime
date | null

Date until which the estimate is valid.

Can be edited, filtered, and sorted

content
string | null

Estimate content.

Can be edited, filtered, and sorted

terms
string | null

Estimate terms.

Can be edited, filtered, and sorted

quoteNumber
string | null

Estimate number, up to 100 characters, for example, F1-001.

Can be edited, filtered, and sorted

dealId
integer | null

ID of the deal the estimate belongs to. Deals are returned by the crm.deal.list method. The method checks that the deal exists.

Can be edited, filtered, and sorted

deal
object | null

Deal. An object of type CRM item.

Read-only. Requested in select

leadId
integer | null

ID of the lead the estimate belongs to. Leads are returned by the crm.lead.list method. The method checks that the lead exists.

Can be edited, filtered, and sorted

lead
object | null

Lead. An object of type CRM item.

Read-only. Requested in select

locationId
integer | null

Client location ID. A system field. The method checks that the location exists.

Can be edited, filtered, and sorted

personTypeId
string

Client type. Bitrix24 determines it by the estimate client. Possible values:

  • CONTACT — individual
  • COMPANY — legal entity, if a company is specified in the estimate

Read-only. Can be filtered and sorted

personType
object

Client type with its name. An object of type client type.

Read-only. Requested in select

id
integer

Estimate ID. Assigned on creation.

Read-only. Can be filtered and sorted

createdTime
datetime

Date and time the estimate was created.

Read-only. Can be filtered and sorted

createdById
integer

ID of the user who created the estimate.

Read-only. Can be filtered and sorted

createdBy
object

User who created the estimate. An object of type employee.

Read-only. Requested in select

updatedTime
datetime

Date and time the estimate was last updated.

Read-only. Can be filtered and sorted

updatedById
integer

ID of the user who last updated the estimate.

Read-only. Can be filtered and sorted

updatedBy
object

User who last updated the estimate. An object of type employee.

Read-only. Requested in select

lastActivityTime
datetime

Date and time of the last activity in the estimate timeline.

Read-only. Can be filtered and sorted

lastActivityById
integer

ID of the author of the last activity in the timeline.

Read-only. Can be filtered and sorted

lastActivityBy
object

Author of the last activity in the timeline. An object of type employee.

Read-only. Requested in select

assignedById
integer

ID of the person responsible for the estimate. User IDs are returned by the user.get method. If the user does not exist, the method returns the error 'Field value is not one of the possible values'.

Can be edited, filtered, and sorted

assignedBy
object

Responsible person. An object of type employee.

Read-only. Requested in select

opened
boolean

Whether the estimate is available to all users: true — yes, false — no.

Can be edited, filtered, and sorted

comments
string | null

Comment on the estimate. Supports BB codes, for example, [b]text[/b].

Can be edited. Cannot be filtered or sorted

webformId
integer | null

ID of the CRM form through which the estimate was created. If the estimate was not created by a form, null. The list of forms is returned by the crm.form.list method.

Read-only. Can be filtered and sorted

webform
object | null

CRM form through which the estimate was created. An object of type CRM form.

Read-only. Requested in select

lastCommunication
object

Dates of the last communications with the client on the estimate. An object of type last communication.

Read-only. Requested in select. Can be filtered by object fields using dot notation, for example, ["lastCommunication.emailTime", ">=", "2026-11-01T00:00:00+03:00"]

entityTypeId
integer

Object type ID. For an estimate, 7.

Read-only

canRead
boolean

Whether the current user can view the estimate: true — yes, false — no.

Read-only

url
string

Relative link to the estimate card, for example, /crm/type/7/details/147/.

Read-only

stageId
string

Estimate stage ID, for example, DRAFT, SENT, APPROVED. Estimates have a single pipeline. Estimate stages are returned by the crm.status.list method with the ENTITY_ID = QUOTE_STATUS filter.

Can be edited, filtered, and sorted

stage
object

Estimate stage. An object of type stage.

Read-only. Requested in select

movedTime
datetime

Date and time of the last stage change.

Read-only. The field is present in the field.list response, but the get and list methods do not accept it and return the BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION error

movedById
integer

ID of the user who last changed the stage.

Read-only. The field is present in the field.list response, but the get and list methods do not accept it and return the BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION error

movedBy
object

User who last changed the stage. An object of type employee.

Read-only. The field is present in the field.list response, but the get and list methods do not accept it and return the BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION error

closed
boolean

Whether the estimate is closed: true — yes, false — no.

Read-only. Can be filtered and sorted

stageSemanticId
string

Stage group. Possible values:

  • P — in progress
  • S — successful
  • F — unsuccessful

Read-only. The field is present in the field.list response, but the get and list methods do not accept it and return the BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION error. The stage group is returned by the stage.semanticId field

stageSemantic
object

Stage group with its name: id and name. The reference list of groups is returned by the crm.dictionary.stagesemantic.list method.

Read-only. The field is present in the field.list response, but the get and list methods do not accept it and return the BITRIX_REST_V3_EXCEPTION_UNKNOWNDTOPROPERTYEXCEPTION error

beginTime
date

Estimate issue date. If not passed on creation, Bitrix24 sets it to the creation date.

Can be edited, filtered, and sorted

closeTime
date

Estimate due date. If not passed on creation, Bitrix24 sets it to seven days after the creation date.

Can be edited, filtered, and sorted

contactId
integer | null

ID of the primary contact, which is the first one in the contactsId list. To set the primary contact, use the crm.quote.setprimarycontact method.

Read-only. Can be filtered, cannot be sorted

contact
object | null

Primary contact. An object of type CRM item.

Read-only. Requested in select

contactsId
integer[]

IDs of the estimate contacts. Contacts are returned by the crm.contact.list method. The passed array replaces the current list of contacts.

Can be edited and filtered, cannot be sorted

contacts
object[]

Estimate contacts. An array of objects of type CRM item. If there are no contacts, an empty array.

Read-only. Requested in select

companyId
integer | null

Company ID. Companies are returned by the crm.company.list method.

Can be edited, filtered, and sorted

company
object | null

Company. An object of type CRM item.

Read-only. Requested in select

myCompanyId
integer | null

ID of your company, on whose behalf the estimate is issued. The list of your companies is returned by the crm.mycompany.list method.

Can be edited, filtered, and sorted

myCompany
object | null

Your company. An object of type CRM item.

Read-only. Requested in select

opportunity
double

Estimate amount, not less than 0. The way the amount is calculated is set by the isManualOpportunity field.

Can be edited, filtered, and sorted

taxValue
double

Tax amount. Calculated from the product rows.

Read-only. Can be filtered and sorted

isManualOpportunity
boolean

Amount calculation mode: true — the amount is set manually, false — the amount is calculated from the product rows.

Can be edited, filtered, and sorted

currencyId
string

Currency ID, for example, EUR. Currencies are returned by the crm.currency.list method.

Can be edited, filtered, and sorted

currency
object

Currency. An object of type currency.

Read-only. Requested in select

utm
object | null

UTM tags of the estimate. An object of type UTM tags. If there are no tags, null.

Can be edited: pass an object with the tags you need, for example, {"source": "google", "medium": "cpc"}. Can be filtered by object fields using dot notation, for example, ["utm.source", "=", "google"], cannot be sorted

trackingSourceId
integer | null

ID of the end-to-end analytics source.

Can be edited and filtered, cannot be sorted

If Bitrix24 has a link configured in which the estimate is subordinate to another object type, the estimate gets the link fields related<type code>Id and related<type code>, for example, relatedSmartProcess177Id. The first one is the ID of the parent item; it can be edited and filtered. The second one is the parent item as an object of type CRM item, read-only. The current list of fields is returned by the crm.quote.field.list method.

Related Objects

A related object is requested in select by the field name without the Id suffix: assignedBy, stage, personType. The whole object name returns all of its fields, and a dot-notation path returns only the selected ones, for example, ["stage.name", "assignedBy.firstName"]. The path supports one level of nesting.

A linked CRM item — deal, lead, contact, company, myCompany — returns only id when requested by its whole name. Request the other item fields using dot notation, for example, ["deal.title", "deal.url"].

If a link is not set, the object is returned as null, and an array of objects, for example, contacts, is returned as an empty array.

Employee Object

Fields createdBy, updatedBy, lastActivityBy, assignedBy.

Name
type

Description

id
integer

User ID

firstName
string

First name

lastName
string

Last name

personalGender
string | null

Gender: M — male, F — female. If the gender is not specified, null

url
string

Relative link to the user profile, for example, /company/personal/user/1/

personalPhoto
string | null

Link to the user photo. If there is no photo, null

CRM Item Object

Fields deal, lead, contact, contacts, company, myCompany.

Name
type

Description

id
integer

Item ID

entityTypeId
integer

Object type ID, for example, 2 — deal, 3 — contact

canRead
boolean

Whether the current user can view the item

title
string

Item title. For a contact, the last name, first name, and middle name

url
string

Relative link to the item card, for example, /crm/deal/details/8987/

Stage Object

Field stage.

Name
type

Description

id
string

Stage ID, for example, DRAFT

name
string

Stage name

sort
integer

Stage order

color
string

Stage color in the #RRGGBB format

semanticId
string

Stage group: P — in progress, S — successful, F — unsuccessful

Client Type Object

Field personType.

Name
type

Description

id
string

Client type ID: CONTACT or COMPANY

name
string

Client type name, for example, Individual

CRM Form Object

Field webform.

Name
type

Description

id
integer

CRM form ID

name
string

CRM form name

Last Communication Object

Field lastCommunication. If there has been no communication of a given kind, the corresponding field is null.

Name
type

Description

communicationTime
datetime | null

Date and time of the last communication of any kind

callTime
datetime | null

Date and time of the last call

emailTime
datetime | null

Date and time of the last email

imolTime
datetime | null

Date and time of the last message in an open channel

webformTime
datetime | null

Date and time the CRM form was last submitted

Currency Object

Field currency.

Name
type

Description

id
string

Currency code, for example, EUR

fullName
string

Currency name

formatString
string

Amount display template. The # character is replaced with the amount. The currency sign is returned as an HTML entity, for example, &euro;#

decPoint
string

Decimal separator

thousandsSep
string

Thousands separator. May be returned as an HTML entity, for example, &nbsp;

decimals
integer

Number of decimal places

hideZero
boolean

Whether to hide insignificant trailing zeros in the fractional part

amount
double

Exchange rate relative to the base currency

amountCount
integer

Number of currency units the exchange rate applies to

base
boolean

Base currency: true — yes, false — no

sort
integer

Sort order

numericCode
string

Numeric currency code, for example, 978

languageId
string

Language for which the name and format are set

createdTime
datetime | null

Date and time the currency was created

updatedTime
datetime | null

Date and time the currency was updated

createdById
integer | null

ID of the user who created the currency

updatedById
integer | null

ID of the user who updated the currency

UTM Tags Object

Field utm. Each tag is a string of up to 255 characters. Tags that were not passed are returned as null.

Name
type

Description

source
string | null

Ad platform, utm_source

medium
string | null

Traffic type, utm_medium, for example, cpc

campaign
string | null

Ad campaign, utm_campaign

content
string | null

Ad content, utm_content

term
string | null

Keyword, utm_term

Custom Fields

Custom estimate fields are named UF_CRM_<code>, for example, UF_CRM_6710EFCBAF22C. They are passed and requested by name in the same way as standard fields. The list of custom fields is returned by the crm.quote.field.custom.list method.

Each custom field has a paired UF_CRM_…_data field, which is read-only and requested in select. It contains the value in several representations:

  • value — the value in the same format as in the field itself
  • rawValue — the value in the storage format, for example, 100.5|EUR for a "Money" field
  • formattedValue — the value for display to the user: 100.50 € for money, the employee name for a "Link to employee" field, the option text for a list
  • extra — additional data: for money, amount, currencyId, and currencyFullName; for an employee, the fields of the employee object. For a string, date, and list, null

For a multiple custom field, UF_CRM_…_data is an array of such objects.

Continue Learning

Previous
Company Fields
Next
Invoice Fields