Declaração anual de quitação

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

Exemplo de payload

{
  "dataDeInicio": "2021", // Ano base da declaração
  "empresaId": 393,
  "lojaId": 437,
  "redeId": 193,
  "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

Exemplo de response

[
  {
    "id":"PDF",
    "descricao":"PDF"
  },
  {
    "id":"XLS",
    "descricao":"Excel"
  }
]

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

Clientes em atrasos Limite disponível por cliente