Edit Delivery Challan

This endpoint allows you to retrieve the details of an existing delivery challan transaction to facilitate its modification. Once the delivery challan details are fetched, you can update the necessary fields in your request to reflect the desired changes.

Request

The GET request with ID in the URL will fetch the details of the specific delivery challan that you intend to modify.

Response

The response contains the complete details of the delivery challan transaction, which can be used for further modifications.

Responses

🟢200Edit Delivery Challan

application/json

Body

data

object

required

integer

required

A unique identifier for the delivery challan transaction.

company_id

integer

required

Represents the company that issued the delivery challan.

number_for_challan

string

required

A sequential numeric identifier for the delivery challan.

challan_number

string

required

The complete formatted challan number, which may include prefixes or suffixes (e.g., "Bill-3").

challan_date

string

required

The date on which the delivery challan was created.

party_ledger_id

integer

required

The unique identifier of the party (customer/vendor) associated with the delivery challan transaction.

party_phone_number

string

required

The contact number of the party receiving the goods.

region_iso

string

required

The ISO code of the country where the transaction is taking place.

region_code

string

required

The numerical code representing the country of operation, typically used in phone numbers and taxation.

gstin

string

required

The Goods and Services Tax Identification Number of the party, ensuring tax compliance for the transaction.

invoice_number

string

required

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

required

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

broker_id

integer

required

The unique identifier of the broker facilitating the transaction, if applicable.

brokerage

number

required

The amount of brokerage applicable on the transaction.

brokerage_on_value_type

integer

required

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

transport_id

integer

required

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

transporter_document_number

string

required

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

transporter_document_date

string

required

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

transporter_vehicle_number

string

required

Represents the vehicle number used for transporting the goods.

po_no

string

required

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

po_date

string

required

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

narration

string

required

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

term_and_condition

string

required

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

dispatch_address_id

integer

required

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

status

string

required

The status with possible values: Open, Fully Invoiced, or Partially Invoiced.

shipping_gstin

string

required

Define the shipping customer gstin number.

shipping_name

string

required

Define the shipping customer's name.

customer_ledger_name

string

required

The name of customer ledger, which linked to the transaction.

media

array[string]

required

Stores media-related data associated with the transaction.

transaction_items

array [object {16}]

required

An array containing the list of items included in the delivery challan

party

object

required

The customer associated with the transaction.

dispatch_address

object

required

Represents the address where the returned goods should be picked up or dispatched from.

billing_address

object

required

Contains details about the billing address linked to the sale return transaction.

shipping_address

object

required

Stores the delivery address where the returned items should be shipped.

broker_details

object

required

This array contains information about the broker involved in the transaction.

transport_details

object

required

This array contains details about the transportation involved in the transaction.

created_by

integer

required

A unique identifier of the user who created the transaction.

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.

deleted_by

integer

required

This field records the ID of the user who deleted the sale return transaction.

deleted_at

string

required

Stores the date and time when the sale return transaction was deleted.

success

boolean

required

message

string

required

Example

