Create Sale From Estimate

This endpoint retrieves the details of a sale transaction linked to an estimate quote transaction, allowing the creation of a sale invoice based on it.

Request

The request must be sent as a GET request, with the sale transaction ID included in the URL. No request body is required for this endpoint.

Response

The response provides the complete details of the sale transaction associated with the specified estimate quote transaction with data needed to generate a sale invoice.

Responses

🟢200Create Sale From Estimate

application/json

Body

data

object

required

integer

required

A unique identifier assigned to the sale transaction.

company_id

integer

required

A unique identifier representing the company that generated the invoice.

created_by

integer

required

A unique identifier of the user who created the sale transaction.

payment_mode

integer

required

Indicates the mode of payment used for the transaction

payment_type_ledger_id

integer

required

A reference to the ledger ID used for payment tracking.

full_invoice_number

string

required

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

invoice_number

string

required

A sequential numeric identifier for the sale invoice.

date

string

required

The date on which the sale transaction was recorded.

next_sent_at_reminder

string

required

This field represents the scheduled date and time for sending the next payment reminder to the customer.

customer_ledger_id

integer

required

The unique identifier for the customer ledger, which maintains financial records related to this transaction.

party_phone_number

string

required

The contact number of the customer.

region_iso

string

required

The ISO code of the region where the transaction is conducted.

region_code

string

required

The country code for phone numbers related to the transaction.

gstin

string

required

The GST identification number of the customer.

broker_id

integer

required

The unique identifier of the broker associated with the transaction.

brokerage_for_sale

integer

required

The brokerage percentage applicable for the sale.

brokerage_on_value_type

integer

required

Indicates whether the brokerage is calculated on a taxable value or a invoice amount basis.

credit_period

integer

required

Specifies the number of days allowed for payment before it becomes due.

credit_period_type

integer

required

Defines the type of credit period in days and month.

credit_period_due_date

string

required

The date on which the payment is due based on the credit period.

transport_id

integer

required

A unique identifier for the transporter handling the delivery

billing_state_id

string

required

This field represents the unique identifier of the billing state associated with the transaction

transporter_document_number

string

required

The reference number of the transport document associated with the sale.

transporter_document_date

string

required

The date of the transport document.

transporter_vehicle_number

string

required

The vehicle number of the transporter responsible for delivery.

eway_bill_number

string

required

The reference number of the e-way bill (if applicable).

eway_bill_date

string

required

The date of e-way bill generation (if applicable).

po_no

string

required

The purchase order number linked to the sale transaction.

po_date

string

required

The date of the purchase order.

sales_item_type

integer

required

Indicates the type of invoice, such as item invoice (2) and accounting invoice (1).

shipping_freight

number

required

This field represents the cost of transporting goods from the seller to the buyer.

packing_charge

number

required

This field denotes the cost incurred for packing the goods before shipment.

tcs_tax_id

integer

required

Represents Tax Collected at Source (TCS) details

tcs_rate

number

required

tcs_amount

number

required

tds_tax_id

integer

required

Represents Tax Deducted at Source (TDS) details.

tds_rate

number

required

tds_amount

number

required

cgst

integer

required

Represents the applicable GST tax amounts for Central, State, and Integrated GST, respectively.

sgst

integer

required

igst

integer

required

shipping_freight_with_gst

integer

required

Represents the total shipping freight cost, including GST.

packing_charge_with_gst

integer

required

Represents the total packing charge, including GST.

shipping_freight_sgst_amount

number

required

Represents the applicable GST tax amounts on shipping cost for Central, State, and Integrated GST, respectively.

shipping_freight_cgst_amount

number

required

shipping_freight_igst_amount

number

required

packing_charge_sgst_amount

number

required

Represents the applicable GST tax amounts on packing cost for Central, State, and Integrated GST, respectively.

packing_charge_cgst_amount

number

required

packing_charge_igst_amount

number

required

rounding_amount

integer

required

The amount adjusted for rounding off the total bill.

total

integer

required

The total value of the sale transaction before tax.

grand_total

integer

required

The final payable amount after applying all calculations, including taxes and discounts.

taxable_value

integer

required

The amount on which tax is calculated.

gross_value

integer

required

The total gross value of the sale before deductions.

payment_status

string

required

The current payment status of the sale transaction (e.g., "Unpaid").

due_amount

integer

required

The amount still pending for payment.

narration

string

required

Additional notes or comments regarding the sale transaction.

term_and_condition

string

required

Terms and conditions applied to the sale transaction.

dispatch_address_id

integer

required

The reference ID of the dispatch address, if applicable.

is_gst_enabled

integer

required

Indicates whether GST is applicable (1 = Yes, 0 = No).

is_gst_na

integer

required

Indicates true when GST is not applicable to this transaction.

is_cgst_sgst_igst_calculated

integer

required

Specifies whether GST components calculated or not.

estimate_quote_no

string

required

This field holds the delivery challan number that was generated before creating the invoice and allows to use the details of it in the sales invoice.

delivery_challan_no

string

required

