Documentation

Available fields


Imporant! It's strongly recommended to pass full sets of address fields within an update method. Partial update is supported, but is not recommended due to competing address update requests issued from other applications.

Example

For example, the company had the following address: "33 Ferndale Ave, Staten Island, NY 10314, United States".

Third-party application: reads address "33 Ferndale Ave, Staten Island, NY 10314, United States".
Your application: reads address "33 Ferndale Ave, Staten Island, NY 10314, United States".

Third-party application: saves the address "Brooklyn, 1922, US" (updating the address - full address replacement).
Your application: saving the address "44 Ferndale Ave" (error fix - correcting the street name, but effectively creating a new error).

As a result of two competing address update queries, company address became "44 Ferndale Ave, Brooklyn, 1922, US".
This way, result can contain an inconsistent address.


Deals

Field Description Read Write
ID Deal ID. Creates automatically and is unique within database. Yes No
TITLE Deal name. Required field. Yes Yes
TYPE_ID Deal type ID. Yes Yes
STAGE_ID Deal stage ID. Yes Yes
PROBABILITY Deal probability (in %). Yes Yes
CURRENCY_ID Deal currency. Yes Yes
OPPORTUNITY Amount in deal currency. Yes Yes
COMPANY_ID Deal company ID. Yes Yes
CONTACT_ID Contact person ID. Yes Yes
BEGINDATE Deal start date. Yes Yes
CLOSEDATE Deal closed date. Yes Yes
OPENED "Deal is public" flag. Yes Yes
CLOSED "Deal is closed". Yes Yes
COMMENTS Comments. Yes Yes
ASSIGNED_BY_ID Deal assigned by user - ID. Yes Yes
CREATED_BY_ID Deal created by user - ID. Yes No
MODIFY_BY_ID Deal modified by user - ID. Yes No
DATE_CREATE Date created. Yes No
DATE_MODIFY Date modified. Yes No
LEAD_ID Lead ID. Yes No
ADDITIONAL_INFO Additional information. Yes Yes
ORIGINATOR_ID External database ID. Field designation can be modified by developer. Yes Yes
ORIGIN_ID External ID, used for exchange operations. External database object ID. Field designation can be modified by developer. Yes Yes

Leads

Field Description Read Write
ID Lead ID. Yes No
TITLE Lead name. Required field. Yes Yes
NAME Contact name. Yes Yes
SECOND_NAME Contact middle name. Yes Yes
LAST_NAME Last name. Yes Yes
COMPANY_TITLE Company name. Yes Yes
SOURCE_ID Source ID. Yes Yes
SOURCE_DESCRIPTION Additional data about the source. Yes Yes
STATUS_ID Lead status ID. Yes Yes
STATUS_DESCRIPTION Status additional information. Yes Yes
POST Position Yes Yes
ADDRESS Street, house, building. Yes Yes
ADDRESS_2 Apartment, officeYesYes
ADDRESS_CITY CityYesYes
ADDRESS_POSTAL_CODE Zip codeYesYes
ADDRESS_REGION DistrictYesYes
ADDRESS_PROVINCE RegionYesYes
ADDRESS_COUNTRY CountryYesYes
ADDRESS_COUNTRY_CODE Country codeYesYes
CURRENCY_ID Currency ID. Yes Yes
OPPORTUNITY Estimated amount. Yes Yes
OPENED "Available for everyone". Yes Yes
COMMENTS Comments. Yes Yes
ASSIGNED_BY_ID Assigned by user - ID. Yes Yes
CREATED_BY_ID Created by user - ID. Yes No
MODIFY_BY_ID Modified by user - ID. Yes No
DATE_CREATE Date created. Yes No
DATE_MODIFY Date modified. Yes No
COMPANY_ID Company ID. Yes No
CONTACT_ID Contact ID. Yes No
DATE_CLOSED Date closed. Yes No
PHONE Phone number. Yes Yes
EMAIL E-mail. Yes Yes
WEB Website. Yes Yes
IM Contact within instant messenger service. Yes Yes
ORIGINATOR_ID External database ID. Field designation can be modified by developer. Yes Yes
ORIGIN_ID External ID, used for exchange operations. External database object ID. Field designation can be modified by developer. Yes Yes

Companies

