Поделиться через


GetAccept

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

Этот соединитель доступен в следующих продуктах и регионах:

Услуга Class Регионы
Copilot Studio Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Логические приложения Стандарт Все регионы Logic Apps , кроме следующих:
     — Регионы Azure для государственных организаций
     — Регионы Azure Для Китая
     - Министерство обороны США (DoD)
Power Apps Премия Все регионы Power Apps , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Power Automate Премия Все регионы Power Automate , кроме следующих:
     - Правительство США (GCC)
     - Правительство США (GCC High)
     — Облако Китая, управляемое 21Vianet
     - Министерство обороны США (DoD)
Контакт
Имя Команда API GetAccept
URL https://app.getaccept.com/api
Адрес электронной почты integrations@getaccept.com
Метаданные соединителя
Publisher GetAccept, Inc.
Веб-сайт https://www.getaccept.com
Политика конфиденциальности https://www.getaccept.com/privacy-policy
Категории Продажи и CRM; Продуктивность

GetAccept предоставляет платформу поддержки продаж для продаж для разработки, отправки, продвижения, отслеживания и электронных подписей документов, использования обеспечения продаж, управления контрактами, предложений и электронных подписей в одном месте. Этот соединитель помогает автоматизировать рабочие процессы для хранения документов, извлечения, назначения задач и настраиваемых уведомлений.

Предпосылки

Для использования этого подключения требуется учетная запись GetAccept. Перейдите к getaccept.com , чтобы зарегистрировать бесплатную учетную запись.

Как получить учетные данные?

Требуется только допустимая учетная запись GetAccept, так как OAuth2 используется для проверки подлинности текущего пользователя, вошедшего в систему в GetAccept.

Известные проблемы и ограничения

Обратитесь в нашу [mailto:support@getaccept.com](техническую поддержку) для любых проблем, связанных с интеграцией.

Ограничения регулирования

Имя Вызовы Период обновления
Вызовы API для каждого подключения 100 60 секунд

Действия

Вывод списка видео

Получение списка доступных видео на сущности. Вы можете добавить новые видео в мобильное приложение или в GetAccept.

Обновление срока действия документа

Используйте этот метод для обновления даты и времени окончания срока действия документа.

Отправка видео

Вы можете отправить файлы вложений для включения в отправленные документы. Успешный запрос вернет attachment_id. Используйте attachment_id, чтобы назначить вложение документу.

Отправка вложения

Вы можете отправить файлы вложений для включения в отправленные документы. Успешный запрос вернет attachment_id. Используйте attachment_id, чтобы назначить вложение документу.

Отправка существующего документа

При отправке документа с помощью GetAccept мы предоставляем электронную почту всем получателям, каждая из которых содержит уникальную безопасную ссылку. Этот вызов API активирует действие отправки документа и может выполняться только для документов с document_status = черновик. Документ будет отправлен получателям, предоставленным при его создании.

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

Отправка файла документа

Вы можете отправить один файл одновременно и получить идентификатор файла. Идентификатор файла используется для подключения файла с документом GetAccept, который отправляется получателям. Если вы хотите отправить мутисл-файлы, которые вы запускаете несколько POST. Мы принимаем только файлы размером до 10 МБ по умолчанию. Отправленный файл необходимо импортировать или добавить в документ в течение 48 часов после отправки.

Мы рекомендуем отправлять PDF-файлы, чтобы гарантировать тот же внешний вид при отправке. Другие типы файлов можно преобразовать, например:

Mirosoft Office: doc, docx, xls, xls, xlsx, ppt, pptx Mac: числа, ключевые изображения: jpg, jpeg, png Other: html, tex, csv

Перечисление пользователей

Получение списка активных пользователей для текущей сущности, прошедшей проверку подлинности

Получение вложений документов

Получение вложений документов путем указания идентификатора документа.

Получение полей документа

Получение списка полей для документа или шаблона. Можно использовать как до, так и после подписания документа.

Получение полей шаблона

Получение списка полей для определенного шаблона.

Получение получателей документов

Получение списка получателей для определенного документа.

Получение ролей шаблона

Получение списка ролей для определенного шаблона.

Получение сведений о документе

Получение сведений о документе путем указания идентификатора документа.

Получение сведений о пользователе

Этот вызов возвращает сведения об одном пользователе. Получение сведений и доступных сущностей текущего пользователя, прошедшего проверку подлинности, с помощью идентификатора пользователя

Получение таблиц ценообразования шаблонов

Получение списка элементов таблицы ценообразования для определенного шаблона.

Скачивание документа

Файл документа всегда можно скачать, но, скорее всего, вы хотите скачать его, когда у него есть состояние "Подписанный".

Вы можете выбрать, чтобы получить URL-адрес скачивания или получить двоичный файл.

URL-адрес скачивания доступен через 10 минут после выполнения запроса.

Создание и отправка документа или шаблона

Необходимо создать документ, чтобы его можно было отправить получателю. При создании документа можно ссылаться на ранее отправленные файлы с file_id или создать документ и отправить файлы в публикацию API. При добавлении файла в документ POST можно передать только один файл.

