Update Delivery Challan

Request

Authorization

Add parameter in header

ApiKey

Example:

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

Path Params

id

integer

required

This is the ID of the delivery challan you want to update.

Example:

1

Body Params application/json

challan_number

integer

required

A unique system-generated challan number assigned to each delivery challan. It is typically fetched from the next available challan number sequence in the system.

challan_date

string

required

The date on which the delivery challan is created, formatted as DD-MM-YYYY.

party_ledger_id

integer

required

A unique identifier assigned to the party receiving the goods, linked to the party's ledger in the accounting system.

billing_address

object

required

Represents the billing address of the customer for invoicing purposes.

country_id

integer

required

state_id

integer

required

address_1

string

optional

address_2

string

optional

city_id

integer

optional

pin_code

string

optional

items

array [object {4}]

required

A list of products or services being delivered

item_id

integer

required

This is the unique identifier assigned to the item in the transaction.

unit_id

integer

required

This field holds the identifier for the unit of measurement used for the item, such as pieces etc.

quantity

integer

required

Indicates the number of items being delivered in the transaction

additional_description

string | null

optional

Provides any extra details or notes about the item being delivered.

gstin

string

optional

The Goods and Services Tax Identification Number (GSTIN) of the recipient, used for tax compliance and invoice matching.

party_phone_number

number

optional

The contact number of the recipient party, used for communication and order tracking.

region_iso

string

optional

Represents the ISO code for the country of the customer. For example, "IN" indicates India, helping in country-specific tax.

region_code

integer

optional

Represents the country-specific regional code (e.g., 91 for India). It is used to simplify geographical regions and used for country-based taxation.

invoice_number

string

optional

Represents the sales transaction invoice number that is used as a reference to create a delivery challan. This links the delivery challan to the original sale.

invoice_date

string

optional

The invoice date represents the date on which the sales invoice was created. It serves as a reference for generating a delivery challan.

dispatch_address

integer

optional

Contains the delivery address for the products or services being invoiced.

shipping_address

object

optional

The shipping address where goods should be delivered. This includes customer details, GSTIN, and address information.

country_id

integer

required

state_id

integer

required

shipping_name

string | null

optional

Define the shipping customer's name.

shipping_gstin

string | null

optional

Define the shipping customer gstin number.

address_1

string

optional

address_2

string

optional

city_id

integer

optional

pin_code

string

optional

broker_details

object

optional

Contains details about broker related to the transaction.

broker_id

integer

optional

The broker id is the unique identifier assigned to the broker involved in the transaction or deal.

brokerage_for_sale

number

optional

The brokerage value is the percentage fee that the broker receives for facilitating the deal.

brokerage_on_value_type

integer

optional

This field determines the basis on which the brokerage fee is calculated such as invoice value (1) and taxable value (2).

transport_details

object

optional

transport_id

integer

optional

Represents the unique identifier for the transport service provider that is responsible for delivering the goods.

transporter_document_number

string

optional

Refers to the document number issued by the transporter, such as a bill.

transporter_document_date

string

optional

This is the date when the transporter's document was issued.

transporter_vehicle_number

string

optional

Represents the vehicle number used for transporting the goods.

other_details

object

optional

po_no

string

optional

Represents the Purchase Order Number associated with the transaction issued by the buyer.

po_date

string

optional

This is the date on which the Purchase Order was issued.

credit_period

string

optional

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

credit_period_type

integer

optional

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

narration

string | null

optional

An optional narrative field for providing additional notes or descriptions related to the transaction.

term_and_condition

string | null

optional

Includes any terms and conditions relevant to the transaction, such as delivery schedules, or return policies.

delivery_challan_document

string | null

optional

Attached document related to the delivery challan, typically used for record-keeping and compliance.

Example

