Compras por clientes

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

Exemplo de payload

{
  "dataFim": null, // campo opcional para filtrar por data
  "dataInicio": null, // campo opcional para filtrar por data
  "empresaId": 388,
  "lojaId": 433,
  "redeId": 193,
  "listarEstornos": false, // incluir compras canceladas no relatório
  "comprasSemJuros": false, // listar apenas o valor principal
  "totalizarCliente": false, // detalhar compras da loja por cliente
  "tipoRel": "PDF", // verificar endpoints de tipagem
  "tpGrupos": "null", // verificar endpoints de tipagem
  "tpPor": "CAIXA", // 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

Exemplo de response

[
  {
    "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

Exemplo de response

[
  {
      "id": "A",
      "descricao": "A"
  },
  {
      "id": "B",
      "descricao": "B"
  },
  ...
  {
      "id": "Q",
      "descricao": "Aval Loja"
  },
  {
      "id": "Z",
      "descricao": "Não Informado"
  }
]

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

Exemplo de response

[
  {
    "id": "CAIXA",
    "descricao": "Caixa"
  },
  {
    "id": "COMPETENCIA",
    "descricao": "Competência"
  }
]

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

Compras canceladas Compras por idas a loja