Compartilhar via


GetAccept

O GetAccept fornece uma plataforma de habilitação de vendas para vendas para projetar, enviar, promover, acompanhar e assinar documentos de vendas, aproveitando garantias de vendas, gerenciamento de contratos, propostas e assinaturas eletrônicas em um só lugar.

Esse conector está disponível nos seguintes produtos e regiões:

Service Class Regions
Copilot Studio Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Aplicativos Lógicos Standard Todas as regiões dos Aplicativos Lógicos , exceto as seguintes:
     – Regiões do Azure Governamental
     - Regiões do Azure China
     - Departamento de Defesa dos EUA (DoD)
Power Apps Premium Todas as regiões do Power Apps , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Power Automate Premium Todas as regiões do Power Automate , exceto as seguintes:
     – Governo dos EUA (GCC)
     – Governo dos EUA (GCC High)
     - China Cloud operado pela 21Vianet
     - Departamento de Defesa dos EUA (DoD)
Contato
Nome Equipe de API GetAccept
URL https://app.getaccept.com/api
Email integrations@getaccept.com
Metadados do conector
Publicador GetAccept, Inc.
Site https://www.getaccept.com
Política de privacidade https://www.getaccept.com/privacy-policy
Categorias Vendas e CRM; Produtividade

O GetAccept fornece uma plataforma de habilitação de vendas para vendas para projetar, enviar, promover, acompanhar e assinar documentos de vendas, aproveitando garantias de vendas, gerenciamento de contratos, propostas e assinaturas eletrônicas em um só lugar. Esse conector ajuda a automatizar seus fluxos de trabalho para armazenamento de documentos, recuperação, atribuição de tarefas e notificações personalizadas.

Pré-requisitos

Uma conta GetAccept é necessária para usar essa conexão. Vá para getaccept.com para registrar uma conta gratuita.

Como obter credenciais?

Somente uma conta getaccept válida é necessária, pois o OAuth2 é usado para autenticar o usuário conectado atual no GetAccept.

Problemas e limitações conhecidos

Entre em contato com nosso [mailto:support@getaccept.com](suporte técnico) para quaisquer problemas relacionados à integração.

Limitações

Nome Chamadas Período de renovação
Chamadas à API por conexão 100 60 segundos

Ações

Atualizar expiração do documento

Use esse método para atualizar a data e a hora de validade de um documento.

Baixar documento

O arquivo de documento sempre pode ser baixado, mas provavelmente você deseja baixá-lo quando ele tiver o status assinado.

Você pode selecionar para receber uma url de download ou obter o arquivo binário.

A URL de download pode ser acessada 10 minutos após a solicitação ter sido feita.

Carregar um anexo

Você pode carregar arquivos de anexo para incluir com documentos enviados. A solicitação bem-sucedida retornará o attachment_id. Use attachment_id para atribuir um anexo a um documento.

Carregar um arquivo de documento

Você pode carregar um arquivo por vez e obter uma ID de arquivo. A ID do arquivo é usada para conectar um arquivo com um documento GetAccept que é enviado aos destinatários. Se você quiser carregar arquivos mutliple, execute vários POST. Só aceitamos arquivos de até 10 MB como padrão. O arquivo carregado precisa ser importado/adicionado a um documento dentro de 48 horas após o carregamento.

Recomendamos que você carregue arquivos PDF para garantir a mesma aparência quando enviado. Outros tipos de arquivo podem ser convertidos, como:

Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Outros: html, tex, csv

Carregar um vídeo

Você pode carregar arquivos de anexo para incluir com documentos enviados. A solicitação bem-sucedida retornará o attachment_id. Use attachment_id para atribuir um anexo a um documento.

Criar contato

Isso criará um novo contato no banco de dados para a entidade atual

Criar e enviar documento ou modelo

Você deve criar um documento para poder enviá-lo a um destinatário. Ao criar um documento, você pode consultar arquivos carregados anteriormente com file_id ou pode optar por criar um documento e carregar os arquivos na postagem da API. Você só pode carregar um arquivo ao incluir um arquivo no post do documento de criação.

Use file_ids parâmetro para usar arquivos carregados existentes, file_content para enviar o documento como cadeia de caracteres codificada em base64 ou fazer uma postagem de várias partes com o parâmetro de arquivo.

Todos os destinatários devem ter um email válido ou um número de celular.

Todos os eventos são registrados usando o endereço IP do solicitante. Você pode substituir isso usando o cabeçalho CLIENT_IP que contém o endereço IP público dos usuários finais.

Criar usuário

Isso criará um novo contato no banco de dados para a entidade atual

Enviar documento existente

Quando você envia um documento por meio do GetAccept, entregamos um email para todos os destinatários, cada um contendo um link seguro e exclusivo. Essa chamada à API dispara a ação de envio de documento e só pode ser executada em documentos com document_status = rascunho. O documento será enviado aos destinatários fornecidos quando ele foi criado.

Se o documento tiver sido criado usando a opção de autoassinamento, ele também será autoassinado pelo usuário autenticado ou especificado antes de enviar.

Listar anexos

Receba uma lista de anexos disponíveis. Você pode adicionar novos anexos no GetAccept usando um novo documento.

