Faturas Financeiras

Endpoint para buscarmos pendencias financeiras para recebimento.

Este método é responsável para retornar dados (lista) de faturas pendentes de um cliente, ou uma entidade devedora.

O endpoint para estas consultas é /api/financeiro/faturas, verbo GET onde poderão ser informados os seguintes filtros:

  • ?dueForUser=true >> Traz todas as pendências do usuário logado. (Implementação não obrigatória).

  • ?query=XXX >> busca inteligente por parte do ERP

  • ?cnpj=XXX >> traz as pendências de um determinado CNPJ no ERP.

  • ?codCliente=XXX >> traz as pendências de um determinado Cliente por Código;

  • ?numFatura=XXX >> traz as pendências de um determinado Cliente pelo numero da fatura;

  • ?numDocumento=XXX >> traz as pendências de um determinado Cliente pelo numero do documento de origem;

  • ?page=XXX (Implementação não obrigatória) >> será informada a pagina dos registros

O retorno esperado é 200 - OK, com uma lista de pendências financeiras com o objeto:

//RESPONSÁVEL: ERP
{
    "list":[{
        "numeroFatura":"10", //CAMPO STRING >> Identificação do fatura (Único)
        "historico":"Pedido de Venda 15",
        "valorFatura":100,
        "pagamentoParcial": true, //Aceita receber parte do Valor
        "pessoa: {
            "cpfCnpj":"xxx",
            "codigo" : 10 , //Codigo do cliente
            "nome": "NOME DO CLIENTE" //FORMATAVEL
        },
        "pagamento: {
            [{    
                "nome" : "Dinheiro", //Nome que irá aparecer
                "tipoPagamento" : 0, // Enum com as possibilidades
                "numeroParcelas" : 1 // Em quantas parcelas pode fazer 
            }]
        }
        "origem: {
            [{
                "origem" : "Nota Fiscal", //Origem que gerou a fatura
                "numero" : "1", //Numero do documento que originou
                "infAdic" : "Informação" // Informação adicional sobre a origem.
            }]
        }
    }],
    "totalResults": 1,
    "totalPages": 1,
    "pageIndex": 1,
    "pageSize": 10
}

Com este retorno será realizada a apresentação das pendências de recebimento ao operador e ele selecionará UM OU MAIS items para recebimento.

**No momento do cadastramento da solução, será parametrizado se pode ser realizado mais de um recebimento ao mesmo tempo.

Last updated