HisabKitab
  1. Sale Return Transaction
HisabKitab
  • Third Party APIs
    • How to Generate ApiKey ?
    • Account Master
      • Ledger Groups
        • List of All Groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Ledgers
        • Create Ledger
          • Customer Ledger
          • Supplier Ledger
          • Bank Ledger
          • Capital Ledger
          • Cash Ledger
          • Income Ledger
          • Expense Ledger
          • Fixed Asset Ledger
          • Investment Ledger
          • Loan and Advance (Asset) Ledger
          • Misc Assets Ledger
          • Other Current Assets Ledger
          • Taxes - GST Ledger
          • Taxes - TDS Ledger
          • Taxes - TCS Ledger
          • Provisions Ledger
          • Reserve and Surplus Ledger
          • Secured Loan Ledger
          • Unsecured Loan Ledger
          • Stock In Hand Ledger
          • Other Current Liabilities Ledger
          • TDS Receivable Ledger
          • TCS Receivable Ledger
        • Ledger Detail
        • List of all Ledgers
        • Edit Ledger
        • Update Ledger
        • Delete Ledger
        • Delete Ledger Media
        • Add Location(Fixed Asset )
        • Check Unique GST Number
        • Check Unique GST Number with Ledger
        • Holding & Profit Ratio
        • Ledger TDS tax Data
        • Ledger TCS tax Data
    • Item Master
      • Item Groups
        • List of all groups
        • Create Group
        • Create Batch Groups
        • Edit Group
        • Update Group
        • Delete Group
      • Items
        • Item Form Details
        • List of items
        • Create Good Item
        • Create Service Item
        • Edit Item
        • Update Item
        • Delete Item
      • Unit of Measurement
        • List of Unit of Measurement
        • Create Unit of Measurement
        • Edit Unit of Measurement
        • Update Unit of Measurement
        • Delete Unit of Measurement
    • Broker Master
      • List of Brokers
      • Create Broker
      • Edit Broker
      • Update Broker
      • Delete Broker
    • Transport Master
      • List of Transport
      • Create Transport
      • Edit Transport
      • Update Transport
      • Delete Transport
    • Cess Rate
      • List of Cess Rate
      • Create Cess Rate
      • Edit Cess Rate
      • Update Cess Rate
      • Delete Cess Rate
    • Dispatch Address
      • List of Dispatch Address
      • Create Dispatch Address
      • Edit Dispatch Address
      • Update Dispatch Address
      • Delete Dispatch Address
    • Shipping Address
      • List of Shipping Addresses
      • Create Shipping Address
      • Edit Shipping Address
      • Update Shipping Address
      • Delete Shipping Address
    • Comman APIs
      • Company Details
      • Countries
      • States
      • Cities
      • Gst Rates
      • Classification-nature-type
    • Configuration
      • Sale
        • Sale Configuration
        • Update Configuration
        • Update Configuration with Type
      • Sale Return
        • Sale Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Debit Note
        • Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Income Credit Note
        • Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Estimate Quote
        • Estimate Configuration
        • Update Configuration with Type
        • Update Configuration
      • Delivery Challan
        • Delivery Challan Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase
        • Purchase Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Return
        • Purchase Return Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Credit Note
        • Expense Credit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Expense Debit Note
        • Expense Debit Note Configuration
        • Update Configuration
        • Update Configuration with Type
      • Purchase Order
        • Purchase Order Configuration
        • Update Configuration
        • Update Configuration with Type
    • Sale Transactions
      • List of Transactions
      • Next Invoice Number
      • Create Item Sale
      • Create Accounting Sale
      • Edit Sale
      • Update Sale
      • Duplicate Sale
      • Delete Sale
      • Get Sale For Sale Return
      • Create Challan From Sale Invoice
    • Sale Return Transaction
      • List of Transactions
        GET
      • Next Invoice Number
        GET
      • Create Item Sale Return
        POST
      • Create Accounting Sale Return
        POST
      • Edit Sale Return
        GET
      • Update Sale Return
        POST
      • Duplicate Sale Return
        GET
      • Delete Sale Return
        DELETE
    • Income Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Debit Note
      • Create Accounting Debit Note
      • Edit Debit Note
      • Update Debit Note
      • Duplicate Debit Note
      • Delete Debit Note
    • Income Credit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Credit Note
      • Create Accounting Credit Note
      • Edit Credit Note
      • Update Credit Note
      • Duplicate Credit Note
      • Delete Credit Note
    • Estimate Quote Transaction
      • List of Transactions
      • Next Estimate Number
      • Create Item Estimate
      • Create Accounting Estimate
      • Edit Estimate
      • Update Estimate
      • Duplicate Estimate
      • Create Sale From Estimate
      • Delete Estimate
    • Delivery Challan Transaction
      • List of Transactions
      • Next Challan Number
      • Create Delivery Challan
      • Edit Delivery Challan
      • Update Delivery Challan
      • Duplicate Delivery Challan
      • Create Sale From Delivery Challan
      • Delete Delivery Challan
    • Purchase Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase
      • Create Accounting Purchase
      • Edit purchase
      • Update purchase
      • Duplicate purchase
      • Get purchase For purchase Return
      • Delete purchase
    • Purchase Return Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Return
      • Create Accounting Purchase Return
      • Edit purchase Return
      • Update purchase Return
      • Duplicate purchase Return
      • Delete purchase Return
    • Expense Credit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Credit Note
      • Create Accounting Expense Credit Note
      • Edit Expense Credit Note
      • Update Expense Credit Note
      • Duplicate Expense Credit Note
      • Delete Expense Credit Note
    • Expense Debit Note Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Expense Debit Note
      • Create Accounting Expense Debit Note
      • Edit Expense Debit Note
      • Update Expense Debit Note
      • Duplicate Expense Debit Note
      • Delete Expense Debit Note
    • Purchase Order Transaction
      • List of Transactions
      • Next Invoice Number
      • Create Item Purchase Order
      • Create Accounting Purchase Order
      • Edit purchase Order
      • Update Purchase Order
      • Duplicate purchase Order
      • Delete purchase Order
      • Book Purchase Order
    • Receipt Transaction
      • List of Receipts
      • Next invoice number
      • Create Receipt
      • Edit Receipt
      • Update Receipt
      • Delete Receipt
    • Payment Transaction
      • List of Payments
      • Next invoice number
      • Create Payment
      • Edit Payment
      • Update Payment
      • Delete Payment
    • Journal Transaction
      • List of Journals
      • Next invoice number
      • Create Journal
      • Edit Journal
      • Update Journal
      • Delete Journal
  1. Sale Return Transaction

