Create New Ledger

POST

ledgers

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"
  }
}

If you’re using the auto-provisioned Enterprise Core instance included with your Production License deployment, set the base URL to: https://ENTERPRISE_PUBLIC_URL/core.If you’re connecting to a different Core instance, use the publicly accessible base URL for that instance instead.

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: Scoped API keys and Secure your Blnk server.

Body

string

required

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

object

Additional metadata for the request body.

Response

string

required

Unique id to represent the created ledger.

string

required

Name of the ledger.

string

required

Indicates the date & time of creation.

User 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"
  }
}

Need help?

We are very happy to help you make the most of Blnk, regardless of whether it is your first time or you are switching from another tool. To ask questions or discuss issues, please contact us or join our Discord community.

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"
  }
}

Start Here

Ledgers

Ledger balances

Transactions

Reconciliation

Identities

Metadata

Search

Transaction hooks

API keys

System

Authorization

Body

Response

Need help?

​Authorization

​Body

​Response

​Need help?

Authorization

Body

Response

Need help?