Page Comparison

...

1. Exemplo do json:

...

1. Exemplo do json:

Code Block

[
  {
    "codigo": 1,
    "id_pessoa_grupo": 20,
    "id_procuradortipo_cliente": 02,
    "ativoid_comissao": "string"3,
    "data_inativoidentificacao": "2024-08-28123456789",
    "datacpf_limitecnpj": "2024-08-28123.456.789-00",
    "codigocategoria_externopessoa": "stringC",
  },   "pessoa_representanteid_situacao_duplicata_padrao": {4,
    "id_pessoa_conceito": 010,
    "nomerazao_social": "stringEmpresa XYZ",
    "codigoapelido_externonome_canal_vendafantasia": "stringXYZ",
    "iddata_canalnascimento_vendafundacao": 0"01/01/2000",
    "margem_minimadata_vigencia_final_limite_credito": 0"31/12/2023",
    "data_inativoassociado": "2024-08-28S",
    "codigo_externorevenda": "stringN",
  },   "carteira_representantematricula": ["12345",
    {
 "obriga_numero_pedido_terceiro": "S",
    "iddata_vigencia_inicio_limite_credito": 0"01/01/2023",
      "id_enderecogenero": 0"M",
 
    "idshelf_life_representanteativo": 0"S",
 
    "idshelf_life_filialminimo": 030,
    }
"shelf_life_maximo": 90,
 ],   "familiaresurl_imagem": [
    {"http://example.com/image.jpg",
    "imagem": [
      "idstring":
  0,  ],
    "idurl_pessoaassinatura": "stringhttp://example.com/signature.jpg",
 
    "id_pessoa_familiaassinatura": 0,[
      "codigo_externo_pessoa_familia": "string",
 string"
    ],
    "nomehash_mobile": "stringhash123",
 
    "data_nascimentodesconto_diferenciado_tabela_preco": "2024-08-28",
10,
     "cpfestado_civil": "stringS",
      "rginscricao_municipal": "string123456",
      "telefonedata_inativo": "string31/12/2023",
 
    "emailvalor_limite_credito": "string"10000,

     "tipocrea_vinculocfta": "stringCREA123",
      "codigo_externoprestador": "stringS",
    }
"representante": "N",
 ],   "enderecosfornecedor": ["S",
    {
 "cliente": "S",
    "contatosengenheiro": ["N",
    "tecnico_agricola": "S",
  {      "consulente": "N",
    "idfisica_juridica": 0"F",
    "codigo_externo": "EXT001",
    "descricaoativo": "stringS",
          "id_endereco"data_alteracao": 0"2024-08-30T13:09:13.082Z",
    "procuradores": [
    "id_contato": 0, {
         "codigo_externoid": "string"123,
        }
"id_procurador": 456,
     ],       "idativo": 0"S",
        "iddata_pessoainativo": 0,"01/01/2023",
        "iddata_tipo_logradourolimite": 0"31/12/2023",
        "codigo_externo_tipo_logradouro": "stringEXT123",
      "id_cidade": 0,}
    ],
    "codigopessoa_externo_cidaderepresentante": "string",{
      "id_regiao": 0,
      "codigoid_externocanal_regiaovenda": "string"0,
      "idmargem_endereco_classificacaominima": 0,
      "codigo_externo_endereco_classificacaodata_inativo": "string",
      "inscricaocodigo_produtorexterno": "string",
    },
    "numerocarteira_representante": "string",[
      {
"logradouro": "string",       "bairroid": "string"0,
        "cepid_endereco": "string"0,
        "tipoid_enderecorepresentante": "string"0,
        "produtorid_filial": "string"0,
        "complementocodigo_externo": "string",
      "latitude": 0,}
    ],
    "longitudefamiliares": [
0,       "data_validade_inscricao_suframa": "2024-08-28",{
        "inscricao_suframaid": "string"1,
        "contribuinteid_icmspessoa": "string12345",
        "consumidorid_pessoa_finalfamilia": "string"67890,
        "obriga_nfpenome": "stringJoão da Silva",
        "cpfdata_cnpjnascimento": "string01/01/2023",
      "data_validade_inscricao_estadual  "cpf": "2024-08-2812345678901",
        "nomerg": "stringMG1234567",
        "codigo_externotelefone": "string31987654321",
        "ativoemail": "stringjoao.silva@example.com",
    }
  ],   "contatostipo_vinculo": ["P",
    {       "id": 1,"codigo_externo": "EXT123"
      }
"descricao": "Contato principal",  ],
    "id_pessoatalhoes": 2,[
      "id_contato": 3{
    }   ],   "anexosid": [1,
    {
      "id_endereco": 1,
        "id_pessoacultura": 21,
        "id_tipo_documentosafra": 31,
       "codigo_externo_tipo_documento "descricao": "DOC123Talhão 1",
        "extensaoarea": "pdf",10.5,
        "urlnivel_anexotecnologico": "http://example.com/anexo.pdfM",
        "anexolatitude": [-23.55052,
        "stringlongitude"
      ]: -46.633308,
      "observacao": "Documento importante",
      "codigo_externo": "ANX123EXT001"
      }
    ],
    "referencias_bancariasenderecos": [
      {
        "idcontatos": 0,[
       "id_pessoa": 0,  {
    "id_banco": 0,       "codigo_externo_bancoid": "string"1,
      "agencia": "string",       "conta"descricao": "stringContato principal",
 
    "situacao": "string",       "favorecidoid_contato": "string"67890,
      "cpf_cnpj": "string",       "tipocodigo_contaexterno": "stringEXT123",
        "observacao": "string", }
     "codigo_externo": "string"  ],
  }   ],   "referencias_comerciaisid": [
  1,
 {       "id_tipo_logradouro": 067890,
        "id_pessoacidade": 054321,
        "nomeid_regiao": "string"98765,
        "cargoid_endereco_classificacao": "string"11223,
        "contatoinscricao_produtor": "string123456789",
        "telefonenumero": "string123",
        "observacaologradouro": "stringRua Exemplo",
        "codigo_externobairro": "stringCentro",
    }
  ],   "referencias_pessoaiscep": ["12345678",
    {       "id"tipo_endereco": 0"A",
        "id_pessoaprodutor": 0"S",
        "nomecomplemento": "stringApto 101",
        "telefonelatitude": "string"-19.8157,
        "observacaolongitude": "string"-43.9542,
      "codigo_externo  "data_validade_inscricao_suframa": "string31/12/2023",
    }   ],
  "atividades_empregado "inscricao_suframa": [
  "123456789",
 {       "idcontribuinte_icms": 1"S",
        "idconsumidor_pessoafinal": 2"S",
        "empresaobriga_nfpe": "Empresa XYZS",
        "cpf_cnpj": "1234567890123412345678901",
      "telefone  "data_validade_inscricao_estadual": "123456789031/12/2023",
        "ocupacaonome": "GerenteEndereço Exemplo",
        "datacodigo_admissaoexterno": "2024-08-28EXT123",
   
  "rendimento_mensal": 5000,       "codigo_externoativo": "EXT456S"
      }
    ],
    "atividades_aposentadocontatos": [
      {
        "id": 1,
    
 "id_pessoa": 2,       "instituicaodescricao": "INSSContato principal",
        "tipoid_beneficiocontato": "A",3
      }
 "cpf_cnpj": "12345678901234",  ],
    "rendimento_mensalanexos": 2000,[
      "codigo_externo": "EXT456"{
     }   ],
  "atividades_proprietario"id": [1,
    {       "id_tipo_documento": 13,
        "id_pessoaextensao": 2"pdf",
        "empresaurl_anexo": "Empresa XYZhttp://example.com/anexo.pdf",
        "cpf_cnpjanexo": "12345678901234", [
          "faturamento_mensalstring":
10000,       "percentual_participacao": 50 ],
        "tempo_existenciaobservacao": 5"Documento importante",
        "codigo_externo": "EXT456ANX123"
      }
    ],
    "atividadestabelas_de_autonomopreco": [
      {
        "id": 1,
        "id_tabela_pessoapreco": 267890,
        "profissaopadrao": "EngenheiroS",
      }
 "tempo_profissao": 10,  ],
    "rendimento_mensallimites": [
5000,      {
"codigo_externo": "EXT456"     }  "id": ]1,
  "atividades_agropecuario": [
    {
       "id_limite_credito_tipo": 167890,
        "iddata_vigencia_pessoainicial": 2,"01/01/2023",
        "iddata_vigencia_atividadefinal": 3"31/12/2023",
      "codigo_externo_atividade  "observacao": "EXT123",Limite de crédito aprovado para o  "nivel_tecnologico": "ALTOano fiscal de 2023",
        "data_iniciovalor": "2024-08-28"10000,
        "producaopendente": 100"S",
        "unidadecodigo_externo": "TONEXT123",
      "rendimento_anual": 100000,}
    ],
    "codigoformas_externopagamento": "EXT456"[
    }  {
],   "atividades_agricola": [
    {       "id": 1,
        "id_pessoaforma_pagamento": 267890,
        "id_atividadepadrao": 3"S",
        "codigo_externo_atividade": "EXT123",
      }
 "id_pessoa_endereco": 4,  ],
    "codigoformas_externo_enderecoparcelamento": "END123",[
      {
"id_cultura": 5,       "codigo_externo_culturaid": "CULT123"1,
        "id_forma_safraparcelamento": 667890,
      "codigo_externo_safra  "padrao": "SAF123S",
        "nivel_tecnologicotipo": "ALTOA",
        "datapercentual_iniciocorrecao": "2024-08-28",10.5,
        "datacodigo_conclusaoexterno": "2024-08-28",EXT123"
       "area_ativa": "SIM",
 }
    ],
    "area_plantadareferencias": 100,{
      "producaoreferencias_anualbancarias": 500,[
        {
  "faturamento_anual": 100000,       "analise_creditoid": "SIM"1,
          "codigoid_externobanco": "EXT456"67890,
    }   ],   "patrimonios_bem_semoventes"agencia": ["1234-5",
    {       "idconta": 0"123456-7",
      "id_pessoa": 0,       "especiesituacao": "stringL",
      "quantidade": 0,       "categoriafavorecido": "stringJoão da Silva",
      "raca    "cpf_cnpj": "string12345678901",
          "tipo_onusconta": "stringCC",
          "credorobservacao": "string",
   Conta utilizada para recebimento de salário",
  "saldo_devedor": 0,       "valorcodigo_mercadoexterno": 0,"EXT456"
       "produtividade": 0, }
      "codigo_externo": "string"
    }],
   ],   "patrimoniosreferencias_bem_moveiscomerciais": [
    {    {
  "id": 0,       "id_pessoa": 01,
      "tipo_bem_movel    "nome": "stringEmpresa XYZ",
          "nomecargo": "stringGerente de Vendas",
      "ano_fabricacao": 0,       "placa_chassi"contato": "stringJoão da Silva",
          "antttelefone": "string11987654321",
          "conservacaoobservacao": "string",Cliente há mais de    "valor_mercado": 05 anos",
      "marca    "codigo_externo": "stringEXT123",
      "modelo": "string", }
     "descricao": "string" ],
      "quantidadereferencias_pessoais": [
0,       "codigo_externo": "string" {
    }   ],   "patrimonios_imoveis_arrendadosid": [1,
    {       "idnome": 0 "Maria da Silva",
      "id_cidade    "telefone": 0"11987654321",
        "codigo_externo_cidade  "observacao": "string",Amiga de longa data",
   "id_matricula": 0,       "codigo_externo_matricula": "stringEXT123",
       "id_pessoa_endereco": 0, }
      ]
 "nome": "string",  },
    "areaatividades_totaleconomicas": 0,{
      "areaatividades_cultivadaempregado": 0,[
      "proprietario": "string",
   {
   "cpf_cnpj": "string",       "valor_anualid": 01,
       "data_vigencia   "empresa": "2024-08-28Empresa XYZ",
          "descricaocpf_cnpj": "string12345678901234",
          "codigo_externotelefone": "string1234567890",
    }   ],   "patrimonios_imoveis_propriosocupacao": ["Gerente",
    {       "iddata_admissao": 0,"01/01/2020",
          "idrendimento_cidademensal": 05000,
          "codigo_externo_cidade": "stringEXT456",
      "id_matricula": 0, }
     "codigo_externo_matricula": "string" ],
      "idatividades_pessoa_enderecoaposentado": 0,[
        {
 "nome": "string",         "area_totalid": 01,
          "tipo_imovelinstituicao": "stringINSS",
          "naturezatipo_beneficio": "stringA",
          "areacpf_cultivadacnpj": 0"12345678901234",
      "situacao_imovel": "string",
        "valorrendimento_mercadomensal": 02000,
      "valor_hectare": 0,       "condominio"codigo_externo": "stringEXT456",
      "percentual_condominio": 0, }
     "descricao": "string" ],
      "codigoatividades_externoproprietario": "string",       "onus_imovel": [
        {
          "id": 01,
          "id_pessoa_patrimonio_imovelempresa": "Empresa 0XYZ",
          "codigo_externo_patrimonio_imovelcpf_cnpj": "string12345678901234",
          "tipofaturamento_onusmensal": "string"10000,
          "graupercentual_participacao": 050,
          "hectaretempo_existencia": 05,
          "credorcodigo_externo": "stringEXT456",
        }
 "ano_vencimento": 0,    ],
      "saldoatividades_devedorautonomo": 0,[
        {
 "observacao": "string",           "codigo_externo"id": "string"1,
        }    "profissao": "Engenheiro",
  ]     }   ],
  "patrimoniostempo_outros_imoveisprofissao": [
10,
   {       "idrendimento_mensal": 05000,
      "id_cidade": 0,       "codigo_externo_cidade": "stringEXT456",
       "id_matricula": 0, }
      "codigo_externo_matricula": "string"],
      "idatividades_pessoa_enderecoagropecuario": 0,[
      "nome": "string", {
     "area_total": 0,       "tipo_imovelid": "string",1,
          "valorid_mercadoatividade": 03,
          "situacaonivel_imoveltecnologico": "stringA",
          "conservacaodata_inicio": "string01/01/2020",
          "descricaoproducao": "string",100,
          "codigo_externounidade": "stringTON",
          "onusrendimento_imovelanual": [100000,
        {   "codigo_externo": "EXT456"
       "id": 0, }
      ],
      "id_pessoa_patrimonio_imovelatividades_agricola": 0,[
        {
 "codigo_externo_patrimonio_imovel": "string",
          "tipo_onusid": "string"1,
          "grauid_atividade": 03,
          "hectareid_pessoa_endereco": 04,
          "credorid_cultura": "string"5,
          "anoid_vencimentosafra": 06,
          "saldonivel_devedortecnologico": 0"A",
          "observacaodata_inicio": "string01/01/2020",
          "codigodata_externoconclusao": "string31/12/2020",
        }   "area_ativa": "S",
          ]"area_plantada": 100,
     }   ] }
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)
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)

