Referências a outras entidades

Campos que referenciam outra entidade armazenam apenas o identificador e devolvem, na leitura, um objeto com a forma de CodeKeyName:

"product": { "code": 40, "key": "private_payroll", "name": "Consignado Privado" }

Campo	Tipo	Aceita nulo	Descrição
code	integer	Sim (null quando a referência não existe)	Código da entidade referenciada.
key	string	Sim	Chave da entidade referenciada, quando ela tem uma (product). Frequentemente null para unidades, parceiros e usuários.
name	string	Sim	Nome da entidade referenciada.

Ao enviar, informe só o identificador ou a key (ex.: "product": "private_payroll" ou "productId": "..."); os demais campos são derivados.

Hierarquia organizacional

Todo registro guarda seis referências que dizem a quem pertence. Elas são preenchidas automaticamente a partir do usuário autenticado (ou do userId informado, quando o payload aceita) — você não as envia.

Na API de integração, as respostas de termos, consultas Dataprev, simulações e empréstimos não trazem esse bloco; ele aparece apenas nos recursos cuja página o mostra (por exemplo, Jornadas). Mesmo quando não aparece, a hierarquia continua definindo o nível de acesso descrito abaixo.

"company": { "code": 0, "key": null, "name": null },
"unit":    { "code": 5, "key": null, "name": "Unidade Exemplo" },
"partner": { "code": 14, "key": null, "name": "Parceiro Exemplo" },
"branch":  { "code": 4, "key": null, "name": "Agência Exemplo" },
"agent":   { "code": 51, "key": null, "name": "Agente Exemplo" },
"user":    { "code": 18, "key": null, "name": "Usuário Exemplo" }

Campo	Entidade	Observação
company	Empresa (tenant)	Costuma vir com code: 0 ou null e name: null na leitura: a empresa é o escopo implícito de toda consulta.
unit	Unidade de negócio
partner	Parceiro comercial
branch	Agência / filial
agent	Agente / correspondente
user	Usuário que criou o registro	Em chamadas com API Key, é o usuário de integração associado à chave.

Essas referências também alimentam o nível de acesso: as permissões de visualização por unidade, parceiro, agência, agente ou usuário limitam a leitura aos registros cuja hierarquia coincide com a do usuário autenticado (ver Autenticação).