Repasse de Resumo de Pagamento

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

Exemplo de payload
{
  "redeId": 193,
  "empresaId": 388,
  "lojaId": 433,
  "dataInicio": null, // campo opcional para filtrar por data
  "dataFim": null // campo opcional para filtrar por data
  "tipoRel": "PDF", // verificar endpoints de tipagem
  "tipoLancamentoId": -1, // verificar endpoints de tipagem 
  // -1 para todos os tipos de lançamento
}

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 relatórios

É 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 Lançamentos Repasse

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

{{ BASE_API_URL }}/v1/tipos/tipos-lancamento-repasse
Exemplo de response
[
  {
    "id": 1,
    "descricao": "Aluguel POS"
  },
  {
    "id": 2,
    "descricao": "Aluguel TEF"
  },
  {
    "id": 3,
    "descricao": "Cartões Emitidos"
  },
  {
    "id": 4,
    "descricao": "Compras POS"
  },
  ...
  {
    "id": 25,
    "descricao": "Outros Créditos Prático"
  },
  {
    "id": 26,
    "descricao": "Outros Créditos Lojista"
  },
  {
    "id": 27,
    "descricao": "Perdas Prático"
  },
  {
    "id": 28,
    "descricao": "Cadastro Aprovado"
  }
]

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


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