Используйте параметр file_ids для использования существующих загруженных файлов, file_content для отправки документа в кодировке Base64 или многопартийной записи с параметром файла.

У всех получателей должна быть допустимая электронная почта или номер мобильного телефона.

Все события записываются с помощью IP-адреса запрашивателя. Это можно переопределить с помощью заголовка CLIENT_IP, содержащего общедоступный IP-адрес конечных пользователей.

Создание контакта

При этом будет создан новый контакт в базе данных для текущей сущности.

Создание пользователя

При этом будет создан новый контакт в базе данных для текущей сущности.

Список вложений

Получение списка доступных вложений. Вы можете добавить новые вложения в GetAccept с помощью нового документа.

Список документов

Получение списка доступных документов

Список контактов

Получение списка доступных контактов для текущей сущности. Все контакты, добавленные как получатель, сохраняются в качестве контакта и доступны для последующего использования в этой сущности.

Шаблоны списка

Получение списка доступных шаблонов документов. Вы можете добавить новые шаблоны в разделе "Шаблоны" в GetAccept.

Вывод списка видео

Получение списка доступных видео на сущности. Вы можете добавить новые видео в мобильное приложение или в GetAccept.

Возвращаемое значение

Имя Путь Тип Описание
videos
videos array of object
Редактируемые
videos.editable boolean
опубликованный
videos.published boolean
Сохранено
videos.saved boolean
thumb_url
videos.thumb_url string
video_id
videos.video_id string
video_title
videos.video_title string
video_type
videos.video_type string
video_url
videos.video_url string

Обновление срока действия документа

Используйте этот метод для обновления даты и времени окончания срока действия документа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
documentId True string

Идентификатор документа

Срок действия
expiration_date date-time

Дата и время истечения срока действия документа (UTC)

Отправка уведомления
send_notification boolean

Если уведомление об обновлении отправляется получателям

Возвращаемое значение

Имя Путь Тип Описание
Состояние
status integer

Состояние обновления

Отправка видео

Вы можете отправить файлы вложений для включения в отправленные документы. Успешный запрос вернет attachment_id. Используйте attachment_id, чтобы назначить вложение документу.

Параметры

Имя Ключ Обязательно Тип Описание
Содержимое файла
file_content string

Отправьте файл в кодировке Base64. Обратите внимание, что файлы кодировки Base64 увеличивают размер файла примерно на 30%

Имя файла
file_name string

Имя файла документа с расширением. Это будет полезно для преобразования различных типов файлов.

URL-адрес файла
file_url string

URL-адрес файла документа. Файл должен быть доступен для скачивания без авторизации

Возвращаемое значение

Имя Путь Тип Описание
Состояние файла
file_status string

Состояние видео

Имя файла
filename string

Имя файла видео

Идентификатор задания
job_id string

Идентификатор задания обработки, преобразующего и сжимающего видео. Опрос обновлений состояния задания с помощью /video/job/<ID>.

Идентификатор видео
video_id string

Идентификатор отправленного видео, который будет использоваться в video_id при создании документа

Отправка вложения

Вы можете отправить файлы вложений для включения в отправленные документы. Успешный запрос вернет attachment_id. Используйте attachment_id, чтобы назначить вложение документу.

Параметры

Имя Ключ Обязательно Тип Описание
Содержимое файла
file_content string

Отправьте файл в кодировке Base64. Обратите внимание, что файлы кодировки Base64 увеличивают размер файла примерно на 30%

Имя файла
file_name string

Имя файла документа с расширением. Это будет полезно для преобразования различных типов файлов.

URL-адрес файла
file_url string

URL-адрес файла документа. Файл должен быть доступен для скачивания без авторизации

Возвращаемое значение

Имя Путь Тип Описание
Имя файла
filename string

Имя файла вложения

Идентификатор вложения
id string

Идентификатор отправленного вложения, используемого в attachment_id при создании документа

Заголовок вложения
title string

Заголовок вложения

Тип вложения
type string

Тип вложения

Отправка существующего документа

При отправке документа с помощью GetAccept мы предоставляем электронную почту всем получателям, каждая из которых содержит уникальную безопасную ссылку. Этот вызов API активирует действие отправки документа и может выполняться только для документов с document_status = черновик. Документ будет отправлен получателям, предоставленным при его создании.

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

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
documentId True string

Идентификатор документа

sender_email
sender_email email

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

sender_id
sender_id string

Используйте это, чтобы указать пользователя или владельца отправителя по идентификатору, который будет использоваться для самозаверяния документа.

Возвращаемое значение

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

Документ
Document

Отправка файла документа

Вы можете отправить один файл одновременно и получить идентификатор файла. Идентификатор файла используется для подключения файла с документом GetAccept, который отправляется получателям. Если вы хотите отправить мутисл-файлы, которые вы запускаете несколько POST. Мы принимаем только файлы размером до 10 МБ по умолчанию. Отправленный файл необходимо импортировать или добавить в документ в течение 48 часов после отправки.

Мы рекомендуем отправлять PDF-файлы, чтобы гарантировать тот же внешний вид при отправке. Другие типы файлов можно преобразовать, например:

