A seçãoDocumentation 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.
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:- 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.
- 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
| Campo | Tipo | Descrição |
|---|---|---|
count | number | Quantidade total de protestos |
totalAmount | number | Valor total protestado (R$) |
lastOccurrenceDate | string | Data do protesto mais recente |
firstOccurrenceDate | string | Data do protesto mais antigo |
calculatedRevenuePercentage | number | % do faturamento comprometido em protestos |
Lista de protestos (protests[])
| Campo | Tipo | Descrição |
|---|---|---|
id | string | ID do protesto |
amount | number | Valor do protesto (R$) |
protestDate | string | Data do protesto |
creditor | string | Credor |
notary | string | Cartório responsável |
city | string | Cidade |
state | string | Estado (UF) |
instrumentType | string | Tipo de instrumento: DUPLICATA, CHEQUE, CCB, NOTA_PROMISSORIA, etc. |
Exemplo de resposta
Regras sugeridas para protestos
| Objetivo | Regra | Critério |
|---|---|---|
| Sem protestos | NOTARIES_COUNT | = 0 → APPROVED |
| Tolerância mínima | NOTARIES_COUNT | BETWEEN 1–2 → ALERT |
| Negar acima de X | NOTARIES_AMOUNT | > R$ 50.000 → DENIED |
| Protestos recentes | NOTARIES_LAST_DAYS | = 0 nos últimos 90 dias → APPROVED |
| Proporcional | NOTARIES_CALCULATED_REVENUE | < 5% → APPROVED |

