Ploomes

Adicionando o conector

Baseado na documentação da API do Ploomes

Este conector está em modo beta

Requisitos

  • Siga as instruções abaixo com um usuário administrador

Instruções

1) Acesse o site e faça login em sua conta Ploomes e, no painel lateral direito acesse Administração

2) Em integrações, selecione “Usuários de integração”

3) No modal, selecione “Novo usuário”

4) Preencha nome o “Kondado”, email “kondado@suaempresa.com.br” (utilize um email válido da sua empresa) e perfil Administrador > Criar usuário

5) Confirme a criação

6) Voltando ao modal de listagem de usuários, selecione o usuário Kondado recém criado

7) Copie a o valor exibido na caixa de“Chave da API”

8) Faça login na plataforma da Kondado, clique para criar um novo conector Ploomes e cole em “Chave da API” o valor obtido no passo 7

Agora basta clicar em SALVAR e criar suas integrações para começar a receber dados do Ploomes no seu Data Warehouse, Data Lake ou planilha

Integrações

Índice

Gráfico de relacionamento

Clique para ampliar

Campos do Ploomes baseados em listas de seleções irão gerar 2 campos em sua tabela, terminados em “_val” e “_id”. Onde “_val” corressponderá ao texto da opção no momento da leitura dos dados e “_id” ao id desta opção. É possível que edições no texto da opção, diretamente na lista de opções, não alterem que não alterem o registro integrado diretamente, deixando este defasado

Campos do Ploomes que suportem múltiplas escolhas serão escritos em um mesmo campo da tabela da integração, separados por vírgulas

Entidades que suportem campos customizados irão trazer os todos os campos durante a criação da integração, não sendo criados novos campos após este momento, sendo necessária edição avançada para sincronização da lista de campos. Campos que deixem de existir no Ploomes apenas irão passar a ser escritos como nulos

Vendas: produtos

Campo Tipo

orderid

text

[pt] Id da venda

    Vendas > > id

id

text

[pt] Id do registro venda/produto

productid

text

[pt] Id produto

    Produtos > > id

dealid

text

[pt] Id do negócio da venda.

    Negócios > > id

ownerid

text

    Usuários > > id

contactid

text

    Clientes (empresas e pessoas) > > id

quantity

float

unityprice

float

discount

float

total

float

bonus

float

Vendas: estágios

Campo Tipo

id

text

[pt] Id do estágio da venda, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome do estágio da venda.

icon

text

[pt] Ícone do estágio da venda.

ordination

int

[pt] Ordenação do estágio da venda. Esse é o número que define a ordem entre os estágios dentro de um funil, indo do menor para o maior.

Vendas

Campo Tipo

id

text

[pt] Id da venda, gerado automaticamente pelo Bando de Dados.

ordernumber

int

[pt] Número da venda.

date

timestamp

[pt] Data da venda, prenchida automaticamente com a data atual se nenhum valor for infomado.

contactid

text

[pt] Id do cliente da venda

    Clientes (empresas e pessoas) > > id

personid

text

[pt] Id da pessoa da venda

    Clientes (empresas e pessoas) > > id

stageid

text

[pt] Id do estágio da venda. Assume um valor de um estágio padrão se não for informado

    Vendas: estágios > > id

dealid

text

[pt] Id do negócio da venda.

    Negócios > > id

ownerid

text

[pt] Id do responsável da venda

    Usuários > > id

currencyid

text

[pt] Id da moeda da venda. Assume o valor da moeda do cliente ou da conta se não for informado

    Moedas > > id

amount

float

[pt] Valor da venda.

discount

text

[pt] Disconto da venda.

internalcomments

text

[pt] Comentários internos da venda.

description

text

[pt] Descrição da venda.

key

text

[pt] Chave da venda.

agentid

text

[pt] Id do comissionado da venda.

commission

text

[pt] Comissão da venda.

templateid

text