Listar contatos

Receba uma lista de contatos disponíveis para a entidade atual. Todos os contatos adicionados como um destinatário são salvos como um contato e estão disponíveis para uso posterior nessa entidade.

Listar documentos

Obter uma lista de documentos disponíveis

Listar modelos

Receba uma lista de modelos de documento disponíveis. Você pode adicionar novos modelos na seção Modelos no GetAccept.

Listar usuários

Buscar uma lista de usuários ativos para a entidade autenticada atual

Listar vídeos

Receba uma lista de vídeos disponíveis na entidade. Você pode adicionar novos vídeos no aplicativo móvel ou no GetAccept.

Obter anexos de documento

Obtenha anexos de documento especificando uma ID de documento.

Obter campos de documento

Obtenha uma lista de campos para um documento ou modelo. Pode ser usado antes e depois de um documento ter sido assinado.

Obter campos de modelo

Receba uma lista de campos para um modelo específico.

Obter destinatários de documentos

Obtenha uma lista de destinatários para um documento específico.

Obter detalhes do documento

Obtenha detalhes do documento especificando uma ID do documento.

Obter detalhes do usuário

Essa chamada retornará detalhes de um único usuário. Receber detalhes e entidades disponíveis do usuário autenticado atual usando a ID do usuário

Obter funções de modelo

Receba uma lista de funções para um modelo específico.

Obter tabelas de preços de modelo

Receba uma lista de itens de tabela de preços para um modelo específico.

Atualizar expiração do documento

Use esse método para atualizar a data e a hora de validade de um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
documentId True string

ID do documento

Data de validade
expiration_date date-time

Data e hora em que o documento deve expirar (UTC)

Enviar notificação
send_notification boolean

Se uma notificação sobre a atualização for enviada aos destinatários

Retornos

Nome Caminho Tipo Description
Situação
status integer

Status da atualização

Baixar documento

O arquivo de documento sempre pode ser baixado, mas provavelmente você deseja baixá-lo quando ele tiver o status assinado.

Você pode selecionar para receber uma url de download ou obter o arquivo binário.

A URL de download pode ser acessada 10 minutos após a solicitação ter sido feita.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
documentId True string

ID do documento

Retornar o arquivo binário diretamente
direct string

Retornar o arquivo binário diretamente

Retornos

Nome Caminho Tipo Description
document_url
document_url string
arquivo
file string

Carregar um anexo

Você pode carregar arquivos de anexo para incluir com documentos enviados. A solicitação bem-sucedida retornará o attachment_id. Use attachment_id para atribuir um anexo a um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Conteúdo do ficheiro
file_content string

Envie o arquivo como codificado em base64. Observe que os arquivos de codificação base64 aumentarão o tamanho do arquivo com cerca de 30%

Nome do arquivo
file_name string

Nome do arquivo do documento, com a extensão. Isso será útil para converter diferentes tipos de arquivo.

URL do Arquivo
file_url string

Url para o arquivo de documento. O arquivo deve estar disponível para download sem autorização

Retornos

Nome Caminho Tipo Description
Nome do arquivo
filename string

Nome do arquivo do anexo

ID do anexo
id string

ID do anexo carregado a ser usado no attachment_id ao criar um documento

Título do anexo
title string

Título do anexo

Tipo de anexo
type string

Tipo do anexo

Carregar um arquivo de documento

Você pode carregar um arquivo por vez e obter uma ID de arquivo. A ID do arquivo é usada para conectar um arquivo com um documento GetAccept que é enviado aos destinatários. Se você quiser carregar arquivos mutliple, execute vários POST. Só aceitamos arquivos de até 10 MB como padrão. O arquivo carregado precisa ser importado/adicionado a um documento dentro de 48 horas após o carregamento.

Recomendamos que você carregue arquivos PDF para garantir a mesma aparência quando enviado. Outros tipos de arquivo podem ser convertidos, como:

Mirosoft Office: doc, docx, xl, xls, xlsx, ppt, pptx Mac: numbers, key Images: jpg, jpeg, png Outros: html, tex, csv

Parâmetros

Nome Chave Obrigatório Tipo Description
Conteúdo do ficheiro
file_content string

Envie o arquivo como codificado em base64. Observe que os arquivos de codificação base64 aumentarão o tamanho do arquivo com cerca de 30%

Nome do arquivo
file_name string

Nome do arquivo do documento, com a extensão. Isso será útil para converter diferentes tipos de arquivo.

URL do Arquivo
file_url string

Url para o arquivo de documento. O arquivo deve estar disponível para download sem autorização

Retornos

Nome Caminho Tipo Description
file_id
file_id string

ID do arquivo carregado a ser usado no file_ids ao criar um documento

file_status
file_status string

Status do arquivo carregado

Carregar um vídeo

Você pode carregar arquivos de anexo para incluir com documentos enviados. A solicitação bem-sucedida retornará o attachment_id. Use attachment_id para atribuir um anexo a um documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
Conteúdo do ficheiro
file_content string

Envie o arquivo como codificado em base64. Observe que os arquivos de codificação base64 aumentarão o tamanho do arquivo com cerca de 30%

