Invoices: Overview of Methods

An invoice is the final stage of a deal. It is created when all discussions are complete and the terms of the agreement are agreed upon. Multiple invoices can be created for different products and services within a single deal.

An invoice can be generated from a template and sent to the client as a document. In the invoice detail form, you can:

• Manage the sales process of a product or service
• Track the stages of working with the invoice
• Accept online payments

Quick navigation: all methods and events

User documentation: New invoices in CRM

Linking Invoices with Other CRM ObjectsLinking Invoices with Other CRM Objects

Deal. Pass the deal ID in the parentId2 parameter to link the new invoice with the deal.

Estimate. Pass the estimate ID in the parentId7 parameter to link the new invoice with the estimate.

Client. This field in the invoice detail form consists of the associated company and contacts. All activities related to calls, e-mails, and chats with the contact or company will be saved in the invoice detail form. There can be one company in the field, and it is referenced through the invoice field companyId. Multiple contacts can be specified, and interactions with them are managed through the contactIds field; pass an array of contact IDs in this field.

Products. Adding, modifying, and deleting product items in invoices can be done through the group of methods crm.item.productrow.*.

Payments. Adding, modifying, and deleting payment documents in invoices can be done through the group of methods crm.item.payment.*.

Your Company Details. Specify your company ID in the mycompanyId field so that its details are automatically used in documents. You can obtain your company ID using the method crm.item.list for the companies object with a filter on the isMyCompany field.

BX24.callMethod(
                'crm.item.list',
                {
                    entityTypeId: 4,
                    filter: {
                        "isMyCompany": "Y",
                    },
                },
                (result) => {
                    if (result.error())
                    {
                        console.error(result.error());
                        return;
                    }
                    console.info(result.data());
                },
            );
        

Invoice Detail FormInvoice Detail Form

The main workspace in invoices is the General tab of the detail form. It consists of two parts:

• The left part contains fields with information. If the system fields are insufficient, you can create your own custom fields. They allow you to store information in various data formats: string, number, link, address, and others. To create, modify, retrieve, or delete custom fields for invoices, use the group of methods userfieldconfig.*.

• The right part contains the invoice timeline. In it, you can create, edit, filter, and delete CRM activities — the group of methods crm.activity.*, and timeline records — the group of methods crm.timeline.*.

The parameters of the invoice detail form can be managed through the group of methods crm.item.details.configuration.*.

WidgetsWidgets

You can embed an application into the invoice detail form. This allows you to use the application without leaving the invoice detail form.

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.

Embedding Locations for New InvoicesEmbedding Locations for New Invoices

• CRM_SMART_INVOICE_DETAIL_TAB — a tab in the detailed view of the CRM entity

• CRM_SMART_INVOICE_DETAIL_ACTIVITY — a button above the timeline of the detail form

• CRM_SMART_INVOICE_DETAIL_TOOLBAR — an item in the dropdown menu of the top button in the detail form

• CRM_SMART_INVOICE_DOCUMENTGENERATOR_BUTTON — an item in the dropdown menu of the document generator

• CRM_SMART_INVOICE_LIST_MENU — an item in the context menu in the list of entities

• CRM_SMART_INVOICE_LIST_TOOLBAR — an item in the dropdown menu above the list of entities

• CRM_SMART_INVOICE_TIMELINE_MENU — an item in the context menu of an activity in the detail form

• CRM_SMART_INVOICE_ROBOT_DESIGNER_TOOLBAR — an item in the dropdown menu of the top button of the robot designer

Overview of Methods and EventsOverview of Methods and Events

Scope: crm

Who can execute the method: depending on the method

MainMain

CRM Object Identifier entityTypeId — 31

Custom FieldsCustom Fields

CRM Object Identifier entityId — CRM_SMART_INVOICE

Product ItemsProduct Items

CRM Object Identifier ownerType — SI

PaymentsPayments

CRM Object Identifier entityTypeId — 31

Product Items in PaymentProduct Items in Payment

Delivery in PaymentDelivery in Payment

Managing Invoice Detail Form SettingsManaging Invoice Detail Form Settings

CRM Object Identifier entityTypeId — 31