[pt] Id do modelo da venda

shared

boolean

[pt] Indica se a venda foi compartilhada.

externallyaccepted

boolean

[pt] Indica se a venda foi aceita externamente.

externalnotifications

boolean

[pt] Indica o recebimento de notificações externas.

externalsharingdate

timestamp

[pt] Data de compartilhamento da venda.

documenturl

text

[pt] URL da venda (Quando compartilhada externamente).

approvalstatusid

text

[pt] Indica o status da aprovação da venda

approvallevelid

text

[pt] Indica o nível de aprovação da venda.

originquoteid

text

[pt] Id da proposta origem da venda.

    Propostas > > id

filename

text

[pt] Nome do arquivo da venda.

last_update_date

timestamp

Usuários: perfis

Campo Tipo

id

text

[pt] Id do perfil de usuário, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome do perfil de usuário.

Usuários: motivos de suspensão

Campo Tipo

id

text

[pt] Id do motivo de suspensão.

name

text

[pt] Nome do motivo de suspensão.

Usuários

Campo Tipo

id

text

[pt] Id do usuário, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome do usuário.

email

text

[pt] Email do usuário.

roleid

text

[pt] Id do cargo do usuário

    Cargos > > id

profileid

text

[pt] Id do perfil do usuário

    Usuários: perfis > > id

avatarurl

text

[pt] Url do avatar do usuário (Foto).

phone

text

[pt] Telefone do usuário.

language

text

[pt] Língua do usuário.

facebook

text

[pt] Facebook do usuário.

linkedin

text

[pt] LinkedIn do usuário.

suspensionreasonid

text

[pt] Id do motivo de suspensão do usuário.

    Usuários: motivos de suspensão > > id

suspensionreasoncomments

text

[pt] Comentário sobre a suspensão do usuário.

integration

boolean

[pt] Boleano que indica se é um usuário de integração (UserKey fixa).

nativeintegration

boolean

[pt] Boleano que indica se é um usuário de integração nativa (Utilizado pelas integrações Plug-In-Play).

courtesy

boolean

[pt] Boleano que indica se é um usuário cortesia (Não conta no pagamento). Usuários que não são de integração terão o valor de falso.

last_update_date

timestamp

Tarefas: tipos de lembrete de email

Campo Tipo

id

text

[pt] Id do lembrete de email.

name

text

[pt] Nome do lembrete de email.

Tarefas: tipos

Campo Tipo

id

text

[pt] Id do tipo de tarefa.

name

text

[pt] Nome do tipo de tarefa.

icon

text

[pt] Ícone do tipo de tarefa.

color

text

[pt] Cor do tipo de tarefa.

Tarefas: intervalos de repetição

Campo Tipo

id

text

[pt] Id do intervalo de repetição.

name

text

[pt] Nome do intervalo de repetição.

datepart

text

[pt] Parte da data.

datepartlength

int

[pt] Tamanho da parte da data.

Tarefas

Campo Tipo

id

text

[pt] Id da tarefa, gerada automaticamente pelo Banco de Dados.

title

text

[pt] Título da tarefa.

description

text

[pt] Descrição da tarefa.

typeid

text

[pt] Id do tipo de tarefa

    Tarefas: tipos > > id

contactid

text

[pt] Id do contato da tarefa

    Clientes (empresas e pessoas) > > id

dealid

text

[pt] Id do negócio da tarefa.

    Negócios > > id

lenght

int

[pt] Duração da tarefa.

repeatintervallength

int

[pt] Duração do intervalo de repetição da tarefa.

repeatintervalunitid

text

[pt] Id do intervalo de repetição da Task

    Tarefas: intervalos de repetição > > id

emailreminderid

text

[pt] Id do lembrete por email

    Tarefas: tipos de lembrete de email > > id

last_update_date

timestamp

Registros de interação

Campo Tipo

id

text