Mirosoft Office: doc, docx, xls, xls, xlsx, ppt, pptx Mac: числа, ключевые изображения: jpg, jpeg, png Other: html, tex, csv

Параметры

Имя Ключ Обязательно Тип Описание
Содержимое файла
file_content string

Отправьте файл в кодировке Base64. Обратите внимание, что файлы кодировки Base64 увеличивают размер файла примерно на 30%

Имя файла
file_name string

Имя файла документа с расширением. Это будет полезно для преобразования различных типов файлов.

URL-адрес файла
file_url string

URL-адрес файла документа. Файл должен быть доступен для скачивания без авторизации

Возвращаемое значение

Имя Путь Тип Описание
идентификатор_файла
file_id string

Идентификатор отправленного файла, который будет использоваться в file_ids при создании документа

file_status
file_status string

Состояние отправленного файла

Перечисление пользователей

Получение списка активных пользователей для текущей сущности, прошедшей проверку подлинности

Возвращаемое значение

Список пользователей

Users
Users

Получение вложений документов

Получение вложений документов путем указания идентификатора документа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
documentId True string

Идентификатор документа

Возвращаемое значение

Список вложений

Attachments
Attachments

Получение полей документа

Получение списка полей для документа или шаблона. Можно использовать как до, так и после подписания документа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
documentId True string

Идентификатор документа

Возвращаемое значение

Список полей

Fields
Fields

Получение полей шаблона

Получение списка полей для определенного шаблона.

Параметры

Имя Ключ Обязательно Тип Описание
ИД шаблона
templateId True string

ИД шаблона

Возвращаемое значение

Список полей

Fields
Fields

Получение получателей документов

Получение списка получателей для определенного документа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
documentId True string

Идентификатор документа

Возвращаемое значение

Список получателей

Получатели
Recipients

Получение ролей шаблона

Получение списка ролей для определенного шаблона.

Параметры

Имя Ключ Обязательно Тип Описание
ИД шаблона
templateId True string

ИД шаблона

Возвращаемое значение

Имя Путь Тип Описание
roles
roles array of object
электронная почта
roles.email string
first_name
roles.first_name string
last_name
roles.last_name string
mobile
roles.mobile string
роль
roles.role string
role_id
roles.role_id string
role_name
roles.role_name string

Получение сведений о документе

Получение сведений о документе путем указания идентификатора документа.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
documentId True string

Идентификатор документа

Возвращаемое значение

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

Документ
Document

Получение сведений о пользователе

Этот вызов возвращает сведения об одном пользователе. Получение сведений и доступных сущностей текущего пользователя, прошедшего проверку подлинности, с помощью идентификатора пользователя

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор пользователя
userId True string

Идентификатор пользователя

Возвращаемое значение

Пользователь определяется адресом электронной почты и подключен к одной или нескольким сущностям.

Роли пользователя

Администратор:

  • Просмотр всех документов
  • Изменение всех документов
  • Изменение параметров сущности, сведений и выставления счетов
  • Добавление новых пользователей в сущность
  • Назначение ролей сущностей

Управляющий:

  • Просмотр документов группы
  • Изменение всех документов
  • Добавление новых пользователей в сущность

Объект

Сущность — это верхний узел, а все пользователи и соответствующие документы подключены к сущности. Сущность часто совпадает с организацией, страной или отделом в крупной организации.

User
User

Получение таблиц ценообразования шаблонов

Получение списка элементов таблицы ценообразования для определенного шаблона.

Параметры

Имя Ключ Обязательно Тип Описание
ИД шаблона
templateId True string

ИД шаблона

Возвращаемое значение

Таблицы цен

Pricing
PricingTables

Скачивание документа

Файл документа всегда можно скачать, но, скорее всего, вы хотите скачать его, когда у него есть состояние "Подписанный".

Вы можете выбрать, чтобы получить URL-адрес скачивания или получить двоичный файл.

URL-адрес скачивания доступен через 10 минут после выполнения запроса.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор документа
documentId True string

Идентификатор документа

Возврат двоичного файла напрямую
direct string

Возврат двоичного файла напрямую

Возвращаемое значение

Имя Путь Тип Описание
document_url
document_url string
file
file string

Создание и отправка документа или шаблона

Необходимо создать документ, чтобы его можно было отправить получателю. При создании документа можно ссылаться на ранее отправленные файлы с file_id или создать документ и отправить файлы в публикацию API. При добавлении файла в документ POST можно передать только один файл.

Используйте параметр file_ids для использования существующих загруженных файлов, file_content для отправки документа в кодировке Base64 или многопартийной записи с параметром файла.

У всех получателей должна быть допустимая электронная почта или номер мобильного телефона.

Все события записываются с помощью IP-адреса запрашивателя. Это можно переопределить с помощью заголовка CLIENT_IP, содержащего общедоступный IP-адрес конечных пользователей.

Параметры

Имя Ключ Обязательно Тип Описание
Идентификатор
id string

Идентификатор вложения, полученный из списка или после отправки

Требовать представление
require_view boolean

