A API disponibiliza os seguintes campos :
Atributo | Tipo | Descrição |
---|---|---|
id | número | Id do cliente no Nomus ERP |
codigo | texto | Código do cliente |
nome | texto | Nome do cliente |
classificacao | texto | Classificação do cliente |
idClassificacao | número | Id da classificação do cliente no Nomus ERP |
grupoPessoa | texto | Nome do grupo de pessoa do cliente |
idGrupoPessoa | número | Id do grupo de pessoa do cliente |
tipoPessoa | número | 1 - Pessoa jurídica 2 - Pessoa física |
cnpj | texto | CNPJ do cliente caso seja pessoa jurídica |
cpf | texto | CPF do cliente caso seja pessoa física |
razaoSocial | texto | Razão social do cliente quando é pessoa jurídica |
cep | texto | CEP do cliente |
tipoLogradouro | texto | Valores possíveis: RUA, AVENIDA, ESTRADA, PRAÇA, RODOVIA, AEROPORTO, ALAMEDA, ÁREA,CAMPO, CHÁCARA, COLÔNIA, CONDOMÍNIO, CONJUNTO, DISTRITO, ESPLANADA, ESTAÇÃO, FAVELA, FAZENDA, FEIRA, JARDIM, LADEIRA, LAGO, LAGOA, LARGO, LOTEAMENTO, MORRO, NÚCLEO, PARQUE, PASSARELA, PÁTIO, QUADRA, RECANTO, RESIDENCIAL, SETOR, SÍTIO, TRAVESSA, TRECHO, TREVO, VEREDA, VIA, VALE, VIELA, VILA |
endereco | texto | Endereço do cliente |
numero | texto | Número do endereço do cliente |
complemento | texto | Complemento do endereço do cliente |
pais | texto | Nome do país do cliente |
tipoBairro | texto | Valores possíveis: BAIRRO, BOSQUE, CHÁCARA, CONJUNTO, DESMEMBRAMENTO, DISTRITO, FAVELA, FAZENDA, GLEBA, HORTO, JARDIM, LOTEAMENTO, NÚCLEO, PARQUE, RESIDENCIAL, SÍTIO, TROPICAL, VILA, ZONA |
bairro | texto | Nome do bairro do cliente |
municipio | texto | Nome da cidade do cliente |
codigoIBGEMunicipio | texto | Código IBGE da cidade do representante cliente |
uf | texto | UF do cliente |
documentoIdentificacaoEstrangeiro | texto | Documento de identificação do cliente estrangeiro |
telefone | texto | Telefone do cliente |
site | texto | Site do cliente |
tipoContribuinteICMS | número | 1 - Contribuinte 2 - Isento 3 - Não contribuinte |
inscricaoEstadual | texto | Inscrição estadual do cliente |
inscricaoMunicipal | texto | Inscrição municipal do cliente |
inscricaoSuframa | texto | Inscrição SUFRAMA do cliente Saiba mais |
email | texto | E-mail do cliente |
crt | número | Código de regime tributário. Valores possíveis: 1 - Simples nacional 2 - Simples nacional - excesso de sublimite de receita bruta 3 - Regime normal |
cnaePrincipal | texto | Classificação nacional de atividades econômicas do cliente |
ativo | booleano | True se o cliente está ativo, ou false caso contrário |
dataInicioRelacionamento | data (dd/mm/aaaa) | Data do início do relacionamento com o cliente |
codigoSistemaContabil | texto | Código no sistema contábil |
observacoes | texto | Observações a respeito do representante |
dataHoraUltimaModificacao | data (dd/mm/aaaa hh:mm) | Data e hora da última modificação efetuada no cadastro do cliente |
dataCriacao | data (dd/mm/aaaa hh:mm) | Registro da data e hora quando o representante foi cadastrado no Nomus ERP |
dataModificacao | data (dd/mm/aaaa hh:mm) | Data e hora da última edição no cadastro do representante no Nomus ERP |
dataEmissaoUltimoPedidoVenda | data (dd/mm/aaaa hh:mm) | Data e hora da última emissão do pedido de venda para o cliente |
representantes | lista de representantes | Ver abaixo |
vendedores | lista de vendedores | Ver abaixo |
expedicao | Informações da expedição para o cliente | Ver abaixo |
representantes
Atributo | Tipo | Descrição |
---|---|---|
id | número | Id da tabela de preço no Nomus ERP |
nome | texto | Nome do representante |
tipoPessoa | número | 1 - Pessoa jurídica 2 - Pessoa física |
cnpj | texto | CNPJ do representante |
cpf | texto | CPF do representante |
vendedores
Atributo | Tipo | Descrição |
---|---|---|
idVendedor | número | Id do vendedor no Nomus ERP |
nomeVendedor | texto | Nome do vendedor |
tipoPessoaVendedor | número | 1 - Pessoa jurídica 2 - Pessoa física |
cnpjVendedor | texto | CNPJ do vendedor |
cpfVendedor | texto | CPF do vendedor |
expedição
Atributo | Tipo | Descrição |
---|---|---|
idRotaCliente | número | Id da rota no Nomus ERP |
nomeRotaCliente | texto | Nome da rota do cliente |
Serviços disponíveis
Consultar um cliente
Retorna as informações de um cliente com o id passado por parâmetro.
GET - /rest/clientes/{id_cliente}
Retorno:
{ "ativo": true, "cep": "12345-678", "classificacao": "BRASIL", "cnpj": "12.345.678/0000-21", "codigo": "0000189", "codigoIBGEMunicipio": "3304557", "codigoSistemaContabil": "", "dataCriacao": "10/05/2019", "dataEmissaoUltimoPedidoVenda": "30/07/2018 00:00:00", "dataInicioRelacionamento": "10/05/2019", "dataModificacao": "14/05/2019", "endereco": "Av Rio branco", "id": 1, "inscricaoEstadual": "", "municipio": "Rio de Janeiro", "nome": "cliente", "numero": "15", "observacoes": "", "pais": "BRASIL", "razaoSocial": "cliente LTDA", "site": "", "telefone": "", "tipoPessoa": "1", "uf": "RJ" }
Consultar todos clientes
GET - /rest/clientes
Este serviço lista todos os clientes. O resultado é listado de forma paginada, retornando no máximo 50 registros. Se nenhuma página for passada será retornado os 50 registros mais recentes. Para listar todos os resultados é necessário passar o número da página. Exemplo:
clientes?pagina=2
Retorno (exemplo simplificado)::
[ { "ativo": true, "cep": "25585-160", "classificacao": "BRASIL", "cnpj": "12.658.000/1000-21", "codigo": "0000189", "codigoIBGEMunicipio": "3304557", "codigoSistemaContabil": "", "dataCriacao": "10/05/2019", "dataEmissaoUltimoPedidoVenda": "30/07/2018 00:00:00", "dataInicioRelacionamento": "10/05/2019", "dataModificacao": "14/05/2019", "endereco": "Av Rio branco", "id": 466, "inscricaoEstadual": "", "municipio": "Rio de Janeiro", "nome": "cliente x", "numero": "15", "observacoes": "", "pais": "BRASIL", "razaoSocial": "cliente x LTDA", "site": "", "telefone": "", "tipoPessoa": "1", "uf": "RJ" }, { "ativo": true, "classificacao": "BRASIL", "cnpj": "00.211.240/2001-20", "codigo": "0000183", "codigoSistemaContabil": "", "dataCriacao": "18/04/2019", "dataInicioRelacionamento": "18/04/2019", "dataModificacao": "22/04/2019", "id": 460, "inscricaoEstadual": "", "municipio": "", "nome": "cliente y", "observacoes": "", "pais": "BRASIL", "razaoSocial": "cliente y ltda", "site": "", "telefone": "", "tipoPessoa": "1" }, { "ativo": true, "bairro": "Lapa", "classificacao": "BRASIL", "cnpj": "00.090.040/0001-23", "codigo": "0000178", "codigoIBGEMunicipio": "3550308", "codigoSistemaContabil": "", "dataCriacao": "22/03/2019", "dataEmissaoUltimoPedidoVenda": "02/04/2019 00:00:00", "dataInicioRelacionamento": "22/03/2019", "dataModificacao": "25/03/2019", "email": "vendas2@cliente.com.br", "endereco": "Rua dos clientes", "id": 455, "inscricaoEstadual": "", "municipio": "São Paulo", "nome": "Empresa", "numero": "427", "observacoes": "", "pais": "BRASIL", "razaoSocial": "Empresa", "site": "", "telefone": "55 (11) 2385-0001", "tipoContribuinteICMS": "2", "tipoPessoa": "1", "uf": "SP" }, ... ]
Consultar clientes filtrando por parâmetro
GET - /rest/clientes?query={parâmetros}
Podem ser usados os seguintes operadores de comparação
Igual a:
==
Não igual a:
!=
Menor que:
<
Menor ou igual que: <=
Maior que:
>
Maior ou igual que:
>=
Operadores lógicos:
- E: ;
- OU: ,
Para filtrar usando o operador E por 2 atributos diferentes adicionaria: ?query=campo1==valor;campo2==valor2
É possível consultar no Nomus ERP através de qualquer um dos campos listados acima e da combinação deles.
A resposta será um JSON com os campos solicitados no método preenchidos desde que todas as condições sejam atingidas.
O limite por retorno são 50 registros por consulta. Para retornar além dessa quantidade é necessário passar o parâmetro pagina.
Exemplo:
clientes?query=dataInicioRelacionamento=="10/01/2019",ativo==false
Retorno (exemplo simplificado)::
[ { "ativo": false, "bairro": "sao paulo", "cep": "13000-000", "classificacao": "BRASIL", "codigo": "0000169", "codigoIBGEMunicipio": "3549102", "codigoSistemaContabil": "", "cpf": "000.000.000-00", "dataCriacao": "12/03/2019", "dataInicioRelacionamento": "12/03/2019", "dataModificacao": "12/03/2019", "endereco": "Rua cliente", "id": 446, "inscricaoEstadual": "", "municipio": "São João", "nome": "pessoa", "numero": "500", "observacoes": "", "pais": "BRASIL", "razaoSocial": "pessoa", "site": "", "telefone": "", "tipoBairro": "JARDIM", "tipoContribuinteICMS": "2", "tipoLogradouro": "RUA", "tipoPessoa": "2", "uf": "SP" }, { "ativo": false, "bairro": "VILA METALURGICA", "cep": "09220-250", "classificacao": "BRASIL", "cnaePrincipal": "Comércio varejista de outros produtos não especificados anteriormente", "cnpj": "01.000.008/0001-00", "codigo": "0000165", "codigoIBGEMunicipio": "3547809", "codigoSistemaContabil": "", "dataCriacao": "08/03/2019", "dataInicioRelacionamento": "08/03/2019", "dataModificacao": "11/03/2019", "email": "teste@teste.com.br", "endereco": "R Integrada", "id": 442, "inscricaoEstadual": "", "municipio": "Santo André", "nome": "Pessoa 2", "numero": "1", "observacoes": "", "pais": "BRASIL", "razaoSocial": "Pessoa 2 LTDA - EPP", "site": "", "telefone": "55 (11) 1234-0000", "tipoPessoa": "1", "uf": "SP" }, ... ]