[pt] Id do registro de interação, gerado automaticamente pelo Banco de Dados.

contactid

text

[pt] Id do cliente do registro de interação. Se for informado algum Id de negócio, o Id do cliente passa a ser o mesmo do cliente desse negócio. Caso contrário, o id do cliente deve ser válido para a criação do registro se completar

    Clientes (empresas e pessoas) > > id

dealid

text

[pt] Id do negócio do registro de interação

    Negócios > > id

date

timestamp

[pt] Data do registro de interação. Se estiver vazia, recebe a data atual da criação.

typeid

text

[pt] Id do tipo de registro de interação

    Tarefas: tipos > > id

title

text

[pt] Título do registro de interação.

content

text

[pt] Conteúdo do registro de interação.

latitude

float

[pt] Latitude do registro de interação (Se fizer sentido para o tipo dele).

longitude

float

[pt] Longitude do registro de interação (Se fizer sentido para o tipo dele).

emailrecipients

text

[pt] Destinatários do email do registro de interação (Se fizer sentido para o tipo dele).

emailsubject

text

[pt] Assunto do email do registro de interação (Se fizer sentido para o tipo dele).

last_update_date

timestamp

Propostas: produtos

Campo Tipo

quoteid

text

[pt] Id da proposta

    Propostas > > id

id

text

[pt] Id do registro proposta/produto

productid

text

[pt] Id produto

    Produtos > > id

dealid

text

[pt] Id do negócio da proposta.

    Negócios > > id

ownerid

text

    Usuários > > id

contactid

text

    Clientes (empresas e pessoas) > > id

quantity

float

unityprice

float

discount

float

total

float

bonus

float

Propostas: status de aprovação

Campo Tipo

id

text

[pt] Id do status de aprovação da proposta.

name

text

[pt] Nome do status de aprovação da proposta.

Propostas

Campo Tipo

id

text

[pt] Id da proposta, gerado automaticamente pelo Banco de Dados.

dealid

text

[pt] Id do negócio da proposta.

    Negócios > > id

templateid

text

[pt] Id do modelo da proposta

approvalstatusid

text

[pt] Id do status de aprovação da proposta

    Propostas: status de aprovação > > id

quotenumber

int

[pt] Número da proposta.

shared

boolean

[pt] Indica se a proposta foi compartilhado.

externalnotifications

boolean

[pt] Indica o recebimento de notificações externas.

externalsharingdate

timestamp

[pt] Data de compartilhamento da proposta.

lastreviewid

text

[pt] Id da última revisão.

last_update_date

timestamp

Produtos: grupos: famílias

Campo Tipo

id

text

[pt] Id da família de produto, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome da família de produto.

Produtos: grupos

Campo Tipo

id

text

[pt] Id do grupo de produto, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome do grupo de produto.

familyid

text

[pt] Id da família do grupo de produto

    Produtos: grupos: famílias > > id

fixedprice

boolean

[pt] Indica se o preço é fixado nesse grupo de produto.

default

boolean

[pt] Indica se esse grupo de produto é padrão.

Produtos

Campo Tipo

id

text

[pt] Id do produto, gerado automaticamente pelo Banco de Dados.

groupid

text

[pt] Id do grupo do produto.

    Produtos: grupos > > id

name

text

[pt] Nome do produto.

code

text

[pt] Código do produto.

measurementunit

text

[pt] Unidade de medida do produto.

imageurl

text

[pt] Imagem do produto.

currencyid

text

[pt] Id da moeda do produto. Essa informação pode ser consultada no endpoint de '/Currencies'.

    Moedas > > id

unitprice

float

[pt] Unit value of the product.

last_update_date

timestamp

Negócios: status

Campo Tipo

id

text

[pt] Id do status do negócio.

name

text

[pt] Nome do status do negócio.

Negócios: motivos de perda

Campo Tipo

id

text

[pt] Id do motivo de perda, gerado automaticamente pelo Banco de dados.

