A API disponibiliza os seguintes campos :
Atributo | Tipo | Descrição |
---|---|---|
id | número | Id da rota no Nomus ERP |
nome | texto | Nome da rota |
ativo | booleano | True se ativo, ou false caso contrário |
Serviços disponíveis
Consultar uma conta a receber
Retorna as informações de uma rota com o id passado por parâmetro.
GET - /rest/rotas/{id_da_rota}
Retorno:
{ "ativo": true, "id": 1, "nome": "132" }
Consultar todas contas a receber
GET - /rest/rotas
Este serviço lista todas as rotas. 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:
rotas?pagina=2
Retorno (exemplo simplificado)::
[ { "ativo": true, "id": 1, "nome": "132" }, { "ativo": true, "id": 2, "nome": "354" }, ... ]
Consultar contas a receber filtrando por parâmetro
GET - /rest/rotas?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 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:
rotas?query=nome==132
Retorno (exemplo simplificado)::
[ { "ativo": true, "id": 1, "nome": "132" } ]