Details in CRM: Overview of Methods

Details are separate CRM entities that store data used in closing deals: Tax Identification Number (TIN), Tax Registration Reason Code (TRRC), Primary State Registration Number (PSRN), banking details, and addresses. Everything necessary for document templates.

The Details field is available:

  • in contacts and companies — where buyer data is stored
  • in your companies — where your company's data, acting as the seller, is stored. This type of company is located in a separate section in the CRM settings

Quick navigation: all methods and events

User documentation: add company details, use of company details

Connection of Details with Other CRM Entities

Contact. The default details template is Person.

Company. The default details template is Company.

My Company. The details of the company selected as the main seller are automatically filled in all documents.

Address. A separate entity accessible through the standard Address field. Addresses can only be linked to Details or Leads. To work with addresses, use the group of methods crm.address.*, where the details ID is passed in the ENTITY_ID parameter.

Documents. Any printed forms: invoices, acts, contracts, and others generated through the document generator.

User Documentation

Details Templates

Any detail for a contact or company is created within templates. A template consists of a set of fields characteristic of a specific type of legal and natural persons:

  • 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

You can add, modify, and delete details templates through the group of methods crm.requisite.preset.*.

Manage the list of fields for a specific template — crm.requisite.preset.field.*.

Create and modify custom fields that can be used in the template — crm.requisite.userfield.*.

User Documentation

Overview of Methods and Events

Scope: crm

Who can execute methods: depending on the method

Basic

Method

Description

crm.requisite.add

Creates a new requisite

crm.requisite.update

Updates an existing requisite

crm.requisite.get

Returns a requisite by ID

crm.requisite.list

Returns a list of requisites by filter

crm.requisite.delete

Deletes a requisite and all associated objects

crm.requisite.fields

Returns the description of requisite fields

Event

Triggered

onCrmRequisiteAdd

When a requisite is added

onCrmRequisiteUpdate

When a requisite is modified

onCrmRequisiteDelete

When a requisite is deleted

Addresses

Method

Description

crm.address.add

Adds a new address for a requisite or lead

crm.address.update

Modifies an address for a requisite or lead

crm.address.list

Returns a list of addresses by filter

crm.address.delete

Deletes an address

crm.address.fields

Returns the formal description of address fields

Event

Triggered

onCrmAddressRegister

When an address is registered

onCrmAddressUnregister

When an address is deleted

Banking Details

Method

Description

crm.requisite.bankdetail.add

Creates a new banking requisite

crm.requisite.bankdetail.update

Modifies an existing banking requisite

crm.requisite.bankdetail.get

Returns a banking requisite by ID

crm.requisite.bankdetail.list

Returns a list of banking requisites by filter

crm.requisite.bankdetail.delete

Deletes a banking requisite

crm.requisite.bankdetail.fields

Returns the formal description of banking requisite fields

Event

Triggered

onCrmBankDetailAdd

When a banking requisite is added

onCrmBankDetailUpdate

When a banking requisite is modified

onCrmBankDetailDelete

When a banking requisite is deleted

Custom Requisite Fields

Method

Description

crm.requisite.userfield.add.md

Creates a new custom field for a requisite

crm.requisite.userfield.update.md

Modifies an existing custom field for a requisite

crm.requisite.userfield.get.md

Returns a custom field for a requisite by ID

crm.requisite.userfield.list.md

Returns a list of custom fields for a requisite by filter

crm.requisite.userfield.delete.md

Deletes a custom field for a requisite

Event

Triggered

onCrmRequisiteUserFieldAdd

When a custom field is added

onCrmRequisiteUserFieldUpdate

When a custom field is modified

onCrmRequisiteUserFieldDelete

When a custom field is deleted

onCrmRequisiteUserFieldSetEnumValues

When the set of values for a custom field of list type is modified

Connections of Requisites with CRM Entities

Method

Description

crm.requisite.link.register

Registers the connection of requisites with an entity

crm.requisite.link.get

Returns the connection of requisites with an entity

crm.requisite.link.list

Returns a list of requisites connections by filter

crm.requisite.link.unregister

Deletes the connection of requisites with an entity

crm.requisite.link.fields

Returns the formal description of fields for requisites connections

Requisites Templates

Method

Description

crm.requisite.preset.add

Creates a new requisites template

crm.requisite.preset.update

Modifies a requisites template

crm.requisite.preset.countries

Returns a possible list of countries for requisites templates

crm.requisite.preset.get

Returns a requisites template by ID

crm.requisite.preset.list

Returns a list of requisites templates by filter

crm.requisite.preset.delete

Deletes a requisites template

crm.requisite.preset.fields

Returns the formal description of fields for requisites templates

Fields of Requisites Templates

Method

Description

crm.requisite.preset.field.add

Adds a customizable field to the requisites template

crm.requisite.preset.field.update

Modifies a customizable field in the requisites template

crm.requisite.preset.field.availabletoadd

Returns fields available for addition to the specified requisites template

crm.requisite.preset.field.get

Returns the description of a customizable field in the requisites template by ID

crm.requisite.preset.field.list

Returns a list of all customizable fields for a specific requisites template

crm.requisite.preset.field.delete

Deletes a customizable field from the requisites template

crm.requisite.preset.field.fields

Returns the formal description of fields that describe the customizable field in the requisites template
Previous
When deleting an estimate
Next
Overview of Methods