name

text

[pt] Nome do motivo de perda.

pipelineid

text

[pt] Id do funil do motivo de perda.

Negócios: funis

Campo Tipo

id

text

[pt] Id do Funil de negócio, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome do funil de negócio.

mustpassallstages

boolean

[pt] Boleano que indica se a passagem por todos os estágios é obrigatória neste funil. Assume o valor de falso se não for informado.

forbiddenstagereturn

boolean

[pt] Boleano que indica se é proibido voltar de etapa neste funil. Assume o valor de falso se não for informado.

maycreatequotes

boolean

[pt] Boleano que indica se pode gerar propostas neste funil. Assume o valor de falso se não for informado.

maycreateorders

boolean

[pt] Boleano que indica se pode gerar vendas neste funil. Assume o valor de falso se não for informado.

maycreatedocuments

boolean

[pt] Boleano que indica se pode gerar documentos neste funil. Assume o valor de falso se não for informado.

maywindeals

boolean

[pt] Boleano que indica se pode ganhar negócios neste funil. Assume o valor de falso se não for informado.

maylosedeals

boolean

[pt] Boleano que indica se pode perder propostas neste funil. Assume o valor de falso se não for informado.

formid

text

[pt] Id do formulário do funil de negócio.

quickformid

text

[pt] Id do formulário mini do funil de negócio.

archived

boolean

[pt] Indica de o formulário está arquivado. Assume o valor de falso inicialmente.

neworderonwondeal

boolean

[pt] Boleano que indica se deve gerar uma nova venda ao ganhar um negócio neste funil (Abrindo a janela de criação de uma nova venda). Assume o valor de falso se não for informado.

createorderonwondeal

boolean

[pt] Boleano que indica se deve gerar uma nova venda automaticamente ao ganhar um negócio neste funil. Assume o valor de falso se não for informado.

windealonlaststage

boolean

[pt] Boleano que indica se é possível ganhar um negócio apenas na última etapa neste funil. Assume o valor de falso se não for informado.

singularunitname

text

[pt] Nome da unidade no singular desse funil.

pluralunitname

text

[pt] Nome da unidade no plural desse funil.

genderid

text

[pt] Gênero da unidade desse funil.

enabletableviewmode

boolean

[pt] Boleano que indica se a visualização de tabela está disponível.

enablefunnelviewmode

boolean

[pt] Boleano que indica se a visualização de Funil/Kanban está disponível.

ordination

int

[pt] Ordenação do funil.

quotesuseerpformat

boolean

[pt] Boleano que indica se deve usar formato de tela cheia para criação/edição de propostas neste funil.

ordersuseerpformat

boolean

[pt] Boleano que indica se deve usar formato de tela cheia para criação/edição de vendas neste funil.

documentsuseerpformat

boolean

[pt] Boleano que indica se deve usar formato de tela cheia para criação/edição de documentos neste funil.

Negócios: estágios

Campo Tipo

id

text

[pt] Id da estágio do negócio, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome do estágio do negócio.

pipelineid

text

[pt] Funil do estágio do negócio. Essa informação pode ser consultada no endpoint '/Deals@Pipelines'.

    Negócios: funis > > id

ordination

int

[pt] Ordenação do estágio do negócio. Esse é o número que define a ordem entre os estágios dentro de um funil, indo do menor para o maior. Não é possível inserir estágios com ordenação igual dentro do mesmo funil.

Negócios

Campo Tipo

id

text

[pt] Id do negócio, gerado automaticamente pelo Banco de Dados.

title

text

[pt] Título do negócio.

contactid

text

[pt] Id do cliente do negócio. Se o negócio não possuir nenhum cliente, o cliente Fantasma da conta será adicionado (É um id de cliente que todas as contas possuem para representar um cliente vazio)

    Clientes (empresas e pessoas) > > id

personid

text

[pt] Id da pessoa do negócio

    Clientes (empresas e pessoas) > > id