Требовать, чтобы получатель просматривал вложение

Тип
type string

файл или внешний, где файл является отправленным файлом, а внешний — ссылкой на внешний файл.

ИД поля
id string

Идентификатор настраиваемого поля шаблона

Имя поля
name string

Имя настраиваемого поля шаблона

Значение поля
value string

Значение настраиваемого поля шаблона

Валюта
currency string

Валюта, например. SEK

Региональные настройки
locale string

Языковой стандарт, например sv-SE

Отображаемое имя
display_name string

Отображаемое имя таблицы цен

Внешний идентификатор
external_id string

Внешний идентификатор для представления сводного объекта в сторонней системе

Код(ID) таблицы
id string

Код(ID) таблицы

Предварительно вычисляемые итоги
pre_calculated boolean

Если итоговая таблица цен должна быть предварительно рассчитана

Отображаемое имя
display_name string

Отображаемое имя таблицы цен

Идентификатор
id string

Идентификатор раздела

Rows
rows

Массив со значениями с массивом column_id, значением

Включен
enabled boolean

Если скидка на раздел должна быть включена

Плоская плата
flat_fee boolean

Если раздел должен использовать скидки на плоскую плату

Значение скидки
value string

Значение скидки на раздел

Включен
enabled boolean

Если цена раздела должна быть включена

Плоская плата
flat_fee boolean

Если раздел должен использовать неструктурированные цены

Значение цены
value string

Значение цены на раздел

Включен
enabled boolean

Если налог на раздел должен быть включен

Плоская плата
flat_fee boolean

Если раздел должен использовать налоги на плоскую плату

Налоговая стоимость
value string

Значение налога на раздел

Включен
enabled boolean

Если скидка на таблицу цен должна быть включена

Плоская плата
flat_fee boolean

Если таблица цен должна использовать скидки на плоскую плату

Значение скидки
value string

Значение сводной скидки

Включен
enabled boolean

Если цена на ценовую таблицу должна быть включена

Плоская плата
flat_fee boolean

Если таблица цен должна использовать неструктурированные цены

Значение цены
value string

Значение сводной цены

Включен
enabled boolean

Если необходимо включить налог на таблицу цен

Плоская плата
flat_fee boolean

Если таблица цен должна использовать налоги на плоскую плату

Ценность
value string

Значение сводного налога

Срок действия
expiration_date date-time

Дата и время истечения срока действия документа

Внешний идентификатор
external_id string

Идентификатор внешней системы для идентификации

Содержимое файла
file_content string

Содержимое файла в кодировке Base64

Идентификаторы файлов
file_ids string

Разделенные запятыми уникальные идентификаторы файлов, полученные при отправке файлов

Имя файла
file_name string

Имя файла документа с расширением. Это будет полезно для преобразования различных типов файлов.

URL-адрес файла
file_url string

URL-адрес файла документа. Документы должны быть общедоступными для скачивания

Автоматическая отправка
is_automatic_sending boolean

Если документ должен быть отправлен после создания

Отправка напоминаний
is_reminder_sending boolean

Следует отправлять автоматические напоминания

Планирование отправки
is_scheduled_sending boolean

Если отправка будет запланирована на отправку в будущем

Подписыв документ
is_signing boolean

Если документ будет отправлен для подписи

Рукописная подпись
is_signing_biometric boolean

Использование рукописной подписи

Разрешить передачу подписей
is_signing_forward boolean

Должны ли получатели иметь возможность передавать права подписи

Вход с помощью инициалов
is_signing_initials boolean

Подписыв документ с помощью инициалов получателей

Отправка SMS
is_sms_sending boolean

Если документ отправляется на мобильный адрес получателя по тексту

Имя документа
name True string

Введите имя документа

Название компании
company_name string

Имя компании получателя

Номер компании
company_number string

Номер компании получателя

Адрес электронной почты
email string

Адрес электронной почты получателя

Имя (первое имя)
first_name string

Имя получателя

Фамилия
last_name string

Фамилия получателя

мобильное устройство
mobile string

Мобильный телефон в международном формате

Замечание
note string

Дополнительная заметка для получателя

Порядок подписывания
order_num integer

Если заказ подписывания включен

Тип получателя
role string

Тип получателя в документе

Роль шаблона
role_name string

Имя роли в шаблоне

Проверка EID
verify_eid boolean

Проверка использования EID

Тип EID
verify_eid_type string

Тип EID, используемый для личной проверки

Включение вопроса
verify_qna boolean

Следует ли задавать вопрос

Ответ на проверку
verify_qna_answer string

Ответ на вопрос

Вопрос о открытии
verify_qna_open boolean

Следует задать вопрос перед открытием документа

Вопрос проверки
verify_qna_question string

Вопрос для запроса проверки

Вопрос о подписи
verify_qna_sign boolean

Следует задать вопрос перед подписанием

Проверка SMS
verify_sms boolean

Проверка получателя по SMS

Проверка sms при открытии
verify_sms_open boolean

Проверка sms при открытии

Проверка по SMS
verify_sms_sign boolean

