Contratos

Esta seção reúne tudo o que o XJUR Connect oferece sobre contratos: criar, consultar, descobrir os campos de cada tipo de contrato, cadastrar partes contrárias e as integrações específicas com outros sistemas.

Por onde começar

Quero…	Vá para
Criar contratos no Xjur a partir do meu sistema	Criar Contrato
Saber quais campos enviar e quais são obrigatórios	Campos Dinâmicos
Cadastrar representantes e garantidores em contratos existentes	Partes Contrárias
Atualizar contratos a partir do SAP	Integração SAP
Enviar propostas aprovadas da PNE	Integração PNE
Entender um erro devolvido pela API	Códigos de Erro
Testar as rotas de forma interativa	Referência da API

Conceitos

Conceito	O que é
Pasta	Agrupa um contrato e os instrumentos derivados dele (aditivos, distratos). Todo contrato pertence a uma pasta
Número do contrato	Gerado pelo Xjur: pasta + sequência do instrumento (ex.: 114330.001). Não pode ser enviado
Tipo de contrato	Cadastrado por cliente. Define o fluxo de aprovação, a minuta padrão e quais campos são obrigatórios
Campos personalizados	Campos que o cliente criou no Xjur e que só existem naquele cliente. Descobertos em Campos Dinâmicos
Parte contrária	A outra parte do contrato (cliente, fornecedor, locador…), com um papel (Contratante, Contratada…)
Empresa	Empresa do grupo do cliente que figura no contrato
Código	Identificador do contrato no seu sistema. É a chave de rastreio e de idempotência

Como as peças se encaixam

flowchart LR
  T["GET /contrato/tipos"] --> C["GET /contrato/tipos/{id}/campos"]
  C --> K["GET /contrato/catalogos/{catalogo}"]
  C --> P["POST /contrato"]
  K --> P
  P --> G["GET /contrato/{contratoId}"]
  P --> PC["POST /Contrato/AdicionarParteContraria"]
  P --> S["PUT /contratos (SAP)"]

1. Descubra o tipo de contrato e os campos que ele exige — uma vez, ao configurar a integração.
2. Crie o contrato com POST /contrato.
3. Evolua o contrato pelas demais rotas: partes contrárias, atualização via SAP.

Endpoints

Contratos

Método	Rota	Descrição	Documentação
POST	/contrato	Cria um contrato	Criar Contrato
GET	/contrato/{contratoId}	Consulta um contrato	Criar Contrato
GET	/contrato/tipos	Tipos de contrato do cliente	Campos Dinâmicos
GET	/contrato/tipos/{tipoContratoId}/campos	Campos do cadastro, obrigatórios e opções	Campos Dinâmicos
GET	/contrato/catalogos/{catalogo}	Ids aceitos pelos campos de lista	Campos Dinâmicos
POST	/Contrato/AdicionarParteContraria	Cadastra representantes e garantidores	Partes Contrárias

Integrações específicas

Integração	Rota	Descrição	Documentação
SAP	PUT /contratos	Atualiza um contrato pelo numeroContratoSap	Integração SAP
PNE	POST /pne/contratos	Recebe a proposta aprovada e abre a pasta	Integração PNE

Pré-requisitos

• Token JWT de usuário de serviço obtido em POST /Autenticacao/AuthenticateUserService (veja Autenticação)
• Subscription key (X-XJUR-SUBSCRIPTION-KEY)
• Permissões do usuário de serviço: Contratos (leitura e escrita) e Administração (leitura — tipos de contrato, campos, catálogos e papéis). Para informar a parte contrária por pessoaId, também Pessoas (leitura)

Ambientes

Ambiente	URL Base
Produção	https://apim-xjur-prd.xjur.com.br/connect
Homologação	https://apim-xjur-qa.xjur.com.br/connect