Campos e XCampos

Cada cliente configura no Xjur a tela de cadastro de processo por área do direito: quais campos aparecem, quais são obrigatórios e quais campos personalizados (XCampos) existem — por exemplo “Área de Origem da Demanda”, “D&O”, “Marcação de Débito”. Esta página mostra como descobrir esses campos e como enviá-los.

Consultar os campos

GET /processo/areas/{areaDireitoId}/campos HTTP/1.1

Parâmetro	Padrão	Descrição
incluirOpcoes	true	Traz as opções das listas, os níveis da lista nivelada e as colunas das tabelas
somentePersonalizados	false	Só os XCampos

Cada item da resposta:

Propriedade	Descrição
nome	Nome técnico do campo (ex.: ipirangaAreadoDireito). Nos XCampos, pode ser usado em campo
rotulo	Rótulo da tela (ex.: “Área do Direito”). Também aceito em campo
tipo	Tipo no Xjur: Lista, ListaMulti, ListaNivelada, Tabela, ListaTipoPedido, Texto, Data, Valor…
obrigatorio	Se a tela exige o campo
condicional	O campo só aparece conforme o valor de outro; a obrigatoriedade dele não é conferida pela integração
separador	Aba da tela em que o campo aparece
personalizado	true para XCampos, enviados em camposPersonalizados
campoId	Id do XCampo
propriedade	Onde enviar o campo no payload de POST /processo
valorEm	Nos XCampos, a propriedade de camposPersonalizados[] que recebe o valor
catalogo	Catálogo com os valores aceitos (GET /processo/catalogos/{catalogo})
suportado	false quando o campo não pode ser enviado pela integração (upload de documento, advogados de escritório…)
opcoes	{ opcaoId, nome, codigo, nivel, opcaoPaiId }
niveis	Lista nivelada: { nivel, rotulo, obrigatorio }
colunas	Tabela: { indice, rotulo, tipo, obrigatorio }

Exemplo (resumido):

[
  { "nome": "Esfera", "rotulo": "Esfera", "tipo": "Lista", "obrigatorio": true, "personalizado": false,
    "propriedade": "esferaId", "catalogo": "esferas", "suportado": true },
  { "nome": "ipirangaAreadoDireito", "rotulo": "Área do Direito", "tipo": "Lista", "obrigatorio": true,
    "personalizado": true, "campoId": 5099, "propriedade": "camposPersonalizados", "valorEm": "opcao", "suportado": true,
    "opcoes": [ { "opcaoId": 64698, "nome": "Administrativa" } ] },
  { "nome": "ipirangaMarcacaodeDebito", "rotulo": "Marcação de Débito", "tipo": "Tabela", "obrigatorio": false,
    "personalizado": true, "campoId": 8834, "valorEm": "linhas", "suportado": true,
    "colunas": [ { "indice": 0, "rotulo": "Tipo de Débito", "tipo": "Texto" },
                 { "indice": 1, "rotulo": "Valor Histórico", "tipo": "Valor" },
                 { "indice": 2, "rotulo": "Prognóstico", "tipo": "Texto" } ] }
]

Consulte uma vez

A configuração muda pouco. Consulte os campos ao configurar a integração (e quando o cliente avisar de mudanças na tela) e guarde o mapeamento no seu sistema.

Enviar os XCampos

Em camposPersonalizados, cada item identifica o campo e traz um valor, na propriedade indicada em valorEm.

Identificar o campo

Forma	Exemplo
Nome técnico	"campo": "ipirangaAreadoDireito"
Rótulo da tela	"campo": "Área do Direito"
Id	"campoId": 5099

Maiúsculas e acentos não importam. Se dois campos tiverem o mesmo rótulo, use o nome técnico ou o id.

Valor por tipo

valorEm	Tipos	Como enviar
texto	Texto, Área de texto, Hora (HH:mm), E-mail	"texto": "..."
data	Data	"data": "2026-10-07"
valor	Valor, Percentual	"valor": 1500.25
inteiro	Inteiro	"inteiro": 3
booleano	Sim/Não	"booleano": true
usuarioId	Usuário do Xjur	"usuarioId": 1355
opcao	Lista	"opcao": "Administrativa" ou "opcaoId": 64698
opcoes	Lista múltipla	"opcoes": ["A", "B"] ou "opcoesIds": [1, 2]
niveis	Lista nivelada	"niveis": [{ "opcao": "Nível 1" }, { "opcao": "Nível 2" }] — ou só a última opção em opcao/opcaoId
linhas	Tabela	"linhas": [{ "Rótulo da coluna": valor, ... }]
tiposPedido	Lista de tipos de pedido	"tiposPedido": ["Dano Moral"] ou "tiposPedidoIds": [940]

As opções também são aceitas pelo código da opção, quando o cliente o cadastrou.

Exemplos

Lista e texto:

"camposPersonalizados": [
  { "campo": "Área do Direito", "opcao": "Administrativa" },
  { "campo": "Código do Meridio", "texto": "MRD-2026-0042" }
]

Lista nivelada — o caminho do primeiro ao último nível; cada nível é procurado entre as opções filhas do anterior:

{ "campo": "Área de Origem da Demanda", "niveis": [
  { "opcao": "3072002 - VP Comercial Rede" },
  { "opcao": "4070835 - Diretoria Negócios Rede - Oeste" },
  { "opcao": "6070837 - GN Urbano Goiânia" }
] }

Também é possível mandar só a última opção ("opcao": "6070837 - GN Urbano Goiânia"): o caminho é montado pelas opções-pai. Os níveis marcados como obrigatórios precisam estar no caminho.

Tabela — uma entrada por linha; a chave é o rótulo da coluna (ou o índice). O tipo do valor segue o tipo da coluna:

{ "campo": "Marcação de Débito", "linhas": [
  { "Tipo de Débito": "Multa", "Valor Histórico": 1500.25, "Prognóstico": "Possível" },
  { "Tipo de Débito": "Juros", "Valor Histórico": 320.00, "Prognóstico": "Remoto" }
] }

Lista de tipos de pedido:

{ "campo": "Objeto", "tiposPedido": ["Dano Moral", "Horas Extras"] }

Erros de validação

Todos os problemas dos XCampos e dos obrigatórios voltam juntos em um 400, para corrigir de uma vez:

{
  "codigo": "DADOS_INVALIDOS",
  "descricao": "camposPersonalizados[0] (\"D&O\", Lista): opção \"Talvez\" não existe. Opções: \"Não\", \"Sim\". Campos obrigatórios para esta área do direito não informados: \"Tipo de Cadastro\" (camposPersonalizados, campo \"ipirangaTipodeCadastro\", valor em opcao). Consulte GET /processo/areas/34/campos."
}

Mensagem	Como resolver
campo "X" não existe na tela de cadastro desta área do direito	Confira o nome em GET /processo/areas/{id}/campos — cada área tem os seus XCampos
há mais de um campo com o rótulo "X"	Use o nome técnico (nome) ou o campoId
envie o valor em opcao ou opcaoId (recebido em texto)	Use a propriedade indicada em valorEm
opção "X" não existe. Opções: ...	Use um dos nomes listados (ou o id)
a opção "X" está sem nível cadastrado no Xjur	Configuração da lista nivelada no Xjur; escolha outra opção ou acione o cliente
faltam níveis obrigatórios (...)	Complete o caminho da lista nivelada
coluna "X" não existe. Colunas: ...	Use os rótulos de colunas
a coluna "X" é obrigatória	Preencha a coluna em todas as linhas
o campo "X" (tipo Imagem) não pode ser enviado pela integração	Campo com suportado: false; preencha pelo Xjur