CRM Requisite Templates: Methods Overview

A requisite template defines which fields a contact's or company's requisite consists of. Every requisite is created from one of the templates, for example:

• the Company template consists of fields for legal entities such as LLC: VAT ID, Company Name
• the Person template consists of other fields: First Name, Last Name

The set of fields depends on the country: a template is linked to a country identifier, and only the fields supported by that country can be added to it.

Quick navigation: all methods

User documentation: How to Create and Configure Company Details Templates in CRM

Getting StartedGetting Started

1. Retrieve the list of countries using the crm.requisite.preset.countries method — a country identifier is required for a new template
2. Create a template using the crm.requisite.preset.add method. Pass the parent object type, the country, and the name to it
3. Configure the set of template fields using the methods of the customizable fields section
4. Retrieve the list of templates using the crm.requisite.preset.list method — the template identifier is required to create a requisite using the crm.requisite.add method

Template IdentifiersTemplate Identifiers

• ID — template identifier. It is returned by the crm.requisite.preset.add, crm.requisite.preset.get, and crm.requisite.preset.list methods. This identifier is passed in the PRESET_ID field when creating a requisite
• ENTITY_TYPE_ID — parent object type. For requisite templates, it is always 8 — "Requisite". All values are provided by the crm.enum.ownertype method
• COUNTRY_ID — country identifier. Available values are returned by the crm.requisite.preset.countries method
• XML_ID — external key for data exchange. Values of the form #CRM_REQUISITE_PRESET_DEF_... are reserved for default templates and must not be used for your own purposes

Fields of the Requisite TemplateFields of the Requisite Template

Name	Description	Read	Write	Required	Immutable
ID integer	Identifier of the template. Automatically created and unique within Bitrix24	Yes	No	No	Yes
ENTITY_TYPE_ID integer	Identifier of the parent object's type. The identifiers of CRM object types are provided by the method crm.enum.ownertype	Yes	Yes	Yes	Yes
COUNTRY_ID integer	Identifier of the country corresponding to the set of fields in the requisite template (to get available values, see the method crm.requisite.preset.countries)	Yes	Yes	Yes	Yes
DATE_CREATE datetime	Creation date	Yes	No	No	No
DATE_MODIFY datetime	Modification date. Contains an empty string if the template has not been changed since creation	Yes	No	No	No
CREATED_BY_ID user	Identifier of the user who created the template	Yes	No	No	No
MODIFY_BY_ID user	Identifier of the user who modified the template	Yes	No	No	No
NAME string	Name of the template	Yes	Yes	Yes	No
XML_ID string	External key. Used for exchange operations. Identifier of the external information base object. The purpose of the field may change by the final developer. Each application ensures the uniqueness of values in this field. It is recommended to use a unique prefix to avoid collisions with other applications. Values of the form #CRM_REQUISITE_PRESET_DEF_... are reserved in CRM for identifying templates that are used by default. These identifiers should not be used for your purposes, as this may lead to logic violations	Yes	Yes	No	No
ACTIVE char	Activity status. Uses values Y or N. Determines the availability of the template in the selection list when adding requisites	Yes	Yes	No	No
SORT integer	Sorting	Yes	Yes	No	No

Use the crm.requisite.preset.fields method to get a formal description of the fields.

Overview of MethodsOverview of Methods

Scope: crm

Who can execute the methods: a user with access permissions for contacts and companies

Access permissions for templates are checked against two CRM objects at once — contacts and companies. To retrieve a template, "read" access permission for both objects is required. To create, modify, or delete a template, "add", "edit", or "delete" access permission for both objects is required.

Method	Description
crm.requisite.preset.add	Creates a new requisite template
crm.requisite.preset.update	Modifies a requisite template
crm.requisite.preset.get	Returns a requisite template by identifier
crm.requisite.preset.list	Returns a list of requisite templates by filter
crm.requisite.preset.delete	Deletes a requisite template
crm.requisite.preset.countries	Returns the list of countries available for requisite templates
crm.requisite.preset.fields	Returns a formal description of the fields of the requisite template