Skip to main content

pessoa.getpessoa

Este endpoint devolve dados cadastrais de uma pessoa dentro do T4ERP

Dados da requisição

API Método
api.rule - API principal GET

JSON da requisição

{
	"resource": "pessoa",
	"endpoint": "getpessoa",
	"versao": "v1",
	"taggetpessoa":[
		{
			"idconsumer": "yyyy",
			"tpfiltro": "1",
			"docreceita":"XXXXXXXXXXXXXX"
		}
	]  
}

Especificação das tags

Tag N Obrigatório Descrição
idconsumer 1 N ID interno para controle do ator
tpfiltro 1 S Define o tipo de filtro a ser utilizado na localização
1 - CNPJ ou CPF
docreceita 1 S CNPJ ou CPF a ser localizado
Enviar com zeros a esquerda (11 para CPF, 14 para CNPJ)

✅ Resposta de Sucesso

{
	"taggetpessoa": [
		{
			"id": "00011886-B2D3-467C-9217-9DCFCB415CBD",
			"nome": "Razao",
			"docreceita": "99999999999999",
			"rg": null,
			"cnh": null,
			"idconsumer": "0",
			"erromensagemitem": null,
			"contatos": [
				{
					"tipo": "1",
					"valor": "11999999999",
					"principal": "N"
				},
				{
					"tipo": "11",
					"valor": "email@email",
					"principal": "N"
				}
			],
			"endereco": {
				"logradouro": "Rua",
				"numero": "",
				"complemento": "",
				"bairro": "bairro",
				"cep": "99999999",
				"municipio": {
					"nome": "municipio",
					"codigoibge": 9999999
				},
				"uf": {
					"sigla": "XX"
				},
				"pais": {
					"nome": "BRASIL"
				}
			}
		}
	]
}

Especificação das tags de retorno

Tag N Obrigatório Descrição
id 2 S ID do registro
nome 2 S Razão social / nome do cliente
docreceita 2 S Documento da receita
rg 2 S RG (Pessoa física)
cnh 2 S Carteira Nacional de habilitação (Pessoa física)
idconsumer 1 N ID interno para controle do ator
erromensagemitem 1 Se possuir conteúdo, a chamada do endpoint não foi bem sucedida, se possuir conteúdo, traz o erro ocorrido
contatos 2 N Dados de contato
tipo 3 S Tipo do contato
0 - Telefone fixo
1 - Telefone celular
10 - Email de contato
11 - Email para entrega de DFe
valor 3 S Conteudo do contato (Telefone, email, etc)
principal 3 S S - Indica que é o contato principal da pessoa
endereco 2 S Dados do endereço
logradouro 3 S Rua
numero 3 N Número
complemento 3 N Complemento
bairro 3 N Bairro
cep 3 N CEP
municipio 3 N Dados do município
nome 4 N Nome do município
codigoibge 4 N Código do Município no IBGE
uf 3 N Dados da UF
sigla 4 N Sigla do estado
pais 3 N Dados do país
nome 4 N Nome do país

❌ Possíveis Erros

- `400 Bad Request`
  - JSON de parâmetros inválido
- `401 Unauthorized` → Credenciais inválidas.
  - Header authorization não inciado com "token" 
  - Token inválido 
- `405 Method Not Allowed`
  - Tentativa de acesso ao endpoint com método diferente de GET.

Observações