Compras por idas à loja
Para emissão do relatório de compras por idas à loja, é enviado uma requisição do tipo POSTpara o endpoint {{ BASE_REPORT_API_URL }}/v1/relatorio/idas-a-loja passando um objeto FiltroRelatorioDTO no corpo da requisição, com os filtros desejados.
Exemplo de payload
{
"dataFim": null, // campo opcional para customizar o período
"dataInicio": null, // campo opcional para customizar o período
"empresaId": 388,
"lojaId": 433,
"redeId": 193,
"tipoRel": "PDF", // verificar endpoints de tipagem
"tpGrupos": "null", // verificar endpoints de tipagem
"tpPeriodo": "SETE_DIAS" // verificar endpoints de tipagem - opções de períodos padrão
}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 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[
{
"id": "A",
"descricao": "A"
},
{
"id": "B",
"descricao": "B"
},
...
{
"id": "Q",
"descricao": "Aval Loja"
},
{
"id": "Z",
"descricao": "Não Informado"
}
]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"
}
]