This field holds the delivery challan number that was generated before creating the invoice and allows to use the details of it in the sales invoice.

created_at

string

required

The timestamp indicating when the record was initially created in the system,

updated_at

string

required

he timestamp indicating when the record was last modified or updated in the system.

cess

integer

required

Any additional cess tax applied to the transaction.

shipping_gstin

string

required

The GST identification number of the shipping party.

shipping_name

string

required

The name of the shipping recipient.

deleted_by

integer

required

This section provides information about a transaction deletion.

deleted_at

string

required

is_round_off_not_changed

integer

required

Specifies whether the round fo amount change or not.

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.

delivery_challan_list

array [object {2}]

required

Contains a list of delivery challans linked to the transaction.

estimate_number_list

array [object {2}]

required

Holds details of estimate numbers related to the transaction.

customer

object

required

Represents customer details.

billing_address

object

required

Stores the customer's billing address.

shipping_address

object

required

Contains the address where the goods or services will be delivered.

sale_items

array [object {40}]

required

Lists all items involved in the sale transaction, including quantity, price, and applicable taxes.

sale_ledgers

array[string]

required

Represents financial ledger entries associated with the sale when accounting type invoice is created.

additional_charges

array [object {12}]

required

Includes any extra charges applied to the transaction

add_less

array[string]

required

Represents any adjustments made to the final transaction amount

payment_details

array[string]

required

Holds information about payments made for the transaction

receipt_transaction_item

array[string]

required

Tracks payment receipts associated with the transaction.

journal_transaction_item

array[string]

required

Stores journal entries linked to the transaction for accounting reconciliation.

sale_return

array[string]

required

Lists any returns associated with the sale

credit_note

array[string]

required

Contains details of credit notes issued against the transaction.

success

boolean

required

message

string

required

Example

