List Transactions

curl --request GET \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "route": "<string>",
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "amount": "<string>",
      "assetCode": "<string>",
      "chartOfAccountsGroupName": "<string>",
      "source": [
        "<string>"
      ],
      "destination": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "operations": [
        {
          "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",
          "accountAlias": "<string>",
          "balanceId": "<string>",
          "balanceKey": "<string>",
          "description": "<string>",
          "type": "CREDIT",
          "assetCode": "<string>",
          "chartOfAccounts": "<string>",
          "route": "<string>",
          "amount": {
            "value": "<string>"
          },
          "balance": {
            "available": "<string>",
            "onHold": "<string>",
            "version": 123
          },
          "balanceAfter": {
            "available": "<string>",
            "onHold": "<string>",
            "version": 123
          },
          "status": {
            "code": "<string>",
            "description": "<string>"
          },
          "balanceAffected": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z",
          "metadata": {}
        }
      ],
      "metadata": {}
    }
  ],
  "next_cursor": "<string>",
  "limit": 123
}

GET

organizations

{organization_id}

ledgers

{ledger_id}

transactions

List Transactions

curl --request GET \
  --url https://transaction.sandbox.lerian.net/v1/organizations/{organization_id}/ledgers/{ledger_id}/transactions

{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "ledgerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "description": "<string>",
      "route": "<string>",
      "status": {
        "code": "<string>",
        "description": "<string>"
      },
      "amount": "<string>",
      "assetCode": "<string>",
      "chartOfAccountsGroupName": "<string>",
      "source": [
        "<string>"
      ],
      "destination": [
        "<string>"
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "deletedAt": "2023-11-07T05:31:56Z",
      "operations": [
        {
          "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",
          "accountAlias": "<string>",
          "balanceId": "<string>",
          "balanceKey": "<string>",
          "description": "<string>",
          "type": "CREDIT",
          "assetCode": "<string>",
          "chartOfAccounts": "<string>",
          "route": "<string>",
          "amount": {
            "value": "<string>"
          },
          "balance": {
            "available": "<string>",
            "onHold": "<string>",
            "version": 123
          },
          "balanceAfter": {
            "available": "<string>",
            "onHold": "<string>",
            "version": 123
          },
          "status": {
            "code": "<string>",
            "description": "<string>"
          },
          "balanceAffected": true,
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "deletedAt": "2023-11-07T05:31:56Z",
          "metadata": {}
        }
      ],
      "metadata": {}
    }
  ],
  "next_cursor": "<string>",
  "limit": 123
}

Headers

Authorization

string

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

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.

Query Parameters

limit

string

required

The maximum number of items to include in the response.

metadata.message

string

required

The message that will be used as metadata.

start_date

string

The beginning of the period you want to retrieve. You must also include the end_date.

end_date

string

The end of the period you want to retrieve. You must also include the start_date.

sort_order

enum<enum>

The order used to sort the results.

Available options:

asc,

desc

cursor

string

The position in a dataset where the next page of results should start.

Response

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

items

object[]

Show child attributes

items.id

string<uuid>

The unique identifier of the transaction.

items.organizationId

string<uuid>

The unique identifier of the Organization.

items.ledgerId

string<uuid>

The unique identifier of the Ledger.

items.description

string

Description of the transaction.

items.route

string

Specifies the Transaction Route associated with the transaction.

items.status

object

The transaction status (pending, completed, reversed).

Show child attributes

items.status.code

string

Transaction status code.

items.status.description

string

Transaction status description.

items.amount

string

The sent amount.

items.assetCode

string

The name of the asset used in the operation.

items.chartOfAccountsGroupName

string

The name of the chart-of-accounts group.

items.source

string[]

The list of accounts used as source.

items.destination

string[]

The list of accounts used as destination.

items.createdAt

string<date-time>

Timestamp of creation (UTC).

items.updatedAt

string<date-time>

Timestamp of last update (UTC).

items.deletedAt

string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

items.operations

object[]

Show child attributes

items.operations.id

string<uuid>

The unique identifier of the Operation.

items.operations.transactionId

string<uuid>

The unique identifier of the Transaction.

items.operations.organizationId

string<uuid>

The unique identifier of the Organization.

items.operations.ledgerId

string<uuid>

The unique identifier of the Ledger.

items.operations.accountId

string<uuid>

The unique identifier of the Account.

items.operations.accountAlias

string

The alias for the account used in the operation.

items.operations.balanceId

string

The unique identifier of the Balance.

items.operations.balanceKey

string

The key identifier of the Balance.

items.operations.description

string

A description for the operation.

items.operations.type

enum<string>

The type of the operation.

Available options:

CREDIT,

DEBIT,

ON_HOLD,

RELEASE

items.operations.assetCode

string

The code that identifies the sent asset.

items.operations.chartOfAccounts

string

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

items.operations.route

string

Specifies the Operation Route for each individual debit or credit operation.

items.operations.amount

object

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

Show child attributes

items.operations.amount.value

string

The amount that will be sent.

items.operations.balance

object

An object containing information about the balance before the operation.

Show child attributes

items.operations.balance.available

string

Previous available balance.

items.operations.balance.onHold

string

Amount on hold/reserved.

items.operations.balance.version

integer

Balance version, which is updated with each transaction.

items.operations.balanceAfter

object

An object containing information about the balance after the operation.

Show child attributes

items.operations.balanceAfter.available

string

Current available balance.

items.operations.balanceAfter.onHold

string

Amount on hold/reserved.

items.operations.balanceAfter.version

integer

Balance version, which is updated with each transaction.

items.operations.status

object

The transaction status (pending, completed, reversed).

Show child attributes

items.operations.status.code

string

Transaction status code.

items.operations.status.description

string | null

Transaction status description.

items.operations.balanceAffected

boolean

Indicates whether the operation had an impact on the account balance.

items.operations.createdAt

string<date-time>

Timestamp of creation (UTC).

items.operations.updatedAt

string<date-time>

Timestamp of last update (UTC).

items.operations.deletedAt

string<date-time> | null

Timestamp of soft deletion, if applicable (UTC).

items.operations.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'.

Show child attributes

items.operations.metadata.{key}

string

items.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'.

Show child attributes

items.metadata.{key}

string

next_cursor

string

The position in a dataset of next page of results.

limit

integer

The maximum number of items included in the response.

Create a Transaction using DSL

Retrieve a Transaction

⌘I

Organizations API

Ledgers API

Assets API

Account Types API

Accounts API

Portfolios API

Segments API

Balances API

Transactions API

Operations API

Operation Routes API

Transaction Routes API

Error handling

List Transactions

Headers

Path Parameters

Query Parameters

Response