statusid

text

[pt] Id do status do negócio

    Negócios: status > > id

pipelineid

text

[pt] Id do funil do negócio

    Negócios: funis > > id

stageid

text

[pt] Id do estágio do negócio. Se o estágio não for informado, esse campo será preenchido com o primeiro estágio de um funil não arquivado.

    Negócios: estágios > > id

laststageid

text

[pt] Id do último estágio do negócio.

    Negócios: estágios > > id

lossreasonid

text

[pt] Id do motivo de perda do negócio.

    Negócios: motivos de perda > > id

originid

text

[pt] Id da origem do negócio.

ownerid

text

[pt] Id do responsável do negócio.

    Usuários > > id

currencyid

text

[pt] Id da moeda do negócio. Será inserido nesse campo a moeda do cliente ou a moeda padrão da conta.

    Moedas > > id

amount

float

[pt] Valor do negócio. Esse campo tem um valor padrão de 0.

origindealid

text

[pt] Id do negócio origem desse negócio. Esse campo estará preenchido se esse negócio for um negócio derivado de outro.

dealnumber

int

[pt] Número do negócio.

contactproductid

text

[pt] Id do produto de cliente do negócio.

last_update_date

timestamp

Moedas

Campo Tipo

id

text

[pt] Id da moeda, gerado automaticamente pelo Banco de dados.

symbol

text

[pt] Símbolo da moeda.

code

text

[pt] Código da moeda.

Documentos

Campo Tipo

id

text

[pt] Id do documento, gerado automaticamente pelo Bando de Dados.

name

text

[pt] Nome do documento.

documentnumber

int

[pt] Número do documento.

date

timestamp

[pt] Data do documento, prenchida automaticamente com a data atual se nenhum valor for infomado.

templateid

text

[pt] Id do modelo do documento

contactid

text

[pt] Id do cliente do documento

    Clientes (empresas e pessoas) > > id

personid

text

[pt] Id da pessoa do documento

    Clientes (empresas e pessoas) > > id

dealid

text

[pt] Id do negócio do documento

    Negócios > > id

ownerid

text

[pt] Id do responsável do documento

    Usuários > > id

key

text

[pt] Chave do documento.

shared

boolean

[pt] Indica se o documento foi compartilhado.

externallyaccepted

boolean

[pt] Indica se o documento foi aceito externamente.

externalnotifications

boolean

[pt] Indica o recebimento de notificações externas.

externalsharingdate

timestamp

[pt] Data de compartilhamento do documento.

documenturl

text

[pt] URL do documento (Quando compartilhado externamente).

approvalstatusid

text

[pt] Id do status da aprovação do documento.

approvallevelid

text

[pt] Indica o nível de aprovação do documento.

originquoteid

text

[pt] Id da proposta origem do documento.

    Propostas > > id

currencyid

text

[pt] Id da moeda do documento

    Moedas > > id

filename

text

[pt] Nome do arquivo do documento.

last_update_date

timestamp

Departamentos

Campo Tipo

id

text

[pt] Id do departamento, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome do departamento.

Clientes: tipos

Campo Tipo

id

text

[pt] Id do tipo de cliente.

name

text

[pt] Nome do tipo de cliente.

Clientes: status

Campo Tipo

id

text

[pt] Id do status do cliente, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome do status do cliente.

Clientes: relações

Campo Tipo

id

text

[pt] Id da relação, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome da relação.

Clientes: segmentos

Campo Tipo

id

text

[pt] Id do Segmento , gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome do Segmento.

Clientes: origens

Campo Tipo

id

text

[pt] Id da origem, gerado automaticamente pelo banco de dados.

name

text

[pt] Nome da origem.

Clientes: classificações

Campo Tipo

id

text

[pt] Id da relação, gerado automaticamente pelo Banco de Dados.

name

text

[pt] Nome da relação.

