Documentation

CRM

Before using the module, please check if it was installed and connect it via the following structure:

<?    if(CModule::IncludeModule("crm")){  
//here you can use module functions and classes
} 
?> 

The module includes the following Components 2.0:


Module components
Name Name in bitrix namespace Description
Companies
Companies (complex component) crm.company Allows to manage list of companies.
List of companies crm.company.list Retrieves list of companies.
Редактирование компании crm.company.edit Allows to add new or edit parameters of existing company.
Company view crm.company.show Shows detailed description of a company.
Company menu crm.company.menu Allows to configure the upper menu for company.
Company import* crm.company.menu Allows to import list of companies.
Contacts
Contacts (complex component) crm.contact Allows to manage list of contacts.
List of contacts crm.contact.list Shows list of contacts.
Contact editing crm.contact.edit allows to add new or edit parameters of existing contact.
Contact view crm.contact.show Shows detailed description of a contact.
Contact menu crm.contact.menu Allows to configure the upper menu for entity.
Export* crm.contact.export Designed to export contacts in the .xml format.
Contact import*crm.contact.import Designed to import the list of contacts in the CSV format.
Deal import*crm.deal.import Designed to import list of deals in the CSV format.
Web service* crm.contact.webservice Designed to create and export contacts.
Leads
Leads (complex component) crm.lead Allows to work with leads.
List of leads crm.lead.list Shows list of leads.
Lead edit crm.lead.edit Allows to create new to edit existing lead.
Lead view crm.lead.show Shows detailed description of a lead.
Toolbar crm.lead.menu Allows to configure the upper menu of an entity.
Lead conversion crm.lead.convert Allows to convert lead into a contact, company or a deal.
Lead import* crm.lead.import Designed to import list of leads in the CSV format.
Web service* crm.lead.webservice Service to create a lead.
REST handler* crm.lead.rest REST handler to create a lead.
Settings
User fields settings (complex component crm.config.fieldsAllows to configure user fields in CRM module.
List of user fields crm.config.fields.listShows list of CRM module user fields.
List of user field types crm.config.fields.typesShows list of user field types for CRM module.
User field settings crm.config.fields.editAllows to configure CRM module user field.
Access permissions settings (complex component) crm.config.permsAllows to configure access permissions to CRM module.
Send&Save settings* crm.config.sendsaveSettings for Send&Save integration with CRM module.
Status settings* crm.config.statusAllows to configure CRM module statuses.
Deals
Deals (complex component)crm.dealAllows to handle deals.
Sales Funnelcrm.deal.funnelShows the quantitative ratio of deals at different stages of completion.
List of dealsdeal.listShows list of deals.
Deal edit crm.deal.edit Allows to create new or edit existing deal.
Deal view crm.deal.show Shows detailed description of a deal.
Deal menu crm.deal.menu Allows to configure the upper menu of entity.
Activities
List of taskscrm.activity.task.listShows list of tasks.
List of calls/meetingscrm.activity.calendar.listShows list of calendar entries.
Invoices
Invoices (complex component)crm.invoiceAllows to handle invoices in CRM.
List of invoicescrm.invoice.listShows list of invoices.
Invoice editcrm.invoice.editAdds new or allows to edit parameters of existing invoice.
Invoice viewcrm.invoice.showShows detailed description of an invoice.
invoice menucrm.invoice.menuAllows to configure context menu of entity.
View invoice in the HTML/PDF format*crm.invoice.paymentView invoice in the HTML/PDF format.
Products
Products (complex component)crm.productAllows to manage products for CRM deals.
List of productscrm.product.listShows list of products for CRM.
List of product sectionscrm.product.section.listAllows to manage list of sections for selected catalog.
Product editcrm.product.editAllows to edit an existing, or to add a new product.
Product viewcrm.product.showShows detailed description of a product.
Toolbarcrm.product.menuAllows to configure content menu to handle catalogs and products.
.

Event view crm.event.view Shows list of activities, performed with the CRM module entities.
Reports (complex component) crm.report Prepares reports about the activities in CRM.
View invoice events crm.invoice.events Shows list of activities, performed with invoices in CRM.
* cancelled system components (not described)


© «Bitrix24», 2001-2023
Up