Códigos de Erro
Todos os erros dos endpoints /contrato/* seguem o formato padrão do XJUR Connect:
{ "codigo": "CODIGO_DO_ERRO", "descricao": "Descrição legível do que ocorreu.", "detalhes": "Mensagem original do Xjur, quando disponível."}Tabela de erros
Seção intitulada “Tabela de erros”| HTTP | Código | Quando ocorre |
|---|---|---|
400 | DADOS_INVALIDOS | Validação do payload no XJUR Connect (campo obrigatório ausente, tipo ou papel inexistente, centros de custo que não somam 100, pasta não encontrada) ou validação de entrada do Xjur |
401 | NAO_AUTORIZADO | Token ausente, inválido ou expirado |
403 | SEM_PERMISSAO | O usuário de serviço não tem a permissão necessária (Contratos; Administração para tipos, papéis, campos e catálogos; Pessoas para pessoaId) |
404 | NAO_ENCONTRADO | Contrato não localizado para o cliente do token, ou catálogo inexistente |
422 | REGRA_NEGOCIO | O Xjur recusou a criação por uma regra de negócio. descricao traz o motivo informado pelo Xjur |
502 | ERRO_SERVICO_EXTERNO | O Xjur respondeu com erro interno ou está indisponível |
504 | TIMEOUT_SERVICO_EXTERNO | O Xjur não respondeu dentro do tempo limite |
Mensagens mais comuns
Seção intitulada “Mensagens mais comuns”Validação do payload (400)
Seção intitulada “Validação do payload (400)”| Descrição | Como resolver |
|---|---|
tipoContratoId ou tipoContrato é obrigatório. | Informe o tipo — veja GET /contrato/tipos |
Tipo de contrato "X" não encontrado. | O nome precisa ser idêntico ao de GET /contrato/tipos; prefira tipoContratoId |
Campos obrigatórios para este tipo de contrato não informados: "Rótulo" (propriedade); ... | Envie os campos listados. A lista completa está em GET /contrato/tipos/{id}/campos. Para criar mesmo assim, use validarCamposObrigatorios: false |
pastaId é obrigatório quando novaPasta = false. | Informe a pasta que receberá o instrumento |
Pasta 123 não encontrada. | A pasta não existe ou não pertence ao cliente do token |
contratoOrigemId 9 não pertence à pasta 123. | O contrato de origem precisa estar na mesma pasta |
Informe partesContrarias[0].pessoaId ou partesContrarias[0].nome + partesContrarias[0].documento. | Identifique a pessoa de uma das duas formas |
Informe partesContrarias[0].endereco.cidadeId ou partesContrarias[0].endereco.cidade + partesContrarias[0].endereco.estado. | O Xjur exige a cidade de cada parte contrária |
partesContrarias[0].papelSignatarioId ou partesContrarias[0].papel é obrigatório. | Veja GET /xsigner/papeis-signatario |
Papel "X" não encontrado. | O nome precisa ser idêntico ao do cadastro; prefira papelSignatarioId |
Pessoa 123 não encontrada ou sem nome/documento no cadastro. | Envie nome + documento em vez de pessoaId |
Apenas uma parte contrária pode ser a principal. | Marque principal: true em no máximo uma |
A soma dos percentuais de centrosCusto deve ser 100 (atual: 60). | Ajuste o rateio |
camposPersonalizados[0] deve informar exatamente um valor (...) | Preencha só a propriedade indicada em valorEm |
dataInicioVigencia não pode ser posterior a dataFimVigencia. | Corrija as datas |
Regra de negócio do Xjur (422)
Seção intitulada “Regra de negócio do Xjur (422)”| Descrição | Como resolver |
|---|---|
Não foi possível encontrar a cidade com os parametros informados | A cidade da parte contrária não existe no cadastro do Xjur com esse nome/estado. Confira a grafia (com acentos) ou envie cidadeId |
O contrato permite no máximo N parcelas de bonificação antecipada. | Regra do tipo de contrato; ajuste os dados |