Clientes (empresas e pessoas)

Campo Tipo

id

text

[pt] Id do cliente, gerado automaticamente pelo Banco de dados.

typeid

text

[pt] Id do tipo do cliente, podendo ser um cliente do tipo pessoa ou do tipo empresa.

    Clientes: tipos > > id

classid

text

[pt] Id da classe do cliente.

    Clientes: classificações > > id

name

text

[pt] Nome do cliente.

legalname

text

[pt] Razão social do cliente.

register

text

[pt] CNPJ ou CPF do cliente, a escolha do tipo do campo é de acordo com o tipo do cliente.

statusid

text

[pt] Id do status do cliente. Se não estiver preenchido, assume um valor padrão

    Clientes: status > > id

companyid

text

[pt] Id da empresa do cliente (Se aplica para clientes do tipo pessoa).

    Clientes (empresas e pessoas) > > id

relationshipid

text

[pt] Id da relação do cliente

    Clientes: relações > > id

lineofbusinessid

text

[pt] Id do segmento do cliente

    Clientes: segmentos > > id

originid

text

[pt] Id da origem do cliente

    Clientes: origens > > id

ownerid

text

[pt] Id do usuário responsável do cliente.

    Usuários > > id

note

text

[pt] Observações sobre o cliente.

email

text

[pt] Email do cliente.

website

text

[pt] Site do cliente.

roleid

text

[pt] Id do cargo do cliente

    Cargos > > id

departmentid

text

[pt] Id do departamento do cliente

    Departamentos > > id

skype

text

[pt] Skype do cliente.

facebook

text

[pt] Facebook do cliente.

streetaddress

text

[pt] Endereço do cliente.

streetaddressnumber

text

[pt] Número do endereço do cliente.

streetaddressline2

text

[pt] Complemento do endereço do cliente.

neighborhood

text

[pt] Bairro do cliente.

zipcode

int

[pt] CEP do cliente.

foreignzipcode

text

[pt] Código postal internacional do cliente.

cityid

text

[pt] Id da cidade do cliente

    Cidades > > id

currencyid

text

[pt] Id da moeda do cliente

    Moedas > > id

emailmarketing

boolean

[pt] Boleano sobre o recebimento de email marketing.

cnaecode

text

[pt] Código CNAE do cliente.

cnaename

text

[pt] Descrição do CNAE do cliente.

latitude

float

[pt] Latitude do cliente.

longitude

float

[pt] Longitude do cliente.

key

text

[pt] Chave externa do cliente.

avatarurl

text

[pt] URL do avatar do cliente (Ícone).

identitydocument

text

[pt] Documento de identidade internacional do cliente.

last_update_date

timestamp

Cidades: países

Campo Tipo

id

text

[pt] Id do país, gerado automaticamente pelo Banco de dados.

short

text

[pt] Código Alpha-3. Representa a sigla do país, com 3 letras.

short2

text

[pt] Código Alpha-2. Representa a sigla do país, com 2 letras.

name

text

[pt] Nome do País.

Cidades: estados

Campo Tipo

id

text

[pt] Id do estado, gerado automaticamente pelo Banco de dados.

short

text

[pt] Sigla do estado.

name

text

[pt] Nome do estado.

countryid

text

[pt] Id do país desse estado

    Cidades: países > > id

Cidades

Campo Tipo

id

text

[pt] Id da cidade, gerado automaticamente pelo Banco de dados.

name

text

[pt] Nome da cidade.

countryid

text

[pt] Id do país da cidade

    Cidades: países > > id

stateid

text

[pt] Id do estado da cidade

    Cidades: estados > > id

ibgecode

int

[pt] Código do IBGE da cidade.

latitude

text

[pt] Latitude da cidade.

longitude

text

[pt] Longitude da cidade.

Cargos

Campo Tipo

id

text

[pt] Id do cargo.

name

text

[pt] Nome do cargo.