Счета: обзор методов
Счет — это финальный этап сделки. Он создается, когда все обсуждения завершены, а условия договора согласованы. Для одной сделки можно создать несколько счетов для разных товаров и услуг.
Счет можно сформировать по шаблону и отправить клиенту в виде документа. В карточке счета вы можете:
- Управлять процессом продажи товара или услуги
- Отслеживать этапы работы со счетом
- Принимать онлайн-платежи
Быстрый переход: все методы и события
Пользовательская документация: Новые счета в CRM
Связь счетов с другими объектами CRM
Сделка. Передавайте ID сделки в параметре parentId2, чтобы новый счет был связан со сделкой.
Предложение. Передавайте ID предложения в параметре parentId7, чтобы новый счет был связан с предложением.
Клиент. Поле в карточке счета, состоящее из связанных с ним компании и контактов. Все дела звонков, писем, чатов с контактом или компанией будут сохранены в карточке счета. Компания в поле одна, обращение к ней происходит через поле счета companyId. Контактов может быть указано несколько, взаимодействие с ними ведется через поле contactIds, передавайте в поле массив с ID контактов.
Товары. Добавление, изменение, удаление товарных позиций в счетах возможно через группу методов crm.item.productrow.*.
Оплаты. Добавление, изменение, удаление документов оплаты в счетах возможно через группу методов crm.item.payment.*.
Реквизиты вашей компании. Укажите ID вашей компании в поле mycompanyId, чтобы ее реквизиты автоматически использовались в документах. Получить ID вашей компании можно методом crm.item.list для объекта компаний с фильтром по полю isMyCompany.
BX24.callMethod(
'crm.item.list',
{
entityTypeId: 4,
filter: {
"isMyCompany": "Y",
},
},
(result) => {
if (result.error())
{
console.error(result.error());
return;
}
console.info(result.data());
},
);
Пользовательская документация
Карточка счета
Основное рабочее пространство в счетах — это вкладка Общее карточки. Она состоит из двух частей:
-
левая, в ней располагаются поля с информацией. Если системных полей недостаточно, вы можете создать собственные пользовательские поля. Они позволяют хранить информацию в различных форматах данных: строка, число, ссылка, адрес и другие. Для создания, изменения, получения или удаления пользовательских полей счетов используйте группу методов userfieldconfig.*
-
правая, в ней располагается таймлайн счета. В нем можно создавать, редактировать, фильтровать, удалять дела 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_TIMELINE_MENU— пункт контекстного меню дела в карточке элемента -
CRM_SMART_INVOICE_ROBOT_DESIGNER_TOOLBAR— пункт выпадающего меню верхней кнопки дизайнера роботов
Частые кейсы и сценарии
Обзор методов и событий
Scope:
crmКто может выполнять метод: в зависимости от метода
Основные
Идентификатор объекта CRM entityTypeId — 31
|
Создает новый элемент CRM |
|
|
Обновляет элемент |
|
|
Возвращает элемент по Id |
|
|
Возвращает список элементов по фильтру |
|
|
Удаляет элемент |
|
|
Возвращает поля элемента |
|
При создании объекта CRM пользовательского типа |
|
|
При удалении объекта CRM пользовательского типа |
|
|
При изменении объекта CRM пользовательского типа |
Пользовательские поля
Идентификатор объекта CRM entityId — CRM_SMART_INVOICE
|
Метод |
Описание |
|
Создает пользовательское поле |
|
|
Изменяет настройки поля |
|
|
Возвращает настройки пользовательского поля по идентификатору |
|
|
Возвращает набор доступных типов пользовательских полей для модуля |
|
|
Возвращает список настроек пользовательских полей |
|
|
Удаляет пользовательское поле |
Товарные позиции
Идентификатор объекта CRM ownerType — SI
|
Метод |
Описание |
|
Добавляет товарную позицию |
|
|
Обновляет товарную позицию |
|
|
Получает информацию о товарной позиции по id |
|
|
Привязывает товарную позицию к объекту CRM |
|
|
Получает список товарных позиций |
|
|
Получает список неоплаченных товаров |
|
|
Удаляет товарную позицию |
|
|
Получает список полей товарных позиций |
Оплаты
Идентификатор объекта CRM entityTypeId — 31
|
Метод |
Описание |
|
Создает оплату для объекта CRM |
|
|
Изменяет набор полей оплаты |
|
|
Получает краткую информацию об оплате |
|
|
Получает список оплат конкретного объекта CRM |
|
|
Удаляет оплату |
|
|
Изменяет статус оплаты на «Оплачено» |
|
|
Изменяет статус оплаты на «Не оплачено» |
Товарные позиции в оплате
|
Метод |
Описание |
|
Добавляет товарную позицию в оплату |
|
|
Получает список товарных позиций в оплате |
|
|
Удаляет товарную позицию из оплаты |
|
|
Изменяет количество товара в товарной позиции оплаты |
Доставка в оплате
|
Метод |
Описание |
|
Добавляет позицию доставки в оплату |
|
|
Получает список позиций доставки по конкретной оплате |
|
|
Удаляет позицию доставки из оплаты |
|
|
Перепривязывает позицию доставки к другому документу доставки |
Управление настройками карточки
Идентификатор объекта CRM entityTypeId — 31
|
Устанавливает общую карточку для всех пользователей |
|
|
Получает параметры карточки элементов |
|
|
Сбрасывает параметры карточки элементов |
|
|
Устанавливает параметры карточки элементов |