Para realizar integrações, automações e outras integrações, 

Mas como saber quais os campos disponíveis e a chave de cada um? Isso se torna ainda mais importante caso a conta em questão tenha campos customizados, que foram criados sob demanda.

Este artigo visa explicar como realizar o procedimento, que é bastante simples: basta dar um GET no endpoint de Fields, como mostrado abaixo:
https://api2.ploomes.com/Fields

Esta chamada retornará todos os campos da conta, mas para fins práticos pode ser útil filtrar por alguns critérios. Por exemplo, imagine que você precise de todos os campos customizados de Clientes para uma determinada conta Ploomes. Basta filtrar pelo EntityId = 1 (clientes) e Dynamic = 1.

https://api2.ploomes.com/Fields?$filter=EntityId+eq+1+and+Dynamic+eq+true+and+TypeId+eq+7&$expand=Type($select=NativeType)&$select=Name,Key,Type

No imagem acima vemos o resultado da pesquisa. Se quisermos inserir um cliente informando o "E-mail de cobrança", basta criar um objeto no seguinte padrão:

{
    "FieldKey" : "contact_A51DFABF-56CA-4F03-AABB-F89AF0E7D354",
    "StringValue": "cobranca@ploomes.com"
}

Este objeto precisa então ser adicionado a um Array de Fields, com a chave "OtherProperties".

____________________________________
"OtherProperties":[
    {
        "FieldKey" : "contact_A51DFABF-56CA-4F03-AABB-F89AF0E7D354",
        "StringValue": "cobranca@ploomes.com"
    }
]
____________________________________

Informações complementares:
Note que o tipo do campo "E-mail de cobrança" é String. Sendo assim, é necessário passar seu valor em um atributo chamado StringValue. Basta adicionar a palavra "Value" ao tipo do campo. Então "Integer" ficaria "IntegerValue", por exemplo.

____________________________________

Lista das principais entidades disponíveis:
1 Cliente
2 Negócio
3 Lead
4 Venda
5 Tabela da venda
6 Cotação
7 Revisão da Cotação
8 Tabela de Revisão da Cotação
10 Produto
14 Produto da Proposta
36 Registro de contato

Então se deseja-se buscar todos os campos do Negócio, basta realizar uma requisição GET no seguinte endereço:

https://api2.ploomes.com/Fields?$filter=EntityId+eq+2

____________________________________

Para campos do tipo 7 (opções pré-cadastradas), existe um Endpoint específico que retorna a lista de todas as opções disponíveis. Primeiro é necessário identificar o "OptionsTableId" do campo, retornado no GET de Fields. No exemplo acima esta opção não foi mostrada porque omitimos ela ao selecionar apenas o Nome, Chave e Tipo dos campos ($select=Name,Key,Type). Mas no exemplo abaixo esta informação é exibida:

Usando o código 1204 retornado, pode-se então realizar uma chamada em OptionsTable para descobrir todas as opções válidas, como mostrado abaixo:

https://api2.ploomes.com/Fields@OptionsTables?$filter=Id+eq+1204&$expand=Options

Ou seja, se a intenção for adicionar uma Empresa e informar que a Faculdade relacionada for "Universidade Federal do Rio Grande do Norte", basta dar um POST em "Contacts" e incluir um objeto dentro do Array de OtherProperties no seguinte formato:

"FieldKey" : "contact_94F9848B-7F0A-4BC4-9BC6-E1E9D846563B",
"IntegerValue": 18653

____________________________________

Encontrou sua resposta?