Nome do arquivo
file_name string

Nome do arquivo do documento, com a extensão. Isso será útil para converter diferentes tipos de arquivo.

URL do Arquivo
file_url string

Url para o arquivo de documento. O arquivo deve estar disponível para download sem autorização

Retornos

Nome Caminho Tipo Description
Status do arquivo
file_status string

Status do vídeo

Nome do arquivo
filename string

Nome do arquivo do vídeo

ID do trabalho
job_id string

ID do trabalho de processamento convertendo e compactando o vídeo. Sondar atualizações de status do trabalho usando /video/job/<ID>.

ID do vídeo
video_id string

ID do vídeo carregado a ser usado no video_id ao criar um documento

Criar contato

Isso criará um novo contato no banco de dados para a entidade atual

Parâmetros

Nome Chave Obrigatório Tipo Description
Nome da Empresa
company_name string

Nome da empresa associada

Número da Empresa
company_number string

Número da empresa associada

Email
email string

Endereço de email do contato

Nome
first_name string

Nome do contato

Nome completo
fullname string

Use para especificar o nome completo em vez do nome/sobrenome

Sobrenome
last_name string

Sobrenome do contato

Telemóvel
mobile string

Número de celular em formato internacional

Observação
note string

Observação interna opcional para contato

Telefone
phone string

Número de telefone em formato internacional

Title
title string

O título do contato, ex. CEO, gerente de vendas

Retornos

Nome Caminho Tipo Description
ID de contato
contact_id string

ID do contato criado

Criar e enviar documento ou modelo

Você deve criar um documento para poder enviá-lo a um destinatário. Ao criar um documento, você pode consultar arquivos carregados anteriormente com file_id ou pode optar por criar um documento e carregar os arquivos na postagem da API. Você só pode carregar um arquivo ao incluir um arquivo no post do documento de criação.

Use file_ids parâmetro para usar arquivos carregados existentes, file_content para enviar o documento como cadeia de caracteres codificada em base64 ou fazer uma postagem de várias partes com o parâmetro de arquivo.

Todos os destinatários devem ter um email válido ou um número de celular.

Todos os eventos são registrados usando o endereço IP do solicitante. Você pode substituir isso usando o cabeçalho CLIENT_IP que contém o endereço IP público dos usuários finais.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID
id string

ID do anexo recebida da lista ou após o upload

Exigir exibição
require_view boolean

Exigir que o destinatário exiba o anexo

Tipo
type string

arquivo ou externo em que o arquivo é um arquivo carregado e externo é um link para um arquivo externo

ID do campo
id string

ID do campo de modelo personalizado

Nome do campo
name string

Nome do campo de modelo personalizado

Valor do campo
value string

Valor do campo de modelo personalizado

Moeda
currency string

Moeda, ex. SEK

Local
locale string

Localidade, ex. sv-SE

Nome de Exibição
display_name string

Nome de exibição da tabela de preços

ID externa
external_id string

ID externa para representar o objeto de resumo dentro de um sistema de terceiros

ID da tabela
id string

ID da tabela

Totais pré-calculados
pre_calculated boolean

Se os totais da tabela de preços devem ser pré-calculados

Nome de Exibição
display_name string

Nome de exibição da tabela de preços

ID
id string

ID da seção

Rows
rows

Matriz com objeto values com matriz de column_id, valor

Enabled
enabled boolean

Se o desconto da seção deve ser habilitado

Taxa fixa
flat_fee boolean

Se a seção deve usar o uso de descontos de taxa fixa

Valor do desconto
value string

O valor do desconto da seção

Enabled
enabled boolean

Se o preço da seção deve ser habilitado

Taxa fixa
flat_fee boolean

Se a seção deve usar o uso de preços de taxa fixa

Valor do preço
value string

O valor do preço da seção

Enabled
enabled boolean

Se o imposto de seção deve ser habilitado

Taxa fixa
flat_fee boolean

Se a seção deve usar o uso de impostos de taxa fixa

Valor do imposto
value string

O valor do imposto de seção

Enabled
enabled boolean

Se o desconto da tabela de preços deve ser habilitado

Taxa fixa
flat_fee boolean

Se a tabela de preços deve usar o uso de descontos de taxa fixa

Valor do desconto
value string

O valor do desconto resumido

Enabled
enabled boolean

Se o preço da tabela de preços deve ser habilitado

Taxa fixa
flat_fee boolean

Se a tabela de preços deve usar o uso de preços fixos

Valor do preço
value string

O valor do preço resumido

Enabled
enabled boolean

Se o imposto sobre tabela de preços deve ser habilitado

Taxa fixa
flat_fee boolean

Se a tabela de preços deve usar o uso de impostos de taxa fixa

Value
value string

O valor do imposto resumido

Data de validade
expiration_date date-time

Data e hora em que o documento deve expirar

ID externa
external_id string

ID do sistema externo para identificação

Conteúdo do ficheiro
file_content string

Conteúdo do arquivo codificado em Base64

IDs de arquivo
file_ids string

IDs de arquivo exclusivas e separadas por vírgulas recebidas ao carregar arquivos

