Glossário

Os termos do domínio Arbitralis usados nesta documentação e nos payloads da API.

Esta página reúne os termos que aparecem nos campos e respostas da API. Vale a leitura antes de mapear os dados do seu sistema para os da Arbitralis.

Estrutura

Workspace

O escritório, câmara de arbitragem ou empresa que contrata a Arbitralis. Toda API key pertence a um workspace e só enxerga os dados dele. Nos payloads internos aparece como escritorio.

O nível acima do workspace. Algumas chaves de idempotência (batchCode, externalId, número de processo) têm escopo de empresa, não de workspace — na prática, isso significa que o mesmo código não pode se repetir entre workspaces da mesma empresa.

Notificações extrajudiciais

Notificação extrajudicial

Comunicação formal enviada a uma pessoa fora de um processo judicial — cobrança, aviso de vencimento, convite à negociação. Não confundir com intimação, que é comunicação judicial.

Item

Uma notificação individual. Todo item pertence a um lote — mesmo quando você cria uma notificação avulsa, a API gera um lote individual para acomodá-la.

Lote (batch)

Agrupamento de itens que compartilham método de envio, templates e agendamento. É a unidade de confirmação e disparo.

Método de envio (`deliveryMethod`)

Valor	Canal
`DIGITAL`	WhatsApp e/ou e-mail
`EMAIL_ONLY`	Apenas e-mail
`WHATSAPP_ONLY`	Apenas WhatsApp
`PHYSICAL`	Carta física (SEDEX)
`DIGITAL_PHYSICAL`	Digital + carta física

Nomes internos podem aparecer nas respostas

Algumas respostas expõem o método no vocabulário interno: DIGITAL, EMAIL_APENAS, WHATSAPP_APENAS, SEDEX e DIGITAL_SEDEX. Eles correspondem, na ordem, aos cinco valores da tabela acima.

Template de notificação

O documento da notificação — o conteúdo jurídico que o destinatário visualiza e baixa no portal. Cadastrado no painel da Arbitralis, com variáveis interpoláveis ({{nome}}, {{numero_contrato}}).

É referenciado por notificationTemplateId e vale para todos os canais: o mesmo documento serve WhatsApp, e-mail e carta física. Os canais carregam apenas o aviso que leva o destinatário até o portal, e o layout desse aviso é fixo do sistema — não é escolhido nem editado pelo cliente.

Consulte os disponíveis em Listar templates.

Variáveis do template

Cada template declara as variáveis que usa, classificadas por origem:

BASE_PLATFORM — preenchidas pela Arbitralis a partir dos dados da notificação (nome, CPF, valor).
CUSTOM_FIELD — campos personalizados do workspace, que você envia em metadata.

O campo mustSendInPayload de Obter um template diz exatamente quais valores sua integração precisa fornecer.

Opções de resposta (`responseOptions`)

Botões que o destinatário vê no portal da Arbitralis ao abrir a notificação. Cada opção tem um rótulo e um tipo: RESPONSE (resposta genérica), MANIFESTATION (manifestação), DISAGREEMENT (discordância) ou NEGOTIATION_REQUEST (solicitação de negociação).

Margem de negociação (`negotiationMargin`)

Percentual de 0 a 100 que define o desconto máximo que pode ser oferecido ao destinatário no portal de negociação.

Negociações

Agente

Fluxo automatizado que conduz uma negociação — envia mensagens, interpreta respostas, aplica regras de desconto e escala para um humano quando necessário. Cada agente declara as variáveis que espera receber (agenteVariables). Consulte Listar agentes.

Negociação (caso)

Uma conversa de negociação com uma contraparte específica, conduzida por um agente. Tem ciclo de vida próprio.

Contraparte (`counterparty`)

A pessoa com quem se negocia — normalmente o devedor. Identificada por CPF/CNPJ, nome e telefone.

`agenteInput`

Mapa chave-valor com as variáveis que o agente consome durante a execução: valor pleiteado, piso de negociação, instruções extras e campos personalizados. As chaves aceitas vêm de Obter um agente.

Status da negociação

Status	Significado
`SCHEDULED`	Agendada; o agente inicia na data marcada
`STARTED`	Recém-criada e iniciada
`ACTIVE`	Em andamento
`PAUSED`	Pausada; o agente não atua
`AGREEMENT_CLOSED`	Encerrada com acordo — não permite reabertura
`NO_AGREEMENT`	Encerrada sem acordo
`CLOSED`	Encerrada por desistência ou cancelamento

O arquivamento é independente do status e aparece no campo archivedAt.

Tipo de encerramento

Tipo	Status final
`ACORDO_MANUAL`	`AGREEMENT_CLOSED` — exige `detalhesAcordo`
`ACORDO_IA`	`AGREEMENT_CLOSED`
`DESISTENCIA`	`CLOSED`
`CANCELAMENTO`	`CLOSED`

Processos judiciais

Processo

Caso judicial — cumprimento de sentença, execução de título, ação ordinária. Identificado pelo numero, que também é a chave de idempotência na ingestão.

Partes

As pessoas vinculadas ao processo. Na ingestão, os requerentes viram partes do tipo AUTOR, os requeridos viram RÉU e advogadoRequerente vira ADVOGADO.

Tipo de processo

Valor	Significado
`CUMPRIMENTO`	Cumprimento de sentença (padrão)
`EXECUCAO_SENTENCA`	Execução de sentença
`EXECUCAO_TITULO`	Execução de título extrajudicial