Glossário

Os nomes que aparecem no contrato da API, e o que cada um significa.

No contrato

Notice: o ato que o órgão manda comunicar. É o termo guarda-chuva: cobre citação e intimação. É o nome do recurso na API (/notices) e do tipo (Notice).

noticeType: a natureza do ato. Dois valores e só dois:

Ato	Valor
Citação	`SUMMONS`
Intimação	`NOTICE`

O eco entre o nome do recurso e o valor NOTICE é conhecido e aceito: o guarda-chuva e o tipo têm nomes parecidos porque um deles é caso do outro.

protocol: o identificador legível do ato, formado pelo ano de Brasília e uma sequência. É o que uma pessoa lê e cita. Não substitui o id, que é o UUID usado nas rotas.

id: UUIDv7 do ato. É o identificador das rotas.

status: o progresso operacional, dez valores. Ver O rito da comunicação.

case, os dados do processo: número, vara, assunto e as partes.

courtDivision: a vara. É propriedade do ato, não do usuário que o cadastrou: dois atos criados pela mesma pessoa podem ser de varas diferentes.

sourceDocument: o documento que o órgão manda comunicar, identificado pela chave no armazenamento e pelo digest SHA-256.

customFields: campos específicos do órgão, congelados no ato no momento do registro. Mudar o formulário depois não altera atos já criados.

idempotencyKey: a chave que torna a repetição de um registro segura. Ver Registrar um ato.

Os homônimos

Três palavras têm mais de um sentido neste domínio. Quem integra precisa saber qual está em jogo.

“Notificação” tem dois sentidos:

Sentido	Onde vale
Guarda-chuva que cobre citação e intimação	Banco, tipos e contrato da API
Ato próprio de um tribunal de contas	Peças que o cidadão lê, em órgãos que usam esse nome

Um tribunal de contas notifica e cita; “intimação” é palavra do judiciário. Por isso o rótulo que o cidadão vê depende do órgão, e nunca do nome interno do campo.

“Relatório” tem três sentidos que não se misturam: a certidão do desfecho de um ato, os relatórios gerenciais do painel, e o relatório de uso para faturamento. A API que esta documentação cobre não expõe nenhum dos três.

“Mandado” é a palavra do servidor no painel, e varia por cliente. Ela não aparece no contrato da API: lá o nome é notice.