Nome do arquivo
file_name string

Nome do arquivo do documento, com a extensão. Isso será útil para converter diferentes tipos de arquivo.

URL do Arquivo
file_url string

Url para o arquivo de documento. Os documentos devem estar disponíveis para download

Enviar automaticamente
is_automatic_sending boolean

Se o documento deve ser enviado após a criação

Enviar lembretes
is_reminder_sending boolean

Os lembretes automáticos devem ser enviados

Agendar envio
is_scheduled_sending boolean

Caso o envio seja agendado para envio no futuro

Assinar documento
is_signing boolean

Caso o documento seja enviado para assinatura

Assinatura manuscrita
is_signing_biometric boolean

Usar assinatura manuscrita

Permitir transferência de assinatura
is_signing_forward boolean

Se os destinatários puderem transferir direitos de assinatura

Assinar com iniciais
is_signing_initials boolean

Assinar documento usando as iniciais do destinatário

Enviar SMS
is_sms_sending boolean

Se o documento for enviado para o destinatário móvel por texto

Nome do documento
name True string

Insira um nome do documento

Nome da empresa
company_name string

Nome da empresa do destinatário

Número da empresa
company_number string

Número da empresa do destinatário

Email
email string

Endereço de email do destinatário

Nome
first_name string

Nome do destinatário

Sobrenome
last_name string

Sobrenome do destinatário

Telemóvel
mobile string

Telefone celular em formato internacional

Observação
note string

Observação adicional para um destinatário

Ordem de assinatura
order_num integer

Se a ordem de assinatura estiver habilitada

Tipo de destinatário
role string

O tipo de destinatário no documento

Função de modelo
role_name string

O nome da função em um modelo

Verificar o EID
verify_eid boolean

Verificar o uso de EID

Tipo de EID
verify_eid_type string

Tipo de EID a ser usado para verificação pessoal

Habilitar pergunta
verify_qna boolean

Se uma pergunta for feita

Resposta de verificação
verify_qna_answer string

A resposta à pergunta

Pergunta em aberto
verify_qna_open boolean

Deve ser feita uma pergunta antes de abrir o documento

Pergunta de verificação
verify_qna_question string

Pergunta a ser feita para verificação

Pergunta de sinal
verify_qna_sign boolean

Se uma pergunta for feita antes da assinatura

Verificar SMS
verify_sms boolean

Verificar destinatário por SMS

Verificar o SMS aberto
verify_sms_open boolean

Verificar o SMS aberto

Verificar por SMS
verify_sms_sign boolean

Se um SMS verificar o destinatário antes de assinar

Agendar data de envio
scheduled_sending_time date-time

Data e hora em que o documento deve ser enviado

Substituição de email do remetente
sender_email string

Enviar de outro email que não seja um usuário autenticado

Substituição do usuário do remetente
sender_id string

Enviar de outro usuário que não seja autenticado

ID do Modelo
template_id string

Selecione um modelo a ser usado para o envio

Tipo de documento
type string

Definir o tipo/categoria do documento

Valor do documento
value integer

Valor da oferta ou documento

ID do vídeo
video_id string

Selecione um vídeo a ser usado para o envio

Retornos

Um documento é um ou vários arquivos carregados que devem ser enviados para um ou muitos destinatários criados por um usuário.

Documento
Document

Criar usuário

Isso criará um novo contato no banco de dados para a entidade atual

Parâmetros

Nome Chave Obrigatório Tipo Description
company_name
company_name string

Nome da empresa associada

company_number
company_number string

Número da empresa associada

email
email string

Endereço de email do contato

first_name
first_name string

Nome do contato

fullname
fullname string

Use para especificar o nome completo em vez do nome/sobrenome

last_name
last_name string

Sobrenome do contato

móvel
mobile string

Número de celular em formato internacional

nota
note string

Observação interna opcional para contato

phone
phone string

Número de telefone em formato internacional

title
title string

O título do contato, ex. CEO, gerente de vendas

Retornos

Um usuário é definido por seu endereço de email e está conectado a uma ou muitas entidades.

Funções de usuário

Administrador:

  • Exibir todos os documentos
  • Editar todos os documentos
  • Alterar configurações de entidade, informações e cobrança
  • Adicionar novos usuários à entidade
  • Atribuir funções de entidade

Gerente:

  • Exibir documentos da equipe
  • Editar todos os documentos
  • Adicionar novos usuários à entidade

Entidade

Uma entidade é o nó superior e todos os usuários e documentos correspondentes estão conectados a uma entidade. Uma entidade geralmente é a mesma que uma empresa, um país ou um departamento em uma grande organização.

Utilizador
User

Enviar documento existente

Quando você envia um documento por meio do GetAccept, entregamos um email para todos os destinatários, cada um contendo um link seguro e exclusivo. Essa chamada à API dispara a ação de envio de documento e só pode ser executada em documentos com document_status = rascunho. O documento será enviado aos destinatários fornecidos quando ele foi criado.

Se o documento tiver sido criado usando a opção de autoassinamento, ele também será autoassinado pelo usuário autenticado ou especificado antes de enviar.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
documentId True string

ID do documento

