Crédito, renda e birô

Quod Gasto Estimado PJ

Gasto mensal estimado da empresa (CNPJ) e comprometimento do faturamento.

Quando usar

Descrição

O serviço Quod Gasto Estimado PJ retorna o gasto mensal estimado da empresa e o percentual do faturamento comprometido com esse gasto, para apoiar a avaliação da capacidade de pagamento.

Requisição

Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.

POST /api/v1/{tenant}/empresas/quod-gasto-estimado-pj

CampoObrigatórioDescrição
document sim CNPJ da empresa, com ou sem máscara.
{
  "document": "00.000.000/0000-00"
}

Campos de retorno

Campos dentro de data. [] indica lista.

CampoTipo
VerifiQPJResponseEx.Response.Header.Status número
VerifiQPJResponseEx.Response.Header.QueryId texto
VerifiQPJResponseEx.Response.Header.TransactionId texto
VerifiQPJResponseEx.Response.Records.QdpjVerifiQPJOutput[].CNPJ texto
VerifiQPJResponseEx.Response.Records.QdpjVerifiQPJOutput[].DateReference texto
VerifiQPJResponseEx.Response.Records.QdpjVerifiQPJOutput[].Analytics.GastoEstimadoPJ.ExpenseValue texto
VerifiQPJResponseEx.Response.Records.QdpjVerifiQPJOutput[].Analytics.GastoEstimadoPJ.PercentExpense texto
VerifiQPJResponseEx.Response.Records.QdpjVerifiQPJOutput[].Analytics.GastoEstimadoPJ.RangePresumed texto
VerifiQPJResponseEx.Response.Records.QdpjVerifiQPJOutput[].Analytics.GastoEstimadoPJ.PercentPresumed texto

Exemplo de resposta

Estrutura real da resposta, com valores fictícios.

{
  "execution_id": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "message": "Consulta realizada com sucesso",
  "query_name": "Quod Gasto Estimado PJ",
  "query_slug": "quod-gasto-estimado-pj",
  "data": {
    "VerifiQPJResponseEx": {
      "Response": {
        "Header": {
          "Status": 0,
          "QueryId": "texto",
          "TransactionId": "texto"
        },
        "Records": {
          "QdpjVerifiQPJOutput": [
            {
              "CNPJ": "texto",
              "DateReference": "texto",
              "Analytics": {
                "GastoEstimadoPJ": {
                  "ExpenseValue": "texto",
                  "PercentExpense": "texto",
                  "RangePresumed": "texto",
                  "PercentPresumed": "texto"
                }
              }
            }
          ]
        }
      }
    }
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "3.180"
}

Cobrança e respostas

  • O valor é cobrado por consulta bem-sucedida.
  • 200 — consulta processada (veja status no corpo da resposta)
  • 401 — token ausente, inválido, inativo ou expirado
  • 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
  • 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
  • 429 — limite de requisições por minuto da chave excedido
  • 504 — tempo máximo de execução do serviço excedido