A API disponibiliza os seguintes campos :


Atributo
Tipo
Descrição
idnúmeroId do representante no Nomus ERP
codigotextoCódigo do representante
nometextoNome do representante
classificacaotextoClassificação do representante
idClassificacaonúmeroId da classificação do representante
tipoPessoanúmero1 - Pessoa jurídica
2 - Pessoa física
cnpjtextoCNPJ do representante
cpftextoCPF do representante
razaoSocial
textoA razão social do representante
cep
textoCEP do representante
tipoLogradouro
textoValores 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
enderecotextoEndereço do representante
numerotextoNúmero do endereço do representante
paistextoNome do país do representante
tipoBairro
textoValores 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
textoNome do bairro do representante
municipio
textoNome da cidade do representante
codigoIBGEMunicipio
textoCódigo IBGE da cidade do representante
uftextoUF do representante
documentoIdentificacaoEstrangeiro
textoDocumento de identificação do representante estrangeiro
telefone
textoTelefone do representante
site
textoSite do representante
tipoContribuinteICMS
número1 - Contribuinte
2 - Isento
3 - Não contribuinte
inscricaoEstadual
textoInscrição estadual do representante
inscricaoMunicipal
textoInscrição municipal do representante
inscricaoSuframa
textoInscrição SUFRAMA do representante Saiba mais
email
textoE-mail do representante
crtnúmeroCódigo de regime tributário. Valores possíveis:
1 - Simples nacional
2 - Simples nacional - excesso de sublimite de receita bruta
3 - Regime normal
cnaePrincipal
textoClassificação nacional de atividades econômicas do representante
ativo
booleano
True se o representante está ativo, ou false caso contrário
dataInicioRelacionamento
data (dd/mm/aaaa)Data do início do relacionamento com o representante
codigoSistemaContabil
textoCódigo no sistema contábil
observacoes
textoObservações a respeito do representante
dataHoraUltimaModificacao
data (dd/mm/aaaa hh:mm)
Data e hora da última modificação efetuada no cadastro do representante
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




Serviços disponíveis


Consultar um representante


Retorna as informações de um representante com o id passado por parâmetro.


GET - /rest/representantes/{id_do_representante}


Retorno:


{
    "ativo": true,
    "dataHoraUltimaModificacao": "13/02/2019 08:41:59",
    "dataModificacao": "13/02/2019 08:41:59",
    "email": "teste e-mail proposta",
    "id": 210,
    "nome": "Vendedor Carlos",
    "pais": "BRASIL",
    "tipoPessoa": "1"
}



Consultar todos os representantes


GET - /rest/representantes


Este serviço lista todos os representantes. 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:


representantes?pagina=2



Retorno:


[
    {
        "ativo": true,
        "codigo": "0000181",
        "cpf": "00000000022",
        "dataCriacao": "16/04/2019 16:05:37",
        "dataHoraUltimaModificacao": "16/04/2019 16:06:21",
        "dataModificacao": "16/04/2019 16:06:21",
        "id": 458,
        "nome": "Representante 1",
        "pais": "BRASIL",
        "tipoPessoa": 2
    },
    {
        "ativo": true,
        "codigo": "0000180",
        "cpf": "00000000025",
        "dataCriacao": "16/04/2019 16:00:39",
        "dataHoraUltimaModificacao": "16/04/2019 16:06:49",
        "dataModificacao": "16/04/2019 16:06:49",
        "id": 457,
        "nome": "Representante 2",
        "pais": "BRASIL",
        "tipoPessoa": 2
    },
    {
        "ativo": true,
        "cep": "01234-010",
        "cnaePrincipal": "5819-1/00",
        "codigo": "0000174",
        "dataCriacao": "15/03/2019 10:22:03",
        "dataHoraUltimaModificacao": "15/03/2019 10:22:03",
        "email": "representante3@email.com.br",
        "endereco": "R do representante 3",
        "id": 451,
        "municipio": "São Paulo",
        "nome": "Representante 3",
        "numero": "83",
        "pais": "BRASIL",
        "tipoPessoa": 1,
        "uf": "SP"
    },
...
]


Consultar representantes filtrando por parâmetro


GET - /rest/representantes?query={condições}


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 representantes do 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:


representantes?query=ativo==false


Retorno (exemplo simplificado):

[
    {
        "ativo": true,
        "dataHoraUltimaModificacao": "13/02/2019 08:41:59",
        "dataModificacao": "13/02/2019 08:41:59",
        "email": "teste e-mail proposta",
        "id": 210,
        "nome": "Vendedor Carlos",
        "pais": "BRASIL",
        "tipoPessoa": "1"
    },
    {
        "ativo": true,
        "cep": "01234-025",
        "classificacao": "01",
        "codigo": "0000211",
        "complemento": "Apto 42",
        "cpf": "12345678901",
        "dataHoraUltimaModificacao": "04/02/2019 14:12:41",
        "dataModificacao": "04/02/2019 14:12:41",
        "endereco": "rua do representante",
        "id": 226,
        "idClassificacao": 1,
        "municipio": "São Paulo",
        "nome": "Jo Nomus",
        "numero": "70",
        "pais": "BRASIL",
        "tipoBairro": "BAIRRO",
        "tipoContribuinteICMS": "3",
        "tipoPessoa": "2",
        "uf": "SP"
    },
 
...
]