sender_email
sender_email email

Use isso para especificar o usuário/proprietário do remetente por endereço de email a ser usado para auto-assinatura do documento.

sender_id
sender_id string

Use isso para especificar o usuário/proprietário do remetente por ID a ser usado para auto-assinatura do documento.

Retornos

Um documento é um ou vários arquivos carregados que devem ser enviados para um ou muitos destinatários criados por um usuário.

Documento
Document

Listar anexos

Receba uma lista de anexos disponíveis. Você pode adicionar novos anexos no GetAccept usando um novo documento.

Retornos

Lista de anexos

Attachments
Attachments

Listar contatos

Receba uma lista de contatos disponíveis para a entidade atual. Todos os contatos adicionados como um destinatário são salvos como um contato e estão disponíveis para uso posterior nessa entidade.

Retornos

Lista de contatos

Contatos
Contacts

Listar documentos

Obter uma lista de documentos disponíveis

Parâmetros

Nome Chave Obrigatório Tipo Description
Lista de filtros no status
filter string

Lista de filtros no status

Como classificar resultados
sort_by string

Como classificar resultados

Classificar a ordem dos resultados
sort_order string

Classificar a ordem dos resultados

Incluir documentos de membros da equipe
showteam boolean

Incluir documentos de membros da equipe

Incluir todos os documentos da entidade
showall boolean

Incluir todos os documentos da entidade

ID externa
external_id string

Uma ID externa é um campo personalizado que pode conter um identificador de registro exclusivo de um sistema fora do GetAccept

Offset
offset number

Iniciar lista do registro x até o limite

Limit
limit number

Número de registros a serem listados

Retornos

Lista de documentos

Itens
Documents

Listar modelos

Receba uma lista de modelos de documento disponíveis. Você pode adicionar novos modelos na seção Modelos no GetAccept.

Parâmetros

Nome Chave Obrigatório Tipo Description
Mostrar tudo
showall string

Mostrar todos os modelos para a entidade

ID da pasta
folder_id string

Mostrar modelos em uma pasta específica

Retornos

Nome Caminho Tipo Description
templates
templates array of object
tags
templates.tags string
criado_em
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
nome
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
tipo
templates.type string
user_id
templates.user_id string
video_id
templates.video_id string
video_thumb_url
templates.video_thumb_url string

Listar usuários

Buscar uma lista de usuários ativos para a entidade autenticada atual

Retornos

Lista de usuários

Usuários
Users

Listar vídeos

Receba uma lista de vídeos disponíveis na entidade. Você pode adicionar novos vídeos no aplicativo móvel ou no GetAccept.

Retornos

Nome Caminho Tipo Description
videos
videos array of object
Editável
videos.editable boolean
publicado
videos.published boolean
Salvou
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

Obter anexos de documento

Obtenha anexos de documento especificando uma ID de documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
documentId True string

ID do documento

Retornos

Lista de anexos

Attachments
Attachments

Obter campos de documento

Obtenha uma lista de campos para um documento ou modelo. Pode ser usado antes e depois de um documento ter sido assinado.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
documentId True string

ID do documento

Retornos

Lista de campos

Fields
Fields

Obter campos de modelo

Receba uma lista de campos para um modelo específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Modelo
templateId True string

ID do Modelo

Retornos

Lista de campos

Fields
Fields

Obter destinatários de documentos

Obtenha uma lista de destinatários para um documento específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
documentId True string

ID do documento

Retornos

Lista de destinatários

Destinatários
Recipients

Obter detalhes do documento

Obtenha detalhes do documento especificando uma ID do documento.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do documento
documentId True string

ID do documento

Retornos

Um documento é um ou vários arquivos carregados que devem ser enviados para um ou muitos destinatários criados por um usuário.

Documento
Document

Obter detalhes do usuário

Essa chamada retornará detalhes de um único usuário. Receber detalhes e entidades disponíveis do usuário autenticado atual usando a ID do usuário

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Usuário
userId True string

ID do Usuário

Retornos

Um usuário é definido por seu endereço de email e está conectado a uma ou muitas entidades.

Funções de usuário

Administrador:

  • Exibir todos os documentos
  • Editar todos os documentos
  • Alterar configurações de entidade, informações e cobrança
  • Adicionar novos usuários à entidade
  • Atribuir funções de entidade

Gerente:

  • Exibir documentos da equipe
  • Editar todos os documentos
  • Adicionar novos usuários à entidade

Entidade

Uma entidade é o nó superior e todos os usuários e documentos correspondentes estão conectados a uma entidade. Uma entidade geralmente é a mesma que uma empresa, um país ou um departamento em uma grande organização.

Utilizador
User

Obter funções de modelo

Receba uma lista de funções para um modelo específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Modelo
templateId True string

ID do Modelo

Retornos

Nome Caminho Tipo Description
funções
roles array of object
email
roles.email string
first_name
roles.first_name string
last_name
roles.last_name string
móvel
roles.mobile string
função
roles.role string
role_id
roles.role_id string
role_name
roles.role_name string

Obter tabelas de preços de modelo

Receba uma lista de itens de tabela de preços para um modelo específico.

Parâmetros