Update Sale Return

POST
https://app.hisabkitab.co/third-party/sale-return-transactions/{id}
This endpoint enables the modification of an existing sale return transaction.

Request#

The request must be sent as a POST request, with the sale return transaction ID provided in the URL. The body of the request should include the updated information for the sale return transaction.

Response#

The API will return a confirmation message along with the updated details of the sale return transaction. The response will include the revised transaction data, reflecting changes to the return invoice and other modifications made.

Request

Authorization
Add parameter in header
ApiKey
Example:
ApiKey: ********************
Path Params
id
integer 
required
The ID represents the sale transaction ID for the updated transaction.
Example:
1
Body Params application/json
invoice_number
string 
required
The unique invoice number is system-generated and assigned to each invoice and Typically fetched from the Next Invoice Number Endpoint.
date
string 
required
The invoice date represents the date on which an invoice is issued, and the date is set within the applicable financial year.
customer_ledger_id
integer 
required
Represents the unique identifier of the customer for whom the invoice is being created, linking the invoice to the relevant business entity.
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
sale_return_item_type
integer 
required
Indicates the type of invoice such as item invoice (2) and accounting invoice (1).
Default:
1
items
array [object {19}] 
required
An array of items for item invoice.
item_id
integer 
required
This is the unique identifier assigned to the item in the transaction.
ledger_id
integer 
required
Refers to the unique identifier of the ledger account where the item's transaction is recorded.
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 sold in the transaction
rpu
number 
required
Represents the Rate Per Unit of the item, the selling price for each unit before taxes and discounts.
with_tax
integer 
required
This indicates whether the price is inclusive of tax. A value of 0 means the price is exclusive of tax.
discount_type
integer 
required
Type of discount applied to the selling price (2 = Percentage, 1 = Fixed amount).
total
integer 
required
This is the final total for the item after all calculations, including discounts.
gst_id
integer 
optional
This field represents the GST tax rate for the item and is required if your company is GST applicable.
mrp
integer  | null 
optional
Refers to the Maximum Retail Price of the item.
additional_description
string  | null 
optional
Provides any extra details or notes about the item being sold.
discount_value
number  | null 
optional
Represents the discount amount applied to the item.
discount_type_2
integer  | null 
optional
Similar to discount_type applicable on the second discount amount.
discount_value_2
number  | null 
optional
Represents the second discount amount applied.
classification_igst_tax
integer 
optional
This field is required when applying GST to an item.
classification_cgst_tax
integer 
optional
This field is required when applying GST to an item.
classification_sgst_tax
integer 
optional
This field is required when applying GST to an item.
cess
integer  | null 
optional
Represents the cess (additional tax) applied to the item.
consolidating_items_to_invoice
string 
optional
This field indicates whether multiple item quantities are being combined into a single invoice.
main_classification_nature_type
string 
required
Describes the nature of the sale for tax purposes, such as "Intrastate Sales Taxable".
is_rcm_applicable
boolean 
required
Indicates whether the Reverse Charge Mechanism (RCM) is applicable, it is a tax mechanism where the buyer, rather than the seller, is liable to pay the tax.
Default:
false
gstin
string 
optional
The GSTIN (Goods and Services Tax Identification Number) is a unique number assigned to the customer for claim tax credits.
gross_value
number <double>
required
Represents the total value of the transaction before applying any discounts, taxes, or additional charges.
taxable_value
number <double>
required
The total value of the invoice, after applying discounts and additional charges but before adding any taxes.
cgst
number 
required
These fields represent the Central GST
sgst
number 
required
These fields represent the State GST
igst
number 
required
These fields represent the Integrated GST
cess
number 
required
Represents the cess (additional tax) applied to the transaction.
grand_total
number <double>
required
The final amount of the invoice, which includes all items, taxes, additional charges, and rounding adjustments.
rounding_amount
number <double>
required
The rounding adjustment to make the total amount a round figure. This is usually done for simplifying invoice totals.
is_gst_enabled
boolean 
required
Indicates whether GST is enabled for the transaction.
is_cgst_sgst_igst_calculated
boolean 
required
Indicates whether CGST, SGST, or IGST has been calculated.
is_gst_na
boolean 
required
Indicates if GST is not applicable to the transaction.
is_round_off_not_changed
boolean 
required
check if adjustments are made to the rounding of the invoice total.
party_phone_number
number 
optional
The contact phone number of the party (customer) for the invoice.
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.
original_inv_no
integer 
optional
Represents the sales transaction invoice number that is used as a reference to create a sales return transaction invoice. This links the return invoice to the original sale.
original_inv_date
string 
optional
The invoice date represents the date on which the sales transaction invoice was created. It serves as a reference for generating a sales return transaction invoice.
dispatch_address_id
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 
optional
Define the shipping customer's name.
shipping_gstin
string 
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 <double>
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
integer 
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.
eway_bill_details
object 
optional
eway_bill_number
string 
optional
This field holds the unique identification number of the E-way bill generated for the shipment of goods.
eway_bill_date
string 
optional
This is the date when the E-way bill was generated.
other_details
object 
optional
po_no
string 
required
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
integer 
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 payment terms, delivery schedules, or return policies.
additional_charges
array [object {5}] 
optional
This section lists any extra charges that are added to the invoice, such as shipping .
ac_ledger_id
integer 
required
This field represents the unique identifier for the ledger account that records the additional charge.
ac_type
integer 
required
Indicates the type of charge being applied (2 = Percentage, 1 = Fixed amount).
ac_value
number 
required
Represents the value or amount of the additional charge.
ac_gst_rate_id
integer 
required
This field specifies the GST tax rate applied to the additional charge.
ac_total_without_tax
number 
required
This indicates the total amount of the additional charge excluding taxes.
tcs_details
object 
optional
Includes Tax Collected at Source (TCS) information
tcs_tax_id
integer 
required
This field holds the id for the TCS rate applied to the transaction.
tcs_rate
integer 
required
Represents the rate (%) at which TCS is collected on the transaction.
tcs_amount
number 
required
This field shows the amount of TCS collected on the transaction.
tds_details
object 
optional
Contains information regarding Tax Deducted at Source (TDS).
tds_tax_id
integer 
required
This field holds the id for the TDS applied to the transaction.
tds_rate
integer 
required
Represents the rate (%) at which TDS is collected on the transaction.
tds_amount
number 
required
This field shows the amount of TDS collected on the transaction.
add_less
array [object {4}] 
optional
An array for any adjustments (either additions or reductions) to the total invoice amount.
al_ledger_id
integer 
required
This is the unique identifier for the ledger account associated with the add or less charge.
al_is_show_in_print
boolean 
required
This field determines whether the charge should be displayed in the printed invoice.
Default:
true
al_type
integer 
required
Indicates the type of charge being applied (2 = Percentage, 1 = Fixed amount).
al_value
number 
required
Represents the value or amount of the add or less charge.
payment_details
array [object {5}] 
optional
pd_ledger_id
integer 
required
This is the unique identifier for the ledger account associated with the payment.
pd_date
string 
required
Refers to the date when the payment was made.
pd_amount
number 
required
This is the amount paid in the transaction.
pd_mode
integer 
optional
Represents the mode id of payment used for the transaction, such as cash, cheque, UPI, RTGS, etc.
pd_reference_number
number 
optional
This field holds a reference number related to the payment, like a transaction number or cheque number.
submit_button_value
integer 
optional
Defines the action of the button used for submitting the form, where 1 means Save, 2 means Save & New, and 3 means Save & Print.
Example
{
    "invoice_number": "SR-1",
    "date": "12-02-2025",
    "customer_ledger_id": 1,
    "gstin": "06AAKCA6445Q1Z2",
    "party_phone_number": "9521453010",
    "region_iso": "in",
    "region_code": 91,
    "original_inv_no": null,
    "original_inv_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": "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"
    },
    "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"
    },
    "eway_bill_details": {
        "eway_bill_number": null,
        "eway_bill_date": null
    },
    "other_details": {
        "po_no": "FASG522",
        "po_date": "10-12-2024",
        "credit_period": "30",
        "credit_period_type": 2
    },
    "sale_return_item_type": 2,
    "items": [
        {
            "item_id": 1,
            "additional_description": "test",
            "ledger_id": 2,
            "unit_id": 2,
            "quantity": 1,
            "mrp": null,
            "rpu": 118,
            "with_tax": 1,
            "discount_type": 1,
            "discount_value": null,
            "discount_type_2": 1,
            "discount_value_2": null,
            "gst_id": 1,
            "classification_igst_tax": 18,
            "classification_cgst_tax": 0,
            "classification_sgst_tax": 0,
            "cess": 0,
            "total": 100,
            "consolidating_items_to_invoice": 0
        },
        {
            "item_id": 2,
            "additional_description": "test",
            "ledger_id": 1,
            "unit_id": 2,
            "quantity": 1,
            "mrp": null,
            "rpu": 118,
            "with_tax": 1,
            "discount_type": 1,
            "discount_value": null,
            "discount_type_2": 1,
            "discount_value_2": null,
            "gst_id": 1,
            "classification_igst_tax": 18,
            "classification_cgst_tax": 0,
            "classification_sgst_tax": 0,
            "cess": 0,
            "total": 100,
            "consolidating_items_to_invoice": 0
        }
    ],
    "main_classification_nature_type": "Interstate Sales Taxable",
    "is_rcm_applicable": 0,
    "narration": null,
    "term_and_condition": null,
    "additional_charges": [
        {
            "ac_ledger_id": 2,
            "ac_type": 1,
            "ac_value": 100,
            "ac_gst_rate_id": 12,
            "ac_total_without_tax": 100
        }
    ],
    "gross_value": 200,
    "taxable_value": 200,
    "cgst": 0,
    "sgst": 0,
    "igst": 36,
    "cess": 0,
    "tcs_details": {
        "tcs_tax_id": null,
        "tcs_rate": null,
        "tcs_amount": null
    },
    "tds_details": {
        "tds_tax_id": null,
        "tds_rate": null,
        "tds_amount": null
    },
    "add_less": [
        {
            "al_ledger_id": 2,
            "al_is_show_in_print": false,
            "al_type": 1,
            "al_value": 100
        }
    ],
    "rounding_amount": 0,
    "grand_total": 236,
    "payment_details": [
        {
            "pd_ledger_id": 3,
            "pd_date": "16-10-2024",
            "pd_amount": 500,
            "pd_mode": 3592,
            "pd_reference_number": null
        }
    ],
    "is_gst_enabled": 1,
    "is_cgst_sgst_igst_calculated": 1,
    "is_gst_na": 0,
    "is_round_off_not_changed": false,
    "submit_button_value": 3
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.hisabkitab.co/third-party/sale-return-transactions/1' \
--header 'Content-Type: application/json' \
--header 'ApiKey;' \
--data-raw '{
    "invoice_number": "SR-1",
    "date": "12-02-2025",
    "customer_ledger_id": 1,
    "gstin": "06AAKCA6445Q1Z2",
    "party_phone_number": "9521453010",
    "region_iso": "in",
    "region_code": 91,
    "original_inv_no": null,
    "original_inv_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": "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"
    },
    "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"
    },
    "eway_bill_details": {
        "eway_bill_number": null,
        "eway_bill_date": null
    },
    "other_details": {
        "po_no": "FASG522",
        "po_date": "10-12-2024",
        "credit_period": "30",
        "credit_period_type": 2
    },
    "sale_return_item_type": 2,
    "items": [
        {
            "item_id": 1,
            "additional_description": "test",
            "ledger_id": 2,
            "unit_id": 2,
            "quantity": 1,
            "mrp": null,
            "rpu": 118,
            "with_tax": 1,
            "discount_type": 1,
            "discount_value": null,
            "discount_type_2": 1,
            "discount_value_2": null,
            "gst_id": 1,
            "classification_igst_tax": 18,
            "classification_cgst_tax": 0,
            "classification_sgst_tax": 0,
            "cess": 0,
            "total": 100,
            "consolidating_items_to_invoice": 0
        },
        {
            "item_id": 2,
            "additional_description": "test",
            "ledger_id": 1,
            "unit_id": 2,
            "quantity": 1,
            "mrp": null,
            "rpu": 118,
            "with_tax": 1,
            "discount_type": 1,
            "discount_value": null,
            "discount_type_2": 1,
            "discount_value_2": null,
            "gst_id": 1,
            "classification_igst_tax": 18,
            "classification_cgst_tax": 0,
            "classification_sgst_tax": 0,
            "cess": 0,
            "total": 100,
            "consolidating_items_to_invoice": 0
        }
    ],
    "main_classification_nature_type": "Interstate Sales Taxable",
    "is_rcm_applicable": 0,
    "narration": null,
    "term_and_condition": null,
    "additional_charges": [
        {
            "ac_ledger_id": 2,
            "ac_type": 1,
            "ac_value": 100,
            "ac_gst_rate_id": 12,
            "ac_total_without_tax": 100
        }
    ],
    "gross_value": 200,
    "taxable_value": 200,
    "cgst": 0,
    "sgst": 0,
    "igst": 36,
    "cess": 0,
    "tcs_details": {
        "tcs_tax_id": null,
        "tcs_rate": null,
        "tcs_amount": null
    },
    "tds_details": {
        "tds_tax_id": null,
        "tds_rate": null,
        "tds_amount": null
    },
    "add_less": [
        {
            "al_ledger_id": 2,
            "al_is_show_in_print": false,
            "al_type": 1,
            "al_value": 100
        }
    ],
    "rounding_amount": 0,
    "grand_total": 236,
    "payment_details": [
        {
            "pd_ledger_id": 3,
            "pd_date": "16-10-2024",
            "pd_amount": 500,
            "pd_mode": 3592,
            "pd_reference_number": null
        }
    ],
    "is_gst_enabled": 1,
    "is_cgst_sgst_igst_calculated": 1,
    "is_gst_na": 0,
    "is_round_off_not_changed": false,
    "submit_button_value": 3
}'