Todos os endpoints, com exceção do deletar, retornam o json nesse formato.

2. Endpoints

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.

...

Validações: É necessário informar pelo menos um dos parâmetros. Caso informado os dois o sistema prioriza o código externo.

Resposta: Status 200 - Retorna a pessoa no formato documentado na sessão Exemplo do json

2.2 - Buscar todas os produtos

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

...

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;

Resposta: Status 200 - Retorna a pessoa cadastrada, no formato documentado na sessão Exemplo do json

2.4 - Inativar uma pessoa

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.

...

Tipo: delete

Parâmetros:

...

codigoInterno: Tipo: Inteiro. Código da pessoa no banco de dados do CRM.

...

Resposta: Status 200 - Mensagem: Registro inativado com sucesso.

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:

...

Exemplo do corpo da requisição:

Code Block
{ "pagina": 1, "quantidadeRegistros": 10, "filtros": [ { "campo": "nome_razao_social", "comparacao": "CONTEM", "valor": "A" } ], "ordenacao": [ { "campo": "nome_razao_social", "ordenacao": "ASC" } ] }

Nesse exemplo, estamos filtrando todas as pessoa cuja nome/razão social possua o texto “A”, também estamos ordenando os registros pela nome/razão social de forma ascendente.

2.7 - Vincular familiares a pessoa

