Skip to main content
Retrieve an Operation by Account
curl --request GET \
  --url http://127.0.0.1:3001/v1/organizations/{organization_id}/ledgers/{ledger_id}/accounts/{account_id}/operations/{operation_id} \
  --header 'Content-Type: <content-type>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "accountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "balanceId": "<string>",
  "accountAlias": "<string>",
  "description": "<string>",
  "type": "CREDIT",
  "assetCode": "<string>",
  "chartOfAccounts": "<string>",
  "amount": {
    "amount": 123,
    "scale": 123
  },
  "balance": {
    "available": 123,
    "onHold": 123,
    "scale": 123
  },
  "balanceAfter": {
    "available": 123,
    "onHold": 123,
    "scale": 123
  },
  "status": {
    "code": "<string>",
    "description": "<string>"
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Headers

​
Authorization
string

The authorization token. This header is required if your environment has the Access Manager enabled.

​
Content-Type
string
required

The type of media of the resource. Must be <code>application/json</code>.

​
X-Request-Id
string

A unique identifier used to trace and track each request.

Path Parameters

​
organization_id
string
required

The unique identifier of the Organization associated with the Ledger.

​
ledger_id
string
required

The unique identifier of the associated Ledger.

​
account_id
string
required

The unique identifier of the account of which you want to retrieve the balances.

​
operation_id
string
required

The unique identifier of the operation that you want to retrieve.

Response

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

​
id
string<uuid>

The unique identifier of the Operation.

​
transactionId
string<uuid>

The unique identifier of the Transaction.

​
organizationId
string<uuid>

The unique identifier of the Organization.

​
ledgerId
string<uuid>

The unique identifier of the Ledger.

​
accountId
string<uuid>

The unique identifier of the Account.

​
balanceId
string

The unique identifier of the Balance.

​
accountAlias
string

The alias for the account used in the operation.

​
description
string

Description of the transaction.

​
type
enum<string>

The type of the operation.

Available options:
CREDIT,
DEBIT
​
assetCode
string

The name of the asset used in the operation.

​
chartOfAccounts
string

The name of the Chart-of-Accounts that the operation belongs to.

​
amount
object

An object containing information about the amount used in the operation.

​
balance
object

An object containing information about the balance before the operation.

​
balanceAfter
object

An object containing information about the balance after the operation.

​
status
object

The transaction status (pending, completed, reversed).

​
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).

​
metadata
object

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