About Universal Requisites

Scope: crm

Who 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
type

Description

Read

Write

Required

Immutable

ID
integer

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*
integer

Identifier of the parent entity type.

Currently, this can only be:

  • 3 — contact
  • 4 — company

Identifiers of all CRM entity types can be obtained from the method crm.enum.ownertype

Yes

Yes

Yes

Yes

ENTITY_ID*
integer

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*
integer

Identifier of the requisites template.

Template identifiers can be obtained using the method crm.requisite.preset.list

Yes

Yes

Yes

Yes

DATE_CREATE
datetime

Creation date

Yes

No

No

No

DATE_MODIFY
datetime

Modification date

Yes

No

No

No

CREATED_BY_ID
user

Identifier of the user who created the requisite

Yes

No

No

No

MODIFY_BY_ID
user

Identifier of the user who modified the requisite

Yes

No

No

No

NAME*
string

Name of the requisite

Yes

Yes

Yes

No

CODE
string

Symbolic code of the requisite

Yes

Yes

No

No

XML_ID
string

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
string

Identifier of the external information database.

The purpose of the field may change by the final developer

Yes

Yes

No

No

ACTIVE
char

Activity status.

Values Y or N are used.

Currently, the field does not actually affect anything

Yes

Yes

No

No

ADDRESS_ONLY
char

Status indicator when the requisite is used only for storing the address.

Values Y or N are used. When Y, the requisites are not displayed in the entity detail form, but the address is shown

Yes

Yes

No

No

SORT
integer

Sorting. Order in the list of entity requisites when there are multiple

Yes

Yes

No

No

RQ_NAME
string

Full name

Yes

Yes

No

No

RQ_FIRST_NAME
string

First name

Yes

Yes

No

No

RQ_LAST_NAME
string

Last name

Yes

Yes

No

No

RQ_SECOND_NAME
string

Middle name

Yes

Yes

No

No

RQ_COMPANY_ID
string

Identifier of the organization

Yes

Yes

No

No

RQ_COMPANY_NAME
string

Short name of the organization

Yes

Yes

No

No

RQ_COMPANY_FULL_NAME
string

Full name of the organization

Yes

Yes

No

No

RQ_COMPANY_REG_DATE
string

Date of state registration

Yes

Yes

No

No

RQ_DIRECTOR
string

General Director

Yes

Yes

No

No

RQ_ACCOUNTANT
string

Chief Accountant

Yes

Yes

No

No

RQ_CEO_NAME
string

Full name of the first leader

Yes

Yes

No

No

RQ_CEO_WORK_POS
string

Position of the first leader

Yes

Yes

No

No

RQ_CONTACT
string

Contact person

Yes

Yes

No

No

RQ_EMAIL
string

E-Mail

Yes

Yes

No

No

RQ_PHONE
string

Phone

Yes

Yes

No

No

RQ_FAX
string

Fax

Yes

Yes

No

No

RQ_IDENT_TYPE
crm_status

Identification method

Yes

Yes

No

No

RQ_IDENT_DOC
string

Type of document

Yes

Yes

No

No

RQ_IDENT_DOC_SER
string

Series

Yes

Yes

No

No

RQ_IDENT_DOC_NUM
string

Number

Yes

Yes

No

No

RQ_IDENT_DOC_PERS_NUM
string

Personal number

Yes

Yes

No

No

RQ_IDENT_DOC_DATE
string

Date of issue

Yes

Yes

No

No

RQ_IDENT_DOC_ISSUED_BY
string

Issued by

Yes

Yes

No

No

RQ_IDENT_DOC_DEP_CODE
string

Department code

Yes

Yes

No

No

RQ_INN
string

TIN

Yes

Yes

No

No

RQ_KPP
string

KPP

Yes

Yes

No

No

RQ_USRLE
string

Handelsregisternummer (for country DE)

Yes

Yes

No

No

RQ_IFNS
string

IFNS

Yes

Yes

No

No

RQ_OGRN
string

OGRN

Yes

Yes

No

No

RQ_OGRNIP
string

OGRNIP

Yes

Yes

No

No

RQ_OKPO
string

OKPO

Yes

Yes

No

No

RQ_OKTMO
string

OKTMO

Yes

Yes

No

No

RQ_OKVED
string

OKVED

Yes

Yes

No

No

RQ_EDRPOU
string

EDRPOU

Yes

Yes

No

No

RQ_DRFO
string

DRFO

Yes

Yes

No

No

RQ_KBE
string

KBE

Yes

Yes

No

No

RQ_IIN
string

IIN

Yes

Yes

No

No

RQ_BIN
string

BIN

Yes

Yes

No

No

RQ_ST_CERT_SER
string

Series of the state registration certificate

Yes

Yes

No

No

RQ_ST_CERT_NUM
string

Number of the state registration certificate

Yes

Yes

No

No

RQ_ST_CERT_DATE
string

Date of the state registration certificate

Yes

Yes

No

No

RQ_VAT_PAYER
char

VAT payer (for country UA).

Values Y or N are used

Yes

Yes

No

No

RQ_VAT_ID
string

VAT ID (identification number of the VAT payer)

Yes

Yes

No

No

RQ_VAT_CERT_SER
string

Series of the VAT certificate

Yes

Yes

No

No

RQ_VAT_CERT_NUM
string

Number of the VAT certificate

Yes

Yes

No

No

RQ_VAT_CERT_DATE
string

Date of the VAT certificate

Yes

Yes

No

No

RQ_RESIDENCE_COUNTRY
string

Country of residence

Yes

Yes

No

No

RQ_BASE_DOC
string

Basis of the action

Yes

Yes

No

No

RQ_REGON
string

REGON (for country PL)

Yes

Yes

No

No

RQ_KRS
string

KRS (for country PL)

Yes

Yes

No

No

RQ_PESEL
string

PESEL (for country PL)

Yes

Yes

No

No

RQ_LEGAL_FORM
string

Legal form (for country FR)

Yes

Yes

No

No

RQ_SIRET
string

Siret number (for country FR)

Yes

Yes

No

No

RQ_SIREN
string

Siren number (for country FR)

Yes

Yes

No

No

RQ_CAPITAL
string

Share capital (for country FR)

Yes

Yes

No

No

RQ_RCS
string

RCS (for country FR)

Yes

Yes

No

No

RQ_CNPJ
string

CNPJ (for country BR)

Yes

Yes

No

No

RQ_STATE_REG
string

State Registration (IE) (for country BR)

Yes

Yes

No

No

RQ_MNPL_REG
string

Municipal Registration (IM) (for country BR)

Yes

Yes

No

No

RQ_CPF
string

CPF (for country BR)

Yes

Yes

No

No

UF_CRM_...

Custom fields. For example, UF_CRM_1694526604.

Requisites can have a set of custom fields with types: string, boolean, double, datetime.

You can add a custom field to requisites using the method crm.requisite.userfield.add

Yes

Yes

No

No

Overview of Methods

Method

Description

crm.requisite.add

Creates a new requisite

crm.requisite.update

Updates an existing requisite

crm.requisite.get

Returns the requisite by identifier

crm.requisite.list

Returns a list of requisites by filter

crm.requisite.delete

Deletes the requisite and all related objects

crm.requisite.fields

Returns the description of requisite fields