Campos Extras (Extra Fields)

Este conjunto de endpoints permite consultar os campos extras disponíveis em um template de documento e salvar valores personalizados para esses campos em uma operação.

warning

Para utilizar os campos extras, é necessário que o template do documento já tenha sido definido. Caso contrário, gere uma pré-visualização de minuta antes de utilizar estes endpoints.

Importante

Os campos extras são organizados por tipo de documento (document_type). Ao salvar campos extras via POST, os valores anteriores para aquele document_type são substituídos integralmente — não é feito merge com valores existentes.

---

Consulta de Campos Extras Disponíveis (GET)

Retorna os campos extras disponíveis no template associado ao tipo de documento da operação.

Request

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/extra_fields

MÉTODO

GET

Path Params

Campo	Tipo	Descrição	Caracteres Máx.
OPERATION-KEY *	string	Chave única da operação (UUID v4).	36

Query Params

Campo	Tipo	Descrição	Caracteres Máx.
document_type *	string	Tipo do documento.	Enumeradores document_type

Response

STATUS

200

Response Body

{
  "operation_key": "550e8400-e29b-41d4-a716-446655440000",
  "document_type": "commercial_paper",
  "template_key": "660e8400-e29b-41d4-a716-446655440001",
  "extra_fields": [
    {
      "field_key": "warranty_description",
      "field_label": "Descrição da Garantia",
      "field_type": "string"
    },
    {
      "field_key": "special_conditions",
      "field_label": "Condições Especiais",
      "field_type": "string"
    },
    {
      "field_key": "additional_clause",
      "field_label": "Cláusula Adicional",
      "field_type": "string"
    }
  ]
}

Response Body Params

Campo	Tipo	Descrição	Caracteres Máx.
operation_key *	string	Chave única da operação (UUID v4).	36
document_type *	string	Tipo do documento consultado.	Enumeradores document_type
template_key *	string	Chave única do template associado (UUID v4).	36
extra_fields *	array	Lista de campos extras disponíveis no template.	-

Campos do objeto extra_fields

Campo	Tipo	Descrição	Caracteres Máx.
field_key *	string	Identificador único do campo extra.	255
field_label *	string	Rótulo descritivo do campo extra.	255
field_type *	string	Tipo de dado do campo extra (ex: string).	50

---

Salvar Campos Extras (POST)

Salva os valores dos campos extras para um tipo de documento específico em uma operação. Os valores enviados substituem integralmente os campos extras anteriores para o document_type informado.

Request

ENDPOINT

/commercial_paper/operation/OPERATION-KEY/extra_fields

MÉTODO

POST

Path Params

Campo	Tipo	Descrição	Caracteres Máx.
OPERATION-KEY *	string	Chave única da operação (UUID v4).	36

Request Body

{
  "document_type": "commercial_paper",
  "extra_fields": {
    "warranty_description": "Garantia prestada pelo avalista",
    "special_conditions": "Condição especial de vencimento antecipado",
    "additional_clause": "Cláusula de cross default"
  }
}

Request Body Params

Campo	Tipo	Descrição	Caracteres Máx.
document_type *	string	Tipo do documento.	Enumeradores document_type
extra_fields *	object	Objeto contendo os campos extras e seus valores. As chaves devem corresponder aos field_key retornados na consulta GET. Todos os valores devem ser strings.	-

warning

As chaves enviadas no objeto extra_fields devem corresponder exatamente aos field_key disponíveis no template. Chaves inválidas resultarão em erro.

Response

STATUS

201

Response Body

{
  "operation_key": "550e8400-e29b-41d4-a716-446655440000",
  "document_type": "commercial_paper",
  "extra_fields": {
    "warranty_description": "Garantia prestada pelo avalista",
    "special_conditions": "Condição especial de vencimento antecipado",
    "additional_clause": "Cláusula de cross default"
  }
}

Response Body Params

Campo	Tipo	Descrição	Caracteres Máx.
operation_key *	string	Chave única da operação (UUID v4).	36
document_type *	string	Tipo do documento.	Enumeradores document_type
extra_fields *	object	Objeto contendo os campos extras salvos com seus respectivos valores.	-

---

Enumeradores document_type

Enum	Descrição
commercial_paper	Termo Constitutivo
adhesion_term	Termo de Adesão

---

Erros

Código	HTTP	Descrição
COM000007	404	Operação não encontrada.
COM000008	403	Operação não pertence ao tenant solicitante.
COM000044	400	Template não definido para o tipo de documento. Gere uma pré-visualização de minuta antes de prosseguir.
COM000045	400	Chaves de campos extras não disponíveis no template.