Bank Ledger - HisabKitab

Request

Authorization

Add parameter in header

ApiKey

Example:

ApiKey: ********************

Body Params application/json

action

string

required

Specifies the type of ledger being created. For bank, this value should be "Bank".

name

string

required

This field specifies the name of the ledger.

group_id

integer

required

The unique identifier of the ledger group under which this ledger will be created here is bank group.It should be retrieved from the List of Ledger Groups API.

account_type

integer

required

ID referencing the type of account (fetched from the Ledger Detail API).

account_number

string

optional

A unique number assigned to the bank account.

ifsc_code

string

optional

The IFSC (Indian Financial System Code) used to identify the bank branch for online transactions.

bank_name

string

optional

The full name of the bank (e.g., "Bank of Baroda").

bank_branch

string

optional

The specific branch of the bank where the account is held (e.g., "DUMBHAL BRANCH").

upi_id

string

optional

UPI ID linked to the bank account for digital payments and transfers.

swift_code

string

optional

International SWIFT code used for international wire transfers.

opening_balance_details

object

optional

opening_balance

integer

optional

The starting balance in the account (e.g., ₹50,000).

opening_balance_dr_cr

integer

optional

Indicates whether the opening balance is a debit (1) or credit (2) entry.

Example

{
    "action": "Bank",
    "name": "BOB",
    "group_id": "3",
    "account_number": "26690100033215",
    "account_type": "1",
    "ifsc_code": "BARB0DUMSUR",
    "bank_name": "Bank of Baroda",
    "bank_branch": "DUMBHAL BRANCH",
    "upi_id": "username@barodapay",
    "swift_code": "12345",
    "opening_balance_details": {
        "opening_balance": 50000,
        "opening_balance_dr_cr": 1
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://app.hisabkitab.co/third-party/ledgers' \
--header 'Content-Type: application/json' \
--header 'ApiKey;' \
--data-raw '{
    "action": "Bank",
    "name": "BOB",
    "group_id": "3",
    "account_number": "26690100033215",
    "account_type": "1",
    "ifsc_code": "BARB0DUMSUR",
    "bank_name": "Bank of Baroda",
    "bank_branch": "DUMBHAL BRANCH",
    "upi_id": "username@barodapay",
    "swift_code": "12345",
    "opening_balance_details": {
        "opening_balance": 50000,
        "opening_balance_dr_cr": 1
    }
}'

Responses

🟢200Bank Ledger

application/json

Body

data

object

required

id

integer

required

A unique identifier for the ledger.

name

string

required

This field specifies the name of the ledger.

group_id

integer

required

The unique identifier of the ledger group under which this ledger will be created here is bank group.

model_type

string

required

Defines the type of model the bank belongs to.

model_id

integer

required

The identifier linking the bank to a specific data model.

company_id

integer

required

The ID of the company associated with the ledger.

ledgers_data

object

required

opening_balance

number

required

Initial balance amount to be recorded at ledger creation.

opening_balance_dr_cr

integer

required

Indicates whether the opening balance is a debit (1) or credit (2) entry.

via_api

boolean

required

is_import

boolean

required

created_at

string

required

The date and time indicating when the record was initially created in the system.

updated_at

string

required

The date and time indicating when the record was last modified or updated in the system.

flag

string

required

success

boolean

required

message

string

required

Example

{
    "data": {
        "id": 3,
        "name": "BOB",
        "group_id": "3",
        "model_type": "App\\Models\\Master\\Bank",
        "model_id": 3,
        "company_id": 1,
        "ledgers_data": {
            "Bank": {
                "bank_name": "Bank of Baroda",
                "account_number": "26690100033215",
                "ifsc_code": "BARB0DUMSUR",
                "branch_name": "DUMBHAL BRANCH",
                "account_type": "1",
                "opening_balance": null,
                "opening_balance_dr_cr": null,
                "upi_id": "username@barodapay",
                "swift_code": "12345"
            }
        },
        "opening_balance": null,
        "opening_balance_dr_cr": null,
        "via_api": false,
        "is_import": false,
        "created_at": "2025-04-04T06:57:04.000000Z",
        "updated_at": "2025-04-04T06:57:04.000000Z",
        "flag": "payment"
    },
    "success": true,
    "message": "Bank Created Successfully."
}