Если перед подписью перед подписью получатель проверяется SMS

Дата отправки расписания
scheduled_sending_time date-time

Дата и время отправки документа

Переопределение электронной почты отправителя
sender_email string

Отправка из другого сообщения электронной почты, кроме прошедшего проверку подлинности пользователя

Переопределение пользователя отправителя
sender_id string

Отправка от другого пользователя, отличного от проверки подлинности

ИД шаблона
template_id string

Выбор шаблона для отправки

Тип документа
type string

Установка типа или категории документа

Значение документа
value integer

Значение сделки или документа

Идентификатор видео
video_id string

Выберите видео, используемое для отправки

Возвращаемое значение

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

Документ
Document

Создание контакта

При этом будет создан новый контакт в базе данных для текущей сущности.

Параметры

Имя Ключ Обязательно Тип Описание
Название компании
company_name string

Связанное имя компании

Номер компании
company_number string

Связанный номер компании

Адрес электронной почты
email string

Адрес электронной почты контакта

Имя (первое имя)
first_name string

Имя контакта

ФИО
fullname string

Используется для указания полного имени вместо имени и фамилии

Фамилия
last_name string

Фамилия контакта

мобильное устройство
mobile string

Номер мобильного телефона в международном формате

Замечание
note string

Необязательное внутреннее примечание для контакта

Телефон
phone string

Номер телефона в международном формате

Название
title string

Название контакта, например. Генеральный директор, менеджер по продажам

Возвращаемое значение

Имя Путь Тип Описание
Код контактного лица
contact_id string

Идентификатор созданного контакта

Создание пользователя

При этом будет создан новый контакт в базе данных для текущей сущности.

Параметры

Имя Ключ Обязательно Тип Описание
company_name
company_name string

Связанное имя компании

company_number
company_number string

Связанный номер компании

электронная почта
email string

Адрес электронной почты контакта

first_name
first_name string

Имя контакта

полное имя
fullname string

Используется для указания полного имени вместо имени и фамилии

last_name
last_name string

Фамилия контакта

mobile
mobile string

Номер мобильного телефона в международном формате

заметка
note string

Необязательное внутреннее примечание для контакта

phone
phone string

Номер телефона в международном формате

title
title string

Название контакта, например. Генеральный директор, менеджер по продажам

Возвращаемое значение

Пользователь определяется адресом электронной почты и подключен к одной или нескольким сущностям.

Роли пользователя

Администратор:

  • Просмотр всех документов
  • Изменение всех документов
  • Изменение параметров сущности, сведений и выставления счетов
  • Добавление новых пользователей в сущность
  • Назначение ролей сущностей

Управляющий:

  • Просмотр документов группы
  • Изменение всех документов
  • Добавление новых пользователей в сущность

Объект

Сущность — это верхний узел, а все пользователи и соответствующие документы подключены к сущности. Сущность часто совпадает с организацией, страной или отделом в крупной организации.

User
User

Список вложений

Получение списка доступных вложений. Вы можете добавить новые вложения в GetAccept с помощью нового документа.

Возвращаемое значение

Список вложений

Attachments
Attachments

Список документов

Получение списка доступных документов

Параметры

Имя Ключ Обязательно Тип Описание
Список фильтров по состоянию
filter string

Список фильтров по состоянию

Сортировка результатов
sort_by string

Сортировка результатов

Порядок сортировки результатов
sort_order string

Порядок сортировки результатов

Включение документов из участников группы
showteam boolean

Включение документов из участников группы

Включение всех документов из сущности
showall boolean

Включение всех документов из сущности

Внешний идентификатор
external_id string

Внешний идентификатор — это настраиваемое поле, которое может содержать уникальный идентификатор записи из системы за пределами GetAccept.

Смещение
offset number

Начальный список из записи x до ограничения

Лимит
limit number

Количество записей для списка

Возвращаемое значение

Список документов

Товары
Documents

Список контактов

Получение списка доступных контактов для текущей сущности. Все контакты, добавленные как получатель, сохраняются в качестве контакта и доступны для последующего использования в этой сущности.

Возвращаемое значение

Список контактов

Контакты
Contacts

Шаблоны списка

Получение списка доступных шаблонов документов. Вы можете добавить новые шаблоны в разделе "Шаблоны" в GetAccept.

Параметры

Имя Ключ Обязательно Тип Описание
Показать все
showall string

Показать все шаблоны для сущности

Идентификатор папки
folder_id string

Отображение шаблонов в определенной папке

Возвращаемое значение

Имя Путь Тип Описание
templates
templates array of object
tags
templates.tags string
создано_в
templates.created_at string
external_editor_type
templates.external_editor_type string
field_count
templates.field_count integer
id
templates.id string
is_editable
templates.is_editable boolean
is_private
templates.is_private boolean
имя
templates.name string
page_count
templates.page_count integer
role_count
templates.role_count integer
sender_name
templates.sender_name string
sender_thumb_url
templates.sender_thumb_url string
thumb_url
templates.thumb_url string
type
templates.type string
user_id
templates.user_id string
video_id
templates.video_id string
video_thumb_url
templates.video_thumb_url string

