> ## Documentation Index
> Fetch the complete documentation index at: https://docs.blnkfinance.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Overview
> Learn how ledgers work in Blnk
export const CtaCallout = props => {
const {title, buttonLabel, href, trackingEvent, buttonTarget, rel = "noopener noreferrer", children} = props;
const handleCtaClick = () => {
if (typeof window === "undefined" || !trackingEvent) {
return;
}
try {
window.dispatchEvent(new CustomEvent("blnk:docs-cta", {
detail: {
name: trackingEvent,
href
}
}));
} catch {}
try {
window.posthog?.capture?.(trackingEvent, {
href
});
} catch {}
const gaPayload = {
cta_href: href
};
try {
window.gtag?.("event", trackingEvent, gaPayload);
} catch {}
try {
window.dataLayer = window.dataLayer || [];
window.dataLayer.push({
event: trackingEvent,
...gaPayload
});
} catch {}
};
const isExternal = typeof href === "string" && (/^https?:\/\//i).test(href);
const target = buttonTarget ?? (isExternal ? "_blank" : undefined);
const linkRel = isExternal ? rel : undefined;
return ;
};
Blnk uses a structured ledger system to organize and group account balances effectively. This system simplifies navigation and improves the clarity and accessibility of financial data.
When setting up Blnk for your application, the first step is to create ledgers. Since balances need to be grouped within a ledger, you cannot create balances without one. Therefore, it’s essential to plan how you want to categorize your balances before you begin. To learn more, see the following: [Ledger architecture](/ledgers/architecture).
***
## Types of ledgers in Blnk
Blnk includes two types of ledgers - a General Ledger and custom ledgers.
1. **General Ledger:** This built-in ledger is designed to group balances that represent accounts owned by your organization, similar to a Chart of Accounts. Unlike custom ledgers, balances in the General Ledger come with indicators, making it easier to reference them in your code when recording transactions. To learn more about the General Ledger, see the following: [General Ledger](/ledgers/general-ledger).
2. **Custom ledgers:** These are ledgers you create based on the ledger architecture you’ve defined for your application.
General Ledger balance setup and management.
Structure ledgers for your product.
***
## Creating a ledger
To create a ledger, call the [**Create Ledger**](/reference/create-ledger) endpoint:
```bash cURL wrap theme={"system"}
curl -X POST "http://localhost:5001/ledgers" \
-H "X-blnk-key: " \
-H "Content-Type: application/json" \
-d '{
"name": "Customer Savings Account",
"meta_data": {
"project_owner": "YOUR_APP_NAME"
}
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Ledgers.create({
name: 'Customer Savings Account',
meta_data: {
project_owner: 'YOUR_APP_NAME',
},
});
```
```go Go wrap theme={"system"}
ledger, _, err := client.Ledger.Create(blnkgo.CreateLedgerRequest{
Name: "Customer Savings Account",
MetaData: map[string]interface{}{
"project_owner": "YOUR_APP_NAME",
},
})
if err != nil {
log.Fatal(err)
}
fmt.Println("Ledger Created:", ledger.LedgerID)
```
```bash Blnk CLI wrap theme={"system"}
blnk ledgers create
```
```json Response theme={"system"}
{
"ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"name": "Customer Savings Account",
"created_at": "2024-12-21T01:36:46.997063436Z",
"meta_data":{
"project_owner": "YOUR_APP_NAME"
}
}
```
| Field | Description | Required | Type |
| :---------- | :---------------------------------------------------- | :------- | :------- |
| `name` | A name that best describes the function of the ledger | Yes | `string` |
| `meta_data` | Custom data associated with the ledger being created | No | `object` |
| Field | Description | Type |
| ------------ | -------------------------------------------- | -------- |
| `ledger_id` | Unique identification number for your ledger | `string` |
| `name` | The name of your ledger | `string` |
| `created_at` | Date and time of when it was created | `string` |
***
## Updating a ledger name
You can rename an existing ledger using the [**Update Ledger Name**](/reference/update-ledger-name) endpoint without affecting any balances or transactions:
```bash cURL wrap theme={"system"}
curl -X PUT "http://localhost:5001/ledgers/{id}" \
-H "X-blnk-key: " \
-H "Content-Type: application/json" \
-d '{
"name": "Updated Customer Savings Account"
}'
```
```typescript TypeScript wrap theme={"system"}
const response = await blnk.Ledgers.update(
'ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc',
{
name: 'Updated Customer Savings Account',
},
);
```
```bash Blnk CLI wrap theme={"system"}
blnk ledgers update-name
```
```json Response theme={"system"}
{
"ledger_id": "ldg_073f7ffe-9dfd-42ce-aa50-d1dca1788adc",
"name": "Updated Customer Savings Account",
"created_at": "2024-12-21T01:36:46.997063436Z"
}
```
The ledger ID remains unchanged when you update the name, ensuring all existing references continue to work properly.
***
## Practical example
Here’s an example with seven accounts to illustrate how to use ledgers in Blnk:
| Account name | Type(s) |
| :----------- | :---------------- |
| Aria Collins | Savings |
| Luca Sanders | Savings |
| Ivy Monroe | Checking |
| Jasper Hale | Checking, Savings |
| Mia Delgado | Savings |
| Ezra Donovan | Checking |
| Ruby Foster | Checking, Savings |
With Blnk’s ledger functionality, you can categorize these accounts by name, type, or other criteria that fit your organizational needs.
This helps you maintain clean, organized records that are easy to search and manage. As your data scales, this categorization becomes even more valuable, enabling you to conduct deeper analyses, identify patterns, and make more informed decisions.
### Ledger grouping by type
In this approach, accounts are organized by type rather than by individual customer. Two separate ledgers are created- one for “Savings Accounts” and another for “Checking Accounts.” This setup groups accounts by their function, making it easy to reference all accounts within a specific type.
| Savings Account Ledger | Checking Account Ledger |
| :-------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------- |
| - Aria Collins
- Luca Sanders
- Jasper Hale
- Mia Delgado
- Ruby Foster | - Ivy Monroe
- Jasper Hale
- Ezra Donovan
- Ruby Foster |
In this example, there are 5 savings accounts and 4 checking accounts across 7 unique customers. But customers like Jasper Hale and Ruby Foster have both types of accounts, which means they appear in both ledgers.
This type-based grouping provides a clear breakdown of accounts, showing which accounts fall under savings and which under checking. This can be useful for tracking and reference, particularly if you need to analyze account activity or usage patterns based on account type.
### Ledger grouping by name
In this approach, rather than organizing accounts by type (e.g., Savings or Checking), we create a separate ledger for each unique customer. This allows each customer’s accounts to be listed together under their name, making it easy to view all accounts belonging to a single individual.
| **Aria Collins** | **Luca Sanders** | **Ivy Monroe** | **Jasper Hale** | **Mia Delgado** | **Ezra Donovan** | **Ruby Foster** |
| :--------------- | :--------------- | :------------- | :-------------------------- | :-------------- | :--------------- | :-------------------------- |
| - Savings | - Savings | - Checking | - Checking
- Savings | - Savings | - Checking | - Checking
- Savings |
Each ledger entry is focused on the customer, showing all accounts that the customer holds. For instance, Jasper Hale and Ruby Foster each have both a checking and a savings account, so both account types are listed under their names.
This customer-focused organization makes it easy to see all account types associated with each individual. It can be helpful when managing customer relationships or viewing a comprehensive overview of each customer’s financial engagement in the system.
***
## 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](mailto:support@blnkfinance.com) or [join our Discord community](https://discord.gg/7WNv94zPpx).
Sign up and manage your ledger with our back-office dashboard. You can invite teammates to collaborate and manage your ledger operations directly from the dashboard.