Nome Chave Obrigatório Tipo Description
ID do Modelo
templateId True string

ID do Modelo

Retornos

Tabelas de preços

Pricing
PricingTables

Gatilhos

Assinar eventos de documento

Essa chamada criará uma nova assinatura. A resposta será encapsulada em uma matriz mesmo para um único objeto de acordo com os padrões de gancho REST.

Eventos

  • document.created - O documento é criado
  • document.sent - O documento é enviado
  • document.viewed - O documento é enviado
  • document.signed - O documento está assinado
  • document.approved - O documento foi aprovado
  • document.expired - O documento expirou
  • document.rejected - Documento rejeitado
  • document.downloaded – O documento é baixado
  • document.printed - O documento é impresso
  • document.forwarded - O documento é encaminhado
  • document.partially_signed - O documento foi parcialmente assinado
  • document.commented - O documento é comentado
  • document.hardbounced - O documento é hardbounced
  • document.imported - O documento é importado
Quando um documento foi assinado

Dispara quando um documento foi assinado por todas as partes de assinatura

Quando um documento foi rejeitado

Dispara quando um documento é rejeitado por qualquer um dos destinatários

Quando um documento foi revisado

Dispara quando um documento é revisado por qualquer um dos destinatários

Assinar eventos de documento

Essa chamada criará uma nova assinatura. A resposta será encapsulada em uma matriz mesmo para um único objeto de acordo com os padrões de gancho REST.

Eventos

  • document.created - O documento é criado
  • document.sent - O documento é enviado
  • document.viewed - O documento é enviado
  • document.signed - O documento está assinado
  • document.approved - O documento foi aprovado
  • document.expired - O documento expirou
  • document.rejected - Documento rejeitado
  • document.downloaded – O documento é baixado
  • document.printed - O documento é impresso
  • document.forwarded - O documento é encaminhado
  • document.partially_signed - O documento foi parcialmente assinado
  • document.commented - O documento é comentado
  • document.hardbounced - O documento é hardbounced
  • document.imported - O documento é importado

Parâmetros

Nome Chave Obrigatório Tipo Description
Selecionar evento
event True string

Gatilho de evento

Todos os usuários da entidade
global boolean

Se o webhook deve capturar eventos para todos os usuários de entidade.

Email de erro
notification_email string

Se o evento falhar, envie uma notificação para este email em vez do remetente

Conteúdo
payload string

Dados de conteúdo adicionais a serem postados

Retornos

Conteúdo do Webhook

Webhook
Webhook

Quando um documento foi assinado

Dispara quando um documento foi assinado por todas as partes de assinatura

Parâmetros

Nome Chave Obrigatório Tipo Description
Todos os usuários da entidade
global boolean

Se o webhook deve capturar eventos para todos os usuários de entidade.

Email de erro
notification_email string

Se o evento falhar, envie uma notificação para este email em vez do remetente

Conteúdo
payload string

Dados de conteúdo adicionais a serem postados

Retornos

Conteúdo do Webhook

Webhook
Webhook

Quando um documento foi rejeitado

Dispara quando um documento é rejeitado por qualquer um dos destinatários

Parâmetros

Nome Chave Obrigatório Tipo Description
Todos os usuários da entidade
global boolean

Se o webhook deve capturar eventos para todos os usuários de entidade.

Email de erro
notification_email string

Se o evento falhar, envie uma notificação para este email em vez do remetente

Conteúdo
payload string

Dados de conteúdo adicionais a serem postados

Retornos

Conteúdo do Webhook

Webhook
Webhook

Quando um documento foi revisado

Dispara quando um documento é revisado por qualquer um dos destinatários

Parâmetros

Nome Chave Obrigatório Tipo Description
Todos os usuários da entidade
global boolean

Se o webhook deve capturar eventos para todos os usuários de entidade.

Email de erro
notification_email string

Se o evento falhar, envie uma notificação para este email em vez do remetente

Conteúdo
payload string

Dados de conteúdo adicionais a serem postados

Retornos

Conteúdo do Webhook

Webhook
Webhook

Definições

Anexo

Anexo do documento

Nome Caminho Tipo Description
Acessar destinatários
access_recipient_names array of string

Destinatários com acesso ao anexo

Description
attachment_description string

Descrição do anexo

Transferir URL
attachment_download_url string

URL para baixar o anexo

Extensão de Arquivo
attachment_extension string

Extensão de arquivo do anexo

Nome do Arquivo
attachment_filename string

Nome do arquivo do anexo

ID
attachment_id string

ID do anexo

URL de visualização
attachment_preview_url string

URL interna para visualizar o anexo

Title
attachment_title string

Título do anexo

Tipo
attachment_type string

Tipo do anexo

URL
attachment_url string

URL do anexo

Última Exibição
last_attachment_view string

Data e hora em que o anexo foi exibido pela última vez

Acesso restrito
restrict_access boolean

O anexo tem acesso restrito

Attachments

Lista de anexos

Nome Caminho Tipo Description
attachments
attachments array of Attachment

Contato

Cada endereço de email exclusivo (ou número de celular) é definido como um contato.

