Clientes em atrasos

Para emissão do relatório de clientes em atraso, é enviado uma requisição do tipo POSTpara o endpoint {{ BASE_REPORT_API_URL }}/v1/relatorio/clientes-atraso passando um objeto FiltroRelatorioDTO no corpo da requisição, com os filtros desejados.

Exemplo de payload

FiltroRelatorioDTO

{
  "empresaId": 398,
  "fimAtraso": 10, // qtd máx de dias em atraso desejado.
  "inicioAtraso": 6, // qtd min de dias em atraso desejado.
  "listarEndereco": false,
  "listarSerasa": false,
  "listarTelefone": false,
  "lojaId": 441,
  "redeId": -1,
  "saldoDevedor": "TODAS", // verificar endpoints de tipagem
  "tipoRel": "PDF", // verificar endpoints de tipagem
  "tpGrupos": null, // verificar endpoints de tipagem
  "tpOrdena": "-1"  // opções válidas relacionadas abaixo:  
  // "-1" = alfabética, "1" = por dias em atraso, "2" = por saldo devedor
}

Essa requisição irá retornar um FILE com o relatório em PDF ou XLS, codificado no formato Base64, de acordo com o tipo de relatório escolhido no objeto FiltroRelatorioDTO.

Para composição desse objeto de filtro, acesse as informações abaixo:

Endpoints e documentação para tipagem dos filtros

Tipos de saldo devedor

É enviado uma requisição do tipo GET para o endpoint abaixo, que irá retornar as opções disponíveis para utilização no campo saldoDevedor do objeto FiltroRelatorioDTO.

{{ BASE_API_URL }}/v1/tipos/saldo-devedor

Exemplo de response

[
 {
     "id": "TODAS",
     "descricao": "Todas as faixas"
 },
 {
     "id": "ATE50",
     "descricao": "Até R$ 50,00"
 },
 ...
 {
     "id": "ACIMA50",
     "descricao": "Acima R$ 50,00"
 },
 ...
 {
     "id": "ACIMA10000",
     "descricao": "Acima R$ 10000,00"
 }
]

Tipos de relatório

É enviado uma requisição do tipo GET para o endpoint abaixo, que irá retornar as opções disponíveis para utilização no campo tipoRel do objeto FiltroRelatorioDTO.

{{ BASE_API_URL }}/v1/tipos/tipos-relatorio

Exemplo de response

[
 {
   "id":"PDF",
   "descricao":"PDF"
 },
 {
   "id":"XLS",
   "descricao":"Excel"
 }
]

Tipos grupos

É enviado uma requisição do tipo GET para o endpoint abaixo, que irá retornar as opções disponíveis para utilização no campo tpGrupos do objeto FiltroRelatorioDTO.

{{ BASE_API_URL }}/v1/tipos/tipos-grupos

Exemplo de response

[
  {
      "id": "A",
      "descricao": "A"
  },
  {
      "id": "B",
      "descricao": "B"
  },
  ...
  {
      "id": "Q",
      "descricao": "Aval Loja"
  },
  {
      "id": "Z",
      "descricao": "Não Informado"
  }
]

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

Listar pagamentos Declaração anual de quitação