Objeto de domínio (code/key/name)

A maioria dos campos de "tipo"/"status"/"categoria" retornados pela API usa uma pequena família de objetos-valor, devolvidos embutidos no resultado da entidade.

CodeKeyName

{ "code": 2, "key": "direct_loan", "name": "Empréstimo em Conta" }

Campo	Tipo	Aceita nulo	Descrição
code	integer (int32)	Não (0 quando não informado)	Código numérico do valor.
key	string	Sim	Chave estável (slug) do valor, para uso programático.
name	string	Sim	Rótulo legível, em português, para exibição. Pode mudar.

• Ao enviar, informe apenas a key como string: "paymentMethod": "direct_loan". A resolução por key é feita sem distinção de maiúsculas/minúsculas.
• Ao ler, use key para lógica e name para exibição.
• Um campo não preenchido vem como { "code": 0, "key": null, "name": null } (ou code: null em referências). Trate key == null como "não informado".

As tabelas de valores estão em Domínios.

CodeName

Subconjunto sem key: { "code": 1, "name": "CNPJ" }. Usado nos campos cujo código vem do provedor Dataprev (employerDocumentType, gender, cbo, cnae, loanBlockType, politicallyExposedPerson, nationalityCountry) e em rule do empréstimo.

Variantes com mais campos

• StatusField — CodeKeyName + date, color, note.
• Referência — CodeKeyName apontando para outra entidade (company, unit, product...).