About Universal Requisites
Scope:
crmWho can execute the method: any user
Company requisites are details that allow for the precise identification of an organization. Every officially registered company has a set of such data, including: name, legal address, TIN, OGRN, KPP, OKPO code, OKVED code, and others.
We explain more in the article What are your company's requisites
Requisite Fields
|
Name |
Description |
Read |
Write |
Required |
Immutable |
|
ID |
Identifier of the requisite, can be obtained using the method crm.requisite.list. Created automatically and is unique within the account. |
Yes |
No |
No |
No |
|
ENTITY_TYPE_ID* |
Identifier of the parent entity type. Currently, this can only be:
Identifiers of all CRM entity types can be obtained from the method crm.enum.ownertype |
Yes |
Yes |
Yes |
Yes |
|
ENTITY_ID* |
Identifier of the parent entity (contact or company). The identifier can be obtained using the method crm.company.list for companies and the method crm.contact.list for contacts |
Yes |
Yes |
Yes |
Yes |
|
PRESET_ID* |
Identifier of the requisites template. Template identifiers can be obtained using the method crm.requisite.preset.list |
Yes |
Yes |
Yes |
Yes |
|
DATE_CREATE |
Creation date |
Yes |
No |
No |
No |
|
DATE_MODIFY |
Modification date |
Yes |
No |
No |
No |
|
CREATED_BY_ID |
Identifier of the user who created the requisite |
Yes |
No |
No |
No |
|
MODIFY_BY_ID |
Identifier of the user who modified the requisite |
Yes |
No |
No |
No |
|
NAME* |
Name of the requisite |
Yes |
Yes |
Yes |
No |
|
CODE |
Symbolic code of the requisite |
Yes |
Yes |
No |
No |
|
XML_ID |
External key, used for exchange operations. Identifier of the object in the external information database. The purpose of the field may change by the final developer |
Yes |
Yes |
No |
No |
|
ORIGINATOR_ID |
Identifier of the external information database. The purpose of the field may change by the final developer |
Yes |
Yes |
No |
No |
|
ACTIVE |
Activity status. Values Currently, the field does not actually affect anything |
Yes |
Yes |
No |
No |
|
ADDRESS_ONLY |
Status indicator when the requisite is used only for storing the address. Values |
Yes |
Yes |
No |
No |
|
SORT |
Sorting. Order in the list of entity requisites when there are multiple |
Yes |
Yes |
No |
No |
|
RQ_NAME |
Full name |
Yes |
Yes |
No |
No |
|
RQ_FIRST_NAME |
First name |
Yes |
Yes |
No |
No |
|
RQ_LAST_NAME |
Last name |
Yes |
Yes |
No |
No |
|
RQ_SECOND_NAME |
Middle name |
Yes |
Yes |
No |
No |
|
RQ_COMPANY_ID |
Identifier of the organization |
Yes |
Yes |
No |
No |
|
RQ_COMPANY_NAME |
Short name of the organization |
Yes |
Yes |
No |
No |
|
RQ_COMPANY_FULL_NAME |
Full name of the organization |
Yes |
Yes |
No |
No |
|
RQ_COMPANY_REG_DATE |
Date of state registration |
Yes |
Yes |
No |
No |
|
RQ_DIRECTOR |
General Director |
Yes |
Yes |
No |
No |
|
RQ_ACCOUNTANT |
Chief Accountant |
Yes |
Yes |
No |
No |
|
RQ_CEO_NAME |
Full name of the first leader |
Yes |
Yes |
No |
No |
|
RQ_CEO_WORK_POS |
Position of the first leader |
Yes |
Yes |
No |
No |
|
RQ_CONTACT |
Contact person |
Yes |
Yes |
No |
No |
|
RQ_EMAIL |
|
Yes |
Yes |
No |
No |
|
RQ_PHONE |
Phone |
Yes |
Yes |
No |
No |
|
RQ_FAX |
Fax |
Yes |
Yes |
No |
No |
|
RQ_IDENT_TYPE |
Identification method |
Yes |
Yes |
No |
No |
|
RQ_IDENT_DOC |
Type of document |
Yes |
Yes |
No |
No |
|
RQ_IDENT_DOC_SER |
Series |
Yes |
Yes |
No |
No |
|
RQ_IDENT_DOC_NUM |
Number |
Yes |
Yes |
No |
No |
|
RQ_IDENT_DOC_PERS_NUM |
Personal number |
Yes |
Yes |
No |
No |
|
RQ_IDENT_DOC_DATE |
Date of issue |
Yes |
Yes |
No |
No |
|
RQ_IDENT_DOC_ISSUED_BY |
Issued by |
Yes |
Yes |
No |
No |
|
RQ_IDENT_DOC_DEP_CODE |
Department code |
Yes |
Yes |
No |
No |
|
RQ_INN |
TIN |
Yes |
Yes |
No |
No |
|
RQ_KPP |
KPP |
Yes |
Yes |
No |
No |
|
RQ_USRLE |
Handelsregisternummer (for country DE) |
Yes |
Yes |
No |
No |
|
RQ_IFNS |
IFNS |
Yes |
Yes |
No |
No |
|
RQ_OGRN |
OGRN |
Yes |
Yes |
No |
No |
|
RQ_OGRNIP |
OGRNIP |
Yes |
Yes |
No |
No |
|
RQ_OKPO |
OKPO |
Yes |
Yes |
No |
No |
|
RQ_OKTMO |
OKTMO |
Yes |
Yes |
No |
No |
|
RQ_OKVED |
OKVED |
Yes |
Yes |
No |
No |
|
RQ_EDRPOU |
EDRPOU |
Yes |
Yes |
No |
No |
|
RQ_DRFO |
DRFO |
Yes |
Yes |
No |
No |
|
RQ_KBE |
KBE |
Yes |
Yes |
No |
No |
|
RQ_IIN |
IIN |
Yes |
Yes |
No |
No |
|
RQ_BIN |
BIN |
Yes |
Yes |
No |
No |
|
RQ_ST_CERT_SER |
Series of the state registration certificate |
Yes |
Yes |
No |
No |
|
RQ_ST_CERT_NUM |
Number of the state registration certificate |
Yes |
Yes |
No |
No |
|
RQ_ST_CERT_DATE |
Date of the state registration certificate |
Yes |
Yes |
No |
No |
|
RQ_VAT_PAYER |
VAT payer (for country UA). Values |
Yes |
Yes |
No |
No |
|
RQ_VAT_ID |
VAT ID (identification number of the VAT payer) |
Yes |
Yes |
No |
No |
|
RQ_VAT_CERT_SER |
Series of the VAT certificate |
Yes |
Yes |
No |
No |
|
RQ_VAT_CERT_NUM |
Number of the VAT certificate |
Yes |
Yes |
No |
No |
|
RQ_VAT_CERT_DATE |
Date of the VAT certificate |
Yes |
Yes |
No |
No |
|
RQ_RESIDENCE_COUNTRY |
Country of residence |
Yes |
Yes |
No |
No |
|
RQ_BASE_DOC |
Basis of the action |
Yes |
Yes |
No |
No |
|
RQ_REGON |
REGON (for country PL) |
Yes |
Yes |
No |
No |
|
RQ_KRS |
KRS (for country PL) |
Yes |
Yes |
No |
No |
|
RQ_PESEL |
PESEL (for country PL) |
Yes |
Yes |
No |
No |
|
RQ_LEGAL_FORM |
Legal form (for country FR) |
Yes |
Yes |
No |
No |
|
RQ_SIRET |
Siret number (for country FR) |
Yes |
Yes |
No |
No |
|
RQ_SIREN |
Siren number (for country FR) |
Yes |
Yes |
No |
No |
|
RQ_CAPITAL |
Share capital (for country FR) |
Yes |
Yes |
No |
No |
|
RQ_RCS |
RCS (for country FR) |
Yes |
Yes |
No |
No |
|
RQ_CNPJ |
CNPJ (for country BR) |
Yes |
Yes |
No |
No |
|
RQ_STATE_REG |
State Registration (IE) (for country BR) |
Yes |
Yes |
No |
No |
|
RQ_MNPL_REG |
Municipal Registration (IM) (for country BR) |
Yes |
Yes |
No |
No |
|
RQ_CPF |
CPF (for country BR) |
Yes |
Yes |
No |
No |
|
UF_CRM_... |
Custom fields. For example, Requisites can have a set of custom fields with types: You can add a custom field to requisites using the method crm.requisite.userfield.add |
Yes |
Yes |
No |
No |
Overview of Methods
|
Method |
Description |
|
Creates a new requisite |
|
|
Updates an existing requisite |
|
|
Returns the requisite by identifier |
|
|
Returns a list of requisites by filter |
|
|
Deletes the requisite and all related objects |
|
|
Returns the description of requisite fields |