Núclea — Valor Histórico Transacionado

{
  "type": "object",
  "properties": {
    "cnpj": {
      "type": [
        "string",
        "null"
      ],
      "description": "CNPJ consultado, sem máscara — eco do parâmetro informado."
    },
    "consta": {
      "type": [
        "boolean",
        "null"
      ],
      "description": "true quando há movimentação registrada para o CNPJ na janela consultada. Quando não há registros no recorte (boleto, TED e cartão), a resposta vem com consta: false e uma mensagem explicativa — e a consulta é cobrada normalmente, pois foi executada na base de origem."
    },
    "escopo": {
      "type": [
        "string",
        "null"
      ],
      "description": "O que a soma cobre: recebimentos em boleto, cartão e TED."
    },
    "abrangencia": {
      "type": [
        "string",
        "null"
      ],
      "description": "Abrangência da leitura: CNPJ completo — matriz e filiais somadas, ainda que a consulta informe o CNPJ de uma filial."
    },
    "janelaMeses": {
      "type": [
        "integer",
        "null"
      ],
      "description": "Tamanho da janela de apuração, em meses. Nesta consulta, 12 meses retroativos."
    },
    "mesReferencia": {
      "type": [
        "string",
        "null"
      ],
      "description": "Mês da carga de dados usada na apuração, no formato AAAAMM. A base é atualizada mensalmente; a janela de 12 meses termina neste mês."
    },
    "valorTransacionado": {
      "type": [
        "string",
        "null"
      ],
      "description": "Valor total recebido nos últimos 12 meses, formatado em reais (ex.: R$ 1.234.567,89). Importante: é o valor que transitou em boleto, cartão e TED — não é o faturamento da empresa. Vendas recebidas por Pix ou em dinheiro não entram nesta soma."
    },
    "valorTransacionadoNumerico": {
      "type": [
        "number",
        "null"
      ],
      "description": "O mesmo valor em formato numérico, pronto para cálculo (ex.: 1234567.89)."
    }
  },
  "description": "Valor total que a empresa efetivamente recebeu nos últimos 12 meses em boleto, cartão e TED, medido na infraestrutura de compensação do sistema bancário. É movimentação real compensada — não é estimativa estatística nem faturamento declarado."
}