{
    "data": {
        "id": 1,
        "company_id": 6,
        "created_by": 2,
        "number_for_challan": "1",
        "challan_number": "bill no.12024-25",
        "challan_date": "2025-02-12",
        "party_ledger_id": 2702,
        "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": 1,
        "transporter_document_number": "212",
        "transporter_document_date": "2024-10-12",
        "transporter_vehicle_number": "GJ05-SG-1234",
        "po_no": "FASG522",
        "po_date": "2024-12-10",
        "narration": null,
        "term_and_condition": null,
        "dispatch_address_id": null,
        "status": "Open",
        "shipping_gstin": null,
        "shipping_name": null,
        "customer_ledger_name": "AAW",
        "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-02-11T12:41:03.000000Z",
                "updated_at": "2025-02-11T12:41:03.000000Z",
                "item_name": "Accounting Service",
                "units_of_array": [
                    {
                        "id": 1,
                        "name": "PIECES",
                        "code": "PCS",
                        "full_name": "PCS-PIECES",
                        "is_default": true,
                        "for_gst_use_name": null,
                        "company_id": null,
                        "created_at": "2023-02-10T04:22:56.000000Z",
                        "updated_at": "2023-02-10T04:22:56.000000Z"
                    }
                ],
                "decimal_places": 0,
                "decimal_places_for_rate": 2,
                "secondary_unit_of_measurement": null,
                "conversion_rate": null,
                "items": {
                    "id": 2,
                    "company_id": 6,
                    "item_name": "Accounting Service",
                    "group_id": 1,
                    "item_type": 2,
                    "model_id": 9,
                    "model_type": "App\\Models\\Master\\ItemMasterService",
                    "sku": null,
                    "item_image": "",
                    "model": {
                        "id": 9,
                        "unit_of_measurement": 1,
                        "alternate_unit": null,
                        "secondary_unit_of_measurement": null,
                        "decimal_places": 0,
                        "sale_price_type": 2,
                        "selling_price_with_gst": null,
                        "selling_price_without_gst": null,
                        "purchase_price_type": 2,
                        "purchase_price_with_gst": null,
                        "purchase_price_without_gst": null,
                        "decimal_places_for_rate": null,
                        "conversion_rate": null,
                        "purchase_discount_type": 1,
                        "purchase_discount_value": null,
                        "discount_type": 1,
                        "discount_value": null,
                        "is_gst_applicable": true,
                        "via_api": 0,
                        "hsn_sac_code": "123456",
                        "description": "Accounting Service description",
                        "is_description_same_as_item_name": false,
                        "is_rcm_applicable": false,
                        "gst_tax_id": 10,
                        "gst_cess_rate": null,
                        "income_ledger_id": 842,
                        "expense_ledger_id": 848,
                        "gst_tax": {
                            "id": 10,
                            "name": "18%",
                            "tax_rate": 18,
                            "company_id": null,
                            "created_at": "2023-02-10T04:22:55.000000Z",
                            "updated_at": "2023-02-10T04:22:55.000000Z"
                        },
                        "created_at": "2023-05-02T10:38:28.000000Z",
                        "updated_at": "2024-10-14T04:26:45.000000Z"
                    },
                    "media": [],
                    "via_api": 0,
                    "is_import": 0,
                    "created_at": "2023-05-02T10:38:28.000000Z",
                    "updated_at": "2024-10-14T04:26:45.000000Z"
                }
            }
        ],
        "party": {
            "id": 2702,
            "name": "AAW",
            "company_id": 6,
            "group_id": 1266,
            "parent_id": null,
            "model_id": 279,
            "model_type": "App\\Models\\Master\\Supplier",
            "ledgers_data": {
                "Supplier": {
                    "gstin": "24ABCPM4732A1ZA",
                    "phone_1": "7359971320",
                    "phone_2": null,
                    "website": null,
                    "brokerage": null,
                    "reference": true,
                    "cin_number": "",
                    "entity_type": 9,
                    "person_name": null,
                    "person_email": "vishalinfyom@gmail.com",
                    "broker_master": null,
                    "reference_name": null,
                    "opening_balance": 789679,
                    "pan_card_number": "ABCPM4732A",
                    "rate_of_interest": null,
                    "gst_return_status": null,
                    "reference_address": null,
                    "brokerage_on_value": 3,
                    "credit_period_type": 1,
                    "credit_limit_period": null,
                    "gst_registration_type": 1,
                    "opening_balance_dr_cr": 2,
                    "billing_address_city_id": 134096,
                    "billing_address_pin_code": "395008",
                    "billing_address_state_id": 4030,
                    "shipping_address_city_id": 134096,
                    "billing_address_address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
                    "billing_address_address_2": "KADODARA ROAD",
                    "reference_contact_details": null,
                    "shipping_address_pin_code": "395008",
                    "shipping_address_state_id": 4030,
                    "billing_address_country_id": 101,
                    "shipping_address_address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
                    "shipping_address_address_2": "KADODARA ROAD",
                    "shipping_address_country_id": 101
                }
            },
            "is_default": false,
            "created_at": "2023-06-17T09:20:33.000000Z",
            "updated_at": "2024-07-11T06:57:17.000000Z",
            "opening_balance": 789679,
            "opening_balance_dr_cr": 2,
            "via_api": 0,
            "is_import": 0
        },
        "dispatch_address": null,
        "billing_address": {
            "id": 205048,
            "address_1": "test",
            "address_2": "test",
            "country_id": 101,
            "state_id": 4012,
            "city_id": 134096,
            "pin_code": "395010",
            "model_id": 435,
            "model_type": "App\\Models\\DeliveryChallanTransaction",
            "address_type": 1,
            "created_at": "2025-02-11T12:41:03.000000Z",
            "updated_at": "2025-02-11T12:41:03.000000Z"
        },
        "shipping_address": {
            "id": 205049,
            "address_1": "test1",
            "address_2": "test1",
            "country_id": 101,
            "state_id": 4012,
            "city_id": 134096,
            "pin_code": "395010",
            "model_id": 435,
            "model_type": "App\\Models\\DeliveryChallanTransaction",
            "address_type": 2,
            "created_at": "2025-02-11T12:41:03.000000Z",
            "updated_at": "2025-02-11T12:41:03.000000Z"
        },
        "broker_details": null,
        "transport_details": {
            "id": 1,
            "transporter_name": "Jahhar Travels",
            "gstin": null,
            "company_id": 6,
            "contact_name": null,
            "region_iso": "IN",
            "region_code": "91",
            "via_api": 0,
            "contact_phone_number": null,
            "contact_email": null,
            "created_at": "2024-02-28T07:10:04.000000Z",
            "updated_at": "2024-02-28T07:10:04.000000Z"
        },
        "media": [],
        "via_api": 0,
        "created_at": "2025-02-11T12:41:03.000000Z",
        "updated_at": "2025-02-11T12:41:03.000000Z",
        "deleted_by": null,
        "deleted_at": null
    },
    "success": true,
    "message": "Delivery Challan Transaction Retrieved Successfully"
}

Edit Delivery Challan

Request#

Response#

Request

Request samples

Responses

Request

Response