Pular para o conteúdo principal
GET
Consultar uma Conta Externa

Cabeçalhos

Content-Type
string

O tipo de mídia do recurso. O valor recomendado é application/json.

X-Request-Id
string<uuid>

Um identificador único utilizado para rastrear e acompanhar cada requisição.

Authorization
string

Token JWT bearer para autenticação. Obrigatório quando PLUGIN_AUTH_ENABLED=true (exigido em implantações multi-tenant). Opcional no modo OSS single-tenant padrão. Formato: Bearer <token>

Parâmetros de caminho

organization_id
string<uuid>
obrigatório

O identificador único da Organização associada ao Ledger.

ledger_id
string<uuid>
obrigatório

O identificador único do Ledger associado.

code
string
obrigatório

O código que identifica o Ativo utilizado na Conta.

Resposta

Indica que a requisição foi bem-sucedida e a resposta contém os dados esperados.

id
string<uuid>

O identificador único da Conta.

organizationId
string<uuid>

O identificador único da Organização.

ledgerId
string<uuid>

O identificador único do Ledger.

assetCode
string

O código que identifica o Ativo utilizado na Conta.

name
string

O nome da Conta.

Maximum string length: 256
alias
string

Um identificador único e amigável para a conta. Usado para referenciar a conta em transações e outras operações.

type
string

Especifica o Tipo de Conta associado à conta.

blocked
boolean
padrão:false

Define se a conta deve ser bloqueada.

parentAccountId
string<uuid> | null

O identificador único da Conta Pai.

entityId
string | null

O identificador único da Entidade responsável pela Conta.

portfolioId
string<uuid> | null

O identificador único do Portfolio associado.

segmentId
string<uuid> | null

O identificador único do Segmento utilizado para agrupar a Conta.

status
object

Um objeto contendo informações sobre o status.

metadata
object

Um objeto contendo pares de chave-valor para adicionar como metadata, onde o campo name é a chave e o campo value é o valor. Por exemplo, para adicionar um Centro de Custo, use 'costCenter': 'BR_11101997'.

Restrições: as chaves devem ter no máximo 100 caracteres; valores de string no máximo 2000 caracteres. Objetos aninhados não são permitidos (os valores devem ser string, número ou booleano), a estrutura não pode exceder uma profundidade máxima de 10, e é permitido um máximo de 100 chaves.

createdAt
string<date-time>

Data e hora de criação (UTC).

updatedAt
string<date-time>

Data e hora da última atualização (UTC).

deletedAt
string<date-time> | null

Data e hora da exclusão lógica, se aplicável (UTC).