Endpoint Entidades (v1)

---

 Descrição geral

Manipulação de cliente, fornecedor, transportadora, vendedor, técnico, fabricante

---

URL

“/public-api/v1/entidades“

---

Verbos suportados

POST, PUT, GET e DELETE

---

 Status HTTP

• 200 = OK
• 422 = A requisição falhou ao ser processada. Veja a mensagem retornada para mais detalhes

---

JSON Exemplo

{“entidade”: {“codigo”: “200005”, “nome”:”Cliente teste”, “tipo”: 1}}

---

Exemplos

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “POST” “${endereco_do_servidor}/public-api/v1/entidades”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –data “${json}” –request “PUT” “${endereco_do_servidor}/public-api/v1/entidades”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/entidades/${codigo}”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “GET” “${endereco_do_servidor}/public-api/v1/entidades”

curl –header “Authorization: Bearer ${token_de_acesso}” –header “Content-Type: application/json” –request “DELETE” “${endereco_do_servidor}/public-api/v1/entidades/${codigo}”

---

Lista dos campos do JSON

Identificador	Descrição	Obrigatório	Tipo	Tamanho	Decimais	Observações
bairro	Bairro		Caracter	50
bairroCobranca	Bairro de cobrança		Caracter	50
bairroEntrega	Bairro de entrega		Caracter	50
celular	Celular		Caracter	40
celularCobranca	Celular de cobrança		Caracter	40
celularEntrega	Celular de entrega		Caracter	40
cep	Cep		Caracter	10
cepCobranca	Cep de cobrança		Caracter	10
cepEntrega	CEP de entrega		Caracter	9
cidade	Cidade		Caracter	100
cidadeCobranca	Cidade de cobrança		Caracter	100
cidadeEntrega	Cidade de entrega		Caracter	100
cnpjCpf	CNPJ/CPF		Caracter	18
codigo	Código	Sim	Caracter	10		Se deixar em branco o sistema gera um sequencial
complemento	Complemento		Caracter	50
complementoCobranca	Complemento de cobrança		Caracter	50
complementoEntrega	Complemento do endereço de entrega		Caracter	50
conjuge	Cônjuge		Caracter	50
contatoCobranca	Nome do contato de cobrança		Caracter	50
contatoEntrega	Contato de entrega		Caracter	50
dataNascimento	Data de nascimento		Data
email	Email		Caracter	50
emailCobranca	Email de cobrança		Caracter	50
emailEntrega	Email de entrega		Caracter	50
endereco	Endereço		Caracter	50		Endereço sem o número
enderecoCobranca	Endereco de cobrança		Caracter	50
enderecoEntrega	Endereço de entrega		Caracter	50
estado	Estado		Caracter	2
estadoCivil	Estado civil		Inteiro			0=Casado 1=Solteiro 2=Divorciado 3=Desquitado 4=Viúvo 5=Amasiado 6=Não identificado
estadoCobranca	Estado de cobrança		Caracter	2
estadoEntrega	Estado de entrega		Caracter	2		UF Ex: SC,SP,PE
extra1	extra1		Caracter	512
extra2	extra2		Caracter	512
extra3	extra3		Caracter	512
extra4	extra4		Caracter	512
extra5	extra5		Caracter	512
extra6	extra6		Caracter	512
fax	Fax		Caracter	40
faxEntrega	Fax de entrega		Caracter	40
inativo	Inativo		Inteiro	1		0=Ativo 1=Inativo
inscricaoEstadual	Inscrição Estadual		Caracter	50
limiteCredito	Limite de crédito		Decimal	12	2
mae	Mãe		Caracter	50
nome	Nome	Sim	Caracter	50
nomeContato	Nome do contato		Caracter	50
numeroCobranca	Numero do endereço de cobrança		Caracter	6
numeroEndereco	Número do endereço		Caracter	6
numeroEntrega	Número do endereço de entrega		Caracter	6
observacao	Observação		Caracter	4096
pai	Pai		Caracter	50
profissao	Profissão		Caracter	50
razaoSocial	Razao Social		Caracter	50
renda	Renda		Decimal	12	2
rg	RG		Caracter	20
telefone	Telefone		Caracter	40
telefoneCobranca	Telefone de cobrança		Caracter	40
telefoneEntrega	Telefone de entrega		Caracter	40
tipo	Tipo da entidade	Sim	Caracter	20		1=Cliente 2=Fornecedor 3=Transportadora 4=Vendedor 5=Técnico 6-Fabricante Pode informar uma lista separada por vírgula Ex: (1,2,3)
tipoPessoa	Tipo de pessoa		Caracter	1		0 = Física 1 = Jurídica
usuario	Usuário		Caracter	10
creditoRestrito	Informa se a entidade está bloqueada		Inteiro	1		1=Sim e 0=Não
codigoVendedor	Vendedor		Caracter	50
codigoVendedor2	Vendedor 2		Caracter	50
codigoVendedor3	Vendedor3		Caracter	50

Conteúdo Relacionado

Os artigos listados abaixo estão relacionados ao que você acabou de ler:
• API Rest (WEB)
• Antes de Falar com o Suporte Técnico
• Obtendo suporte técnico e ajuda