Триггеры

Когда документ был проверен

Триггеры при проверке документа любым из получателей

Отклонение документа

Триггеры при отклонении документа любым из получателей

Подписка на события документа

Этот вызов создаст новую подписку. Ответ будет упакован в массив даже для одного объекта в соответствии со стандартами перехватчика REST.

Events

  • document.created — Документ создается
  • document.sent — Документ отправляется
  • document.viewed — Документ отправляется
  • document.signed — Документ подписан
  • document.approved — Документ утвержден
  • document.expired — срок действия документа истек
  • document.rejected — Документ отклонен
  • document.downloaded — Документ скачан
  • document.printed — Документ печатается
  • document.forwarded — Документ пересылается
  • document.partially_signed — Документ был частично подписан
  • document.commented — Документ закомментирован
  • document.hardbounced — Документ жестко защищен
  • document.imported — Документ импортируется
После подписания документа

Активирует, когда документ подписан всеми сторонами подписывания

Когда документ был проверен

Триггеры при проверке документа любым из получателей

Параметры

Имя Ключ Обязательно Тип Описание
Все пользователи сущностей
global boolean

Если веб-перехватчик должен перехватывать события для всех пользователей сущностей.

Сообщение об ошибке
notification_email string

Если событие завершается ошибкой, отправьте уведомление в это сообщение, а не отправитель

Полезная нагрузка
payload string

Дополнительные полезные данные для публикации

Возвращаемое значение

Полезная нагрузка веб-перехватчика

Webhook
Webhook

Отклонение документа

Триггеры при отклонении документа любым из получателей

Параметры

Имя Ключ Обязательно Тип Описание
Все пользователи сущностей
global boolean

Если веб-перехватчик должен перехватывать события для всех пользователей сущностей.

Сообщение об ошибке
notification_email string

Если событие завершается ошибкой, отправьте уведомление в это сообщение, а не отправитель

Полезная нагрузка
payload string

Дополнительные полезные данные для публикации

Возвращаемое значение

Полезная нагрузка веб-перехватчика

Webhook
Webhook

Подписка на события документа

Этот вызов создаст новую подписку. Ответ будет упакован в массив даже для одного объекта в соответствии со стандартами перехватчика REST.

Events

  • document.created — Документ создается
  • document.sent — Документ отправляется
  • document.viewed — Документ отправляется
  • document.signed — Документ подписан
  • document.approved — Документ утвержден
  • document.expired — срок действия документа истек
  • document.rejected — Документ отклонен
  • document.downloaded — Документ скачан
  • document.printed — Документ печатается
  • document.forwarded — Документ пересылается
  • document.partially_signed — Документ был частично подписан
  • document.commented — Документ закомментирован
  • document.hardbounced — Документ жестко защищен
  • document.imported — Документ импортируется

Параметры

Имя Ключ Обязательно Тип Описание
Выбор события
event True string

Триггер события

Все пользователи сущностей
global boolean

Если веб-перехватчик должен перехватывать события для всех пользователей сущностей.

Сообщение об ошибке
notification_email string

Если событие завершается ошибкой, отправьте уведомление в это сообщение, а не отправитель

Полезная нагрузка
payload string

Дополнительные полезные данные для публикации

Возвращаемое значение

Полезная нагрузка веб-перехватчика

Webhook
Webhook

После подписания документа

Активирует, когда документ подписан всеми сторонами подписывания

Параметры

Имя Ключ Обязательно Тип Описание
Все пользователи сущностей
global boolean

Если веб-перехватчик должен перехватывать события для всех пользователей сущностей.

Сообщение об ошибке
notification_email string

Если событие завершается ошибкой, отправьте уведомление в это сообщение, а не отправитель

Полезная нагрузка
payload string

Дополнительные полезные данные для публикации

Возвращаемое значение

Полезная нагрузка веб-перехватчика

Webhook
Webhook

Определения

Attachment

Вложение документа

Имя Путь Тип Описание
Доступ к получателям
access_recipient_names array of string

Получатели с доступом к вложению

Description
attachment_description string

Описание вложения

URL-адрес скачивания
attachment_download_url string

URL-адрес для скачивания вложения

Расширение файла
attachment_extension string

Расширение файла вложения

Filename
attachment_filename string

Имя файла вложения

Идентификатор
attachment_id string

Идентификатор вложения

URL-адрес предварительной версии
attachment_preview_url string

Внутренний URL-адрес для предварительного просмотра вложения

Название
attachment_title string

Заголовок вложения

Тип
attachment_type string

Тип вложения

URL
attachment_url string

URL-адрес вложения

Последнее представление
last_attachment_view string

Дата и время последнего просмотра вложения

Ограниченный доступ
restrict_access boolean

Вложение имеет ограниченный доступ

Attachments

Список вложений

Имя Путь Тип Описание
attachments
attachments array of Attachment

Контакт

Каждый уникальный адрес электронной почты (или номер мобильного телефона) определяется как контакт.

Имя Путь Тип Описание
Идентификатор компании
company_id string

Идентификатор компании

Логотип компании
company_logo_url string