Nome Caminho Tipo Description
ID da Empresa
company_id string

ID da Empresa

Logotipo da empresa
company_logo_url string

Logotipo da empresa

Nome da empresa
company_name string

Nome da empresa do contato

Número da empresa
company_number string

Número da empresa do contato

ID de contato
contact_id string

ID de contato

Criado
created_at string

Data do contato criado

Documentos
document_count number

Número de documentos para um contato

Email de contato
email string

Nome do documento criado

Nome
first_name string

Nome do contato

Nome completo
fullname string

Nome completo do contato

Gênero
gender string

Gênero do destinatário

Sobrenome
last_name string

Sobrenome do contato

Telemóvel
mobile string

Número de celular do contato

Observação
note string

Observação do contato

URL do polegar
thumb_url string

URL do thumb do contato

Title
title string

Título do contato

Contatos

Lista de contatos

Nome Caminho Tipo Description
contacts
contacts array of Contact

Documento

Um documento é um ou vários arquivos carregados que devem ser enviados para um ou muitos destinatários criados por um usuário.

Nome Caminho Tipo Description
Etiquetas
tags string

Marcas de documento

Texto de chat automático
auto_comment_text string

Texto de chat automático

Nome da Empresa
company_name string

Nome da Empresa

Criado em
created_at string

Quando o documento foi criado

Transferir URL
download_url string

URL para baixar o documento assinado

Mensagem de email
email_send_message string

Enviar mensagem de email

Assunto de email
email_send_subject string

Texto da entidade de email

Data de validade
expiration_date string

Data de validade do documento

ID do cliente externo
external_client_id string
ID do Editor Externo
external_editor_id string

ID no editor externo

Tipo de Editor Externo
external_editor_type string
ID externa
external_id string
Contagem de campos
field_count integer

Número de campos no documento

ID
id string
Comentário automático
is_auto_comment boolean

Se o comentário de chat automático estiver habilitado

Email de Comentário Automático
is_auto_comment_email boolean

Se o email de chat automático estiver habilitado

Identificar destinatário
is_identify_recipient boolean

Se o documento tiver identificado o destinatário habilitado

É privado
is_private boolean

Se o documento for privado

Enviar lembretes
is_reminder_sending boolean

Se os lembretes automáticos estiverem habilitados

Envio agendado
is_scheduled_sending boolean

Se o documento tiver o envio agendado

Auto-assinatura
is_selfsign boolean

Se o documento tiver sido autoassinado pelo remetente

Está assinado
is_signed boolean

Se o documento tiver sido assinado

Documento que pode ser assinado
is_signing boolean

Se o documento estiver com sinal

Assinatura manuscrita
is_signing_biometric boolean

Se a assinatura manuscrita estiver habilitada

Permitir transferência de assinatura
is_signing_forward boolean

Se a transferência de direitos de assinatura estiver habilitada

Ordem de assinatura
is_signing_order boolean

Se a ordem de assinatura do destinatário estiver habilitada

Tem Vídeo
is_video boolean

Se o documento tiver um vídeo de introdução

Nome
name string

Nome do documento

ID Principal
parent_id string

ID da versão anterior do documento

URL de visualização
preview_url string

Link para visualização interna do documento

destinatários
recipients array of Recipient
Tempo de envio agendado
scheduled_sending_time string

Quando o documento foi agendado para envio

Data de envio
send_date string

Data de envio do documento

Email do remetente
sender_email string

Endereço de email do usuário remetente

Nome do remetente
sender_name string

Nome do usuário remetente

URL do remetente
sender_thumb_url string

Imagem em miniatura do usuário remetente

Data de assinatura
sign_date string

Data de assinatura do documento

Situação
status string

Status atual do documento

URL do polegar
thumb_url string

Imagem em miniatura do documento

Tipo
type string

Tipo de documento

Identificação Única
unique_id integer

ID exclusiva do documento

ID do Usuário
user_id string

ID do usuário remetente

Value
value integer

Valor do documento

Documentos

Lista de documentos

Nome Caminho Tipo Description
tags
tags string
company_name
company_name string
criado_em
created_at string
expiration_date
expiration_date string
id
id string
is_private
is_private boolean
is_signing
is_signing boolean
nome
name string
sender_name
sender_name string
sender_thumb
sender_thumb string
status
status string
tipo
type string
value
value integer

EditorField

Detalhes do Campo do Editor

Nome Caminho Tipo Description
ID
id string

ID

Etiqueta
input_settings.label string

Etiqueta

Opções
input_settings.options array of string

Opções

Obrigatório
input_settings.required boolean

Obrigatório

Tipo
input_settings.type string

Tipo

ID do destinatário
recipient_id string

ID do destinatário

Tipo
type string

Tipo

ID do Usuário
user_id string

ID do Usuário

Campo

Detalhes do campo

Nome Caminho Tipo Description
Nome da Empresa
company_name string

Nome da Empresa

Número da Empresa
company_number string

Número da Empresa

ID do campo
field_id string

ID do campo

Etiqueta
field_label string

Etiqueta

Opções
field_options array of object

Opções

Value
field_options.value string
Tipo
field_type string

Tipo

Value
field_value string

Value

