Movimento de Pagamentos
Para emissão do relatório de movimento de pagamentos, é enviado uma requisição do tipo POSTpara o endpoint {{ BASE_REPORT_API_URL }}/v1/relatorio/mov-pagamentos passando um objeto FiltroRelatorioDTO no corpo da requisição, com os filtros desejados.
Exemplo de payload
{
"redeId": 193,
"empresaId": 388,
"lojaId": 433,
"dataInicio": "2023-11-29", // campo obrigatório para filtrar por data
"dataFim": "2023-12-01", // campo obrigatório para filtrar por data
"listarEstornos": false, // incluir compras canceladas no relatório
"tpPor": "CAIXA", // verificar endpoints de tipagem
"tipoRel": "PDF", // verificar endpoints de tipagem
"tipoPagamento": "TODOS", // verificar endpoints de tipagem
}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[
{
"id":"PDF",
"descricao":"PDF"
},
{
"id":"XLS",
"descricao":"Excel"
}
]Tipos regime por 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 tpPor do objeto FiltroRelatorioDTO.
{{ BASE_API_URL }}/v1/tipos/por-relatorio[
{
"id": "CAIXA",
"descricao": "Caixa"
},
{
"id": "COMPETENCIA",
"descricao": "Competência"
}
]Tipo de Pagamentos
É enviado uma requisição do tipo GET para o endpoint abaixo, que irá retornar as opções disponíveis para utilização no campo tipoPagamento do objeto FiltroRelatorioDTO.
{{ BASE_API_URL }}/v1/tipos/tipo-pagamento[
{
"id": "ADMINISTRADORA",
"descricao": "Administradora"
},
{
"id": "CARTAO_CREDITO",
"descricao": "Cartão de Crédito"
},
{
"id": "TED",
"descricao": "Ted"
},
{
"id": "PIX",
"descricao": "Pix"
},
{
"id": "LOJA",
"descricao": "Loja"
},
{
"id": "BANCO",
"descricao": "Banco"
},
{
"id": "TODOS",
"descricao": "Todos"
}
]