Логотип компании

Название компании
company_name string

Имя компании контакта

Номер компании
company_number string

Номер компании контакта

Код контактного лица
contact_id string

Код контактного лица

Создано
created_at string

Дата создания контакта

Documents
document_count number

Количество документов для контакта

Контактный адрес электронной почты
email string

Имя созданного документа

Имя (первое имя)
first_name string

Имя контакта

ФИО
fullname string

Полное имя контакта

Gender
gender string

Пол получателя

Фамилия
last_name string

Фамилия контакта

мобильное устройство
mobile string

Номер мобильного телефона контакта

Замечание
note string

Примечание к контакту

URL-адрес отпечатка
thumb_url string

URL-адрес контакта

Название
title string

Заголовок контакта

Контакты

Список контактов

Имя Путь Тип Описание
contacts
contacts array of Contact

Документ

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

Имя Путь Тип Описание
Метки
tags string

Теги документов

Автоматический текст чата
auto_comment_text string

Автоматический текст чата

Название компании
company_name string

Название компании

Время создания
created_at string

При создании документа

URL-адрес скачивания
download_url string

URL-адрес для скачивания подписанного документа

Сообщение электронной почты
email_send_message string

Отправка сообщения электронной почты

Тема электронной почты
email_send_subject string

Текст темы электронной почты

Срок действия
expiration_date string

Дата окончания срока действия документа

Идентификатор внешнего клиента
external_client_id string
Идентификатор внешнего редактора
external_editor_id string

Идентификатор во внешнем редакторе

Внешний тип редактора
external_editor_type string
Внешний идентификатор
external_id string
Число полей
field_count integer

Количество полей в документе

Идентификатор
id string
Автокомментировать
is_auto_comment boolean

Если включен автоматический комментарий чата

Сообщение электронной почты автокомментирования
is_auto_comment_email boolean

Если включена автоматическая почта чата

Определение получателя
is_identify_recipient boolean

Если документ включен для идентификации получателя

Является частным
is_private boolean

Если документ является закрытым

Отправка напоминаний
is_reminder_sending boolean

Если включены автоматические напоминания

Запланированная отправка
is_scheduled_sending boolean

Если документ запланирован на отправку

Самозаверяющий подписывание
is_selfsign boolean

Если документ был самозаверяется отправителем

Подписывается
is_signed boolean

Если документ подписан

Документ, доступный для подписывания
is_signing boolean

Если документ является подписываемым

Рукописная подпись
is_signing_biometric boolean

Если рукописная подпись включена

Разрешить передачу подписей
is_signing_forward boolean

Если включена передача прав подписи

Порядок подписи
is_signing_order boolean

Если заказ на подписывание получателя включен

Имеет видео
is_video boolean

Если в документе есть видео введение

Имя
name string

Имя документа

Родительский идентификатор
parent_id string

Идентификатор предыдущей версии документа

URL-адрес предварительной версии
preview_url string

Ссылка на внутреннюю предварительную версию документа

recipients
recipients array of Recipient
Запланированное время отправки
scheduled_sending_time string

Когда документ был запланирован на отправку

Дата отправки
send_date string

Дата отправки документа

Электронная почта отправителя
sender_email string

Адрес электронной почты пользователя отправителя

Имя отправителя
sender_name string

Имя пользователя отправителя

URL-адрес отправителя
sender_thumb_url string

Изображение пользователя отправителя

Дата подписи
sign_date string

Дата подписи документа

Состояние
status string

Текущее состояние документа

URL-адрес отпечатка
thumb_url string

Изображение документа

Тип
type string

Тип документа

Уникальный идентификатор
unique_id integer

Уникальный идентификатор документа

Идентификатор пользователя
user_id string

Идентификатор пользователя отправителя

Ценность
value integer

Значение документа

Documents

Список документов

Имя Путь Тип Описание
tags
tags string
company_name
company_name string
создано_в
created_at string
expiration_date
expiration_date string
id
id string
is_private
is_private boolean
is_signing
is_signing boolean
имя
name string
sender_name
sender_name string
sender_thumb
sender_thumb string
статус
status string
type
type string
value
value integer

EditorField

Сведения о поле редактора

Имя Путь Тип Описание
Идентификатор
id string

Идентификатор

Этикетка
input_settings.label string

Этикетка

Options
input_settings.options array of string

Options

Обязательно
input_settings.required boolean

Обязательно

Тип
input_settings.type string

Тип

Идентификатор получателя
recipient_id string

Идентификатор получателя

Тип
type string

Тип

Идентификатор пользователя
user_id string

Идентификатор пользователя

Поле

Сведения о поле

Имя Путь Тип Описание
Название компании
company_name string

Название компании

Номер компании
company_number string

Номер компании

ИД поля
field_id string

ИД поля

Этикетка
field_label string

Этикетка

Options
field_options array of object

Options

Ценность
field_options.value string
Тип
field_type string

Тип

Ценность
field_value string

Ценность

is_collectable
is_collectable boolean

Сбор поля

is_editable
is_editable boolean

Редактируемое поле

is_required
is_required boolean

