1. Exemplo do json:
| Code Block |
|---|
{
"codigo": 1,
"id_pessoa_grupo": 220,
"id_tipo_cliente": 32,
"id_comissao": 3,
"identificacao": "123456789012345678123456789",
"cpf_cnpj": "12345678901234123.456.789-00",
"categoria_pessoa": "FISICACliente",
"id_situacao_duplicata_padrao": 4,
"id_pessoa_conceito": 510,
"nome_razao_social": "Empresa XYZ",
"apelido_nome_fantasia": "XYZ",
"data_nascimento_fundacao": "2024-08-2801/01/2000",
"data_vigencia_final_limite_credito": "2024-08-2831/12/2023",
"associado": "SIMS",
"revenda": "NAON",
"matricula": "12345",
"obriga_numero_pedido_terceiro": "SIMS",
"data_vigencia_inicio_limite_credito": "2024-08-2801/01/2023",
"genero": "MASCULINOM",
"shelf_life_ativo": "SIMS",
"shelf_life_minimo": 1030,
"shelf_life_maximo": 2090,
"url_imagem": "http://example.com/imagemimage.jpg",
"imagem": [
"string"
],
"url_assinatura": "http://example.com/assinaturasignature.jpg",
"assinatura": [
"string"
],
"hash_mobile": "hash123",
"desconto_diferenciado_tabela_preco": 10"10%",
"estado_civil": "SOLTEIROSolteiro",
"inscricao_municipal": "123456",
"data_inativo": "2024-08-2831/12/2023",
"valor_limite_credito": 100010000,
"crea_cfta": "123456CREA123",
"prestador": "SIMS",
"representante": "SIMN",
"fornecedor": "SIMS",
"cliente": "SIMS",
"engenheiro": "SIMN",
"tecnico_agricola": "SIMS",
"consulente": "SIMN",
"fisica_juridica": "FISICAF",
"codigo_externo": "EXT123EXT001",
"ativo": "SIMS",
"data_alteracao": "2024-08-28T1728T20:3857:5926.317Z683Z",
"pessoa_procurador": {[
{
"id": 0, "codigo_externo_procuradorid": "string"0,
"id_procurador": 0,
"ativo": "string",
"data_inativo": "2024-08-28",
"data_limite": "2024-08-28",
"codigo_externo": "string"
}
],
"pessoa_representante": [
{
"id": 0,
"nome": "string",
"codigo_externo_canal_venda": "string",
"id_canal_venda": 0,
"margem_minima": 0,
"data_inativo": "2024-08-28",
"codigo_externo": "string"
}
],
"carteira_representante": [
{
"id": 0,
"id_endereco": 0,
"id_representante": 0,
"id_filial": 0
}
],
"familiares": [
{
"id": 01,
"id_pessoa": "string12345",
"id_pessoa_familia": 067890,
"codigo_externo_pessoa_familianome": "string",João da "nome": "string"Silva",
"data_nascimento": "2024-08-28",
"cpf": "string12345678901",
"rg": "stringMG1234567",
"telefone": "string31987654321",
"email": "stringjoao.silva@example.com",
"tipo_vinculo": "stringP",
"codigo_externo": "stringEXT123"
}
],
"enderecos": [
{
"contatos": [
{
"id": 01,
"descricao": "stringContato principal",
"id_endereco": 012345,
"id_contato": 067890,
"codigo_externo": "stringEXT123"
}
],
"id": 01,
"id_pessoa": 012345,
"id_tipo_logradouro": 067890,
"codigo_externo_tipo_logradouroid_cidade": "string"54321,
"id_cidaderegiao": 098765,
"codigoid_externoendereco_cidadeclassificacao": "string"11223,
"idinscricao_regiaoprodutor": 0"123456789",
"codigo_externo_regiaonumero": "string123",
"id_endereco_classificacaologradouro": 0"Rua Exemplo",
"codigo_externo_endereco_classificacaobairro": "stringCentro",
"inscricao_produtorcep": "string12345678",
"numerotipo_endereco": "stringR",
"logradouroprodutor": "stringS",
"bairrocomplemento": "stringApto 101",
"ceplatitude": "string"-19.8157,
"tipo_enderecolongitude": "string"-43.9542,
"produtordata_validade_inscricao_suframa": "string2024-08-28",
"complementoinscricao_suframa": "string123456789",
"latitudecontribuinte_icms": 0"S",
"longitude": 0,
"data_validade_inscricao_suframa": "2024-08-28",
"inscricao_suframa": "string",
"contribuinte_icms": "string",
"consumidor_consumidor_final": "stringS",
"obriga_nfpe": "stringS",
"cpf_cnpj": "string12345678901",
"data_validade_inscricao_estadual": "2024-08-28",
"nome": "stringEndereço Exemplo",
"codigo_externo": "stringEXT123",
"ativo": "stringS"
}
],
"contatos": [
{
"id": 1,
"descricao": "Contato principal",
"id_pessoa": 2,
"id_contato": 3
}
],
"anexos": [
{
"id": 1,
"id_pessoa": 2,
"id_tipo_documento": 3,
"codigo_externo_tipo_documentoextensao": "DOC123pdf",
"extensao": "pdf",
"urlurl_anexo": "http://example.com/anexo.pdf",
"anexo": [
"string"
],
"observacao": "Documento importante",
"codigo_externo": "ANX123"
}
],
"referenciastabelas_de_bancariaspreco": [
{
"id": 01,
"id_pessoa": 012345,
"id_tabela_bancopreco": 067890,
"codigo_externo_bancopadrao": "stringS",
}
"agencia": "string" ],
"limites": [
"conta": "string", {
"situacaoid": "string"1,
"favorecidoid_pessoa": "string"12345,
"cpf_cnpjid_limite_credito_tipo": "string"67890,
"tipodata_vigencia_containicial": "string2024-08-28",
"observacaodata_vigencia_final": "string2024-08-28",
"codigo_externoobservacao": "string"Limite de crédito aprovado para o }ano fiscal de ]2023",
"referencias_comerciais": [ {"valor": 10000,
"idpendente": 0"S",
"idcodigo_pessoaexterno": 0,
"EXT123"
}
],
"nomereferencias": "string",{
"cargoreferencias_bancarias": "string",[
{
"contato": "string", "telefoneid": "string"1,
"observacaoid_pessoa": "string"12345,
"codigoid_externobanco": "string"
67890,
} ], "referencias_pessoaisagencia": [
"1234-5",
{ "idconta": 0"123456-7",
"id_pessoasituacao": 0"A",
"nomefavorecido": "stringJoão da Silva",
"telefonecpf_cnpj": "string12345678901",
"observacaotipo_conta": "stringCC",
"codigo_externoobservacao": "string"Conta utilizada para recebimento de salário",
} "codigo_externo": "EXT456"
}
],
"atividadesreferencias_empregadocomerciais": [
{
"id": 1,
"id_pessoa": 212345,
"empresanome": "Empresa XYZ",
"cpf_cnpjcargo": "12345678901234Gerente de Vendas",
"telefonecontato": "1234567890João da Silva",
"ocupacaotelefone": "Gerente11987654321",
"data_admissaoobservacao": "2024-08-28",
"rendimento_mensal": 5000,Cliente há mais de 5 anos",
"codigo_externo": "EXT456EXT123"
}
],
"atividadesreferencias_aposentadopessoais": [
{
"id": 1,
"id_pessoa": 212345,
"instituicaonome": "INSSMaria da Silva",
"tipo_beneficiotelefone": "A11987654321",
"cpf_cnpjobservacao": "12345678901234",Amiga de longa data",
"rendimento_mensal": 2000, "codigo_externo": "EXT456EXT123"
}
]
},
"atividades_proprietarioeconomicas": {
"atividades_empregado": [
{
"id": 1,
"id_pessoa": 2,
"empresa": "Empresa XYZ",
"cpf_cnpj": "12345678901234",
"faturamento_mensal "telefone": "1234567890",
"ocupacao": 10000"Gerente",
"percentualdata_participacaoadmissao": 50,"2024-08-28",
"temporendimento_existenciamensal": 55000,
"codigo_externo": "EXT456"
}
],
"atividades_autonomoaposentado": [
{
"id": 1,
"id_pessoa": 2,
"profissaoinstituicao": "EngenheiroINSS",
"tempotipo_profissaobeneficio": 10"A",
"rendimentocpf_mensalcnpj": 5000"12345678901234",
"codigorendimento_externomensal": "EXT456"2000,
} ], "atividadescodigo_agropecuarioexterno": "EXT456"
[ }
{ ],
"idatividades_proprietario": [
1, {
"id_pessoa": 2, "id_atividade": 31,
"codigoid_externo_atividadepessoa": "EXT123"2,
"nivel_tecnologicoempresa": "ALTOEmpresa XYZ",
"datacpf_iniciocnpj": "2024-08-2812345678901234",
"producaofaturamento_mensal": 10010000,
"unidadepercentual_participacao": "TON"50,
"rendimentotempo_anualexistencia": 1000005,
"codigo_externo": "EXT456"
} }
],
"atividades_agricolaautonomo": [
{
"id": 1,
"id_pessoa": 2,
"id_atividadeprofissao": 3"Engenheiro",
"codigotempo_externo_atividadeprofissao": "EXT123"10,
"idrendimento_pessoa_enderecomensal": 45000,
"codigo_externo_endereco": "END123EXT456",
"id_cultura": 5,}
],
"codigoatividades_externo_culturaagropecuario": [
"CULT123", {
"id_safra": 6, "codigo_externo_safraid": "SAF123"1,
"nivelid_tecnologicopessoa": "ALTO"2,
"dataid_inicioatividade": "2024-08-28"3,
"datacodigo_externo_conclusaoatividade": "2024-08-28EXT123",
"areanivel_ativatecnologico": "SIMALTO",
"areadata_plantadainicio": 100"2024-08-28",
"producao_anual": 500100,
"faturamento_anualunidade": 100000"TON",
"analiserendimento_creditoanual": "SIM"100000,
"codigo_externo": "EXT456"
}
],
"patrimoniosatividades_bem_semoventesagricola": [
{
"id": 01,
"id_pessoa": 02,
"especieid_atividade": "string"3,
"quantidadecodigo_externo_atividade": 0"EXT123",
"categoriaid_pessoa_endereco": "string"4,
"racacodigo_externo_endereco": "stringEND123",
"tipoid_onuscultura": "string"5,
"credor "codigo_externo_cultura": "stringCULT123",
"saldoid_devedorsafra": 06,
"valorcodigo_externo_mercadosafra": 0"SAF123",
"produtividadenivel_tecnologico": 0"ALTO",
"codigodata_externoinicio": "string2024-08-28",
} ],
"patrimoniosdata_bem_moveisconclusao": [
"2024-08-28",
{ "idarea_ativa": 0"SIM",
"idarea_pessoaplantada": 0100,
"tipoproducao_bem_movelanual": "string"500,
"nomefaturamento_anual": "string"100000,
"anoanalise_fabricacaocredito": 0"SIM",
"placacodigo_chassiexterno": "stringEXT456",
}
"antt": "string",
]
},
"conservacaopatrimonios": {
"string", "patrimonios_bem_semoventes": [
{
"valor_mercado": 0, "marcaid": "string"1,
"modeloid_pessoa": "string"12345,
"descricaoespecie": "stringB",
"quantidade": 050,
"codigo_externocategoria": "stringLeiteiro"
,
} ], "patrimonios_imoveis_arrendadosraca": ["Holandês",
{
"idtipo_onus": 0"H",
"id_cidadecredor": "Banco 0XYZ",
"codigosaldo_externo_cidadedevedor": "string"5000,
"idvalor_matriculamercado": 015000,
"codigo_externo_matricula "produtividade": "string"20.5,
"idcodigo_pessoa_enderecoexterno": 0,"EXT123"
}
"nome": "string", ],
"areapatrimonios_bem_totalmoveis": 0,[
"area_cultivada": 0,{
"proprietarioid": "string"1,
"cpfid_cnpjpessoa": "string"12345,
"valortipo_bem_anualmovel": 0"A",
"data_vigencianome": "2024-08-28Trator",
"descricaoano_fabricacao": "string"2020,
"codigoplaca_externochassi": "stringABC1234"
,
} ], "patrimonios_imoveis_propriosantt": ["1234567890",
{ "idconservacao": 0"B",
"idvalor_cidademercado": 0150000,
"codigo_externo_cidade "marca": "stringJohn Deere",
"id_matriculamodelo": "Modelo 0X",
"codigo_externo_matriculadescricao": "stringTrator agrícola",
"id_pessoa_enderecoquantidade": 02,
"nomecodigo_externo": "stringEXT123",
}
"area_total": 0, ],
"tipopatrimonios_imoveis_imovelarrendados": [
"string", {
"natureza": "string", "area_cultivadaid": 01,
"situacaoid_imovelcidade": "string"12345,
"valorcodigo_externo_mercadocidade": 0"EXT123",
"valorid_hectarematricula": 067890,
"condominio "codigo_externo_matricula": "stringEXT456",
"percentualid_pessoa_condominioendereco": 011223,
"descricaonome": "stringFazenda Arrendada",
"codigoarea_externototal": "string",100.5,
"onusarea_imovelcultivada": [80,
{
"proprietario": "João da Silva",
"idcpf_cnpj": 0"12345678901",
"id_pessoa_patrimonio_imovelvalor_anual": 050000,
"codigo_externo_patrimonio_imoveldata_vigencia": "string2024-08-28",
"tipo_onusdescricao": "string",
Fazenda arrendada para cultivo de soja",
"graucodigo_externo": 0, "EXT789"
}
],
"hectarepatrimonios_imoveis_proprios": 0, [
{
"credorid": "string"1,
"anoid_vencimentocidade": 012345,
"saldocodigo_externo_devedorcidade": 0"EXT123",
"observacaoid_matricula": "string"67890,
"codigo_externo_matricula": "stringEXT456",
}
"id_pessoa_endereco": 11223,
] "nome": "Fazenda Própria",
} ], "patrimonios_outros_imoveis "area_total": [
100.5,
{ "idtipo_imovel": 0"A",
"id_cidadenatureza": 0"E",
"codigoarea_externo_cidadecultivada": "string"80,
"idsituacao_matriculaimovel": 0"Q",
"codigovalor_externo_matriculamercado": "string"500000,
"idvalor_pessoa_enderecohectare": 05000,
"nomecondominio": "stringN",
"areapercentual_totalcondominio": 050,
"tipo_imoveldescricao": "stringFazenda própria para cultivo de soja",
"valorcodigo_mercadoexterno": 0"EXT789",
"situacaoonus_imovel": [
"string", "conservacao": "string", {
"descricao": "string", "codigo_externoid": "string"1,
"onus_imovel "descricao": [ "Hipoteca"
}
{ ]
"id": 0, }
],
"idpatrimonios_pessoaoutros_patrimonio_imovelimoveis": 0, [
{
"codigo_externo_patrimonio_imovelid": "string"1,
"tipoid_onuscidade": "string"12345,
"graucodigo_externo_cidade": 0"EXT123",
"hectareid_matricula": 067890,
"credorcodigo_externo_matricula": "stringEXT456",
"anoid_pessoa_vencimentoendereco": 011223,
"saldo_devedornome": 0"Fazenda",
"observacaoarea_total": "string"100.5,
"codigotipo_externoimovel": "stringA",
}
"valor_mercado": 500000,
] "situacao_imovel": }"Q",
] }
Responses |
Campos:
...
codigo: Código do registro no banco de dados do CRM
...
id_pessoa_grupo: ID do grupo da pessoa
...
id_tipo_cliente: ID do tipo de cliente
...
id_comissao: ID da comissão padrão do cliente
...
identificacao: Identificação da pessoa
...
cpf_cnpj: CPF ou CNPJ da pessoa
...
categoria_pessoa: Categoria da pessoa
...
id_situacao_duplicata_padrao: ID da situação padrão da duplicata
...
id_pessoa_conceito: ID do conceito da pessoa
...
nome_razao_social: Nome ou razão social da pessoa
...
apelido_nome_fantasia: Apelido ou nome fantasia da pessoa
...
data_nascimento_fundacao: Data de nascimento ou fundação
...
data_vigencia_final_limite_credito: Data de vencimento do limite de crédito
...
associado: Indica se a pessoa é associada Valores aceitos: S (Sim), N (Não)
...
revenda: Indica se é uma revenda Valores aceitos: S (Sim), N (Não)
...
matricula: Matrícula
...
obriga_numero_pedido_terceiro: Indica se obriga número de pedido de terceiro Valores aceitos: S (Sim), N (Não)
...
data_vigencia_inicio_limite_credito: Data de início da vigência do limite de crédito
...
genero: Gênero da pessoa Valores aceitos: M (Masculino), F (Feminino), J (Jurídico)
...
shelf_life_ativo: Indica se o shelf life está ativo Valores aceitos: S (Sim), N (Não)
...
shelf_life_minimo: Shelf life mínimo
...
shelf_life_maximo: Shelf life máximo
...
url_imagem: URL da imagem da pessoa
...
imagem: Imagem da pessoa em bytes
...
url_assinatura: URL da assinatura da pessoa
...
assinatura: Assinatura da pessoa em bytes
...
hash_mobile: Hash mobile indicando que a pessoa foi cadastrada pelo aplicativo mobile desconto_diferenciado_tabela_preco: Desconto diferenciado na tabela de preço
...
estado_civil: Estado civil da pessoa
...
inscricao_municipal: Inscrição municipal da empresa
...
data_inativo: Data de inativação
...
valor_limite_credito: Valor do limite de crédito
...
crea_cfta: CREA ou CFTA da pessoa
...
prestador: Indica se a pessoa é prestador Valores aceitos: S (Sim), N (Não)
...
representante: Indica se a pessoa é representante Valores aceitos: S (Sim), N (Não)
...
fornecedor: Indica se a pessoa é fornecedor Valores aceitos: S (Sim), N (Não)
...
cliente: Indica se a pessoa é cliente Valores aceitos: S (Sim), N (Não)
...
engenheiro: Indica se a pessoa é engenheiro Valores aceitos: S (Sim), N (Não)
...
tecnico_agricola: Indica se a pessoa é técnico agrícola Valores aceitos: S (Sim), N (Não)
...
consulente: Indica se a pessoa é consulente Valores aceitos: S (Sim), N (Não)
...
fisica_juridica: Indica se a pessoa é física ou jurídica
...
codigo_externo: Código externo da pessoa
...
ativo: Indica se a pessoa está ativa Valores aceitos: S (Sim), N (Não)
...
"conservacao": "B",
"descricao": "Fazenda para cultivo de soja",
"codigo_externo": "EXT789",
"onus_imovel": [
{
"id": 1,
"id_pessoa_patrimonio_imovel": 12345,
"tipo_onus": "H",
"grau": 1,
"hectare": 50,
"credor": "Banco XYZ",
"ano_vencimento": 2025,
"saldo_devedor": 100000,
"observacao": "Hipoteca referente ao financiamento do imóvel",
"codigo_externo": "EXT123"
}
]
}
]
}
} |
Campos:
codigo: Código do registro no banco de dados do CRM
id_pessoa_grupo: ID do grupo da pessoa
id_tipo_cliente: ID do tipo de cliente
id_comissao: ID da comissão padrão do cliente
identificacao: Identificação da pessoa
cpf_cnpj: CPF ou CNPJ da pessoa
categoria_pessoa: Categoria da pessoa
id_situacao_duplicata_padrao: ID da situação padrão da duplicata
id_pessoa_conceito: ID do conceito da pessoa
nome_razao_social: Nome ou razão social da pessoa
apelido_nome_fantasia: Apelido ou nome fantasia da pessoa
data_nascimento_fundacao: Data de nascimento ou fundação
data_vigencia_final_limite_credito: Data de vencimento do limite de crédito
associado: Indica se a pessoa é associada Valores aceitos: S (Sim), N (Não)
revenda: Indica se é uma revenda Valores aceitos: S (Sim), N (Não)
matricula: Matrícula
obriga_numero_pedido_terceiro: Indica se obriga número de pedido de terceiro Valores aceitos: S (Sim), N (Não)
data_vigencia_inicio_limite_credito: Data de início da vigência do limite de crédito
genero: Gênero da pessoa Valores aceitos: M (Masculino), F (Feminino), J (Jurídico)
shelf_life_ativo: Indica se o shelf life está ativo Valores aceitos: S (Sim), N (Não)
shelf_life_minimo: Shelf life mínimo
shelf_life_maximo: Shelf life máximo
url_imagem: URL da imagem da pessoa
imagem: Imagem da pessoa em bytes
url_assinatura: URL da assinatura da pessoa
assinatura: Assinatura da pessoa em bytes
hash_mobile: Hash mobile indicando que a pessoa foi cadastrada pelo aplicativo mobile
desconto_diferenciado_tabela_preco: Desconto diferenciado na tabela de preço
estado_civil: Estado civil da pessoa
inscricao_municipal: Inscrição municipal da empresa
data_inativo: Data de inativação
valor_limite_credito: Valor do limite de crédito
crea_cfta: CREA ou CFTA da pessoa
prestador: Indica se a pessoa é prestador Valores aceitos: S (Sim), N (Não)
representante: Indica se a pessoa é representante Valores aceitos: S (Sim), N (Não)
fornecedor: Indica se a pessoa é fornecedor Valores aceitos: S (Sim), N (Não)
cliente: Indica se a pessoa é cliente Valores aceitos: S (Sim), N (Não)
engenheiro: Indica se a pessoa é engenheiro Valores aceitos: S (Sim), N (Não)
tecnico_agricola: Indica se a pessoa é técnico agrícola Valores aceitos: S (Sim), N (Não)
consulente: Indica se a pessoa é consulente Valores aceitos: S (Sim), N (Não)
fisica_juridica: Indica se a pessoa é física ou jurídica
codigo_externo: Código externo da pessoa
ativo: Indica se a pessoa está ativa Valores aceitos: S (Sim), N (Não)
pessoa_procurador (Dados específicos caso a pessoa seja um procurador).
id: ID do registro no banco de dados do CRM
id_procurador: ID do procurador
ativo: Indica se o procurador está ativo Valores aceitos: S (Sim), N (Não)
data_inativo: Data de inativação do procurador
data_limite: Data limite da procuração
codigo_externo: Código externo
pessoa_representante (Dados específicos caso a pessoa seja um representante).
id: ID do representante
nome: Nome do representante
id_canal_venda: ID do canal de venda
margem_minima: Margem mínima de venda
data_inativo: Data de inativação do representante
codigo_externo: Código externo do representante
carteira_representante (Vínculo entre os representantes e os endereços das pessoas).
id: ID da carteira do representante
id_endereco: ID do endereço da pessoa
id_representante: ID do representante
id_filial: ID da filial do representante
familiares (Lista de familiares da pessoa)
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
id_pessoa_familia: ID da pessoa da família
nome: Nome da pessoa da família
data_nascimento: Data de nascimento da pessoa da família
cpf: CPF da pessoa da família
rg: RG da pessoa da família
telefone: Telefone da pessoa da família
email: Email da pessoa da família
tipo_vinculo: Tipo de vínculo da pessoa da família. Valores disponíveis: C (Cônjuge), F (Filho), P (Pai), M (Mãe)
codigo_externo: Código externo da pessoa da família
enderecos (Lista de endereços da pessoa).
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
id_tipo_logradouro: ID do tipo de logradouro
id_cidade: ID da cidade
id_regiao: ID da região
id_endereco_classificacao: ID da classificação do endereço
inscricao_produtor: Inscrição do produtor
numero: Número do endereço
logradouro: Logradouro do endereço
bairro: Bairro do endereço
cep: CEP do endereço
tipo_endereco: Tipo de endereço. Valores disponíveis: C (Cobrança), P (Principal), A (Alternativo)
produtor: Indica se o endereço é de um produtor. Valores disponíveis: S (Sim), N (Não)
complemento: Complemento do endereço
latitude: Latitude do endereço
longitude: Longitude do endereço
data_validade_inscricao_suframa: Data de validade da inscrição no SUFRAMA
inscricao_suframa: Inscrição no SUFRAMA
contribuinte_icms: Indica se é contribuinte de ICMS. Valores disponíveis: S (Sim), N (Não)
consumidor_final: Indica se é consumidor final. Valores disponíveis: S (Sim), N (Não)
obriga_nfpe: Indica se obriga NFPE. Valores disponíveis: S (Sim), N (Não)
cpf_cnpj: CPF ou CNPJ do endereço
data_validade_inscricao_estadual: Data de validade da inscrição estadual
nome: Nome do endereço
codigo_externo: Código externo do endereço
ativo: Indica se o endereço está ativo. Valores disponíveis: S (Sim), N (Não)
contatos: Lista com os contatos específicos do endereço.
id: ID do registro no banco de dados do CRM
descricao: Descrição do contato
id_endereco: ID do endereço
id_contato: ID do contato
codigo_externo: Código externo do contato
talhoes ( Lista de talhões da pessoa )
id: ID do talhão
id_pessoa: ID da pessoa associada ao talhão
id_endereco: ID do endereço da pessoa
id_cultura: ID da cultura associada ao talhão
id_safra: ID da safra associada ao talhão
descricao: Descrição do talhão
area: Área do talhão em hectares
nivel_tecnologico: Nível tecnológico do talhão. Valores disponíveis: B (Baixo), M (Médio), A (Alto)
latitude: Latitude do talhão
longitude: Longitude do talhão
codigo_externo: Código externo do talhão
contatos (Lista de contatos da pessoa)
id: ID único do contato
descricao: Descrição do contato
id_pessoa: ID da pessoa associada ao contato
id_contato: ID do contato
anexos (Lista de anexos da pessoa)
id: ID único do anexo
id_pessoa: ID da pessoa associada ao anexo
id_tipo_documento: ID do tipo de documento
extensao: Extensão do anexo
url_anexo: URL do anexo
anexo: Anexo em bytes
observacao: Observação sobre o anexo
codigo_externo: Código externo do anexo
limites (Limites de crédito da pessoa)
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
id_limite_credito_tipo: ID do tipo de limite de crédito
data_vigencia_inicial: Data de vigência inicial do limite de crédito
data_vigencia_final: Data de vigência final do limite de crédito
observacao: Observação sobre o limite de crédito
valor: Valor do limite de crédito
pendente: Indica se o limite de crédito está pendente. Valores disponíveis: S (Sim), N (Não)
codigo_externo: Código externo do limite de crédito
forma_pagamento (Lista das formas de pagamento associadas a pessoa).
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
id_forma_pagamento: ID da forma de pagamento
padrao: Indica se é a forma de pagamento padrão. Valores disponíveis: S (Sim), N (Não)
codigo_externo: Código externo da forma de pagamento
forma_parcelamento (Lista das formas de parcelamento associadas a pessoa).
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
id_forma_parcelamento: ID da forma de parcelamento
padrao: Indica se é a forma de parcelamento padrão. Valores disponíveis: S (Sim), N (Não)
tipo: Tipo de correção. Valores disponíveis: A (Acréscimo), D (Desconto)
percentual_correcao: Percentual de correção
codigo_externo: Código externo da forma de parcelamento
referencias (Lista das referências associadas a pessoa).
referencias_bancarias (Lista das referências bancárias da pessoa).
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
id_banco: ID do banco
agencia: Agência bancária
conta: Número da conta bancária
situacao: Situação bancária. Valores disponíveis: L(Liberado), B(Bloqueado)
favorecido: Nome do favorecido
cpf_cnpj: CPF ou CNPJ do favorecido
tipo_conta: Tipo de conta. Valores disponíveis: CC (Conta Corrente), CP (Conta Poupança), CS (Conta Salário), OU (Outros)
observacao: Observações sobre a referência bancária
codigo_externo: Código externo da referência bancária
referencias_comerciais (Lista das referências comerciais da pessoa)
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
nome_referencia: Nome da referência comercial
telefone: Telefone da referência comercial
email: Email da referência comercial
observacao: Observações sobre a referência comercial
codigo_externo: Código externo da referência comercial
referencias_pessoais (Lista das referências pessoais da pessoa)
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
nome: Nome da referência pessoal
telefone: Telefone de contato
observacao: Observações sobre a referência pessoal
codigo_externo: Código externo da referência pessoal
atividades_economicas (Lista das atividades econômicas da pessoa).
atividades_empregado (Lista das atividades econômicas com vínculo empregatício)
id: ID único da atividade econômica empregado
id_pessoa: ID da pessoa associada à atividade econômica empregado
empresa: Nome da empresa
cpf_cnpj: CPF ou CNPJ da empresa
telefone: Telefone da empresa
ocupacao: Ocupação do empregado
data_admissao: Data de admissão do empregado
rendimento_mensal: Rendimento mensal em reais
codigo_externo: Código externo da atividade econômica empregado
atividades_aposentado (Lista das atividades econômicas relacionadas a aposentadoria da pessoa)
id: ID único da atividade econômica aposentado
id_pessoa: ID da pessoa associada à atividade econômica aposentado
instituicao: Instituição responsável pelo benefício
tipo_beneficio: Tipo de benefício recebido (valores possíveis: A (Aposentado), P (Pensionista))
cpf_cnpj: CPF ou CNPJ da instituição
rendimento_mensal: Rendimento mensal em reais
codigo_externo: Código externo da atividade econômica aposentado
atividades_proprietario (Lista das atividades econômicas na qual a pessoa é o proprietário)
id: ID único da atividade econômica proprietário
id_pessoa: ID da pessoa associada à atividade econômica proprietário
empresa: Nome da empresa
cpf_cnpj: CPF ou CNPJ da empresa
faturamento_mensal: Faturamento mensal em reais
percentual_participacao: Percentual de participação
tempo_existencia: Tempo de existência da empresa em anos
codigo_externo: Código externo da atividade econômica proprietário
atividades_autonomo (Lista das atividades econômicas na qual a pessoa é autônoma)
id: ID único da atividade econômica autônomo
id_pessoa: ID da pessoa associada à atividade econômica autônomo
profissao: Profissão do autônomo
tempo_profissao: Tempo de profissão em anos
rendimento_mensal: Rendimento mensal em reais
codigo_externo: Código externo da atividade econômica autônomo
atividades_agropecuario (Lista das atividades econômicas relacionadas ao setor agropecuário)
id: ID único da atividade econômica agropecuária
id_pessoa: ID da pessoa associada à atividade econômica agropecuária
id_atividade: ID da atividade
nivel_tecnologico: Nível tecnológico utilizado. Valores Aceitos: (A) Alto - (M) Médio - (B) Baixo
data_inicio: Data de início da atividade
producao: Produção em unidades
unidade: Unidade de medida da produção
rendimento_anual: Rendimento anual em reais
codigo_externo: Código externo da atividade econômica agropecuária
atividades_agricola (Lista das atividades econômicas relacionadas ao setor agrícola)
id: ID único da atividade econômica agrícola
id_pessoa: ID da pessoa associada à atividade econômica agrícola
id_atividade: ID da atividade
id_pessoa_endereco: ID do endereço da pessoa
id_cultura: ID da cultura
id_safra: ID da safra
nivel_tecnologico: Nível tecnológico utilizado (valores aceitos: A (Alto), M (Médio), B (Baixo))
data_inicio: Data de início da atividade
data_conclusao: Data de conclusão da atividade
area_ativa: Indica se a área está ativa
area_plantada: Área plantada em hectares
producao_anual: Produção anual em toneladas
faturamento_anual: Faturamento anual em reais
analise_credito: Indica se a atividade está sujeita a análise de crédito
codigo_externo: Código externo da atividade econômica agrícola
patrimonios (Lista com os patrimônios da pessoa)
familiares (Lista de familiares da pessoa)patrimonios_bem_semoventes (Lista de patrimônios de bens semoventes)
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
especie: Espécie do bem semovente. Valores disponíveis: B (Bovinos/Bubalinos), S (Suínos), C (Ovinos/Caprinos), A (Aves), E (Equinos), O (Outros)
quantidade: Quantidade de bens semoventes
categoria: Categoria do bem semovente
raca: Raça do bem semovente
tipo_onus: Tipo de ônus. Valores disponíveis: H (Hipoteca), A (Averbação), P (Penhor), L (Alienação)
credor: Nome do credor
saldo_devedor: Saldo devedor do bem semovente
valor_mercado: Valor de mercado do bem semovente
produtividade: Produtividade do bem semovente
codigo_externo: Codigo externo do bem semovente
patrimonios_bem_moveis (Lista de patrimônios de bens móveis)
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
tipo_bem_movel: Tipo de bem móvel. Valores disponíveis: A (Automóveis), M (Motocicletas), T (Tratores), H (Colheitadeiras), P (Plantadeiras), L (Pulverizadores), C (Caminhões), O (Outros Equipamentos)
nome: Nome do bem móvel
ano_fabricacao: Ano de fabricação do bem móvel
placa_chassi: Placa ou chassi do bem móvel
antt: Número ANTT do bem móvel
conservacao: Conservação do bem móvel. Valores disponíveis: P (Péssimo), M (Ruim), R (Regular), B (Bom), O (Ótimo), E (Excelente)
valor_mercado: Valor de mercado do bem móvel
marca: Marca do bem móvel
modelo: Modelo do bem móvel
descricao: Descrição do bem móvel
quantidade: Quantidade de bens móveis
codigo_externo: Código externo do bem móvel
patrimonios_imoveis_arrendados (Lista de patrimônios de imóveis arrendados)
id: ID do registro no banco de dados do CRM
id_cidade: ID da cidade
id_matricula: ID da matrícula
id_pessoa_endereco: ID do endereço da pessoa
nome: Nome do imóvel arrendado
area_total: Área total do imóvel arrendado
area_cultivada: Área cultivada do imóvel arrendado
proprietario: Nome do proprietário
cpf_cnpj: CPF ou CNPJ do proprietário
valor_anual: Valor anual do arrendamento
data_vigencia: Data de vigência do arrendamento
descricao: Descrição do imóvel arrendado
codigo_externo: Código externo do imóvel arrendado
patrimonios_imoveis_proprios (Lista de patrimônios de imóveis próprios)
id: ID do registro no banco de dados do CRM
id_cidade: ID da cidade
id_matricula: ID da matrícula
id_pessoa_
endereco: ID
ativo: Indica se o procurador está ativo Valores aceitos: S (Sim), N (Não)
data_inativo: Data de inativação do procurador
data_limite: Data limite da procuração
codigo_externo: Código externo
pessoa_representante (Dados específicos caso a pessoa seja um representante).
id: ID do representante
nome: Nome do representante
id_canal_venda: ID do canal de venda
margem_minima: Margem mínima de venda
data_inativo: Data de inativação do representante
codigo_externo: Código externo do representante
carteira_representante (Vínculo entre os representantes e os endereços das pessoas).
id: ID da carteira do representante
id_endereco: ID do endereço da pessoa
id_representante: ID do representante
id_filial: ID da filial do representante
do endereço da pessoa
nome: Nome do imóvel próprio
area_total: Área total do imóvel próprio
tipo_imovel: Tipo de imóvel. Valores disponíveis: T (Terrenos Urbanos), C (Casas), A (Apartamentos/Afins), R (Armazéns e Silos), G (Galpão/Instalações), O (Outras Instalações), L (Loja), S (Sala Comercial), P (Prédio Comercial)
natureza: Natureza do imóvel. Valores disponíveis: E (Escritura de Compra), C (Cessão de Direitos), V (Contrato de Compra e Venda)
area_cultivada: Área cultivada do imóvel próprio
situacao_imovel: Situação do imóvel. Valores disponíveis: Q (Quitado), A (A pagar)
valor_mercado: Valor de mercado do imóvel próprio
valor_hectare: Valor por hectare do imóvel próprio
condominio: Condomínio. Valores disponíveis: S (Sim), N (Não)
percentual_condominio: Percentual de condomínio do imóvel próprio
descricao: Descrição do imóvel próprio
codigo_externo: Código externo do imóvel próprio
onus_imovel: Lista de ônus do imóvel próprio
id: ID do registro no banco de dados do CRM
id_
pessoa
_
patrimonio_
imovel: ID do patrimônio imóvel da pessoa
nome: Nome da pessoa da família
data_nascimento: Data de nascimento da pessoa da família
cpf: CPF da pessoa da família
rg: RG da pessoa da família
telefone: Telefone da pessoa da família
email: Email da pessoa da família
tipo_onus: Tipo de ônus. Valores disponíveis:
H (
Hipoteca),
A (
Averbação), P (
Penhor),
L (
Alienação)
grau: Grau do ônus
hectare: Área em hectares afetada pelo ônus
credor: Nome do credor
ano_vencimento: Ano de vencimento do ônus
saldo_devedor: Saldo devedor do ônus
observacao: Observações sobre o ônus
codigo_externo: Código externo
enderecos (Lista de endereços da pessoa).
id: ID do registro no banco de dados do CRM
id_pessoa: ID da pessoa
- id_tipo_logradouro: ID do tipo de logradouro
do ônus
patrimonios_outros_imoveis (Lista de outros patrimônios de imóveis)
id: ID do registro no banco de dados do CRM
id_cidade: ID da cidade
id_
matricula: ID da
matrícula
id_pessoa_endereco
: ID
do endereço da pessoa
nome:
Nome do
imóvel
numero: Número do endereço
logradouro: Logradouro do endereço
bairro: Bairro do endereço
cep: CEP do endereço
tipo_endereco: Tipo de endereço. Valores disponíveis: C (Cobrança), P (Principal), A (Alternativo)
produtor: Indica se o endereço é de um produtor. Valores disponíveis: S (Sim), N (Não)
complemento: Complemento do endereço
latitude: Latitude do endereço
longitude: Longitude do endereço
data_validade_inscricao_suframa: Data de validade da inscrição no SUFRAMA
inscricao_suframa: Inscrição no SUFRAMA
contribuinte_icms: Indica se é contribuinte de ICMS. Valores disponíveis: S (Sim), N (Não)
consumidor_final: Indica se é consumidor final. Valores disponíveis: S (Sim), N (Não)
obriga_nfpe: Indica se obriga NFPE. Valores disponíveis: S (Sim), N (Não)
cpf_cnpj: CPF ou CNPJ do endereço
data_validade_inscricao_estadual: Data de validade da inscrição estadual
area_total: Área total do imóvel
tipo_imovel: Tipo de imóvel. Valores disponíveis: T (Terrenos Urbanos), C (Casas), A (Apartamentos/Afins), R (Armazéns e Silos), G (Galpão/Instalações), O (Outras Instalações), L (Loja), S (Sala Comercial), P (Prédio Comercial)
valor_mercado: Valor de mercado do imóvel
situacao_imovel: Situação do imóvel. Valores disponíveis: Q (Quitado), A (A pagar)
conservacao: Conservação do imóvel. Valores disponíveis: P (Péssimo), M (Ruim), R (Regular), B (Bom), O (Ótimo), E (Excelente)
descricao: Descrição do imóvel
codigo_externo: Código externo do imóvel
onus_imovel: Lista de ônus do imóvel
id: ID do registro no banco de dados do CRM
id_pessoa_patrimonio_imovel: ID do patrimônio imóvel da pessoa
tipo_onus: Tipo de ônus. Valores disponíveis: H (Hipoteca), A (Averbação), P (Penhor), L (Alienação)
grau: Grau do ônus
hectare: Área em hectares afetada pelo ônus
credor: Nome do credor
ano_vencimento: Ano de vencimento do ônus
saldo_devedor: Saldo devedor do ônus
observacao: Observações sobre o ônus
codigo_externo: Código externo do
ativo: Indica se o endereço está ativo. Valores disponíveis: S (Sim), N (Não)
ônus
Todos os endpoints, com exceção do deletar, retornam o json nesse formato.
...
2.1 - Buscar pessoa pelo código
Endpoint: /pessoa
Tipo: get
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da pessoa no banco de dados do CRM.
codigoExterno:Tipo: String.Código da pessoa no banco de dados do sistema integrado
...
Resposta: Status 200 - Retorna a pessoa no formato documentado na sessão Exemplo do json
2.2 - Buscar todas
...
as pessoas
Endpoint: /pessoa/todos
Tipo: get
Resposta: Status 200 - Retorna a lista das pessoas no formato documentado na sessão Exemplo do json
2.3 - Cadastrar ou editar pessoa
Endpoint:/pessoa
Tipo: post
Notas:
Informe no corpo da requisição o json conforme exemplo na sessão 1.
Para cadastrar uma nova pessoa não informe o campo “codigo”;
Para editar uma pessoa já existente informe o campo “codigo” com o código da pessoa que deseja editar;
...
Não é possível deletar uma pessoa, apenas inativar, pois a pessoa pode ter vinculo com pedidos e outros registros. Nesse caso, a pessoa continua no banco de dados porém com o status inativo.
Endpoint:/pessoa
Tipo: delete
Parâmetros:
codigoInterno: Tipo: Inteiro. Código da pessoa no banco de dados do CRM.
codigoExterno:Tipo: String.Código da pessoa no banco de dados do sistema integrado, caso existir.
...
2.5 - Retornar os metadados da pessoa
Endpoint: /pessoa/metadados
Tipo: get
Descrição: Retorna os campos do json, com as informações de tipo, tamanho máximo, se o campo é requerido, filtrável e/ou ordenável
Resposta: Status 200 - Retorna um json com as informações dos campos da pessoa
2.6 - Pesquisar
Endpoint: /pessoa/pesquisa
Tipo: post
Notas:
Esse endpointretorna as peneiras baseado nos filtros e na ordenação informados;
Exemplo do corpo da requisição:
...
2.7 - Vincular familiares a pessoa
Endpoint: /pessoa/familiares
Tipo: post
Parâmetro:
codigoPessoa: Código da pessoa no banco de dados do CRM
...
2.8 - Cadastrar dados dos contatos da pessoa
Endpoint: /pessoa
Tipo: post
Parâmetro:
codigoPessoa: Código da pessoa no banco de dados do CRM
...