object-fields.md

CRM Object Fields

{% note tip "" %}

If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.

{% endnote %}

In the section common fields, you will find a list of standard fields used across all types of CRM objects.

The sections for each object type provide lists of standard fields specific to that object type:

• lead,
• deal,
• contact,
• company,
• estimate,
• invoice,
• SPA.

Use the method crm.item.fields with the specified object type in entityTypeId to get a complete list of fields for the object, including custom fields.

Common Fields {#common}

#| || Name type | Description || || assignedById user | Identifier of the user responsible for the item || || createdBy user | Identifier of the user who created the item || || createdTime datetime | Time of item creation || || entityTypeId integer | Identifier of the entity type || || id integer | Identifier of the item || || lastActivityBy user | Identifier of the user who last interacted in the timeline || || lastActivityTime datetime | Time of the last activity in the timeline || || opened boolean | Is the item open || || parentId... crm_entity | Parent field. An element of another CRM object type that is linked to this item. Each such field has the code parentId + {parentEntityTypeId} || || ufCrm... crm_userfield | Custom field. See the section {#T}.

• Values of multiple fields are returned as an array
• Value of the file type field is returned as an object:
• id — identifier
• url — link to the file on the account
• urlMachine — link to the file for the application || || updatedBy user | Identifier of the user who modified the item || || updatedTime datetime | Time of the last modification of the item || || utmCampaign string | Identifier of the advertising campaign || || utmContent string | Content of the campaign. For example, for contextual ads || || utmMedium string | Type of traffic. Possible values:
• CPC — ads
• CPM — banners || || utmSource string | Advertising system. Google Ads and others || || utmTerm string | Search condition of the campaign. For example, keywords for contextual advertising || || webformId integer | Identifier of the CRM form || |#

Object Fields

Lead {#lead}

#| || Name type | Description || || dateCreateShort datetime | Time of item creation (short format). Field is disabled || || dateModifyShort datetime | Time of the last modification of the item (short format). Field is disabled || || companyId crm_company | Identifier of the company linked to the item || || contactId crm_contact | Identifier of the contact linked to the item || || stageId crm_status | String identifier of the item's stage || || isConvert boolean | Has the lead been converted. Field is disabled || || statusDescription text | Additional information about the stage || || stageSemanticId string | Group of the stage. Possible values:

• P — in progress
• S — successful
• F — unsuccessful || || productId string | Identifier of the product. Deprecated. Field is disabled || || opportunity double | Amount || || currencyId crm_currency | Identifier of the item's currency || || sourceId crm_status | String identifier of the source type || || sourceDescription text | Additional information about the source || || title string | Name of the item || || name string | First name || || lastName string | Last name || || secondName string | Middle name || || shortName string | Last name First name. Short format: for example 'Smith John' -> 'Smith J.'. Field is disabled || || companyTitle string | Company name || || post string | Position || || address text | Address. Deprecated. Field is disabled || || comments text | Comment || || originatorId string | External source || || originId string | Identifier of the item in the external source || || dateClosed datetime | Time of item closure || || birthdate date | Date of birth || || honorific crm_status | String identifier of the salutation type || || hasPhone boolean | Does the item have a phone || || hasEmail boolean | Does the item have an email || || hasImol boolean | Does the item have open channels || || login string | Login. Deprecated. Field is disabled || || isReturnCustomer boolean | Is the item a repeat customer || || searchContent text | Information for full-text search. System field || || isManualOpportunity boolean | Is manual mode for calculating the amount set || || movedBy user | Identifier of the user who last changed the stage || || movedTime datetime | Time of the last stage change || || phoneMobile string | Mobile phone || || phoneWork string | Work phone || || phoneMailing string | Mailing phone || || emailHome string | Personal E-mail || || emailWork string | Work E-mail || || emailMailing string | Mailing email || || skype string | Skype || || icq string | ICQ || || imol string | IMOL || || email string | E-mail || || phone string | Phone || || observers user[] | List of user identifiers who are Observers || || contactIds crm_contact[] | List of contact identifiers linked to the item || || fm crm_multifield | Array of multifields. More about multifields can be found in the section {#T} Structure of the multifield:
• id — Unique identifier
• typeId — Type of multifield
• valueType — Type of value
• value — Value || |#

Deal {#deal}

#| || Name type | Description || || dateCreateShort datetime | Time of item creation (short format). Field is disabled || || dateModifyShort datetime | Time of the last modification of the item (short format). Field is disabled || || leadId crm_lead | Identifier of the lead based on which the item was created || || companyId crm_company | Identifier of the company linked to the item || || contactId crm_contact | Identifier of the contact linked to the item || || quoteId crm_quote | Identifier of the estimate linked to the item || || title string | Name of the item || || productId string | Identifier of the product. Deprecated. Field is disabled || || categoryId crm_category | Identifier of the funnel (direction) of the item || || stageId crm_status | String identifier of the item's stage || || stageSemanticId string | Group of the stage

• P — in progress
• S — successful
• F — unsuccessful || || isNew boolean | Is the deal new || || isRecurring boolean | Is the deal recurring || || isReturnCustomer boolean | Is the item a repeat customer || || isRepeatedApproach boolean | Is the deal a repeated approach || || closed boolean | Is the deal closed || || typeId crm_status | String identifier of the deal type || || opportunity double | Amount || || isManualOpportunity boolean | Is manual mode for calculating the amount set || || taxValue double | Tax amount || || currencyId crm_currency | Identifier of the item's currency || || probability integer | Probability, % || || comments text | Comment || || begindate date | Start date of the item || || begindateShort datetime | Start time of the item (short format). Field is disabled || || closedate date | Completion date of the item || || closedateShort datetime | End time of the item (short format). Field is disabled || || eventDate datetime | Event date || || eventDateShort datetime | Event date (short format). Field is disabled || || eventId crm_status | String identifier of the event type || || eventDescription text | Description of the event || || locationId location | Identifier of the location. System field || || sourceId crm_status | String identifier of the source type || || sourceDescription text | Additional information about the source || || originatorId string | External source || || originId string | Identifier of the item in the external source || || additionalInfo string | Additional information || || searchContent text | Information for full-text search. System field || || orderStage string | Payment status of the deal || || movedBy user | Identifier of the user who last changed the stage || || movedTime datetime | Time of the last stage change || || isWork boolean | Is the deal in progress. Field is disabled || || isWon boolean | Is the deal won. Field is disabled || || isLose boolean | Is the deal lost. Field is disabled || || receivedAmount string | Amount received. Field is disabled || || lostAmount string | Amount lost. Field is disabled || || hasProducts boolean | Does the item contain products. Field is disabled || || observers user[] | List of user identifiers who are Observers || || contactIds crm_contact[] | List of contact identifiers linked to the item || |#

Contact {#contact}

#| || Name type | Description || || companyId crm_company | Identifier of the company linked to the item || || sourceId crm_status | String identifier of the source type || || sourceDescription text | Additional information about the source || || name string | First name || || lastName string | Last name || || secondName string | Middle name || || shortName string | Last name First name. Short format: for example 'Smith John' -> 'Smith J.'. Field is disabled || || photo file | Photo || || post string | Position || || address text | Address. Deprecated. Field is disabled || || comments text | Comment || || leadId crm_lead | Identifier of the lead based on which the item was created || || export boolean | Is exporting the contact allowed || || typeId crm_status | String identifier of the deal type || || originatorId string | External source || || originId string | Identifier of the item in the external source || || originVersion string | Version of the original || || birthdate date | Date of birth || || honorific crm_status | String identifier of the salutation type || || hasPhone boolean | Does the item have a phone || || hasEmail boolean | Does the item have an email || || hasImol boolean | Does the item have open channels || || searchContent text | Information for full-text search. System field || || categoryId crm_category | Identifier of the funnel (direction) of the item || || login string | Login. Deprecated. Field is disabled || || emailHome string | Personal E-mail || || emailWork string | Work E-mail || || emailMailing string | Mailing email || || phoneMobile string | Mobile phone || || phoneWork string | Work phone || || phoneMailing string | Mailing phone || || imol string | IMOL || || email string | E-mail || || phone string | Phone || || observers user[] | List of user identifiers who are Observers || || companyIds crm_company[] | List of company identifiers linked to the item || || fm crm_multifield | Array of multifields. More about multifields can be found in the section {#T} Structure of the multifield:

• id — Unique identifier
• typeId — Type of multifield
• valueType — Type of value
• value — Value || |#

Company {#company}

#| || Name type | Description || || title string | Name of the item || || logo file | Logo || || address text | Address. Deprecated. Field is disabled || || addressLegal text | Legal address. Deprecated || || bankingDetails string | Banking details || || comments text | Comment || || typeId crm_status | String identifier of the deal type || || industry crm_status | String identifier of the industry type || || revenue double | Annual turnover || || currencyId crm_currency | Identifier of the item's currency || || employees crm_status | String identifier of the number of employees type || || leadId crm_lead | Identifier of the lead based on which the item was created || || originatorId string | External source || || originId string | Identifier of the item in the external source || || originVersion string | Version of the original || || hasPhone boolean | Does the item have a phone || || hasEmail boolean | Does the item have an email || || hasImol boolean | Does the item have open channels || || isMyCompany boolean | Is the company my company || || searchContent text | Information for full-text search. System field || || categoryId crm_category | Identifier of the funnel (direction) of the item || || emailHome string | Personal E-mail || || emailWork string | Work E-mail || || emailMailing string | Mailing email || || phoneMobile string | Mobile phone || || phoneWork string | Work phone || || phoneMailing string | Mailing phone || || imol string | IMOL || || email string | E-mail || || phone string | Phone || || ufLogo file | Logo (document generator) || || ufStamp file | Company seal (document generator) || || ufDirectorSign file | Director's signature (document generator) || || ufAccountantSign file | Chief accountant's signature (document generator) || || observers user[] | List of user identifiers who are Observers || || contactIds crm_contact[] | List of contact identifiers linked to the item || || fm crm_multifield | Array of multifields. More about multifields can be found in the section {#T} Structure of the multifield:

• id — Unique identifier
• typeId — Type of multifield
• valueType — Type of value
• value — Value || |#

Estimate {#quote}

#| || Name type | Description || || dateCreateShort datetime | Time of item creation (short format). Field is disabled || || dateModifyShort datetime | Time of the last modification of the item (short format). Field is disabled || || leadId crm_lead | Identifier of the lead based on which the item was created || || dealId crm_deal | Identifier of the deal linked to the item || || companyId crm_company | Identifier of the company linked to the item || || contactId crm_contact | Identifier of the contact linked to the item || || personTypeId integer | Identifier of the payer type || || mycompanyId crm_company | Identifier of "my" company || || title string | Name of the item || || stageId crm_status | String identifier of the item's stage || || closed boolean | Is the deal closed || || opportunity double | Amount || || isManualOpportunity boolean | Is manual mode for calculating the amount set || || taxValue double | Tax amount || || currencyId crm_currency | Identifier of the item's currency || || comments text | Comment || || commentsType integer | Identifier of the comment type. Possible values:

• 0 — unknown
• 1 — text
• 2 — bb-code
• 3 — HTML || || begindate date | Start date of the item || || begindateShort datetime | Start time of the item (short format). Field is disabled || || closedate date | Completion date of the item || || closedateShort datetime | End time of the item (short format). Field is disabled || || quoteNumber string | Estimate number || || content text | Content || || contentType integer | Identifier of the content type. Possible values:
• 0 — unknown
• 1 — text
• 2 — bb-code
• 3 — HTML || || terms text | Terms || || termsType integer | Identifier of the terms type. Possible values:
• 0 — unknown
• 1 — text
• 2 — bb-code
• 3 — HTML || || storageTypeId integer | Identifier of the storage type || || storageElementIds integer[] | Array of files || || locationId location | Identifier of the location. System field || || clientTitle string | Client name || || clientAddr string | Client address || || clientContact string | Client contacts || || clientEmail string | Client E-mail || || clientPhone string | Client phone || || clientTpId string | Client TIN || || clientTpaId string | Client TPP || || searchContent text | Information for full-text search. System field || || hasProducts boolean | Does the item contain products. Field is disabled || || actualDate date | Valid until || || contactIds crm_contact[] | List of contact identifiers linked to the item || |#

Invoice {#invoice}

#| || Name type | Description || || xmlId string | External code || || title string | Name of the item || || movedBy user | Identifier of the user who last changed the stage || || movedTime datetime | Time of the last stage change || || categoryId crm_category | Identifier of the funnel (direction) of the item || || stageId crm_status | String identifier of the item's stage || || previousStageId crm_status | Identifier of the previous stage type || || begindate date | Start date of the item || || closedate date | Completion date of the item || || companyId crm_company | Identifier of the company linked to the item || || contactId crm_contact | Identifier of the contact linked to the item || || opportunity double | Amount || || isManualOpportunity boolean | Is manual mode for calculating the amount set || || taxValue double | Tax amount || || currencyId crm_currency | Identifier of the item's currency || || mycompanyId crm_company | Identifier of "my" company || || sourceId crm_status | String identifier of the source type || || sourceDescription text | Additional information about the source || || comments text | Comment || || accountNumber string | Invoice number || || locationId location | Identifier of the location. System field || || observers user[] | List of user identifiers who are Observers || || contactIds crm_contact[] | List of contact identifiers linked to the item || |#

SPA {#spa}

#| || Name type | Description || || xmlId string | External code || || title string | Name of the item || || movedBy user | Identifier of the user who last changed the stage. Available only when the isStagesEnabled setting is enabled for the corresponding SPA || || movedTime datetime | Time of the last stage change. Available only when the isStagesEnabled setting is enabled for the corresponding SPA || || categoryId crm_category | Identifier of the funnel (direction) of the item || || stageId crm_status | String identifier of the item's stage. Available only when the isStagesEnabled setting is enabled for the corresponding SPA || || previousStageId crm_status | Identifier of the previous stage type. Available only when the isStagesEnabled setting is enabled for the corresponding SPA || || begindate date | Start date of the item. Available only when the isBeginCloseDatesEnabled setting is enabled for the corresponding SPA || || closedate date | Completion date of the item. Available only when the isBeginCloseDatesEnabled setting is enabled for the corresponding SPA || || companyId crm_company | Identifier of the company linked to the item. Available only when the isClientEnabled setting is enabled for the corresponding SPA || || contactId crm_contact | Identifier of the contact linked to the item. Available only when the isClientEnabled setting is enabled for the corresponding SPA || || opportunity double | Amount. Available only when the isLinkWithProductsEnabled setting is enabled for the corresponding SPA || || isManualOpportunity boolean | Is manual mode for calculating the amount set. Available only when the isLinkWithProductsEnabled setting is enabled for the corresponding SPA || || taxValue double | Tax amount. Available only when the isLinkWithProductsEnabled setting is enabled for the corresponding SPA || || currencyId crm_currency | Identifier of the item's currency. Available only when the isLinkWithProductsEnabled setting is enabled for the corresponding SPA || || opportunityAccount double | Amount in accounting currency. Deprecated. Field is disabled. Available only when the isLinkWithProductsEnabled setting is enabled for the corresponding SPA || || taxValueAccount double | Tax amount in accounting currency. Deprecated. Field is disabled. Available only when the isLinkWithProductsEnabled setting is enabled for the corresponding SPA || || accountCurrencyId crm_currency | Accounting currency. Field is disabled. Available only when the isLinkWithProductsEnabled setting is enabled for the corresponding SPA || || mycompanyId crm_company | Identifier of "my" company. Available only when the isMycompanyEnabled setting is enabled for the corresponding SPA || || sourceId crm_status | String identifier of the source type. Available only when the isSourceEnabled setting is enabled for the corresponding SPA || || sourceDescription text | Additional information about the source. Available only when the isSourceEnabled setting is enabled for the corresponding SPA || || observers user[] | List of user identifiers who are Observers. Available only when the isObserversEnabled setting is enabled for the corresponding SPA || || contactIds crm_contact[] | List of contact identifiers linked to the item. Available only when the isClientEnabled setting is enabled for the corresponding SPA || |#