Pagamento por Local
Para emissão do relatório de pagamento por local, é enviado uma requisição do tipo POSTpara o endpoint {{ BASE_REPORT_API_URL }}/v1/relatorio/pag-local passando um objeto FiltroRelatorioDTO no corpo da requisição, com os filtros desejados.
Exemplo de payload
{
"redeId": 193,
"empresaId": 388,
"lojaId": 433,
"dataInicio": null,
"dataFim": null,
"listarPagamentoAcordo": false, // listar apenas renegociações
"listarEstornos": false, // incluir compras canceladas no relatório
"tpPagamento": "0", // 0 - Todos, 1 - Banco, 2 - Em loja
"totalizacao": "DIARIA", // verificar endpoints de tipagem
"tpPeriodo": "SETE_DIAS", // verificar endpoints de tipagem
"tpPor": "CAIXA", // verificar endpoints de tipagem
"tipoRel": "PDF", // 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"
}
]Tipos período
É enviado uma requisição do tipo GET para o endpoint abaixo, que irá retornar as opções disponíveis para utilização no campo tpPeriodo do objeto FiltroRelatorioDTO.
{{ BASE_API_URL }}/v1/tipos/periodo-relatorio[
{
"id": "HOJE",
"descricao": "Hoje"
},
{
"id": "ONTEM",
"descricao": "Ontem"
},
{
"id": "SETE_DIAS",
"descricao": "Últimos 7 dias"
},
{
"id": "TRINTA_DIAS",
"descricao": "Últimos 30 dias"
},
{
"id": "SESSENTA_DIAS",
"descricao": "Últimos 60 dias"
}
]Tipos de totalizações
É enviado uma requisição do tipo GET para o endpoint abaixo, que irá retornar as opções disponíveis para utilização no campo totalizacao do objeto FiltroRelatorioDTO.
{{ BASE_API_URL }}/v1/tipos/totalizar-data-relatorio[
{
"id": "DIARIA",
"descricao": "Diária"
},
{
"id": "MENSAL",
"descricao": "Mensal"
},
{
"id": "ANUAL",
"descricao": "Anual"
}
]