Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.gyramais.com.br/llms.txt

Use this file to discover all available pages before exploring further.

A seção PROTESTS traz os protestos em cartório registrados para o documento, com cobertura nacional. Disponível no relatório COMPLETO e COMPLETO+.

Como os dados são coletados

Os dados de protestos são coletados sempre que um Bureau está definido na política. A GYRA+ adota a seguinte hierarquia de fontes:
  1. Cenprot (prioritário) — por padrão, a GYRA+ busca os dados de protestos diretamente no Cenprot. Quando disponíveis, são esses os dados exibidos e usados na avaliação das regras.
  2. Bureau definido na política (fallback) — caso o Cenprot esteja fora do ar ou retorne dados incompletos (ex.: instabilidades da API ou sobrecarga de chamadas), a GYRA+ utiliza os dados do bureau configurado.
O Cenprot é sempre prioritário quando disponível, tanto na exibição quanto na avaliação das regras. O fallback para o bureau é automático e transparente quando há indisponibilidade.

Campos do details

Totalizadores

CampoTipoDescrição
countnumberQuantidade total de protestos
totalAmountnumberValor total protestado (R$)
lastOccurrenceDatestringData do protesto mais recente
firstOccurrenceDatestringData do protesto mais antigo
calculatedRevenuePercentagenumber% do faturamento comprometido em protestos

Lista de protestos (protests[])

CampoTipoDescrição
idstringID do protesto
amountnumberValor do protesto (R$)
protestDatestringData do protesto
creditorstringCredor
notarystringCartório responsável
citystringCidade
statestringEstado (UF)
instrumentTypestringTipo de instrumento: DUPLICATA, CHEQUE, CCB, NOTA_PROMISSORIA, etc.

Exemplo de resposta

{
  "type": { "value": "PROTESTS" },
  "details": {
    "count": 2,
    "totalAmount": 12500.00,
    "lastOccurrenceDate": "2024-08-20",
    "calculatedRevenuePercentage": 6.3,
    "protests": [
      {
        "amount": 8000.00,
        "protestDate": "2024-08-20",
        "creditor": "Fornecedor XYZ",
        "notary": "1º Ofício de Protestos",
        "city": "São Paulo",
        "state": "SP",
        "instrumentType": "DUPLICATA"
      },
      {
        "amount": 4500.00,
        "protestDate": "2024-05-10",
        "creditor": "Banco ABC",
        "notary": "3º Tabelionato",
        "city": "Campinas",
        "state": "SP",
        "instrumentType": "CCB"
      }
    ]
  }
}

Regras sugeridas para protestos

ObjetivoRegraCritério
Sem protestosNOTARIES_COUNT= 0 → APPROVED
Tolerância mínimaNOTARIES_COUNTBETWEEN 1–2 → ALERT
Negar acima de XNOTARIES_AMOUNT> R$ 50.000 → DENIED
Protestos recentesNOTARIES_LAST_DAYS= 0 nos últimos 90 dias → APPROVED
ProporcionalNOTARIES_CALCULATED_REVENUE< 5% → APPROVED