Responses

🟢200Update Sale Return
application/json
Body
data
object 
required
Contains the details of the newly created sale return transaction
sale_return_transaction
object 
required
transaction_id
integer 
required
A unique identifier assigned to the sale transaction.
e_invoice_is_create
boolean 
required
A boolean flag indicates whether an e-invoice has been generated for thistransaction.es
success
boolean 
required
message
string 
required
Example
{
    "data": {
        "sale_return_transaction": {
            "id": 1,
            "company_id": 6,
            "payment_mode": null,
            "payment_type_ledger_id": null,
            "full_invoice_number": "2023-241",
            "credit_note_number": "1",
            "date": "2025-02-11T18:30:00.000000Z",
            "customer_ledger_id": 1,
            "party_phone_number": "9521453010",
            "region_iso": "in",
            "region_code": 91,
            "gstin": "06AAKCA6445Q1Z2",
            "original_inv_no": null,
            "original_inv_date": null,
            "broker_id": null,
            "brokerage_for_sale": null,
            "brokerage_on_value_type": 1,
            "credit_period": 30,
            "credit_period_type": 2,
            "credit_period_due_date": "2025-03-13T18:30:00.000000Z",
            "transport_id": 1,
            "transporter_document_number": "212",
            "transporter_document_date": "2024-10-11T18:30:00.000000Z",
            "transporter_vehicle_number": "GJ05-SG-1234",
            "shipping_name": null,
            "shipping_gstin": null,
            "po_no": "FASG522",
            "po_date": "2024-12-09T18:30:00.000000Z",
            "eway_bill_number": null,
            "eway_bill_date": null,
            "sale_return_item_type": 2,
            "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": 36,
            "rounding_amount": 0,
            "total": 236,
            "grand_total": 236,
            "taxable_value": 200,
            "gross_value": 200,
            "narration": null,
            "term_and_condition": null,
            "dispatch_address_id": null,
            "is_gst_enabled": 1,
            "cess": 0,
            "is_cgst_sgst_igst_calculated": 1,
            "is_gst_na": 0,
            "payment_status": "Unpaid",
            "due_amount": 236,
            "paid_amount": 0,
            "payment_transaction_item": [],
            "journal_transaction_item": [],
            "sale_return_items": [
                {
                    "id": 1,
                    "srt_id": 1,
                    "item_id": 1,
                    "ledger_id": 2,
                    "additional_description": "test",
                    "unit_id": 1,
                    "quantity": 1,
                    "mrp": null,
                    "with_tax": true,
                    "rpu_with_gst": 118,
                    "rpu_without_gst": 100,
                    "discount_type": 1,
                    "discount_value": null,
                    "discount_type_2": 1,
                    "discount_value_2": null,
                    "total_discount_amount": 0,
                    "gst_id": 2,
                    "gst_tax_percentage": 18,
                    "total": 100,
                    "classification_igst_tax": 18,
                    "classification_cgst_tax": 0,
                    "classification_sgst_tax": 0,
                    "classification_cess_tax": 0,
                    "classification_is_rcm_applicable": 0,
                    "classification_nature_type": 4,
                    "consolidating_items_to_invoice": "0",
                    "cess_rate": 0,
                    "cess_amount": 0,
                    "taxable_amount": null,
                    "created_at": "2025-01-28T10:19:38.000000Z",
                    "updated_at": "2025-01-28T10:19:38.000000Z"
                },
                {
                    "id": 2,
                    "srt_id": 1,
                    "item_id": 2,
                    "ledger_id": 1,
                    "additional_description": "test",
                    "unit_id": 2,
                    "quantity": 1,
                    "mrp": null,
                    "with_tax": true,
                    "rpu_with_gst": 118,
                    "rpu_without_gst": 100,
                    "discount_type": 1,
                    "discount_value": null,
                    "discount_type_2": 1,
                    "discount_value_2": null,
                    "total_discount_amount": 0,
                    "gst_id": 2,
                    "gst_tax_percentage": 18,
                    "total": 100,
                    "classification_igst_tax": 18,
                    "classification_cgst_tax": 0,
                    "classification_sgst_tax": 0,
                    "classification_cess_tax": 0,
                    "classification_is_rcm_applicable": 0,
                    "classification_nature_type": 4,
                    "consolidating_items_to_invoice": "0",
                    "cess_rate": 0,
                    "cess_amount": 0,
                    "taxable_amount": null,
                    "created_at": "2025-01-28T10:19:38.000000Z",
                    "updated_at": "2025-01-28T10:19:38.000000Z"
                }
            ],
            "via_api": false,
            "is_import": false,
            "created_by": 1,
            "created_at": "2025-01-28T10:19:38.000000Z",
            "updated_at": "2025-01-28T10:19:38.000000Z"
        },
        "transaction_id": 1,
        "e_invoice_is_create": false
    },
    "success": true,
    "message": "Sale Return Transaction Updated Successfully"
}
Modified at 2025-04-03 10:04:44
Previous
Edit Sale Return
Next
Duplicate Sale Return
Built with