Compras canceladas

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

Exemplo de payload

{
  "dataInicio": "2021-09-01", // campo opcional para filtrar por data
  "dataFim": "2021-09-30",  // campo opcional para filtrar por data
  "empresaId": 393,
  "lojaId": 437,
  "redeId": 193,
  "tipoRel": "PDF", // verificar endpoints de tipagem
  "userPratico": -1, // enviar -1 como valor padrão
  "valor": "0,00", // campo opcional para filtrar por valor mínimo
  "tpLanc": "0", // opções válidas relacionadas abaixo:  
  // "0" = "Todos", "1" = "Apenas compras", 
  // "2" = "Apenas renegociações"
}

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"
  }
]

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

Relação de clientes Compras por cliente