A API disponibiliza os seguintes campos :


Atributo
Tipo
Descrição
idnúmeroId do grupo de produto no Nomus ERP
tipo
número1 - Confirmada
2 - Prevista
3 - Adiantamento de cliente
4 - Adiantamento a fornecedor
classificacaotextoClassificação da conta a receber
valorReceber
númeroValor a receber
dataVencimento
data (dd/mm/aaaa)
Data de vencimento da conta a receber
nomeEmpresa
textoNome da empresa da conta
idEmpresa
númeroId da empresa da conta no Nomus ERP
nomeContaBancaria
textoNome da conta bancária
idContaBancaria
númeroId da conta bancário no Nomus ERP
nomeFormaPagamento
textoNome da forma de pagamento
idFormaPagamento
númeroId da forma de pagamento no Nomus ERP
valorReceberAgendado
númeroValor a receber que está agendado para esta conta
dataAgendamento
data (dd/mm/aaaa)
Data agendada do valor a receber que está agendado
nomePessoatextoNome da pessoa que efetuará o pagamento da conta
idPessoa
númeroId da pessoa no Nomus ERP
dataCompetenciadata (dd/mm/aaaa)
Data da competência da conta
descricaoLancamento
textoDescrição do lançamento na conta
comentarios
textoComentários na conta
statusbooleanoTrue se está baixada, ou false caso contrário
dataBaixa
data (dd/mm/aaaa)
Data da baixa da conta
valorRecebido
númeroValor baixado na conta
saldoReceber
númeroO saldo que tem a receber
numeroNotaFiscalOrigem
númeroNúmero da nota fiscal associada à conta


Serviços disponíveis


Consultar uma conta a receber


Retorna as informações de uma conta a receber com o id passado por parâmetro.


GET - /rest/contasReceber/{id_da_conta_receber}


Retorno:


{
    "classificacao": "10.01.01",
    "comentarios": "",
    "dataAgendamento": "17/05/2019",
    "dataCompetencia": "14/05/2019",
    "dataVencimento": "17/05/2019",
    "descricaoLancamento": "Documento 1365 - Parcela 1 de 1",
    "id": 2733,
    "idContaBancaria": 5,
    "idEmpresa": 2,
    "idFormaPagamento": 10,
    "nomeContaBancaria": "E02 - Caixa Pequeno",
    "nomeEmpresa": "Empresa Padrão",
    "nomeFormaPagamento": "Boleto Bancário",
    "tipo": 1,
    "valorReceber": "10,00",
    "valorReceberAgendado": "10,00"
}




Consultar todas contas a receber


GET - /rest/contasReceber


Este serviço lista todas as contas a receber. 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:


contasReceber?pagina=2


Retorno (exemplo simplificado)::


[
    {
        "classificacao": "10.01.01",
        "comentarios": "",
        "dataAgendamento": "17/05/2019",
        "dataCompetencia": "14/05/2019",
        "dataVencimento": "17/05/2019",
        "descricaoLancamento": "Documento 1365 - Parcela 1 de 1",
        "id": 2733,
        "idContaBancaria": 5,
        "idEmpresa": 2,
        "idFormaPagamento": 10,
        "nomeContaBancaria": "E02 - Caixa Pequeno",
        "nomeEmpresa": "Empresa Padrão",
        "nomeFormaPagamento": "Boleto Bancário",
        "tipo": 1,
        "valorReceber": "10,00",
        "valorReceberAgendado": "10,00"
    },
   {
        "classificacao": "10.01.01",
        "comentarios": "",
        "dataAgendamento": "29/06/2019",
        "dataCompetencia": "07/05/2019",
        "dataVencimento": "29/06/2019",
        "descricaoLancamento": "Documento 1351 - Parcela 3 de 3",
        "id": 2721,
        "idContaBancaria": 29,
        "idEmpresa": 35,
        "idFormaPagamento": 10,
        "nomeContaBancaria": "ITAÚ",
        "nomeEmpresa": "qwerty LTDA",
        "nomeFormaPagamento": "Boleto Bancário",
        "tipo": 1,
        "valorReceber": "333.333,34",
        "valorReceberAgendado": "333.333,34"
    },
    {
        "classificacao": "10.01.01",
        "comentarios": "",
        "dataAgendamento": "18/06/2019",
        "dataCompetencia": "07/05/2019",
        "dataVencimento": "18/06/2019",
        "descricaoLancamento": "Documento 1351 - Parcela 2 de 3",
        "id": 2720,
        "idContaBancaria": 29,
        "idEmpresa": 35,
        "idFormaPagamento": 10,
        "nomeContaBancaria": "ITAÚ",
        "nomeEmpresa": "qwerty LTDA",
        "nomeFormaPagamento": "Boleto Bancário",
        "tipo": 1,
        "valorReceber": "333.333,33",
        "valorReceberAgendado": "333.333,33"
    }
...
]



Consultar contas a receber filtrando por parâmetro


GET - /rest/contasReceber?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:


contasReceber?query=tipo==1;idContaBancaria==5


Retorno  (exemplo simplificado)::


[
    {
        "classificacao": "10.01.01",
        "comentarios": "",
        "dataAgendamento": "17/05/2019",
        "dataCompetencia": "14/05/2019",
        "dataVencimento": "17/05/2019",
        "descricaoLancamento": "Documento 1365 - Parcela 1 de 1",
        "id": 2733,
        "idContaBancaria": 5,
        "idEmpresa": 2,
        "idFormaPagamento": 10,
        "nomeContaBancaria": "E02 - Caixa Pequeno",
        "nomeEmpresa": "Empresa Padrão",
        "nomeFormaPagamento": "Boleto Bancário",
        "tipo": 1,
        "valorReceber": "10,00",
        "valorReceberAgendado": "10,00"
    },
    {
        "classificacao": "10.01.01",
        "comentarios": "",
        "dataAgendamento": "17/05/2019",
        "dataCompetencia": "14/05/2019",
        "dataVencimento": "17/05/2019",
        "descricaoLancamento": "Documento 1363 - Parcela 1 de 1",
        "id": 2731,
        "idContaBancaria": 5,
        "idEmpresa": 2,
        "idFormaPagamento": 10,
        "nomeContaBancaria": "E02 - Caixa Pequeno",
        "nomeEmpresa": "Empresa Padrão",
        "nomeFormaPagamento": "Boleto Bancário",
        "tipo": 1,
        "valorReceber": "10,00",
        "valorReceberAgendado": "10,00"
    },
    {
        "classificacao": "10.01.01",
        "comentarios": "",
        "dataAgendamento": "10/05/2019",
        "dataCompetencia": "07/05/2019",
        "dataVencimento": "10/05/2019",
        "descricaoLancamento": "Documento 1360 - Parcela 1 de 1",
        "id": 2728,
        "idContaBancaria": 5,
        "idEmpresa": 2,
        "idFormaPagamento": 10,
        "nomeContaBancaria": "E02 - Caixa Pequeno",
        "nomeEmpresa": "Empresa Padrão",
        "nomeFormaPagamento": "Boleto Bancário",
        "tipo": 1,
        "valorReceber": "10,00",
        "valorReceberAgendado": "10,00"
    }
...
]