Счета: обзор методов и событий

Счет — это финальный этап сделки. Он создается, когда все обсуждения завершены, а условия договора согласованы. Для одной сделки можно создать несколько счетов для разных товаров и услуг.

Счет можно сформировать по шаблону и отправить клиенту в виде документа. В карточке счета вы можете:

• управлять процессом продажи товара или услуги
• отслеживать этапы работы со счетом
• принимать онлайн-платежи

Счета — это отдельный тип объекта CRM с идентификатором entityTypeId = 31. Работайте с ними универсальными методами crm.item.* и передавайте entityTypeId = 31 в каждом вызове.

Быстрый переход: все методы и события

Пользовательская документация: Новые счета в CRM

Как начать работуКак начать работу

1. Получите список доступных полей счета методом crm.item.fields с entityTypeId = 31.
2. Создайте счет методом crm.item.add. Свяжите его со сделкой через parentId2 и укажите клиента в полях companyId и contactIds.
3. Добавьте товарные позиции методами crm.item.productrow.* с ownerType = SI.
4. Создайте оплату методом crm.item.payment.add и получите ссылку для клиента методом salescenter.payment.getPublicUrl.
5. Отслеживайте статус счета методами crm.item.get и crm.item.list, меняйте его методом crm.item.update.

Связь счетов с другими объектами CRMСвязь счетов с другими объектами CRM

Сделка. Передавайте ID сделки в параметре parentId2, чтобы новый счет был связан со сделкой.

Предложение. Передавайте ID предложения в параметре parentId7, чтобы новый счет был связан с предложением.

Клиент. Поле в карточке счета, состоящее из связанных с ним компании и контактов. Все дела звонков, писем, чатов с контактом или компанией будут сохранены в карточке счета. Компания в поле одна, обращение к ней происходит через поле счета companyId. Контактов может быть указано несколько, взаимодействие с ними ведется через поле contactIds, передавайте в поле массив с ID контактов.

Товары. Добавление, изменение, удаление товарных позиций в счетах возможно через группу методов crm.item.productrow.*.

Оплаты. Добавление, изменение, удаление документов оплаты в счетах возможно через группу методов crm.item.payment.*.

Реквизиты вашей компании. Укажите ID вашей компании в поле mycompanyId, чтобы ее реквизиты автоматически использовались в документах. Получить ID вашей компании можно методом crm.item.list: передайте entityTypeId = 4 и фильтр isMyCompany = Y.

Заказы интернет-магазина. Заказ можно привязать к счету методами crm.orderentity.*, передав ownerTypeId = 31 и ownerId счета.

Карточка счетаКарточка счета

Основное рабочее пространство в счетах — это вкладка «Общее» карточки. Она состоит из двух частей:

• левая, в ней располагаются поля с информацией. Если системных полей недостаточно, вы можете создать собственные пользовательские поля. Они позволяют хранить информацию в различных форматах данных: строка, число, ссылка, адрес и другие. Для создания, изменения, получения или удаления пользовательских полей счетов используйте группу методов userfieldconfig.* с entityId = CRM_SMART_INVOICE.

• правая, в ней располагается таймлайн счета. В нем можно создавать, редактировать, фильтровать, удалять дела CRM — группа методов crm.activity.*, и записи таймлайна — группа методов crm.timeline.*.

Параметрами карточки счета можно управлять через группу методов crm.item.details.configuration.*.

ВиджетыВиджеты

В карточку счета можно встроить приложение. Благодаря встраиванию можно будет использовать приложение и не покидать карточку счета.

Есть два сценария встройки:

• Использовать специальные места встраивания. Например, через создание своей вкладки
• Создать пользовательское поле, в которое будет загружается интерфейс вашего приложения

Места встраивания новых счетовМеста встраивания новых счетов

• CRM_SMART_INVOICE_DETAIL_TAB — вкладка в детальной карточке элемента CRM