{
    "challan_number": 1,
    "challan_date": "12-02-2025",
    "party_ledger_id": 2702,
    "gstin": "06AAKCA6445Q1Z2",
    "party_phone_number": "9521453010",
    "region_iso": "in",
    "region_code": 91,
    "invoice_number": null,
    "invoice_date": null,
    "dispatch_address_id": null,
    "billing_address": {
        "address_1": "172/5, , Coastal City Center",
        "address_2": "Undi Road,  Bhimavaram town and Municipality",
        "country_id": 1,
        "state_id": 2,
        "city_id": 1,
        "pin_code": "395010"
    },
    "shipping_address": {
        "shipping_name": null,
        "shipping_gstin": null,
        "address_1": "",
        "address_2": "",
        "country_id": 1,
        "state_id": 2,
        "city_id": 2,
        "pin_code": "395010"
    },
    "broker_details": {
        "broker_id": null,
        "brokerage_for_sale": null,
        "brokerage_on_value_type": 1
    },
    "transport_details": {
        "transport_id": 1,
        "transporter_document_number": "212",
        "transporter_document_date": "12-10-2024",
        "transporter_vehicle_number": "GJ05-SG-1234"
    },
    "other_details": {
        "po_no": "FASG522",
        "po_date": "10-12-2024",
        "credit_period": "30",
        "credit_period_type": 2
    },
    "items": [
        {
            "item_id": 1,
            "additional_description": "test",
            "unit_id": 1,
            "quantity": 1
        }
    ],
    "narration": null,
    "term_and_condition": null,    
    "delivery_challan_document": null
}

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/delivery-challan-transactions/1' \
--header 'Content-Type: application/json' \
--header 'ApiKey;' \
--data-raw '{
    "challan_number": 1,
    "challan_date": "12-02-2025",
    "party_ledger_id": 2702,
    "gstin": "06AAKCA6445Q1Z2",
    "party_phone_number": "9521453010",
    "region_iso": "in",
    "region_code": 91,
    "invoice_number": null,
    "invoice_date": null,
    "dispatch_address_id": null,
    "billing_address": {
        "address_1": "172/5, , Coastal City Center",
        "address_2": "Undi Road,  Bhimavaram town and Municipality",
        "country_id": 1,
        "state_id": 2,
        "city_id": 1,
        "pin_code": "395010"
    },
    "shipping_address": {
        "shipping_name": null,
        "shipping_gstin": null,
        "address_1": "",
        "address_2": "",
        "country_id": 1,
        "state_id": 2,
        "city_id": 2,
        "pin_code": "395010"
    },
    "broker_details": {
        "broker_id": null,
        "brokerage_for_sale": null,
        "brokerage_on_value_type": 1
    },
    "transport_details": {
        "transport_id": 1,
        "transporter_document_number": "212",
        "transporter_document_date": "12-10-2024",
        "transporter_vehicle_number": "GJ05-SG-1234"
    },
    "other_details": {
        "po_no": "FASG522",
        "po_date": "10-12-2024",
        "credit_period": "30",
        "credit_period_type": 2
    },
    "items": [
        {
            "item_id": 1,
            "additional_description": "test",
            "unit_id": 1,
            "quantity": 1
        }
    ],
    "narration": null,
    "term_and_condition": null,    
    "delivery_challan_document": null
}'

Responses

🟢200Update Delivery Challan

application/json

Body

data

object

required

delivery_challan_transaction

object

required

success

boolean

required

message

string

required

Example

{
    "data": {
        "delivery_challan_transaction": {
            "id": 1,
            "company_id": 6,
            "number_for_challan": "1",
            "challan_number": 1,
            "challan_date": "2025-02-05T18:30:00.000000Z",
            "party_ledger_id": 1,
            "party_phone_number": "9521453010",
            "region_iso": "in",
            "region_code": 91,
            "gstin": "06AAKCA6445Q1Z2",
            "invoice_number": null,
            "invoice_date": null,
            "broker_id": null,
            "brokerage": null,
            "brokerage_on_value_type": 1,
            "transport_id": null,
            "transporter_document_number": "212",
            "transporter_document_date": "2024-10-11T18:30:00.000000Z",
            "transporter_vehicle_number": "GJ05-SG-1234",
            "po_no": "FASG522",
            "po_date": "2024-12-09T18:30:00.000000Z",
            "narration": null,
            "term_and_condition": null,
            "dispatch_address_id": null,
            "status": "Open",
            "shipping_gstin": null,
            "shipping_name": null,
            "transaction_items": [
                {
                    "id": 1,
                    "transaction_id": 1,
                    "item_id": 2,
                    "unit_id": 1,
                    "quantity": 1,
                    "additional_description": "test",
                    "consolidating_items_to_invoice": null,
                    "created_at": "2025-01-28T10:27:56.000000Z",
                    "updated_at": "2025-01-28T10:27:56.000000Z"
                }
            ]
        },
        "via_api": false,
        "is_import": false,
        "created_by": 1,
        "created_at": "2025-01-28T10:27:12.000000Z",
        "updated_at": "2025-01-28T10:27:56.000000Z",
        "deleted_by": null,
        "deleted_at": null
    },
    "success": true,
    "message": "Delivery Challan Transaction Updated Successfully"
}

Update Delivery Challan

Request#

Response#

Request

Request samples

Responses

Request

Response