Ledgers

Get ledger

See the details of one or all ledgers.

GET/ledgers/{ledger_id}

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

See also: Core API key.

Path

ledger_idstringrequiredpath

Unique ledger_id of the ledger being retrieved. Leave ledger_id out to return all ledgers.

Response

[]array

ledger_idstringrequired

Unique id to represent the ledger.

namestringrequired

Name of the ledger.

created_atstringrequired

Indicates the date & time of creation.

meta_dataUser Object

Additional metadata of the ledger.

Returns one ledger.

ledger_idstringrequired

Unique id to represent the ledger.

namestringrequired

Name of the ledger.

created_atstringrequired

Indicates the date & time of creation.

meta_dataUser Object

Additional metadata of the ledger.

curl -X GET "http://localhost:5001/ledgers" \
  -H "X-blnk-key: <api-key>"

curl -X GET "http://localhost:5001/ledgers/{ledger_id}" \
  -H "X-blnk-key: <api-key>"

[
    {
        "ledger_id": "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
        "name": "Customer Checking Ledger",
        "created_at": "2024-11-26T08:23:57.509804Z",
        "meta_data": {
            "project_owner": "Blnk Tech"
        }
    },
    {
        "ledger_id": "ldg_845e6b1e-0463-4ce8-b858-2b3a398beff9",
        "name": "Customer Savings Ledger",
        "created_at": "2024-11-26T08:23:46.171319Z",
        "meta_data": {
            "project_owner": "Blnk Tech"
        }
    },
    {
        "ledger_id": "general_ledger_id",
        "name": "General Ledger",
        "created_at": "2024-09-27T10:58:22.112739Z",
        "meta_data": {}
    }
]

{
    "ledger_id": "ldg_049495c6-356e-4ebc-a45e-60d1e1e16afb",
    "name": "Customer Checking Ledger",
    "created_at": "2024-11-26T08:23:57.509804Z",
    "meta_data": {
        "project_owner": "Blnk Tech"
    }
}

{
  "error": "Ledger not found",
  "error_detail": {
    "code": "LGR_NOT_FOUND",
    "message": "Ledger not found"
  }
}