Exportar consumo da empresa

GET

/companies/{companyId}/excel

Consulta o consumo/faturamento de uma empresa e retorna em formato Excel (xlsx), com filtro opcional por mês (month) e ano (year). Requer autenticação via Bearer JWT ou header x-api-key.

Requisição

Authorization

Forneça seu token bearer no cabeçalho

Authorization

ao fazer requisições para recursos protegidos.

Exemplo:

Authorization: Bearer ********************

Parâmetros de Caminho

Parâmetros de Consulta

Parâmetros Header

Respostas

🟢201

application/json

Harvested 201

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/companies/COMPANY_ID/excel?month=&year=' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

201 - Sucesso

binary

Modificado em 2026-10-13 09:47:06

Página anterior

Listar cobranças de uma empresa

Próxima página

Listar extrações de balanço e DRE de um cliente