GET Usage reports

O campo size de cada arquivo de relatório usa bytes. Filtros ausentes ou inválidos retornam HTTP 422, com os campos message e errors.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Com este endpoint, você pode consultar os arquivos de conferência de consumo gerados pela apuração mensal.

Contas revendedoras podem consultar os arquivos da própria empresa e das suas subcontas vinculadas diretamente. As demais empresas podem consultar somente os próprios arquivos.

Informe a competência no parâmetro period. Você também pode filtrar os resultados por empresa e por execução da apuração, utilizando company_id e run.

Sem o filtro company_id, serão retornados os arquivos de todas as empresas permitidas para o usuário do token. Sem o filtro run, serão retornadas todas as execuções disponíveis na competência.

Cada resultado inclui o endereço para download do arquivo, que também exige autenticação.

Novos arquivos podem levar até 10 minutos para aparecer na consulta, conforme a configuração de atualização da listagem.

Query Params
string
required

Competência da apuração no formato AAAA-MM. Exemplo: 2026-09.

integer

ID da empresa que deseja consultar. Para revendedores, pode ser a própria empresa ou uma subconta vinculada.

integer

Número da execução da apuração. Utilize para consultar os arquivos de uma execução específica.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json