A API disponibiliza os seguintes campos :
| Atributo | Tipo | Descrição |
|---|---|---|
| id | número | Id da forma de pagamento no Nomus ERP |
| nome | texto | Nome da forma de pagamento |
| descricao | texto | Descrição da forma de pagamento |
| meioPagamentoNfe | texto | O meio de pagamento utilizado |
| ativo | booleano | True se ativo, ou false caso contrário |
Serviços disponíveis
Consultar uma forma de pagamento
Retorna as informações de uma forma de pagamento com o id passado por parâmetro.
GET - /rest/formasPagamento/{id_da_forma_de_pagamento}Retorno:
{
"ativo": true,
"id": 1,
"meioPagamentoNfe": "01",
"nome": "Dinheiro"
}Consultar todas formas de pagamento
GET - /rest/formasPagamento
Este serviço lista todas as formas de pagamento. 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:
formasPagamento?pagina=2
Retorno (exemplo simplificado)::
[
{
"ativo": true,
"descricao": "",
"id": 13,
"meioPagamentoNfe": "99",
"nome": "Depósito"
},
{
"ativo": true,
"id": 12,
"meioPagamentoNfe": "99",
"nome": "Outros"
},
{
"ativo": true,
"id": 11,
"meioPagamentoNfe": "90",
"nome": "Sem pagamento"
},
{
"ativo": true,
"id": 10,
"meioPagamentoNfe": "15",
"nome": "Boleto Bancário"
},
{
"ativo": true,
"id": 9,
"meioPagamentoNfe": "13",
"nome": "Vale Combustível"
},
{
"ativo": true,
"id": 8,
"meioPagamentoNfe": "12",
"nome": "Vale Presente"
},
...
]Consultar formas de pagamento filtrando por parâmetro
GET - /rest/formasPagamento?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:
formasPagamento?query=ativo==true;nome=="Vale Presente"
Retorno (exemplo simplificado)::
[
{
"ativo": true,
"id": 8,
"meioPagamentoNfe": "12",
"nome": "Vale Presente"
}
]

