Customer Ledger

This API is used to create a Customer ledger within the accounting system. It enables the storage of comprehensive customer-related financial and contact information to support invoicing, compliance, and record-keeping. The payload includes detailed customer-specific fields such as billing and shipping addresses, tax details (e.g., GSTIN, PAN), contact person information (phone, email, etc.), credit terms (credit limit, credit period), and opening balance. It also allows classification by entity type and includes optional fields like broker or transporter information for further business tracking.

Request

The request method is POST, and it must include a detail in the body that provides all the necessary details for creating the customer ledger.

Response

On successful creation of the customer ledger, the server returns a response containing a success message along with the unique ID of the newly created ledger and a summary of key customer details.

Request

Authorization

Add parameter in header

ApiKey

Example:

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

Body Params application/json

Example

{
    "action": "Customers",
    "name": "Customer ledger",
    "group_id": 1,
    "party_details": {
        "gstin": "27ANUPC5555H1ZM",
        "billing_address": {
            "address_1": "billiing, Ward No. 38, P.C. No. 106A, RIS-Raipur",
            "address_2": "Reng Road",
            "country_id": "1",
            "state_id": "4",
            "city_id": "2",
            "pin_code": "492001"
        },
        "same_as_billing_address": 0,
        "shipping_address": {
            "shipping_gstin": "27ANUPC5555H1ZW",
            "shipping_name": "dk",
            "address_1": "shipping, Ward No. 38, P.C. No. 106A, RIS-Raipur",
            "address_2": "Station Road",
            "country_id": "1",
            "state_id": "4",
            "city_id": "1",
            "pin_code": "492001"
        },
        "contact_person_name": "Joan",
        "region_iso_1": "in",
        "region_code_1": "91",
        "contact_person_phone_1": "7878889877",
        "region_iso_2": "in",
        "region_code_2": "91",
        "contact_person_phone_2": "7878889877",
        "contact_person_email": "joan@gmail.com",
        "contact_person_website": ""
    },
    "tax_details": {
        "pan": "AAOFJ9779K",
        "type_of_entity": 3,
        "gst_registration_type": 1
    },
    "other_details": {
        "credit_period": 1,
        "credit_period_type": 1,
        "allow_credit_limit": 1,
        "credit_limit": 100,
        "credit_limit_action": 1,
        "broker": null,
        "brokerage_percentage": null,
        "brokerage_on_value": null,
        "transporter": null,
        "customer_upload_document": null
    },
    "opening_balance_details": {
        "opening_balance": 100,
        "opening_balance_dr_cr": 2
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://app.hisabkitab.co/third-party/ledgers' \
--header 'ApiKey: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "Customers",
    "name": "Customer ledger",
    "group_id": 1,
    "party_details": {
        "gstin": "27ANUPC5555H1ZM",
        "billing_address": {
            "address_1": "billiing, Ward No. 38, P.C. No. 106A, RIS-Raipur",
            "address_2": "Reng Road",
            "country_id": "1",
            "state_id": "4",
            "city_id": "2",
            "pin_code": "492001"
        },
        "same_as_billing_address": 0,
        "shipping_address": {
            "shipping_gstin": "27ANUPC5555H1ZW",
            "shipping_name": "dk",
            "address_1": "shipping, Ward No. 38, P.C. No. 106A, RIS-Raipur",
            "address_2": "Station Road",
            "country_id": "1",
            "state_id": "4",
            "city_id": "1",
            "pin_code": "492001"
        },
        "contact_person_name": "Joan",
        "region_iso_1": "in",
        "region_code_1": "91",
        "contact_person_phone_1": "7878889877",
        "region_iso_2": "in",
        "region_code_2": "91",
        "contact_person_phone_2": "7878889877",
        "contact_person_email": "joan@gmail.com",
        "contact_person_website": ""
    },
    "tax_details": {
        "pan": "AAOFJ9779K",
        "type_of_entity": 3,
        "gst_registration_type": 1
    },
    "other_details": {
        "credit_period": 1,
        "credit_period_type": 1,
        "allow_credit_limit": 1,
        "credit_limit": 100,
        "credit_limit_action": 1,
        "broker": null,
        "brokerage_percentage": null,
        "brokerage_on_value": null,
        "transporter": null,
        "customer_upload_document": null
    },
    "opening_balance_details": {
        "opening_balance": 100,
        "opening_balance_dr_cr": 2
    }
}'

Responses

🟢200Customer Ledger

application/json

Body

Example

{
    "data": {
        "id": 1,
        "name": "Customer ledger",
        "group_id": 1,
        "model_type": "App\\Models\\Master\\Customer",
        "model_id": 1,
        "company_id": 1,
        "ledgers_data": {
            "Customer": {
                "person_name": "Joan",
                "person_email": "joan@gmail.com",
                "phone_1": "7878889877",
                "phone_2": "7878889877",
                "website": null,
                "pan_card_number": "AAOFJ9779K",
                "entity_type": 3,
                "gstin": "27ANUPC5555H1ZM",
                "tan": null,
                "cin_number": null,
                "gst_registration_type": 1,
                "credit_limit": true,
                "credit_limit_amount": 100,
                "credit_limit_action": 1,
                "credit_limit_period": "1",
                "credit_period_type": 1,
                "rate_of_interest": null,
                "broker_master": null,
                "brokerage": null,
                "brokerage_on_value": null,
                "reference": null,
                "opening_balance": null,
                "opening_balance_dr_cr": null,
                "reference_name": null,
                "reference_address": null,
                "reference_contact_details": null,
                "billing_address_address_1": "billiing, Ward No. 38, P.C. No. 106A, RIS-Raipur",
                "billing_address_address_2": "Ring Road",
                "billing_address_country_id": 1,
                "billing_address_state_id": 4,
                "billing_address_city_id": 1,
                "billing_address_pin_code": "492001",
                "shipping_address_address_1": "shipping, Ward No. 38, P.C. No. 106A, RIS-Raipur",
                "shipping_address_address_2": "Station Road",
                "shipping_address_country_id": 1,
                "shipping_address_state_id": 4,
                "shipping_address_city_id": 2,
                "shipping_address_pin_code": "492001"
            }
        },
        "opening_balance": null,
        "opening_balance_dr_cr": null,
        "via_api": false,
        "is_import": false,
        "created_at": "2025-04-04T06:52:06.000000Z",
        "updated_at": "2025-04-04T06:52:06.000000Z",
        "flag": "party"
    },
    "success": true,
    "message": "Customers Created Successfully."
}

Request#

Response#

Request

Request Code Samples

Responses

Request

Response