Обязательное поле

Идентификатор страницы
page_id string

Идентификатор страницы

Идентификатор получателя
recipient_id string

Идентификатор получателя

Имя получателя
recipient_name string

Имя получателя

Имя роли
role_name string

Имя роли

Fields

Список полей

Имя Путь Тип Описание
editor_fields
editor_fields array of EditorField
столбцов
fields array of Field

PricingColumn

Столбец таблицы цен

Имя Путь Тип Описание
Идентификатор
column_id string

Идентификатор

Отображаемое имя
display_name string

Отображаемое имя

Включен
enabled boolean

Включен

Имя
name string

Имя

Ценоваяsection

Раздел "Таблица цен"

Имя Путь Тип Описание
columns
columns array of PricingColumn
Отображаемое имя
display_name string

Отображаемое имя

Имя
name string

Имя

Идентификатор
section_id string

Идентификатор

Ценоваяtable

Таблица цен

Имя Путь Тип Описание
Валюта
currency_settings.currency string

Валюта

Региональные настройки
currency_settings.locale string

Региональные настройки

Предварительно вычисляемые итоги
pre_calculated boolean

Предварительно вычисляемые итоги

сортовое железо
sections array of PricingSection
Идентификатор
table_id string

Код(ID) таблицы

Ценоваяtables

Таблицы цен

Имя Путь Тип Описание
pricing_tables
pricing_tables array of PricingTable

Recipient

Каждый уникальный электронный адрес (или мобильный номер), подключенный к документу, является получателем.

Имя Путь Тип Описание
Название компании
company_name string

Имя компании получателя

Номер компании
company_number string

Номер компании получателя

URL-адрес документа
document_url string

Уникальный URL-адрес получателя для просмотра и подписания

Электронная почта получателя
email string

Электронная почта получателя

Имя (первое имя)
first_name string

Имя получателя

ФИО
fullname string

Полное имя получателя

Gender
gender string

Пол получателя

Идентификатор
id string

Идентификатор получателя

Фамилия
last_name string

Фамилия получателя

мобильное устройство
mobile string

Номер мобильного телефона получателя

Замечание
note string

Примечание получателя

Порядковый номер подписывания
order_num string

Порядок подписывания получателя

Состояние
status string

Состояние получателя

URL-адрес отпечатка
thumb_url string

URL-адрес получателя

Название
title string

Заголовок получателя

Получатели

Список получателей

Имя Путь Тип Описание
recipients
recipients array of Recipient

User

Пользователь определяется адресом электронной почты и подключен к одной или нескольким сущностям.

Роли пользователя

Администратор:

  • Просмотр всех документов
  • Изменение всех документов
  • Изменение параметров сущности, сведений и выставления счетов
  • Добавление новых пользователей в сущность
  • Назначение ролей сущностей

Управляющий:

  • Просмотр документов группы
  • Изменение всех документов
  • Добавление новых пользователей в сущность

Объект

Сущность — это верхний узел, а все пользователи и соответствующие документы подключены к сущности. Сущность часто совпадает с организацией, страной или отделом в крупной организации.

Имя Путь Тип Описание
Режим приложения
app_mode string
disallow_create
disallow_create boolean
Адрес электронной почты
email string

Адрес электронной почты пользователя

Идентификатор организации
entity_id string
Имя сущности
entity_name string
Имя (первое имя)
first_name string

Имя пользователя

Идентификатор
id string

Идентификатор пользователя

Language
language string
Фамилия
last_name string

Фамилия пользователя

mobile
mobile string

Номер мобильного телефона в международном формате

Замечание
note string

Необязательное внутреннее примечание для пользователя

Телефон
phone string

Номер телефона в международном формате

Role
role string
Пропуск отправки приглашения
skip_invitation boolean
Состояние
status string
Идентификатор команды
team_id string
URL-адрес отпечатка
thumb_url string
Timezone
timezone string
Название
title string

Название пользователя, например. Генеральный директор, менеджер по продажам

Users

Список пользователей

Имя Путь Тип Описание
users
users array of object
Адрес электронной почты
users.email string
Имя (Первое имя)
users.first_name string
Последнее имя входа
users.last_login string
Фамилия
users.last_name string
Имя пользователя
users.name string
Role
users.role string
Состояние
users.status string
Имя группы
users.team_name string
Идентификатор пользователя
users.user_id string

Webhook

Полезная нагрузка веб-перехватчика

Имя Путь Тип Описание
Настраиваемые поля
custom_fields object
Документ
document Document

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

Личный домен сущности
entity.custom_domain string

Настройка личного домена для сущности

Сообщение электронной почты по умолчанию
entity.email_send_message string

Сообщение электронной почты по умолчанию

Тема электронной почты по умолчанию
entity.email_send_subject string

Тема электронной почты по умолчанию

Поддомея сущности
entity.sub_domain string

Вложенный домен для сущности

Имя события
event string
Действие события
event_action string
Тип события
event_type string
Recipient
recipient Recipient

Каждый уникальный электронный адрес (или мобильный номер), подключенный к документу, является получателем.

ID подписки
subscription_id string