Clientes
Cadastro de destinatários, tomadores e consumidores por emitente.
O cadastro de clientes guarda os destinatários da NF-e, os tomadores da NFS-e e os consumidores da NFC-e de cada
emitente. Toda rota exige X-Emitente-Id e vale para qualquer produto contratado.
A emissão não referencia o cliente
A nota sempre recebe o destinatário/tomador completo no JSON. O cadastro serve para o seu sistema (ou o painel) buscar e copiar os dados; mudar um cliente não altera notas já emitidas.
| Método e rota | Resposta |
|---|---|
POST /clientes | 201 + Location; 409 cliente-duplicado (mesmo CNPJ/CPF no emitente) |
GET /clientes?busca=&pagina=&tamanho= | página ordenada por nome (tamanho máx. 100) |
GET /clientes/{id} | cliente; 404 cliente-nao-encontrado |
PUT /clientes/{id} | cliente (substitui); 422 cnpj-imutavel |
DELETE /clientes/{id} | 204 |
Campos
| Campo | Regra |
|---|---|
cnpjCpf | Obrigatório, com ou sem máscara, DV conferido |
nome | Obrigatório, 2 a 60 caracteres |
indicadorIe | CONTRIBUINTE, ISENTO ou NAO_CONTRIBUINTE; padrão: contribuinte se houver IE |
inscricaoEstadual | 2 a 14 dígitos; obrigatória para contribuinte, proibida para isento |
inscricaoMunicipal | Até 15 caracteres |
email, telefone | Até 60 caracteres / 6 a 14 dígitos |
endereco | Obrigatório e completo: logradouro, numero, complemento, bairro, codigoMunicipio (IBGE), cep |
- Pessoa física (CPF) não tem IE nem IM: informá-las, ou
indicadorIediferente deNAO_CONTRIBUINTE, responde400. - A resposta acrescenta
id,endereco.uf(derivada do município),criadoEmeatualizadoEm. - As regras são as do destinatário da NF-e, as mais estritas entre os produtos: todo cliente cadastrado serve a qualquer nota.
Busca
busca só com dígitos (máscara ignorada) procura pelo início do CNPJ/CPF; com letras, por trecho do nome, sem
acento e sem diferenciar maiúsculas.