Ledgers

Create ledger

How to create a new ledger in Blnk.

POST/ledgers

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.

Body

namestringrequiredbody

Name of the ledger. Ensure it is as descriptive as possible for easy reference.

meta_dataobjectbody

Additional metadata for the request body.

Response

ledger_idstringrequired

Unique id to represent the created ledger.

namestringrequired

Name of the ledger.

created_atstringrequired

Indicates the date & time of creation.

meta_dataUser Object

Additional metadata of the ledger.

curl -X POST "http://localhost:5001/ledgers" \
  -H "X-blnk-key: <api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Customer Savings Ledger",
    "meta_data": {
      "project_owner": "Acme LLC",
      "description": "For all savings account created & managed by Acme."
    }
  }'

{
  "ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
  "name": "Customer Savings Ledger",
  "created_at": "2024-02-20T05:28:03.558281542Z",
  "meta_data": {
    "project_owner": "Acme LLC",
    "description": "For all savings account created & managed by Acme."
  }
}

{
  "error": "Ledger with this name or ID already exists",
  "error_detail": {
    "code": "LGR_DUPLICATE",
    "message": "Ledger with this name or ID already exists"
  }
}