Documentation

crm.address.fields

crm.address.fields()

Returns description for address fields.

Parameters

No parameters.

Example


    BX24.callMethod(
            "crm.address.fields", 
            {}, 
            function(result) 
            {
                if(result.error())
                    console.error(result.error());
                else
                    console.dir(result.data());
            }
        );	


Requisites

Name Description Read Write
General requisites
ID Requisite ID. Automatically created and unique within the database. YesNo
ENTITY_TYPE_ID Parent entity type. Possible types: "Company", "Contact". Required field. YesYes
ENTITY_ID Parent entity type. Required field. YesYes
PRESET_ID Requisite template ID. Required field. YesYes
DATE_CREATE Creation date. YesNo
DATE_MODIFY Modification date. YesNo
CREATED_BY_ID Requisite creator ID. YesNo
MODIFY_BY_ID Requisite modifier ID. YesNo
NAME Requisite name. YesYes
CODE Requisite ID. YesYes
XML_ID External key, used for exchange action. External database object ID. Field designation can be changed by the end developer. YesYes
ACTIVE Active state attribute. YesYes
SORT Sorting. YesYes
RQ_NAME Full name YesYes
RQ_FIRST_NAME Name. YesYes
RQ_LAST_NAME Last name. YesYes
RQ_COMPANY_NAME Abbreviated company name. YesYes
RQ_COMPANY_FULL_NAME Full company name. YesYes
RQ_COMPANY_REG_DATE Date of state registration.YesYes
RQ_DIRECTOR General director. YesYes
RQ_ACCOUNTANT Chief accountant. YesYes
RQ_CEO_NAME CEO full name. YesYes
RQ_CEO_WORK_POS CEO work position. YesYes
RQ_CONTACT Contact person. YesYes
RQ_EMAIL E-Mail. YesYes
RQ_PHONE Telephone. YesYes
RQ_FAX Fax. YesYes
RQ_IDENT_DOC Document type. YesYes
RQ_IDENT_DOC_SER Series. YesYes
RQ_IDENT_DOC_NUM Number. YesYes
RQ_IDENT_DOC_DATE Date of issue. YesYes
RQ_IDENT_DOC_ISSUED_BY Issued by. YesYes
RQ_IDENT_DOC_DEP_CODE Dept. code. YesYes
RQ_INN INN. YesYes
RQ_KPP KPP. YesYes
RQ_USRLE Handelsregisternummer (for DE). YesYes
RQ_IFNS IFNS. YesYes
RQ_OGRN OGRN. YesYes
RQ_OGRNIP OGRNIP. YesYes
RQ_OKPO OKPO. YesYes
RQ_OKTMO OKTMO. YesYes
RQ_OKVED OKVED. YesYes
RQ_EDRPOU EDRPOU. YesYes
RQ_DRFO DRFO. YesYes
RQ_KBE KBE. YesYes
RQ_IIN IIN. YesYes
RQ_BIN BIN. YesYes
RQ_VAT_PAYER VAT payer (for UA). YesYes
RQ_VAT_ID VAT ID (VAT payer identification number). YesYes
RQ_VAT_CERT_SER VAT certificate series. YesYes
RQ_VAT_CERT_NUM VAT certificate number. YesYes
RQ_VAT_CERT_DATE VAT certificate date. YesYes
RQ_RESIDENCE_COUNTRY Residence country. YesYes
ORIGINATOR_ID External database ID. Field designation can be changed by the end developer. YesYes
Bank requisites
ID Requisite ID. Automatically created and unique within the database. YesNo
ENTITY_TYPE_ID Parent entity type. Default type: "Requisite". Required field. YesYes
ENTITY_ID Parent entity ID. Required field. YesYes
COUNTRY_ID Country ID. YesYes
DATE_CREATE Creation date. YesNo
DATE_MODIFY Modification date. YesNo
CREATED_BY_ID Requisite creator ID. YesNo
MODIFY_BY_ID Requisite modifier ID. YesNo
NAME Requisite name. YesYes
CODE Requisite ID. YesYes
XML_ID External key used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer. Yes Yes
ACTIVE Active state attribute. YesYes
SORT Sorting. YesYes
RQ_BANK_NAME Bank name. YesYes
RQ_BANK_ADDR Bank address. YesYes
RQ_BANK_ROUTE_NUM Bank Routing Number. YesYes
RQ_BIK BIC. YesYes
RQ_MFO MFO. YesYes
RQ_ACC_NAME Bank Account Holder Name. YesYes
RQ_ACC_NUM Bank Account Number. YesYes
RQ_IIK ИИК. YesYes
RQ_ACC_CURRENCY Account currency. YesYes
RQ_COR_ACC_NUM Corr. account. YesYes
RQ_IBAN IBAN. YesYes
RQ_SWIFT SWIFT. YesYes
RQ_BIC BIC.YesYes
COMMENTS Comment. YesYes
ORIGINATOR_ID External database ID. Field designation can change by the end developer. YesYes
Requisite templates
ID Requisite ID. Automatically created and unique within the database. YesNo
ENTITY_TYPE_ID Parent entity type. Required field. YesYes
COUNTRY_ID Country, to which requisite template fields match. YesYes
DATE_CREATE Creation date. YesNo
DATE_MODIFY Modification date. YesNo
CREATED_BY_ID Requisite creator ID. YesNo
MODIFY_BY_ID Requisite modificatory ID. YesNo
NAME Requisite name. YesYes
XML_ID External key used for exchange operations. ID of an object of the external information database. The field assignment can be modified by the end developer. Yes Yes
ACTIVE Active state attribute. YesYes
SORT Sorting. YesYes
Requisite template fields
ID Requisite ID. Automatically created and unique within the requisite. YesNo
FIELD_NAME Field name. YesYes
FIELD_TITLE Alternative field name for requisite. YesYes
SORT Sorting. YesYes
IN_SHORT_LIST Show in short list. YesYes
Requisite addresses
TYPE_ID Address type ID. Required field. "Address type" enumeration element. YesYes
ENTITY_TYPE_ID Parent entity type. Possible types: "Requisite", "Company", "Contact", "Lead". Required field. YesYes
ENTITY_ID Parent entity ID. Required field. YesYes
ADDRESS_1 Street, house, building. YesYes
ADDRESS_2 Apartment / office. YesYes
CITY Город. YesYes
POSTAL_CODE Postal code. YesYes
REGION Region. YesYes
PROVINCE Province. YesYes
COUNTRY Country. YesYes
COUNTRY_CODE Country code. YesYes


User Comments

User comments are not part of official documentation. Use information provided by other users in the comments at your own risk.

The User Comments section is not to be used as a feature discussion board. Only registered users can post comments. Your comment will be visible once it has been approved by the moderator.
© «Bitrix Inc.», 2001-2020, «Bitrix Inc.», 2020