Consultar Carnês do Cliente

Para buscar os carnês de compras de um cliente é enviado uma requisição do tipo POST para o endpoint {{ BASE_API_URL }}/v1/cliente/{id}/carnes passando como parâmetro o id do cliente na url e no corpo da requisição o objeto CarneClienteDTO, conforme exemplo abaixo:

Exemplo de payload com filtros para consultar carnês
{
  "dataFinal": null,
  "dataInicial": null,
  "lojaId": 441,
  "status": null
}
Exemplo de response com lista de carnês do cliente
[
  {
    "id": null,
    "mensagem": null,
    "permissao": null,
    "dataInicial": null,
    "dataFinal": null,
    "lojaId": null,
    "status": "Em Aberto",
    "tipoCarne": "Carnê Compra",
    "selected": false,
    "expanded": false,
    "carneId": 693782,
    "vendaId": 678192,
    "renegociacaoId": null,
    "dataCompra": 1699552619532,
    "qtdParcela": 1,
    "nomeLoja": "Sonho Azul",
    "valorTotal": 101.69,
    "valorEntrada": 0.00,
    "peMultaPorAtraso": 2.00,
    "peJurosMoraPorAtraso": 13.00,
    "saldoDevedorCarne": 101.69,
    "totalAtrasoCarne": 0,
    "totalVencerCarne": null,
    "totalMultaJurosCarne": 0,
    "parcelas": [
      {
        "id": 708711,
        "mensagem": null,
        "permissao": null,
        "selected": false,
        "podeCancelar": false,
        "dataInicial": null,
        "dataFinal": null,
        "lojaId": 441,
        "empresaId": null,
        "redeId": null,
        "status": "Cancelado",
        "lojaCompra": "Sonho Azul",
        "valor": 101.69,
        "numero": 1,
        "dataVencimento": "19/12/2023",
        "pagamentoId": 591988,
        "dataPagto": "09/11/2023",
        "valorPago": 101.69,
        "valorMulta": 0.00,
        "valorJurosMora": 0.00,
        "desconto": 0.00,
        "localPagto": "Loja",
        "nomeCliente": null,
        "peMulta": 2.00,
        "peJurosMora": 13.00,
        "motivoCancelamento": "teste",
        "tipoPagamento": null,
        "flgCancelado": true,
        "qtdDiasAtraso": 0
      },
      {
        "id": 708712,
        "mensagem": null,
        "permissao": null,
        "selected": false,
        "podeCancelar": false,
        "dataInicial": null,
        "dataFinal": null,
        "lojaId": 441,
        "empresaId": null,
        "redeId": null,
        "status": "Em Aberto",
        "lojaCompra": "Sonho Azul",
        "valor": 101.69,
        "numero": 1,
        "dataVencimento": "19/12/2023",
        "pagamentoId": null,
        "dataPagto": null,
        "valorPago": 101.69,
        "valorMulta": 0,
        "valorJurosMora": 0,
        "desconto": null,
        "localPagto": null,
        "nomeCliente": null,
        "peMulta": 2.00,
        "peJurosMora": 13.00,
        "motivoCancelamento": null,
        "tipoPagamento": null,
        "flgCancelado": false,
        "qtdDiasAtraso": 0
      }
    ],
    "formaPagamento": "CARNE"
  }
]

Para consultar o tipo a ser utilizado no campo CarneClienteDTO.status, é enviado uma requisição do tipo GET para o endpoint {{ BASE_API_URL }}/v1/tipos/status-carne e o retorno será um array de objetos conforme exemplo abaixo:

Exemplo de response do status do carnê
[
  {
    "id": "EM_ABERTO",
    "descricao": "Em Aberto"
  },
  {
    "id": "PAGO",
    "descricao": "Pago"
  },
  {
    "id": "CANCELADO",
    "descricao": "Cancelado"
  },
  {
    "id": "RENEGOCIADO",
    "descricao": "Renegociado"
  }
]

Para mais informações, acesse a documentação da API:


Consultar autorizações de comprasConsultar pagamentos