• CRM_SMART_INVOICE_DETAIL_ACTIVITY — кнопка над таймлайном карточки элемента

• CRM_SMART_INVOICE_DETAIL_TOOLBAR — пункт выпадающего меню верхней кнопки карточки

• CRM_SMART_INVOICE_DOCUMENTGENERATOR_BUTTON — пункт выпадающего меню генератора документов

• CRM_SMART_INVOICE_LIST_MENU — пункт контекстного меню в списке элементов

• CRM_SMART_INVOICE_LIST_TOOLBAR — пункт выпадающего меню над списком элементов

• CRM_SMART_INVOICE_ACTIVITY_TIMELINE_MENU — пункт контекстного меню дела в карточке элемента

• CRM_SMART_INVOICE_ROBOT_DESIGNER_TOOLBAR — пункт выпадающего меню верхней кнопки дизайнера роботов

Обзор методов и событийОбзор методов и событий

Scope: crm, salescenter

Кто может выполнять метод: в зависимости от метода

ОсновныеОсновные

Идентификатор объекта CRM entityTypeId — 31

Пользовательские поляПользовательские поля

Идентификатор объекта CRM entityId — CRM_SMART_INVOICE

Товарные позицииТоварные позиции

Идентификатор объекта CRM ownerType — SI

Метод	Описание
crm.item.productrow.add	Добавляет товарную позицию
crm.item.productrow.update	Обновляет товарную позицию
crm.item.productrow.get	Получает информацию о товарной позиции по id
crm.item.productrow.set	Привязывает товарную позицию к объекту CRM
crm.item.productrow.list	Получает список товарных позиций
crm.item.productrow.getAvailableForPayment	Получает список неоплаченных товаров
crm.item.productrow.delete	Удаляет товарную позицию
crm.item.productrow.fields	Получает список полей товарных позиций

ОплатыОплаты

Идентификатор объекта CRM entityTypeId — 31

Метод	Описание
crm.item.payment.add	Создает оплату для объекта CRM
crm.item.payment.update	Изменяет набор полей оплаты
crm.item.payment.get	Получает краткую информацию об оплате
crm.item.payment.list	Получает список оплат конкретного объекта CRM
crm.item.payment.delete	Удаляет оплату
crm.item.payment.pay	Изменяет статус оплаты на «Оплачено»
crm.item.payment.unpay	Изменяет статус оплаты на «Не оплачено»
salescenter.payment.getPublicUrl	Генерирует публичную ссылку на оплату

Товарные позиции в оплатеТоварные позиции в оплате

Метод	Описание
crm.item.payment.product.add	Добавляет товарную позицию в оплату
crm.item.payment.product.list	Получает список товарных позиций в оплате
crm.item.payment.product.delete	Удаляет товарную позицию из оплаты
crm.item.payment.product.setQuantity	Изменяет количество товара в товарной позиции оплаты

Доставка в оплатеДоставка в оплате

Метод	Описание
crm.item.payment.delivery.add	Добавляет позицию доставки в оплату
crm.item.payment.delivery.list	Получает список позиций доставки по конкретной оплате
crm.item.payment.delivery.delete	Удаляет позицию доставки из оплаты
crm.item.payment.delivery.setDelivery	Перепривязывает позицию доставки к другому документу доставки

Управление настройками карточкиУправление настройками карточки

Идентификатор объекта CRM entityTypeId — 31

Метод	Описание
crm.item.details.configuration.get	Получает параметры карточки элементов
crm.item.details.configuration.set	Устанавливает параметры карточки элементов
crm.item.details.configuration.reset	Сбрасывает параметры карточки элементов
crm.item.details.configuration.forceCommonScopeForAll	Устанавливает общую карточку для всех пользователей

Продолжите изучениеПродолжите изучение

• Универсальные методы CRM: обзор методов и событий
• Оплаты в универсальных объектах CRM: обзор методов
• Товарные позиции в объектах CRM: обзор методов