Companies in CRM: Overview of Methods
A company is a CRM object that stores client data for legal entities. The company card contains:
- phone numbers, email addresses, and messenger identifiers in a special format. These allow direct communication with the client from Bitrix.
- details for generating invoices, contracts, and any other types of printed documents based on templates.
Quick navigation: all methods and events
User documentation: companies in Bitrix24
Company Connection with Other CRM Objects
Deal, lead, SPA. Any CRM object that has the standard field Client is linked to a company. The connection is managed through groups of methods for deals, leads, SPAs, using the COMPANY_ID field.
Contact. Multiple contacts can be associated with a single company. This connection is managed using the group of methods crm.company.contact.*. When you select a company in the Client field of deals or SPAs, all related contacts are automatically pulled into the field.
Details. The details themselves are a separate object, and methods from the group crm.requisite.* and crm.address.* are used to create or modify them. They are displayed in the Details field of the company card.
User Documentation
Company Card
The main workspace in a company is the General tab of its card. It consists of two parts:
-
the left part, which contains fields with information. If the system fields are insufficient, you can create your own custom fields. These allow you to store information in various data formats: string, number, link, address, and others. The group of methods crm.company.userfield.* is used to create, modify, retrieve, or delete custom fields for companies.
-
the right part, which contains the contact timeline. In it, you can create, edit, filter, and delete CRM activities using the group of methods crm.activity.*, and timeline records using the group of methods crm.timeline.*.
The parameters of the company card can be managed through the group of methods crm.company.details.configuration.*.
User Documentation
Widgets
You can embed an application into the company card. This allows you to use the application without leaving the company card.
There are two embedding scenarios:
- Use special embedding locations. For example, by creating your own tab.
- Create a custom field where the interface of your application will be loaded.
Typical use-cases and scenarios
Overview of Methods and Events
Scope:
crmWho can execute methods: depending on the method
Main
|
Method |
Description |
|
Creates a new company |
|
|
Updates an existing company |
|
|
Returns a company by ID |
|
|
Returns a list of companies by filter |
|
|
Deletes a company and all related objects |
|
|
Returns the description of company fields |
|
Event |
Triggered |
|
when a company is created |
|
|
when a company is updated |
|
|
when a company is deleted |
Custom Fields
|
Method |
Description |
|
Creates a new custom field for companies |
|
|
Updates an existing custom field for companies |
|
|
Returns a custom field for companies by ID |
|
|
Returns a list of custom fields for companies by filter |
|
|
Deletes a custom field for companies |
|
Event |
Triggered |
|
when a custom field is added |
|
|
when a custom field is modified |
|
|
when a custom field is deleted |
|
|
when the set of values for a custom field of list type is changed |
Contacts
|
Method |
Description |
|
Adds a contact to the specified company |
|
|
Returns a set of contacts associated with the specified company |
|
|
Sets the set of contacts associated with the specified company |
|
|
Deletes a contact from the specified company |
|
|
Clears the set of contacts associated with the specified company |
|
|
Returns the description of fields for the company-contact connection |
Managing Company Cards
|
Method |
Description |
|
Retrieves the settings for company cards |
|
|
Resets the settings for company cards |
|
|
Sets the settings for company cards |
|
|
Allows forcing a common company card for all users |