is_collectable
is_collectable boolean

Campo de coleta

is_editable
is_editable boolean

Campo editável

is_required
is_required boolean

Campo obrigatório

ID da página
page_id string

ID da página

ID do destinatário
recipient_id string

ID do destinatário

Nome do destinatário
recipient_name string

Nome do destinatário

Nome da Função
role_name string

Nome da Função

Fields

Lista de campos

Nome Caminho Tipo Description
editor_fields
editor_fields array of EditorField
fields
fields array of Field

PricingColumn

Coluna tabela de preços

Nome Caminho Tipo Description
ID
column_id string

ID

Nome de Exibição
display_name string

Nome de Exibição

Enabled
enabled boolean

Enabled

Nome
name string

Nome

PricingSection

Seção Tabela de Preços

Nome Caminho Tipo Description
columns
columns array of PricingColumn
Nome de Exibição
display_name string

Nome de Exibição

Nome
name string

Nome

ID
section_id string

ID

PricingTable

Tabela de preços

Nome Caminho Tipo Description
Moeda
currency_settings.currency string

Moeda

Local
currency_settings.locale string

Local

Totais pré-calculados
pre_calculated boolean

Totais pré-calculados

Seções
sections array of PricingSection
ID
table_id string

ID da tabela

PricingTables

Tabelas de preços

Nome Caminho Tipo Description
pricing_tables
pricing_tables array of PricingTable

Recipient

Cada endereço de email exclusivo (ou número de celular) conectado a um documento é um destinatário.

Nome Caminho Tipo Description
Nome da empresa
company_name string

Nome da empresa do destinatário

Número da empresa
company_number string

Número da empresa do destinatário

URL do documento
document_url string

URL exclusiva para o destinatário exibir/assinar

Email do destinatário
email string

Email do destinatário

Nome
first_name string

Nome do destinatário

Nome completo
fullname string

Nome completo do destinatário

Gênero
gender string

Gênero do destinatário

ID
id string

ID do destinatário

Sobrenome
last_name string

Sobrenome do destinatário

Telemóvel
mobile string

Número de celular do destinatário

Observação
note string

Anotação do destinatário

Núm da ordem de assinatura
order_num string

Ordem de assinatura do destinatário

Situação
status string

Status do destinatário

URL do polegar
thumb_url string

URL do polegar do destinatário

Title
title string

Título do destinatário

Destinatários

Lista de destinatários

Nome Caminho Tipo Description
destinatários
recipients array of Recipient

Utilizador

Um usuário é definido por seu endereço de email e está conectado a uma ou muitas entidades.

Funções de usuário

Administrador:

  • Exibir todos os documentos
  • Editar todos os documentos
  • Alterar configurações de entidade, informações e cobrança
  • Adicionar novos usuários à entidade
  • Atribuir funções de entidade

Gerente:

  • Exibir documentos da equipe
  • Editar todos os documentos
  • Adicionar novos usuários à entidade

Entidade

Uma entidade é o nó superior e todos os usuários e documentos correspondentes estão conectados a uma entidade. Uma entidade geralmente é a mesma que uma empresa, um país ou um departamento em uma grande organização.

Nome Caminho Tipo Description
Modo de Aplicativo
app_mode string
disallow_create
disallow_create boolean
Email
email string

Endereço de email do usuário

ID da entidade
entity_id string
Nome da Entidade
entity_name string
Nome
first_name string

Primeiro nome do usuário

ID
id string

ID do usuário

Linguagem
language string
Sobrenome
last_name string

Sobrenome do usuário

móvel
mobile string

Número de celular em formato internacional

Observação
note string

Observação interna opcional para o usuário

Telefone
phone string

Número de telefone em formato internacional

Função
role string
Ignorar o envio de convite
skip_invitation boolean
Situação
status string
ID da equipe
team_id string
URL do polegar
thumb_url string
Timezone
timezone string
Title
title string

O título do usuário, por exemplo. CEO, gerente de vendas

Usuários

Lista de usuários

Nome Caminho Tipo Description
users
users array of object
Email
users.email string
Primeiro Nome
users.first_name string
Último Logon
users.last_login string
Apelido
users.last_name string
Nome do usuário
users.name string
Função
users.role string
Situação
users.status string
Nome da Equipe
users.team_name string
ID do Usuário
users.user_id string

Webhook

Conteúdo do Webhook

Nome Caminho Tipo Description
Campos personalizados
custom_fields object
Documento
document Document

Um documento é um ou vários arquivos carregados que devem ser enviados para um ou muitos destinatários criados por um usuário.

Domínio personalizado da entidade
entity.custom_domain string

Configuração de domínio personalizado para entidade

Mensagem de email padrão
entity.email_send_message string

Mensagem de email padrão

Assunto de email padrão
entity.email_send_subject string

Assunto de email padrão

Subdomínio de entidade
entity.sub_domain string

Subdomínio para a entidade

Nome do evento
event string
Ação de evento
event_action string
Tipo de evento
event_type string
Recipient
recipient Recipient

Cada endereço de email exclusivo (ou número de celular) conectado a um documento é um destinatário.

ID da assinatura
subscription_id string