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