Skip to main content
GET
Retrieve an Account

Headers

Content-Type
string

The type of media of the resource. Recommended value is application/json.

X-Request-Id
string<uuid>

A unique identifier used to trace and track each request.

Authorization
string

Bearer JWT token for authentication. Required when PLUGIN_AUTH_ENABLED=true (enforced in multi-tenant deployments). Optional in default OSS single-tenant mode. Format: Bearer <token>

Path Parameters

organization_id
string<uuid>
required

The unique identifier of the Organization associated with the Ledger.

ledger_id
string<uuid>
required

The unique identifier of the associated Ledger.

account_id
string<uuid>
required

The unique identifier of the account.

Response

Indicates that the request was successful and the response contains the expected data.

id
string<uuid>

The unique identifier of the Account.

organizationId
string<uuid>

The unique identifier of the Organization.

ledgerId
string<uuid>

The unique identifier of the Ledger.

assetCode
string

The code that identifies the Asset used in the Account.

name
string

The name of the Account.

Maximum string length: 256
alias
string

A unique, user-friendly identifier for the account. Used to reference the account in transactions and other operations.

type
string

Specifies the Account Type associated with the account.

blocked
boolean
default:false

Defines whether the account should be blocked.

parentAccountId
string<uuid> | null

The unique identifier of the Parent Account.

entityId
string | null

The unique identifier of the Entity responsible for the Account.

portfolioId
string<uuid> | null

The unique identifier of the associated Portfolio.

segmentId
string<uuid> | null

The unique identifier of the Segment which is used to cluster the Account.

status
object

An object containing information about the status.

metadata
object

An object containing key-value pairs to add as metadata, where the field name is the key and the field value is the value. For example, to add a Cost Center, use 'costCenter': 'BR_11101997'.

Constraints: keys must be at most 100 characters; string values at most 2000 characters. Nested objects are not allowed (values must be string, number, or boolean), the structure may not exceed a maximum depth of 10, and a maximum of 100 keys is permitted.

createdAt
string<date-time>

Timestamp of creation (UTC).

updatedAt
string<date-time>

Timestamp of last update (UTC).

deletedAt
string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).