Supplier Ledger

Request

Authorization

Add parameter in header

ApiKey

Example:

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

Body Params application/json

action

string

required

Specifies the type of ledger being created. For supplier, this value should be "Supplier".

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 supplier group.It should be retrieved from the List of Ledger Groups API.

party_details

object

required

gstin

string | null

optional

Supplier’s primary GST Identification Number used for tax purposes.

billing_address

object

required

This contains full billing address details including street, area, country, state, city, and pin code.

same_as_billing_address

integer

required

A value 1(true) or 0(false) indicating whether the shipping address is the same as the billing address & by default 0 will take.

shipping_address

object

optional

This contains shipping-specific address details and optional shipping GSTIN and name.

contact_person_name

string

optional

Name of the primary contact person for this supplier.

region_iso_1

string

optional

ISO country code (e.g., "in" for India) for primary and secondary contact numbers.

region_code_1

string

optional

Country dialing code (e.g., "91" for India) for the respective contact numbers.

contact_person_phone_1

string

optional

Primary phone numbers of the contact person.

region_iso_2

string

optional

ISO country code (e.g., "in" for India) for primary and secondary contact numbers.

region_code_2

string

optional

Country dialing code (e.g., "91" for India) for the respective contact numbers.

contact_person_phone_2

string

optional

Alternate phone numbers of the contact person.

contact_person_email

string

optional

Email address of the supplier contact person.

contact_person_website

string

optional

Supplier’s website URL, if applicable.

tax_details

object

optional

Contains tax details.

pan

string

optional

PAN (Permanent Account Number) of the supplier for tax reporting.

type_of_entity

integer

optional

Indicates the legal structure of the supplier, such as Proprietorship, Partnership, LLP, Company, Trust, or other recognized entity types. To get these use ledger detail api.

gst_registration_type

integer

optional

Type of GST registration (e.g., regular, composition). To get these use ledger detail api..

gst_return_status

string

optional

Represents the GST return filing status of the supplier. This helps assess the supplier’s GST compliance and filing frequency.

is_tds_applicable

integer

optional

A flag (1 for Yes, 0 for No) indicating whether TDS (Tax Deducted at Source) is applicable when making payments to the supplier, based on relevant tax laws.

other_details

object

optional

credit_period

integer

optional

Refers to the credit period (number of days or month) granted to the buyer, which is the time allowed to make payment.

credit_period_type

integer

optional

This field defines the type of credit period applied months (1) and days (2).

broker

integer

optional

Optional reference to a broker involved in transactions (null if not applicable).

brokerage_percentage

number

optional

Percentage value of brokerage (if any) to be applied.

brokerage_on_value

integer

optional

here set brokerage on value type such as 1(Invoice Value) & 2(Taxable Value) on which the brokerage percentage will calculate.

transporter

integer

optional

Optional field to link a transporter or shipping agent.

supplier_upload_document

string

optional

Field to attach uploaded documents (null if not used).

opening_balance_details

object

optional

opening_balance

number

optional

Initial balance amount to be recorded at ledger creation.

opening_balance_dr_cr

integer

optional

Type of balance – 1 for Debit, 2 for Credit.

Example

{
    "action": "Supplier",
    "name": "supplier ledger",
    "group_id": 2,
    "party_details": {
        "gstin": "27ANUPC5555H1ZM",
        "billing_address": {
            "address_1": "billiing, Ward No. 38, P.C. No. 106A, RIS-Raipur",
            "address_2": "Ring Road",
            "country_id": "1",
            "state_id": "3",
            "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": "3",
            "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,
        "cin_number": "",
        "gst_return_status": "",
        "is_tds_applicable": 0
    },
    "other_details": {
        "credit_period": 1,
        "credit_period_type": 1,
        "broker": null,
        "brokerage_percentage": null,
        "brokerage_on_value": null,
        "transporter": null,
        "supplier_upload_document": null
    },
    "opening_balance_details": {
        "opening_balance": 100,
        "opening_balance_dr_cr": 2
    }
}

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": "Supplier",
    "name": "supplier ledger",
    "group_id": 2,
    "party_details": {
        "gstin": "27ANUPC5555H1ZM",
        "billing_address": {
            "address_1": "billiing, Ward No. 38, P.C. No. 106A, RIS-Raipur",
            "address_2": "Ring Road",
            "country_id": "1",
            "state_id": "3",
            "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": "3",
            "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,
        "cin_number": "",
        "gst_return_status": "",
        "is_tds_applicable": 0
    },
    "other_details": {
        "credit_period": 1,
        "credit_period_type": 1,
        "broker": null,
        "brokerage_percentage": null,
        "brokerage_on_value": null,
        "transporter": null,
        "supplier_upload_document": null
    },
    "opening_balance_details": {
        "opening_balance": 100,
        "opening_balance_dr_cr": 2
    }
}'

Responses

🟢200Supplier Ledger

application/json

Body

data

object

required

The response contains supplier ledger details.

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 customer group.

model_type

string

required

Defines the type of model the supplier belongs to.

model_id

integer

required

The identifier linking the customer to a specific data model.

company_id

integer

required

The ID of the company associated with the customer.

ledgers_data

object

required

opening_balance

number

required

Initial balance amount to be recorded at ledger creation.

opening_balance_dr_cr

integer

required

Type of balance – 1 for Debit, 2 for Credit.

via_api

boolean

required

is_import

boolean

required

created_at

string

required

The date and time indicating when the record was last modified or updated 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": 2,
        "name": "supplier ledger",
        "group_id": 2,
        "model_type": "App\\Models\\Master\\Supplier",
        "model_id": 2,
        "company_id": 1,
        "ledgers_data": {
            "Supplier": {
                "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",
                "gst_return_status": null,
                "cin_number": null,
                "gst_registration_type": 1,
                "credit_limit_period": 1,
                "credit_period_type": 1,
                "rate_of_interest": null,
                "broker_master": null,
                "brokerage": null,
                "brokerage_on_value": null,
                "reference": null,
                "reference_name": null,
                "reference_address": null,
                "reference_contact_details": null,
                "opening_balance": null,
                "opening_balance_dr_cr": 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": 3,
                "billing_address_city_id": 2,
                "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": 3,
                "shipping_address_city_id": 1,
                "shipping_address_pin_code": "492001"
            }
        },
        "opening_balance": null,
        "opening_balance_dr_cr": null,
        "via_api": false,
        "is_import": false,
        "created_at": "2025-04-04T06:44:42.000000Z",
        "updated_at": "2025-04-04T06:44:42.000000Z",
        "flag": "party"
    },
    "success": true,
    "message": "Supplier Created Successfully."
}

Request#

Response#

Request

Request samples

Responses

Request

Response