Field Description Read Write
ID Company ID. Created automatically and unique within database. Yes No
TITLE Company name. Required field. Yes Yes
COMPANY_TYPE Company type. Selected from list. Yes Yes
LOGO Company logo. Yes Yes
ADDRESSStreet, house, building (actual address)YesYes
ADDRESS_2Apartment / office (actual address)YesYes
ADDRESS_CITYCity (actual address)YesYes
ADDRESS_POSTAL_CODE Zip code (actual address)YesYes
ADDRESS_REGION District (actual address)YesYes
ADDRESS_PROVINCE Region (actual address)YesYes
ADDRESS_COUNTRY Country (actual address)YesYes
ADDRESS_COUNTRY_CODE Country code (actual address)YesYes
REG_ADDRESS Street, house, building (legal address)YesYes
REG_ADDRESS_2Apartment / офис (legal address)YesYes
REG_ADDRESS_CITYCity (legal address)YesYes
REG_ADDRESS_POSTAL_CODE Zip code (legal address)YesYes
REG_ADDRESS_REGION District (legal address)YesYes
REG_ADDRESS_PROVINCE Region (legal address)YesYes
REG_ADDRESS_COUNTRY Country (legal address)YesYes
REG_ADDRESS_COUNTRY_CODE Country code (legal address)YesYes
ADDRESS_LEGAL Legal address. Yes Yes
BANKING_DETAILS Bank details. Yes Yes
INDUSTRY Business segment. Selected from list. Yes Yes
EMPLOYEES Number employees. Selected from list. Yes Yes
CURRENCY_ID Transaction currency. Yes Yes
REVENUE Annual turnover. Yes Yes
OPENED "Available for everyone" flag. Yes Yes
COMMENTS Comments. Yes Yes
ASSIGNED_BY_ID Assigned by user - ID. Yes Yes
CREATED_BY_ID Create by user - ID. Yes No
MODIFY_BY_ID Modified by user - ID. Yes No
DATE_CREATE Date created. Yes No
DATE_MODIFY Date modified. Yes No
LEAD_ID Lead ID. Yes No
ORIGINATOR_ID External database ID. Field designation can be modified by developer. Yes Yes
ORIGIN_ID External ID, used for exchange operations. External database object ID. Field designation can be modified by developer. Yes Yes
PHONE Phone number. Yes Yes
EMAIL E-mail. Yes Yes
WEB Website. Yes Yes
IM Contact within instant messenger service. Yes Yes

Contacts

Field Description Read Write
ID Contact ID. Created automatically and unique within database. Yes Yes
NAME Contact name. Required field. Yes Yes
SECOND_NAME Contact middle name. Required field. Yes Yes
LAST_NAME Contact last name. Required field. Yes Yes
PHOTO Contact photo. Yes Yes
BIRTHDATE Contact creation date. Yes Yes
TYPE_ID Contact type. Yes Yes
SOURCE_ID Source. Yes Yes
SOURCE_DESCRIPTION Source details. Yes Yes
POST Position. Yes Yes
ADDRESS Street, house, building. Yes Yes
ADDRESS_2 Apartment, officeYesYes
ADDRESS_CITY CityYesYes
ADDRESS_POSTAL_CODE Zip codeYesYes
ADDRESS_REGION DistrictYesYes
ADDRESS_PROVINCE RegionYesYes
ADDRESS_COUNTRY CountryYesYes
ADDRESS_COUNTRY_CODE Country codeYesYes
OPENED "Available for everyone" flag. Yes Yes
COMMENTS Comments. Yes Yes
EXPORT Export enabling flag. Yes Yes
ASSIGNED_BY_ID Assigned by user - ID. Yes Yes
CREATED_BY_ID Created by user - ID. Yes No
MODIFY_BY_ID Modified by user - ID. Yes No
DATE_CREATE Date created. Yes No
DATE_MODIFY Date modified. Yes No
COMPANY_ID Company ID. Yes Yes
LEAD_ID Lead ID. Yes No
PHONE Phone number. Yes Yes
EMAIL E-mail. Yes Yes
WEB Website. Yes Yes
IM Contact within instant messenger service. Yes Yes
ORIGINATOR_ID External database ID. Field designation can be modified by developer. Yes Yes
ORIGIN_ID External ID, used for exchange operations. External database object ID. Field designation can be modified by developer. Yes Yes


© «Bitrix24», 2001-2022
Up