Overview of Helper Methods

The helper method groups include multiple fields, enumerations, and VAT rates.

Quick navigation: all methods and events

Multiple Fields

The method crm.multifield.fields returns information about the structure of multiple fields, such as phone numbers or e-mails. To populate a field with a value of type, pass the data in the structure returned by the method.
Example of passing data to fill in a mobile phone number:

PHONE: [
                    { 
                        VALUE: "555888",
                        VALUE_TYPE: "MOBILE",
                    },
                ] ,
        

Enumerations

The group of enumeration methods crm.enum.* returns information about the names and identifiers of CRM objects. For example, the method crm.enum.ownertype returns identifiers for smart processes, while the method crm.enum.addresstype returns identifiers for address types: legal, physical, delivery address.

VAT Rates

The group of methods catalog.vat.* manages VAT rates. These methods allow you to create, delete, update, and retrieve VAT rate values.

To set the VAT for a product in a deal or another CRM object, use the taxRate parameter from the group of methods crm.item.productrow.*.

To set the VAT for a product or service in the product catalog, use the vatId parameter from the group of methods catalog.product.*.

Overview of Methods

Scope: crm

Who can perform methods: depending on the method

Multiple Fields

Method

Description

crm.multifield.fields

Returns the description of multiple fields

Enumerations

Method

Description

crm.enum.fields

Returns the description of enumeration fields

crm.enum.ownertype

Returns the types of objects in CRM

crm.enum.getorderownertypes

Returns the identifiers of object types to which order binding is available

crm.enum.addresstype

Returns the types of addresses

crm.enum.settings.mode

Returns the description of CRM operation modes

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"