Skip to main content
GET
/
ledger
/
balance
Get the current balance
curl --request GET \
  --url https://api.example.com/ledger/balance
[
  {
    "createdAt": "2021-01-01T00:00:00.000Z",
    "updatedAt": "2021-01-01T00:00:00.000Z",
    "organizationId": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "availableBalance": 1000,
    "postedBalance": 1000,
    "unsettledBalance": 1000,
    "currency": "COP"
  }
]

Response

Balance for the organization

​
createdAt
string<date-time>
required

The creation date of the balance

Example:

"2021-01-01T00:00:00.000Z"

​
updatedAt
string<date-time>
required

The update date of the balance

Example:

"2021-01-01T00:00:00.000Z"

​
organizationId
string
required

The organization ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
id
string
required

The ID of the balance

Example:

"123e4567-e89b-12d3-a456-426614174000"

​
availableBalance
number
required

The available balance

Example:

1000

​
postedBalance
number
required

The posted balance

Example:

1000

​
unsettledBalance
number
required

The unsettled amount

Example:

1000

​
currency
string
required

The currency

Example:

"COP"