GET Download usage report

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

Com este endpoint, você pode baixar o arquivo de conferência de consumo de uma empresa na competência informada.

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

Informe a competência em period e o ID da empresa em company_id.

O parâmetro run permite selecionar uma execução específica da apuração. Quando não informado, será utilizada a execução com o maior número disponível para a empresa naquela competência.

Se houver mais de um arquivo na execução selecionada, informe o nome desejado em file. Nesse caso, a consulta sem esse parâmetro retorna 422, com a lista de arquivos disponíveis.

O arquivo é retornado como anexo para download. Novos arquivos podem levar até 10 minutos para ficar disponíveis 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
required

ID da empresa cujo arquivo deseja baixar. Para revendedores, pode ser a própria empresa ou uma subconta vinculada.

integer

Número da execução da apuração. Quando omitido, utiliza a maior execução disponível para a empresa na competência.

string

Nome do arquivo, incluindo a extensão. Exemplo: signatures.csv. Obrigatório quando houver mais de um arquivo na execução. Informe somente o nome, sem barras ou caminho de pastas.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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