Listar cobranças de uma empresa

GET

/queries/companies/{companyId}

Lista as cobranças de produtos e planos da empresa informada em companyId, da mais recente para a mais antiga, com o custo total do conjunto filtrado. Cada item traz billingId, userName (quem solicitou), products (nomes dos produtos ou planos cobrados; um estorno aparece como Estorno (nome do produto)), cost, clientName, clientId, createdAt e, quando a requisição traz clientTaxId, o taxId do cliente. Filtros opcionais: text, um trecho do nome do usuário ou do cliente, sem diferenciar maiúsculas; e month (de 1 a 12) com year, para um mês específico: month sem year vale o ano corrente, e year sem month não filtra. clientTaxId não filtra a lista: o valor informado só faz o taxId aparecer em cada item. A lista tem 60 itens por página, em page (a partir de 1). totalCost soma o custo de todas as cobranças que atendem aos filtros, não só as da página, e fica ausente quando não há nenhuma. 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

🟢200

application/json

Cobranças da empresa

Bodyapplication/json

🟠400BadRequest

🟠401Unauthorized

🟠404NotFound

🟠429TooManyRequests

🔴500InternalError

Request Example

Shell

JavaScript

Java

Swift

curl --location '/queries/companies/5b2a9e40-1c3d-4f68-a7b9-0d4e6f8a1c23?page=1&text=Exemplo&month=9&year=2026&clientTaxId=11222333000181' \
--header 'x-api-key: SUA_CHAVE_DE_API' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Sucesso

{
    "totalCost": 30,
    "items": [
        {
            "billingId": "d1e2f3a4-5b6c-4d7e-8f90-a1b2c3d4e5f6",
            "userName": "Usuária Exemplo",
            "products": [
                {
                    "name": "Consulta Boa Vista"
                }
            ],
            "cost": 42,
            "clientName": "Produtor Exemplo",
            "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "taxId": "11222333000181",
            "createdAt": "2026-09-18T14:02:11.402Z"
        },
        {
            "billingId": "e2f3a4b5-6c7d-4e8f-9a01-b2c3d4e5f607",
            "userName": "Usuária Exemplo",
            "products": [
                {
                    "name": "Estorno (Consulta Boa Vista)"
                }
            ],
            "cost": -12,
            "clientName": "Produtor Exemplo",
            "clientId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
            "taxId": "11222333000181",
            "createdAt": "2026-09-19T09:30:05.220Z"
        }
    ]
}

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

Página anterior

Visualizar detalhes de uma CPR

Próxima página

Exportar consumo da empresa