Helper Objects: Overview of Methods

Helper methods return reference data required to work with the main CRM objects: the structure of multiple fields and enumeration values — identifiers of object types, address types, and activities. These methods do not modify any data of their own.

Helper methods are split into two groups: multiple fields and enumerations.

Quick navigation: all methods

Multiple FieldsMultiple Fields

Multiple fields store the contact details of leads, contacts, and companies: phone numbers, e-mails, messengers. The value of such a field is an array of crm_multifield objects. The method crm.multifield.fields returns the composition and characteristics of this object's fields.

Which methods accept the value and which value types are allowed — see the Multiple Fields subsection.

EnumerationsEnumerations

Enumerations are reference lists of identifiers that CRM uses in the parameters of other methods. The group of methods crm.enum.* returns identifier–name pairs. For example, the method crm.enum.ownertype returns the identifiers of CRM object types and smart processes for the entityTypeId parameter, while the method crm.enum.addresstype returns the identifiers of address types: legal, actual, delivery address.

Which identifier belongs in which parameter — see the Enumerations subsection.

Where to Get VAT RatesWhere to Get VAT Rates

VAT rates are managed by the group of methods catalog.vat.* of the Product Catalog. This group has its own scope catalog, so it is not included in the method tables below.

Pass the rate identifier returned by the catalog.vat.* methods:

• in the taxRate parameter of the group of methods crm.item.productrow.* — to set the VAT for a product in a deal or another CRM object
• in the vatId parameter of the group of methods catalog.product.* — to set the VAT for a product or service in the product catalog

Overview of MethodsOverview of Methods

Scope: crm

Who can perform methods: any user

Multiple FieldsMultiple Fields

Method	Description
crm.multifield.fields	Returns the description of multiple fields

EnumerationsEnumerations

Method	Description
crm.enum.fields	Returns the description of the fields of enumeration items
crm.enum.getorderownertypes	Returns the identifiers of object types to which order binding is available
crm.enum.ownertype	Returns the types of objects in CRM
crm.enum.addresstype	Returns the types of addresses
crm.enum.settings.mode	Returns the description of CRM operation modes

Deprecated EnumerationsDeprecated Enumerations

The methods below are no longer being developed. Retrieve activity enumerations in the Activities in CRM section.

Method	Description
crm.enum.activitytype	Returns the enumeration items "Activity Types"
crm.enum.activitypriority	Returns the enumeration items "Activity Priorities"
crm.enum.activitydirection	Returns the enumeration items "Activity Direction" for e-mails and calls
crm.enum.activitynotifytype	Returns the enumeration items "Activity Start Notification Type" for meetings and calls
crm.enum.activitystatus	Returns the enumeration items "Status"
crm.enum.contenttype	Returns the enumeration items "Description Type"