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
crm.company Allows to manage list of companies.
crm.company.list Retrieves list of companies.
crm.company.edit Allows to add new or edit parameters of existing company.
crm.company.show Shows detailed description of a company.
crm.company.menu Allows to configure the upper menu for company.
Company import* crm.company.menu Allows to import list of companies.
Contacts
crm.contact Allows to manage list of contacts.
crm.contact.list Shows list of contacts.
crm.contact.edit allows to add new or edit parameters of existing contact.
Contact view crm.contact.show Shows detailed description of a contact.
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
crm.lead Allows to work with leads.
crm.lead.list Shows list of leads.
crm.lead.edit Allows to create new to edit existing lead.
crm.lead.show Shows detailed description of a lead.
crm.lead.menu Allows to configure the upper menu of an entity.
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
crm.config.fieldsAllows to configure user fields in CRM module.
crm.config.fields.listShows list of CRM module user fields.
crm.config.fields.typesShows list of user field types for CRM module.
crm.config.fields.editAllows to configure CRM module user field.
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
crm.dealAllows to handle deals.
crm.deal.funnelShows the quantitative ratio of deals at different stages of completion.
deal.listShows list of deals.
crm.deal.edit Allows to create new or edit existing deal.
crm.deal.show Shows detailed description of a deal.
crm.deal.menu Allows to configure the upper menu of entity.
Activities
crm.activity.task.listShows list of tasks.
crm.activity.calendar.listShows list of calendar entries.
Invoices
crm.invoiceAllows to handle invoices in CRM.
crm.invoice.listShows list of invoices.
crm.invoice.editAdds new or allows to edit parameters of existing invoice.
crm.invoice.showShows detailed description of an invoice.
crm.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
crm.productAllows to manage products for CRM deals.
crm.product.listShows list of products for CRM.
crm.product.section.listAllows to manage list of sections for selected catalog.
crm.product.editAllows to edit an existing, or to add a new product.
crm.product.showShows detailed description of a product.
crm.product.menuAllows to configure content menu to handle catalogs and products.
.

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


© «Bitrix24», 2001-2024
Up