Para cadastrar uma pessoa fĂsica precisaremos primeiramente de seu CPF.
Este valor de documento serĂĄ o "doc" que iremos enviar para a API
Nossa API sĂł irĂĄ aceitar valores de "doc" possuindo 11 ou 14 nĂșmeros, representando CPF e CNPJ respectivamente.
Caso seja enviado um valor com um valor diferente de 11 ou 14 nĂșmeros a API nĂŁo irĂĄ realizar o cadastro.
Campos obrigatĂłrios
ânomeâ
âstatusâ
âdata_nascimentoâ
âdocâ
âestado_civilâ
âgrau_instrucaoâ
ânome_fantasiaâ
âforma_juridicaâ
âarmazem_gerenciadoâ
âclassificacaoâ
âtipo_enderecoâ
âtipo_logradouroâ
âcep_enderecoâ
âenderecoâ
ânum_enderecoâ
âbairro_enderecoâ
âcidade_enderecoâ
âestado_enderecoâ
âpais_enderecoâ
âtipo_telefoneâ
âddd_telefoneâ
âtelefoneâ
ânome_contatoâ
âgrau_relacionamentoâ
Com o CPF e os dados cadastrais obrigatórios podemos enviar estas informaçÔes para a API para que seja realizado o cadastro desta pessoa no GTI Plug.
Quando o campo âdocâ possuir 11 caracteres vĂĄlidos (ou seja, Ă© um CPF), os campos abaixo nĂŁo precisam ser enviados e serĂŁo ignorados, pois este sĂŁo relativos Ă Pessoas JurĂdicas.
ânome_fantasiaâ
âforma_juridicaâ,
âporte_empresaâ
âdata_constituicaoâ
âdata_registroâ
âinscricao_municipalâ
âdata_alteracao_contratualâ
âcapital_socialâ
âcapital_integralizadoâ
âpatrimonio_liquidoâ
âreceita_brutaâ
ânumero_filiaisâ
âcrc_responsavelâ
"armazem_gerenciado"
Enviar os dados da pessoa
http://host_name:port/v1/{tenant_id}/pessoa/cadastro/doc/{id}
O "doc" serĂĄ o valor do documenta da pessoa a ser cadastrada.
{
âdados_pessoaâ: [
{
âdocâ: âintegerâ,
âidExternoâ : "string",
âstatusâ: "integer",
ânomeâ: "string",
âdata_nascimentoâ: "string",
ânum_identidadeâ: âstringâ,
âorgao_expedidorâ : âintegerâ,
âestado_civilâ: "integer",
âgrau_instrucaoâ: "integer",
ânome_fantasiaâ: "string",
âforma_juridicaâ: "integer",
âclassificacaoâ: "integer",
ânome_paiâ : "string",
ânome_maeâ : "string",
âemailâ : "string",
âsiteâ : "string",
âporte_empresaâ : "integer",
âdata_constituicaoâ : "string",
âdata_registroâ : "string",
âinscricao_municipalâ : "string",
âdata_alteracao_contratualâ : "string",
âcapital_socialâ : "integer",
âcapital_integralizadoâ : "integer",
âpatrimonio_liquidoâ : "integer",
âreceita_brutaâ : "integer",
ânumero_filiaisâ : "integer",
âcrc_responsavelâ : "string",
âarmazem_gerenciadoâ: âbooleanâ,
}
]
âdados_enderecoâ: [
{
âtipo_enderecoâ : "integer",
âcep_enderecoâ : "string",
âtipo_logradouroâ : "integer",
âenderecoâ : "string",
ânum_enderecoâ : "integer",
âcomplemento_endereçoâ : "string",
âbairro_enderecoâ : "string",
âcidade_enderecoâ : "string",
âestado_enderecoâ : "string",
âpais_enderecoâ : "string",
âzona_urbanaâ : "boolean",
âmodalidade_ocupacaoâ : "iteger",
}
]
âdados_telefoneâ: [
{
âtipo_telefoneâ : "integer",
âddd_telefoneâ : "integer",
âtelefoneâ : "integer",
}
]
âdados_contatoâ: [
{
ânome_contatoâ : "string",
âgrau_relacionamentoâ : "string",
}
]
}
{
"dados_pessoa": [
{
"doc": 10393389090,
"idExterno": "003568",
"status": 2,
"nome": "Teste Especificacao da Silva",
âdata_nascimentoâ: "2020-10-05",
ânum_identidadeâ: â18164266â,
âorgao_expedidorâ : 4,
âestado_civilâ: 1,
âgrau_instrucaoâ: 5,
"classificacao": 6,
ânome_paiâ : "Pai do Teste",
ânome_maeâ : "MĂŁe do Teste",
"email": "[email protected]",
"site": "www.cabtec.com.br",
}
],
"dados_endereco": [
{
"tipo_endereco": 12,
"tipo_logradouro": 34,
"cep_endereco": 30140061,
"endereco": "dos Timbiras",
"num_endereco": 1754,
"complemento_endereco": "10 Andar",
"bairro_endereco": "FuncionĂĄrios",
"cidade_endereco": "Belo Horioznte",
"estado_endereco": "MINAS GERAIS",
"pais_endereco": "Brasil",
"zona_urbana": 1,
"modalidade_ocupacao": 1
}
],
"dados_telefone": [
{
"tipo_telefone": 2,
"ddd_telefone": 31,
"telefone": 21259000
}
],
"dados_contato": [
{
"nome_contato": "Fulano da Silva",
"grau_relacionamento": "Diretor de TI"
}
]
}
O retorno serĂĄ:
{
"dados_pessoa": [
{
"doc": 10393389090,
"idExterno": "003568",
"status": "Ativo",
"nome": "Teste Especificacao da Silva",
âdata_nascimentoâ: "2020-10-05",
ânum_identidadeâ: â18164266â,
âorgao_expedidorâ : âSecretaria de Segurança PĂșblicaâ,
âestado_civilâ: "Solteiro",
âgrau_instrucaoâ: "Superior Completo",
"classificacao": Separador,
ânome_paiâ : "Pai do Teste",
ânome_maeâ : "MĂŁe do Teste",
"email": "[email protected]",
"site": "www.cabtec.com.br",
}
],
"dados_endereco": [
{
"tipo_endereco": "Residencialâ,
"tipo_logradouro": "Ruaâ,
"cep_endereco": 30140061,
"endereco": "dos Timbiras",
"num_endereco": 1754,
"complemento_endereco": "10 Andar",
"bairro_endereco": "FuncionĂĄrios",
"cidade_endereco": "Belo Horioznte",
"estado_endereco": "MINAS GERAIS",
"pais_endereco": "Brasil",
"zona_urbana": "Simâ,
"modalidade_ocupacao": "PrĂłpriaâ
}
],
"dados_telefone": [
{
"tipo_telefone": "Fixo Comercialâ,
"ddd_telefone": 31,
"telefone": 21259000
}
],
"dados_contato": [
{
"nome_contato": "Fulano da Silva",
"grau_relacionamento": "Diretor de TI"}
]
}
Alterar o cadastro de uma Pessoa FĂsica
http://host_name:port/v1/{tenant_id}/pessoa/alteracao/doc/{id}
Para realizarmos uma alteração em uma pessoa jĂĄ cadastrada precisaremos de seu nĂșmero de documento e informar quais campos devem ser alterados.
Diferente do cadastro, ao atualizarmos um cadastro nĂŁo existe a necessidade de enviar todos os campos obrigatĂłrios.
Devemos apenas informar quais informaçÔes da pessoa desejamos alterar.
{
"dados_pessoa": [
{
"grau_instrucao": 6,
"estado_civil": 5,
}
],
"dados_endereco": [],
"dados_telefone": [
{
"tipo_telefone": 1,
"ddd_telefone": 31,
"telefone": 21259047
}
],
"dados_contato": []
}
O retorno serĂĄ:
{
"dados_pessoa": [
{
"doc": 10393389090,
"idExterno": "003568",
"status": "Ativo",
"nome": "Teste Especificacao da Silva",
âdata_nascimentoâ: "2020-10-05",
ânum_identidadeâ: â18164266â,
âorgao_expedidorâ : âSecretaria de Segurança PĂșblicaâ,
âestado_civilâ: "Casado(a)",
âgrau_instrucaoâ: "PĂłs-Graduado",
"classificacao": Separador,
ânome_paiâ : "Pai do Teste",
ânome_maeâ : "MĂŁe do Teste",
"email": "[email protected]",
"site": "www.cabtec.com.br",
}
],
"dados_endereco": [
{
"tipo_endereco": "Residencialâ,
"tipo_logradouro": "Ruaâ,
"cep_endereco": 30140061,
"endereco": "dos Timbiras",
"num_endereco": 1754,
"complemento_endereco": "10 Andar",
"bairro_endereco": "FuncionĂĄrios",
"cidade_endereco": "Belo Horioznte",
"estado_endereco": "MINAS GERAIS",
"pais_endereco": "Brasil",
"zona_urbana": "Simâ,
"modalidade_ocupacao": "PrĂłpriaâ
}
],
"dados_telefone": [
{
"tipo_telefone": "Fixo Residencialâ,
"ddd_telefone": 31,
"telefone": 21259047
}
],
"dados_contato": [
{
"nome_contato": "Fulano da Silva",
"grau_relacionamento": "Diretor de TI"}
]
}