About Requisite Templates

Scope: crm

Who can execute methods: any user

Fields of the Requisite Template

Name	Description	Read	Write	Required	Immutable
ID `integer`	Identifier of the requisite. Automatically created and unique within the account	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 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
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

Overview of Methods

Method	Description
crm.requisite.preset.add	Creates a new requisite template
crm.requisite.preset.update	Modifies a requisite template
crm.requisite.preset.countries	Returns a possible list of countries for requisite templates
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.fields	Returns a formal description of the fields of the requisite template

Previous

Overview of Methods

Next

Create Template