{
    "data": {
        "id": 1,
        "company_id": 6,
        "payment_mode": null,
        "payment_type_ledger_id": null,
        "full_invoice_number": "139",
        "invoice_number": "139",
        "date": "2024-12-26T18:30:00.000000Z",
        "next_sent_at_reminder": null,
        "customer_ledger_id": 2702,
        "party_phone_number": null,
        "region_iso": "in",
        "region_code": "91",
        "gstin": null,
        "broker_id": 279,
        "brokerage_for_sale": 1,
        "brokerage_on_value_type": 1,
        "credit_period": 30,
        "credit_period_type": 2,
        "credit_period_due_date": "2025-01-26",
        "transport_id": 86,
        "billing_state_id": null,
        "transporter_document_number": "212",
        "transporter_document_date": "2024-10-11T18:30:00.000000Z",
        "transporter_vehicle_number": "GJ05-SG-1234",
        "eway_bill_number": null,
        "eway_bill_date": null,
        "po_no": "FASG522",
        "po_date": "2024-12-09T18:30:00.000000Z",
        "sales_item_type": 2,
        "shipping_freight": null,
        "packing_charge": null,
        "tcs_tax_id": null,
        "tcs_rate": null,
        "tcs_amount": null,
        "tds_tax_id": null,
        "tds_rate": null,
        "tds_amount": null,
        "cgst": 0,
        "sgst": 0,
        "igst": 0,
        "shipping_freight_with_gst": 0,
        "packing_charge_with_gst": 0,
        "shipping_freight_sgst_amount": null,
        "shipping_freight_cgst_amount": null,
        "shipping_freight_igst_amount": null,
        "packing_charge_sgst_amount": null,
        "packing_charge_cgst_amount": null,
        "packing_charge_igst_amount": null,
        "rounding_amount": 0,
        "total": 700,
        "grand_total": 700,
        "taxable_value": 700,
        "gross_value": 200,
        "payment_status": "Unpaid",
        "due_amount": 700,
        "narration": null,
        "term_and_condition": null,
        "is_gst_enabled": 0,
        "is_gst_na": 1,
        "is_cgst_sgst_igst_calculated": 0,
        "estimate_quote_no": null,
        "delivery_challan_no": null,
        "cess": 0,
        "shipping_gstin": "27AACCD1376K1ZJ",
        "shipping_name": "ddd",
        "is_round_off_not_changed": 0,
        "customer_ledger_name": "AAW",
        "media": [],
        "delivery_challan_list": [
            {
                "id": 153,
                "document_number": "bill no.182024-25"
            },
            {
                "id": 161,
                "document_number": "bill no.232024-25"
            },
            {
                "id": 321,
                "document_number": "bill no.272024-25"
            }
        ],
        "estimate_number_list": [],
        "customer": {
            "id": 1,
            "name": "AAW",
            "company_id": 6,
            "group_id": 1,
            "parent_id": null,
            "model_id": 1,
            "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": 1,
                    "billing_address_pin_code": "395008",
                    "billing_address_state_id": 2,
                    "shipping_address_city_id": 1,
                    "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": 2,
                    "billing_address_country_id": 1,
                    "shipping_address_address_1": "2121, 3RD FLOOR, RADHA RAMAN TEXTILE MARKET",
                    "shipping_address_address_2": "KADODARA ROAD",
                    "shipping_address_country_id": 1
                }
            },
            "opening_balance": 789679,
            "opening_balance_dr_cr": 2,
            "is_default": false,
            "via_api": 0,
            "is_import": 0,
            "created_at": "2023-06-17T09:20:33.000000Z",
            "updated_at": "2024-07-11T06:57:17.000000Z"
        },
        "dispatch_address_id": null,
        "billing_address": {
            "id": 1,
            "address_1": "172/5, , Coastal City Center",
            "address_2": "Undi Road,  Bhimavaram town and Municipality",
            "country_id": 1,
            "state_id": 1,
            "city_id": 2,
            "pin_code": "395010",
            "model_id": 13710,
            "model_type": "App\\Models\\SaleTransaction",
            "address_type": 1,
            "created_at": "2025-02-11T11:09:39.000000Z",
            "updated_at": "2025-02-11T11:09:39.000000Z"
        },
        "shipping_address": {
            "id": 2,
            "address_1": "172/5, , Coastal City Center",
            "address_2": "Undi Road,  Bhimavaram town and Municipality",
            "country_id": 1,
            "state_id": 1,
            "city_id": 2,
            "pin_code": "395010",
            "model_id": 13710,
            "model_type": "App\\Models\\SaleTransaction",
            "address_type": 2,
            "created_at": "2025-02-11T11:09:39.000000Z",
            "updated_at": "2025-02-11T11:09:39.000000Z"
        },
        "sale_items": [
            {
                "id": 1,
                "sale_transactions_id": 1,
                "item_id": 3,
                "item_name": "Accounting Service",
                "additional_description": "test",
                "unit_id": 2,
                "quantity": 1,
                "mrp": null,
                "with_tax": false,
                "rpu_with_gst": null,
                "rpu_without_gst": 100,
                "discount_type": 1,
                "discount_value": 100,
                "discount_type_2": 1,
                "discount_value_2": null,
                "total_discount_amount": 0,
                "gst_id": 2,
                "gst_tax_percentage": 8,
                "total": 100,
                "ledger_id": 1,
                "ledger_name": "Sale",
                "classification_igst_tax": null,
                "classification_cgst_tax": null,
                "classification_sgst_tax": null,
                "classification_cess_tax": null,
                "classification_is_rcm_applicable": 0,
                "classification_nature_type": null,
                "consolidating_items_to_invoice": "0",
                "cess_rate": 0,
                "cess_amount": 0,
                "taxable_amount": 0,
                "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,
                "taxable_value": 100,
                "created_at": "2025-02-11T11:09:39.000000Z",
                "updated_at": "2025-02-11T11:09:39.000000Z",
            },
            {
                "id": 2,
                "sale_transactions_id": 1,
                "item_id": 1,
                "item_name": "Consultancy",
                "additional_description": "test",
                "unit_id": 2,
                "quantity": 1,
                "mrp": null,
                "with_tax": false,
                "rpu_with_gst": null,
                "rpu_without_gst": 100,
                "discount_type": 1,
                "discount_value": null,
                "discount_type_2": 1,
                "discount_value_2": null,
                "total_discount_amount": 0,
                "gst_id": 1,
                "gst_tax_percentage": 8,
                "total": 100,
                "ledger_id": 2,
                "ledger_name": "Sale",
                "classification_igst_tax": null,
                "classification_cgst_tax": null,
                "classification_sgst_tax": null,
                "classification_cess_tax": null,
                "classification_is_rcm_applicable": 0,
                "classification_nature_type": null,
                "consolidating_items_to_invoice": "0",
                "cess_rate": 0,
                "cess_amount": 0,
                "taxable_amount": 0,
                "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,
                "taxable_value": 100,
                "created_at": "2025-02-11T11:09:39.000000Z",
                "updated_at": "2025-02-11T11:09:39.000000Z"
            }
        ],
        "sale_ledgers": [],
        "additional_charges": [
            {
                "id": 1,
                "sale_id": 3,
                "ledger_id": 2,
                "ledger_name": "Freight Charge Income",
                "charge_type": 1,
                "value": 500,
                "gst_rate_id": null,
                "gst_percentage": null,
                "total": 500,
                "total_without_tax": 500,
                "created_at": "2025-01-28T10:16:24.000000Z",
                "updated_at": "2025-01-28T10:16:24.000000Z"
            }
        ],
        "add_less": [],
        "payment_details": [],
        "receipt_transaction_item": [],
        "journal_transaction_item": [],
        "sale_return": [],
        "credit_note": [],
        "created_by": 8,
        "via_api": 0,
        "is_import": 0,
        "created_at": "2025-01-28T10:16:24.000000Z",
        "updated_at": "2025-01-28T10:16:24.000000Z",
        "deleted_by": null,
        "deleted_at": null
    },
    "success": true,
    "message": "Sale Transaction Retrieved Successfully for Sale Return."
}

Create Sale From Estimate

Request#

Response#

Request

Request samples

Responses

Request

Response