Endpoint: /pessoa/familiares

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block

[
  {
    "id": 1,
    "id_pessoa": "12345",
    "id_pessoa_familia": 67890,
    "nome": "João da Silva",
    "data_nascimento": "2024-08-28",
    "cpf": "12345678901",
    "rg": "MG1234567",
    "telefone": "31987654321",
    "email": "joao.silva@example.com",
    "tipo_vinculo": "P", "producao_anual": 500,
          "faturamento_anual": 100000,
          "analise_credito": "S",
          "codigo_externo": "EXT456"
        }
      ]
    },
    "patrimonios": {
      "patrimonios_bem_semoventes": [
        {
          "id": 1,
          "especie": "B",
          "quantidade": 50,
          "categoria": "Leiteiro",
          "raca": "Holandês",
          "tipo_onus": "H",
          "credor": "Banco XYZ",
          "saldo_devedor": 5000,
          "valor_mercado": 15000,
          "produtividade": 20.5,
          "codigo_externo": "EXT123"
        }
      ],
      "patrimonios_bem_moveis": [
        {
          "id": 1,
          "tipo_bem_movel": "A",
          "nome": "Trator",
          "ano_fabricacao": 2020,
          "placa_chassi": "ABC1234",
          "antt": "1234567890",
          "conservacao": "B",
          "valor_mercado": 150000,
          "marca": "John Deere",
          "modelo": "Modelo X",
          "descricao": "Trator agrícola",
          "quantidade": 2,
          "codigo_externo": "EXT123"
        }
      ],
      "patrimonios_imoveis_arrendados": [
        {
          "id": 1,
          "id_cidade": 12345,
          "id_matricula": 67890,
          "id_pessoa_endereco": 11223,
          "nome": "Fazenda Arrendada",
          "area_total": 100.5,
          "area_cultivada": 80,
          "proprietario": "João da Silva",
          "cpf_cnpj": "12345678901",
          "valor_anual": 50000,
          "data_vigencia": "01/01/2023",
          "descricao": "Fazenda arrendada para cultivo de soja",
          "codigo_externo": "EXT789"
        }
      ],
      "patrimonios_imoveis_proprios": [
        {
          "id": 1,
          "id_cidade": 12345,
          "id_matricula": 67890,
          "id_pessoa_endereco": 11223,
          "nome": "Fazenda Própria",
          "area_total": 100.5,
          "tipo_imovel": "A",
          "natureza": "E",
          "area_cultivada": 80,
          "situacao_imovel": "Q",
          "valor_mercado": 500000,
          "valor_hectare": 5000,
          "condominio": "N",
          "percentual_condominio": 50,
          "descricao": "Fazenda própria para cultivo de soja",
          "codigo_externo": "EXT789",
          "onus_imovel": [
            {
              "id": 1,
              "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"
            }
          ]
        }
      ],
      "patrimonios_outros_imoveis": [
        {
          "id": 1,
          "id_cidade": 12345,
          "id_matricula": 67890,
          "id_pessoa_endereco": 11223,
          "nome": "Fazenda",
          "area_total": 100.5,
          "tipo_imovel": "A",
          "valor_mercado": 500000,
          "situacao_imovel": "Q",
          "conservacao": "B",
          "descricao": "Fazenda para cultivo de soja",
          "codigo_externo": "EXT789",
          "onus_imovel": [
            {
              "id": 1,
              "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_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_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_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_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_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_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_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_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
  - 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
  - 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
  - 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
  - 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
  - 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
  - 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_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)
- patrimonios_bem_semoventes (Lista de patrimônios de bens semoventes)
  - id: ID do registro no banco de dados do CRM
  - 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
  - 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 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
    - 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 ô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
  - 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 ônus

Todos os endpoints, com exceção do deletar, retornam o json nesse formato.

...

2. Endpoints

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

Validações: É necessário informar pelo menos um dos parâmetros. Caso informado os dois o sistema prioriza o código externo.

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;
Serão permitidos o cadastro/edição de até 20 itens por vez.

Resposta: Status 200 - Retorna a pessoa cadastrada, no formato documentado na sessão Exemplo do json

2.4 - Inativar uma pessoa

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.

Resposta: Status 200 - Mensagem: Registro inativado com sucesso.

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:

Code Block
{ "pagina": 1, "quantidadeRegistros": 10, "filtros": [ { "campo": "nome_razao_social", "comparacao": "CONTEM", "valor": "A" } ], "ordenacao": [ { "campo": "nome_razao_social", "ordenacao": "ASC" } ] }

Nesse exemplo, estamos filtrando todas as pessoa cuja nome/razão social possua o texto “A”, também estamos ordenando os registros pela nome/razão social de forma ascendente.

2.7 - Vincular familiares a pessoa

Endpoint: /pessoa/vincular-familiares

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block

[
  {
    "id": 1,
    "id_pessoa": "12345",
    "id_pessoa_familia": 67890,
    "nome": "João da Silva",
    "data_nascimento": "01/01/2023",
    "cpf": "12345678901",
    "rg": "MG1234567",
    "telefone": "31987654321",
    "email": "joao.silva@example.com",
    "tipo_vinculo": "P",
    "codigo_externo": "EXT123"
  }
]

2.8 - Cadastrar dados dos contatos da pessoa

Endpoint: /pessoa/vincular-contatos

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block
[ { "id": 1, "descricao": "Contato principal", "id_contato": 3 } ]

2.9 - Cadastrar dados dos talhões da pessoa

Endpoint: /pessoa/vincular-talhoes

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block

[
  {
    "id": 1,
    "id_endereco": 1,
    "id_cultura": 1,
    "id_safra": 1,
    "descricao": "Talhão 1",
    "area": 10.5,
    "nivel_tecnologico": "M",
    "latitude": -23.55052,
    "longitude": -46.633308,
    "codigo_externo": "EXT001"
  }
]

2.10 - Cadastrar dados das tabelas de preço da pessoa

Endpoint: /pessoa/vincular-tabelas-de-preco

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block
[ { "id": 1, "id_tabela_preco": 67890, "padrao": "S" } ]

2.11 - Cadastrar dados das referências da pessoa

Endpoint: /pessoa/vincular-referencias

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block

{
  "referencias_bancarias": [
    {
      "id": 1,
      "id_banco": 67890,
      "agencia": "1234-5",
      "conta": "123456-7",
      "situacao": "L",
      "favorecido": "João da Silva",
      "cpf_cnpj": "12345678901",
      "tipo_conta": "CC",
      "observacao": "Conta utilizada para recebimento de salário",
      "codigo_externo": "EXT456"
    }
  ],
  "referencias_comerciais": [
    {
      "id": 1,
      "nome": "Empresa XYZ",
      "cargo": "Gerente de Vendas",
      "contato": "João da Silva",
      "telefone": "11987654321",
      "observacao": "Cliente há mais de 5 anos",
      "codigo_externo": "EXT123"
    }
  ],
  "referencias_pessoais": [
    {
      "id": 1,
      "nome": "Maria da Silva",
      "telefone": "11987654321",
      "observacao": "Amiga de longa data",
      "codigo_externo": "EXT123"
    }
  ]
}

2.11 - Cadastrar dados dos patrimônios da pessoa

Endpoint: /pessoa/vincular-patrimonios

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block

{
  "patrimonios_bem_semoventes": [
    {
      "id": 1,
      "especie": "B",
      "quantidade": 50,
      "categoria": "Leiteiro",
      "raca": "Holandês",
      "tipo_onus": "H",
      "credor": "Banco XYZ",
      "saldo_devedor": 5000,
      "valor_mercado": 15000,
      "produtividade": 20.5,
      "codigo_externo": "EXT123"
    }
  ],
  "patrimonios_bem_moveis": [
    {
      "id": 1,
      "tipo_bem_movel": "A",
      "nome": "Trator",
      "ano_fabricacao": 2020,
      "placa_chassi": "ABC1234",
      "antt": "1234567890",
      "conservacao": "B",
      "valor_mercado": 150000,
      "marca": "John Deere",
      "modelo": "Modelo X",
      "descricao": "Trator agrícola",
      "quantidade": 2,
      "codigo_externo": "EXT123"
    }
  ],
  "patrimonios_imoveis_arrendados": [
    {
      "id": 1,
      "id_cidade": 12345,
      "id_matricula": 67890,
      "id_pessoa_endereco": 11223,
      "nome": "Fazenda Arrendada",
      "area_total": 100.5,
      "area_cultivada": 80,
      "proprietario": "João da Silva",
      "cpf_cnpj": "12345678901",
      "valor_anual": 50000,
      "data_vigencia": "01/01/2023",
      "descricao": "Fazenda arrendada para cultivo de soja",
      "codigo_externo": "EXT789"
    }
  ],
  "patrimonios_imoveis_proprios": [
    {
      "id": 1,
      "id_cidade": 12345,
      "id_matricula": 67890,
      "id_pessoa_endereco": 11223,
      "nome": "Fazenda Própria",
      "area_total": 100.5,
      "tipo_imovel": "A",
      "natureza": "E",
      "area_cultivada": 80,
      "situacao_imovel": "Q",
      "valor_mercado": 500000,
      "valor_hectare": 5000,
      "condominio": "N",
      "percentual_condominio": 50,
      "descricao": "Fazenda própria para cultivo de soja",
      "codigo_externo": "EXT789",
      "onus_imovel": [
        {
          "id": 1,
          "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"
        }
      ]
    }
  ],
  "patrimonios_outros_imoveis": [
    {
      "id": 1,
      "id_cidade": 12345,
      "id_matricula": 67890,
      "id_pessoa_endereco": 11223,
      "nome": "Fazenda",
      "area_total": 100.5,
      "tipo_imovel": "A",
      "valor_mercado": 500000,
      "situacao_imovel": "Q",
      "conservacao": "B",
      "descricao": "Fazenda para cultivo de soja",
      "codigo_externo": "EXT789",
      "onus_imovel": [
        {
          "id": 1,
          "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"
        }
      ]
    }
  ]
}

2.12 - Cadastrar dados dos limites de crédito da pessoa

Endpoint: /pessoa/vincular-limites-de-credito

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block

[
  {
    "id": 1,
    "id_limite_credito_tipo": 67890,
    "data_vigencia_inicial": "01/01/2023",
    "data_vigencia_final": "31/12/2023",
    "observacao": "Limite de crédito aprovado para o ano fiscal de 2023",
    "valor": 10000,
    "pendente": "S",
    "codigo_externo": "EXT123"
  }
]

2.13 - Cadastrar dados das formas de parcelamento da pessoa

Endpoint: /pessoa/vincular-formas-de-parcelamento

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block
[ { "id": 1, "id_forma_parcelamento": 67890, "padrao": "S", "tipo": "A", "percentual_correcao": 10.5, "codigo_externo": "EXT123" } ]

2.14 - Cadastrar dados das formas de pagamento da pessoa

Endpoint: /pessoa/vincular-formas-de-pagamento

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block
[ { "id": 1, "id_forma_pagamento": 67890, "padrao": "S", "codigo_externo": "EXT123" } ]

2.15 - Cadastrar dados dos endereços da pessoa

Endpoint: /pessoa/vincular-enderecos

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Code Block

[
  {
    "contatos": [
      {
        "id": 1,
        "descricao": "Contato principal",
        "id_contato": 67890,
        "codigo_externo": "EXT123"
      }
    ],
    "id": 1,
    "id_tipo_logradouro": 67890,
    "id_cidade": 54321,
    "id_regiao": 98765,
    "id_endereco_classificacao": 11223,
    "inscricao_produtor": "123456789",
    "numero": "123",
    "logradouro": "Rua Exemplo",
    "bairro": "Centro",
    "cep": "12345678",
    "tipo_endereco": "A",
    "produtor": "S",
    "complemento": "Apto 101",
    "latitude": -19.8157,
    "longitude": -43.9542,
    "data_validade_inscricao_suframa": "31/12/2023",
    "inscricao_suframa": "123456789",
    "contribuinte_icms": "S",
    "consumidor_final": "S",
    "obriga_nfpe": "S",
    "cpf_cnpj": "12345678901",
    "data_validade_inscricao_estadual": "31/12/2023",
    "nome": "Endereço Exemplo",
    "codigo_externo": "EXT123",
    "ativo": "S"
  }
]

2.16 - Cadastrar dados das atividades econômicas da pessoa

Endpoint: /pessoa/vincular-atividades-economicas

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Code Block

{
  "atividades_empregado": [
    {
      "id": 1,
      "empresa": "Empresa XYZ",
      "cpf_cnpj": "12345678901234",
      "telefone": "1234567890",
      "ocupacao": "Gerente",
      "data_admissao": "01/01/2020",
      "rendimento_mensal": 5000,
      "codigo_externo": "EXT456"
    }
  ],
  "atividades_aposentado": [
    {
      "id": 1,
      "instituicao": "INSS",
      "tipo_beneficio": "A",
      "cpf_cnpj": "12345678901234",
      "rendimento_mensal": 2000,
      "codigo_externo": "EXT456"
    }
  ],
  "atividades_proprietario": [
    {
      "id": 1,
      "empresa": "Empresa XYZ",
      "cpf_cnpj": "12345678901234",
      "faturamento_mensal": 10000,
      "percentual_participacao": 50,
      "tempo_existencia": 5,
      "codigo_externo": "EXT456"
    }
  ],
  "atividades_autonomo": [
    {
      "id": 1,
      "profissao": "Engenheiro",
      "tempo_profissao": 10,
      "rendimento_mensal": 5000,
      "codigo_externo": "EXT456"
    }
  ],
  "atividades_agropecuario": [
    {
      "id": 1,
      "id_atividade": 3,
      "nivel_tecnologico": "A",
      "data_inicio": "01/01/2020",
      "producao": 100,
      "unidade": "TON",
      "rendimento_anual": 100000,
      "codigo_externo": "EXT456"
    }
  ],
  "atividades_agricola": [
    {
      "id": 1,
      "id_atividade": 3,
      "id_pessoa_endereco": 4,
      "id_cultura": 5,
      "id_safra": 6,
      "nivel_tecnologico": "A",
      "data_inicio": "01/01/2020",
      "data_conclusao": "31/12/2020",
      "area_ativa": "S",
      "area_plantada": 100,
      "producao_anual": 500,
      "faturamento_anual": 100000,
      "analise_credito": "S",
      "codigo_externo": "EXT123EXT456"
    }
  ]
}

2.

...

17 - Cadastrar dados dos

...

anexos da pessoa

Endpoint: /pessoa/vincular-anexos

Tipo: post

Parâmetro:

codigoPessoa: Código da pessoa no banco de dados do CRM

Corpo da requisição:

Code Block

[
  {
    "id": 1,
    "descricaoid_tipo_documento": 3,
    "Contato principalextensao": "pdf",
    "id_pessoa": 2url_anexo": "http://example.com/anexo.pdf",
    "anexo": [
      "string"
    ],
    "observacao": "Documento importante",
    "idcodigo_contatoexterno": 3"ANX123"
  }
]

...

Versions Compared

Old Version 1

New Version Current

Key

1. Exemplo do json:

1. Exemplo do json:

2. Endpoints

2.1 - Buscar pessoa pelo código

2.2 - Buscar todas os produtos

2.3 - Cadastrar ou editar pessoa

2.4 - Inativar uma pessoa

2.5 - Retornar os metadados da pessoa

2.6 - Pesquisar

2.7 - Vincular familiares a pessoa

2. Endpoints

2.1 - Buscar pessoa pelo código

2.2 - Buscar todas as pessoas

2.3 - Cadastrar ou editar pessoa

2.4 - Inativar uma pessoa

2.5 - Retornar os metadados da pessoa

2.6 - Pesquisar

2.7 - Vincular familiares a pessoa

2.8 - Cadastrar dados dos contatos da pessoa

2.9 - Cadastrar dados dos talhões da pessoa

2.10 - Cadastrar dados das tabelas de preço da pessoa

2.11 - Cadastrar dados das referências da pessoa

2.11 - Cadastrar dados dos patrimônios da pessoa

2.12 - Cadastrar dados dos limites de crédito da pessoa

2.13 - Cadastrar dados das formas de parcelamento da pessoa

2.14 - Cadastrar dados das formas de pagamento da pessoa

2.15 - Cadastrar dados dos endereços da pessoa

2.16 - Cadastrar dados das atividades econômicas da pessoa

2.

17 - Cadastrar dados dos

anexos da pessoa