Генератор документов: обзор методов и событий

Генератор документов в CRM позволяет подготовить шаблон, настроить нумератор, создать документ по шаблону или загрузить готовый файл. Поддерживает сделки, лиды, контакты, компании, счета, коммерческие предложения и элементы смарт-процессов.

Раздел состоит из трех основных частей. В Нумераторах настраивают шаблон номера и счетчик. В Шаблонах документов загружают файл .docx, привязывают его к нумератору, региону и типам CRM-объектов. В Документах создают документ по шаблону или загружают готовый файл, получают ссылки на файл, включают публичную ссылку, изменяют или удаляют документ.

Например, можно создать нумератор для сделок, привязать его к шаблону сделки и затем создавать документы для конкретных сделок.

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

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

• Документы в CRM: как создать и отправить за пару минут
• Шаблоны документов в CRM: как быстро отправлять счета и акты
• Как создать и настроить нумератор документов в CRM

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

1. Создайте нумератор методом crm.documentgenerator.numerator.add — он задает шаблон номера для документов
2. Подготовьте файл шаблона .docx в формате Base64 — Как загружать файлы
3. Определите entityTypeId нужного CRM-объекта — типовые значения приведены в статье Особенности передаваемых значений
4. Загрузите шаблон методом crm.documentgenerator.template.add: передайте название, файл, numeratorId, entityTypeId и region
5. Получите entityId нужного CRM-объекта методом crm.item.list
6. Выберите способ работы с документом:
   • чтобы создать документ по шаблону, используйте crm.documentgenerator.document.add
   • чтобы загрузить готовый файл, используйте crm.documentgenerator.document.upload

Что важно учитыватьЧто важно учитывать

• При создании документа по шаблону привязка шаблона к воронке сделки автоматически не проверяется — документ создается, даже если шаблон настроен для другой воронки
• Ссылки pdfUrl и imageUrl могут отсутствовать сразу после создания или обновления документа, так как конвертация выполняется асинхронно. Если ссылки нужны сразу, повторите запрос методом crm.documentgenerator.document.get через 30-40 секунд.

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

Нумераторы. Нумератор задает шаблон номера и счетчик документов. Шаблон документа использует его через параметр numeratorId. Если создаете новый нумератор, возьмите id из ответа crm.documentgenerator.numerator.add. Если используете существующий, получите id методом crm.documentgenerator.numerator.list.

Шаблоны документов. Шаблон хранит файл .docx, регион, привязку к типам CRM-объектов и связь с нумератором. Для создания документа нужен templateId — возьмите id из ответа crm.documentgenerator.template.add или id нужного шаблона из ответа crm.documentgenerator.template.list.

Документы. Документ создают по шаблону методом crm.documentgenerator.document.add или загружают готовый файл методом crm.documentgenerator.document.upload — в обоих случаях документ прикрепляют к CRM-объекту.

CRM-объекты. Шаблоны и документы используют entityTypeId и entityId. Типовые значения entityTypeId для CRM-объектов приведены в статье Особенности передаваемых значений. Для смарт-процессов entityTypeId можно получить методом crm.type.list. Идентификатор нужного объекта entityId получают методом crm.item.list.

Регионы. Шаблон привязывают к стране через параметр region. Значение region передают в методе crm.documentgenerator.template.add, например ru. Список доступных регионов можно получить методом documentgenerator.region.list.

Файлы. В шаблонах используют файл .docx, а в методе crm.documentgenerator.document.upload передают содержимое готового DOCX-файла в Base64. Формат загрузки описан в статье Как загружать файлы.

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

Scope: crm

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

НумераторыНумераторы

Метод	Описание
crm.documentgenerator.numerator.add	Добавляет новый нумератор
crm.documentgenerator.numerator.update	Обновляет существующий нумератор
crm.documentgenerator.numerator.get	Возвращает информацию о нумераторе по идентификатору
crm.documentgenerator.numerator.list	Возвращает список нумераторов
crm.documentgenerator.numerator.delete	Удаляет нумератор

Шаблоны документовШаблоны документов

Метод	Описание
crm.documentgenerator.template.add	Добавляет новый шаблон
crm.documentgenerator.template.update	Обновляет существующий шаблон
crm.documentgenerator.template.get	Возвращает информацию о шаблоне по идентификатору
crm.documentgenerator.template.list	Возвращает список шаблонов
crm.documentgenerator.template.delete	Удаляет шаблон
crm.documentgenerator.template.getfields	Возвращает поля шаблона для указанного CRM-объекта

ДокументыДокументы