> For the complete documentation index, see [llms.txt](https://kb.logicerp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/sale/pull/get-sale-returns.md).

# Get Sale Returns

Returns your **sale returns** (credit notes for goods your customers sent back) from Logic ERP, each with its header and item lines. Use it to copy new and changed returns into your own system — normally by asking only for returns **added or changed** since your last call — or to fetch particular returns by their internal number.

The response has **exactly the same layout as** [**Get Sale Invoices**](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/sale/pull/get-sale-invoices.md); this page lists only what is different for returns.

### **Endpoint**

| Name          | Detail                                         |
| ------------- | ---------------------------------------------- |
| Address       | `https://your-server/api/GetSaleReturnInvoice` |
| Method        | `POST`                                         |
| Authorization | Basic Auth                                     |

The response and the common request fields are explained in [How Every API Call Works](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/how-every-api-call-works.md).

### **Request fields**

| Field                                                                  | Type   | Required | Default      | Meaning                                                                                                                                                                                                                                                                                    |
| ---------------------------------------------------------------------- | ------ | -------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `GlobalModifyCode`                                                     | number | No       | `0`          | Your bookmark in the change log, as described in How Every API Call Works: `0` = from the start (or a period, with `DateFrom`/`DateTo`), a number = only changes after it, `-1` = Logic ERP keeps the bookmark for you.                                                                    |
| `DateFrom`, `DateTo`                                                   | date   | No       | empty        | With `GlobalModifyCode` `0`: a period of **changes** (the date a return was saved or edited). Send both as `null` when you are not asking for a period. With `Doc_Codes` or a lookup it also decides the **financial year** searched, as on Get Sale Invoices. Write them as `yyyy-MM-dd`. |
| `Doc_Codes`                                                            | text   | No       | empty        | Logic ERP's internal return numbers (`Vouch_Code`), separated by commas, for example `"2210,2214"`. Returns exactly these returns; the bookmark and period are ignored. Numbers and commas only.                                                                                           |
| `Branch_Codes_From`                                                    | text   | No       | empty        | Branch codes separated by commas, for example `"2,5"`. Only returns of these branches are returned. Numbers and commas only.                                                                                                                                                               |
| `Doc_Num_Like`                                                         | text   | No       | empty        | Only returns whose internal voucher number starts with this text: `SR` followed by the return prefix, for example `"SRESR"`. Used with the bookmark or a period.                                                                                                                           |
| `PartyUserCode`, `ApprovalFilter`                                      | text   | No       | empty, `"0"` | Narrow the result as on Get Sale Invoices.                                                                                                                                                                                                                                                 |
| `SaleBillNo`, `SaleOrderNo`, `PartyOrderNo`, `Mobile_No`, `Challan_No` | text   | No       | empty        | Lookups, as on Get Sale Invoices, matched against sale returns. See the rules.                                                                                                                                                                                                             |

Field names are matched without regard to upper or lower case. Other fields in the request are ignored.

### **Rules Logic ERP applies**

The rules of [Get Sale Invoices](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/sale/pull/get-sale-invoices.md) apply, with these differences:

* **Only sale returns** are returned – every document saved as a sale return, whether or not it is marked as a stock transfer.
* **Shared change log.** Sale invoices, sale returns and stock transfers out share one change log of up to **200 lines per batch**. A batch can hold no returns: you then get `"No Record Found."` with `Status: true` and a higher `LastGlobalModifyCode` – store it and call again. You have caught up when the message is `"No Pending Sale Return found..."` and `LastGlobalModifyCode` is the value you sent. Keep this endpoint's bookmark separate from the bookmark you use for Get Sale Invoices.
* **Lookups.** `SaleBillNo`, `SaleOrderNo`, `PartyOrderNo`, `Mobile_No` and `Challan_No` work as on Get Sale Invoices, matched against sale returns: the change log is not used, the matching returns of the financial year are returned whether or not they changed recently, and `LastGlobalModifyCode` comes back as `0`. `SaleBillNo` takes the return's own number as shown in `New_Bill_No`.
* With `SaleBillNo`, `Mobile_No` or `Challan_No`, `DateFrom` and `DateTo` filter on the return date, as on Get Sale Invoices. Otherwise they never filter on the return date: they are only a period of changes, or – with `Doc_Codes` or a lookup – choose the financial year.
* Returns use the **same API site settings as Get Sale Invoices**: the branches, invoice series and field choice your Logic ERP team set for sale invoices also limit this endpoint.
* **Combined item lines (setting).** Your Logic ERP team can set sale returns to be sent **combined**: lines with the same item code and lot MRP are merged into one line whose `Quantity` is the total. A combined line carries only `LogicUser_Code`, `AddlItemCode`, `Quantity`, `Rate`, `Lot_MRP`, `PackName`, `HSN_Code`, the `Item_…` rates and the `Lot_…` rates (sale, purchase, basic, special); every other line field is `0`, empty or an empty list. When this setting is off – the usual case – every line is returned as saved.

The known issue on Get Sale Invoices about `Discount_Coupon_Amt` applies here too.

### **Example request**

Next batch after your stored bookmark:

```json
{
  "GlobalModifyCode": 18812,
  "DateFrom": null,
  "DateTo": null,
  "Doc_Codes": "",
  "Branch_Codes_From": ""
}
```

Two returns by their internal numbers:

```json
{
  "GlobalModifyCode": 0,
  "DateFrom": null,
  "DateTo": null,
  "Doc_Codes": "2210,2214"
}
```

### **Test it**

Send a request to the Logic ERP **sandbox** (a test company) from this page: open the block below, enter the sandbox user name and password (ask your Logic ERP support team), change the request if you like, and press **Test it**. The example asks for the first batch of the change log. Do not send `"GlobalModifyCode": -1` here – it changes what the sandbox has marked as already sent.

## Get Sale Returns

> Returns your sale returns (credit notes for goods your customers sent back) from Logic ERP, each with its header and item lines. Use it to copy new and changed returns into your own system — normally by asking only for returns added or changed since your last call — or to fetch particular returns by their internal number.

```json
{"openapi":"3.0.3","info":{"title":"Logic ERP API","version":"1.0"},"tags":[{"name":"Sale - Pull"}],"servers":[{"url":"https://demo.logicerp.com/api","description":"Logic ERP sandbox (test company)"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"The user name and password of your API site."}}},"paths":{"/GetSaleReturnInvoice":{"post":{"tags":["Sale - Pull"],"operationId":"GetSaleReturnInvoice","summary":"Get Sale Returns","description":"Returns your sale returns (credit notes for goods your customers sent back) from Logic ERP, each with its header and item lines. Use it to copy new and changed returns into your own system — normally by asking only for returns added or changed since your last call — or to fetch particular returns by their internal number.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"GlobalModifyCode":{"type":"integer","description":"Your bookmark in the change log, as described in How Every API Call Works: `0` = from the start (or a period, with `DateFrom`/`DateTo`), a number = only changes after it, `-1` = Logic ERP keeps the bookmark for you."},"DateFrom":{"type":"string","nullable":true,"description":"With `GlobalModifyCode` `0`: a period of changes (the date a return was saved or edited). Send both as `null` when you are not asking for a period. With `Doc_Codes` or a lookup it also decides the financial year searched, as on Get Sale Invoices. Write them as `yyyy-MM-dd`."},"DateTo":{"type":"string","nullable":true,"description":"With `GlobalModifyCode` `0`: a period of changes (the date a return was saved or edited). Send both as `null` when you are not asking for a period. With `Doc_Codes` or a lookup it also decides the financial year searched, as on Get Sale Invoices. Write them as `yyyy-MM-dd`."},"Doc_Codes":{"type":"string","description":"Logic ERP's internal return numbers (`Vouch_Code`), separated by commas, for example `\"2210,2214\"`. Returns exactly these returns; the bookmark and period are ignored. Numbers and commas only."},"Branch_Codes_From":{"type":"string","description":"Branch codes separated by commas, for example `\"2,5\"`. Only returns of these branches are returned. Numbers and commas only."},"Doc_Num_Like":{"type":"string","description":"Only returns whose internal voucher number starts with this text: `SR` followed by the return prefix, for example `\"SRESR\"`. Used with the bookmark or a period."},"PartyUserCode":{"type":"string","description":"Narrow the result as on Get Sale Invoices."},"ApprovalFilter":{"type":"string","description":"Narrow the result as on Get Sale Invoices."},"SaleBillNo":{"type":"string","description":"Lookups, as on Get Sale Invoices, matched against sale returns. See the rules."},"SaleOrderNo":{"type":"string","description":"Lookups, as on Get Sale Invoices, matched against sale returns. See the rules."},"PartyOrderNo":{"type":"string","description":"Lookups, as on Get Sale Invoices, matched against sale returns. See the rules."},"Mobile_No":{"type":"string","description":"Lookups, as on Get Sale Invoices, matched against sale returns. See the rules."},"Challan_No":{"type":"string","description":"Lookups, as on Get Sale Invoices, matched against sale returns. See the rules."}}}}}},"responses":{"200":{"description":"Always HTTP 200. Check Status, Message and GetData.","content":{"application/json":{"schema":{"type":"object","properties":{"GetData":{"type":"array","items":{"type":"object","properties":{"Vouch_Code":{"type":"integer","description":"Logic ERP's internal invoice number, unique within a financial year. Use it in `Doc_Codes`."},"Bill_No":{"type":"string","description":"The return's prefix and number, for example `ESR-2` and `2627/2/ESR-2`."},"New_Bill_No":{"type":"string","description":"The return's prefix and number, for example `ESR-2` and `2627/2/ESR-2`."},"Bill_Date":{"type":"string","description":"Invoice date, `dd/MM/yyyy`."},"Bill_Time":{"type":"string","description":"Date and time the invoice was saved, `dd/MM/yyyy hh:mm AM/PM`."},"Account_Code":{"type":"string","description":"The party (or cash account) the goods came back from."},"Account_Entry_Customer":{"type":"string","description":"Name of the party whose ledger the invoice amount is posted to, when it differs from the account (for example a marketplace); `(NIL)` when none."},"Account_Entry_User_Code":{"type":"string","description":"Code of that party; `0` when none."},"Account_Name":{"type":"string","description":"The party (or cash account) the goods came back from."},"Customer_Code":{"type":"string","description":"The party (or cash account) the goods came back from."},"Customer_Name":{"type":"string","description":"Name of the invoice's customer party."},"Agent_Name":{"type":"string","description":"The invoice's agent or salesman, or `NIL`."},"Quantity":{"type":"number","description":"Totals of the return, as positive amounts."},"Gross_Amount":{"type":"number","description":"Totals of the return, as positive amounts."},"Net_Amount":{"type":"number","description":"Totals of the return, as positive amounts."},"Total_Tax":{"type":"string","description":"Totals of the return, as positive amounts."},"Branch_Name":{"type":"string","description":"Name of the invoice's branch."},"Branch_Code":{"type":"integer","description":"Code of the invoice's branch."},"Currency_Name":{"type":"string","description":"Currency, for example `INR`."},"Tax_Region_Name":{"type":"string","description":"The invoice's tax region, for example `CGST/SGST` or `IGST (INCL)`."},"Action_Code":{"type":"string","description":"The latest change: `N` = added, `M` = modified, `D` = deleted."},"Type":{"type":"string","description":"`SR`."},"Branch_Short_Name":{"type":"string","description":"Short name of the invoice's branch."},"Doc_Prefix":{"type":"string","description":"The return's prefix and number, for example `ESR-2` and `2627/2/ESR-2`."},"Doc_Number":{"type":"integer","description":"The return's prefix and number, for example `ESR-2` and `2627/2/ESR-2`."},"RCU_Membership_Series":{"type":"string","description":"Membership series and number of the retail customer on the invoice; empty and `0` when none."},"RCU_Membership_Number":{"type":"integer","description":"Membership series and number of the retail customer on the invoice; empty and `0` when none."},"Retail_Cust_Name":{"type":"string","description":"Retail customer's first, middle and last name, separated by spaces."},"Retail_Cust_Mobile_No":{"type":"string","description":"Retail customer's mobile number."},"Retail_Cust_Email_ID":{"type":"string","description":"Retail customer's e-mail address."},"SO_Order_No":{"type":"string","description":"Number and date of the sale order the invoice lines were made against (when lines come from different orders, the last line's order); empty when none."},"SO_Order_Date":{"type":"string","description":"Number and date of the sale order the invoice lines were made against (when lines come from different orders, the last line's order); empty when none."},"SO_Party_Order_No":{"type":"string","description":"The party's own order number and date on that sale order."},"SO_Party_Order_Date":{"type":"string","description":"The party's own order number and date on that sale order."},"Credit_Note_Bill_Amount":{"type":"number","description":"The return's total (the same as `Net_Amount`): the credit note it creates."},"Gr_Number":{"type":"string","description":"Transport GR / LR number and date."},"Gr_Date":{"type":"string","description":"Transport GR / LR number and date."},"Order_No":{"type":"string","description":"Order number and date typed in the invoice's other details."},"Order_Date":{"type":"string","description":"Order number and date typed in the invoice's other details."},"Remarks1":{"type":"string","description":"Remarks typed on the invoice."},"Cases":{"type":"string","description":"Number of cases or packages."},"Transport_Mode":{"type":"string","description":"Mode of transport, as typed."},"DNParty_Name":{"type":"string","description":"Accounts used for the debit note, credit note, display, handling and postage amounts of the invoice, or `(NIL)`."},"CNParty_Name":{"type":"string","description":"Accounts used for the debit note, credit note, display, handling and postage amounts of the invoice, or `(NIL)`."},"DISPParty_Name":{"type":"string","description":"Accounts used for the debit note, credit note, display, handling and postage amounts of the invoice, or `(NIL)`."},"HANDParty_Name":{"type":"string","description":"Accounts used for the debit note, credit note, display, handling and postage amounts of the invoice, or `(NIL)`."},"POSTParty_Name":{"type":"string","description":"Accounts used for the debit note, credit note, display, handling and postage amounts of the invoice, or `(NIL)`."},"DN_Desc":{"type":"string","description":"Descriptions typed for the debit note, credit note and display amounts."},"CN_Desc":{"type":"string","description":"Descriptions typed for the debit note, credit note and display amounts."},"Display_Desc":{"type":"string","description":"Descriptions typed for the debit note, credit note and display amounts."},"Challan_Date":{"type":"string","description":"Challan reference typed in the invoice's other details."},"Challan_no":{"type":"string","description":"Challan reference typed in the invoice's other details."},"DD_Chq":{"type":"string","description":"Demand draft / cheque indicator as stored, usually `\"0\"` or empty."},"DD_Chq_No":{"type":"string","description":"Demand draft or cheque number and amount."},"DD_Chq_Amt":{"type":"number","description":"Demand draft or cheque number and amount."},"GR_Number_2":{"type":"string","description":"A second GR / LR number and date."},"GR_Date_2":{"type":"string","description":"A second GR / LR number and date."},"Issue_Time":{"type":"string","description":"Time of issue and time of removal of goods, `dd/MM/yyyy hh:mm AM/PM`; empty when not filled."},"Removal_Time":{"type":"string","description":"Time of issue and time of removal of goods, `dd/MM/yyyy hh:mm AM/PM`; empty when not filled."},"Trans_Name":{"type":"string","description":"Transporter, or `(NIL)`."},"Remarks2":{"type":"string","description":"Remarks typed on the invoice."},"Remarks3":{"type":"string","description":"Remarks typed on the invoice."},"Credit_Note_Amount":{"type":"number","description":"Normally `0` (it is the credit notes adjusted against an invoice)."},"ST_Branch_Code":{"type":"integer","description":"`0` for a sale invoice (used by stock transfers)."},"RCU_Create_Date":{"type":"string","description":"When the retail customer was created, `dd/MM/yyyy`."},"RCU_State":{"type":"string","description":"State and country of the retail customer's city, or `(NIL)`."},"RCU_Country":{"type":"string","description":"State and country of the retail customer's city, or `(NIL)`."},"RCU_CountryCode":{"type":"string","description":"Code of that country, if one is kept."},"Credit_Amount":{"type":"number","description":"How the return was settled; without a payment split the whole `Net_Amount` is shown as `Cash_Amount` (cash return) or `Credit_Amount` (credit return)."},"Cash_Amount":{"type":"number","description":"How the return was settled; without a payment split the whole `Net_Amount` is shown as `Cash_Amount` (cash return) or `Credit_Amount` (credit return)."},"Gift_Voucher_Amount":{"type":"number","description":"How the return was settled; without a payment split the whole `Net_Amount` is shown as `Cash_Amount` (cash return) or `Credit_Amount` (credit return)."},"Discount_Coupon_No":{"type":"string","description":"Number of the discount coupon linked to the invoice; empty when none."},"Discount_Coupon_Amt":{"type":"number","description":"See the known issue."},"Bill_Cancelled":{"type":"boolean","description":"`true` when the invoice has been cancelled."},"GST_EInvoice_IRN_No":{"type":"string","description":"GST e-invoice IRN; empty when none."},"GST_EInvoice_QR_Image":{"type":"string","description":"The signed QR code data of the e-invoice; empty when none."},"GST_EInvoice_Acknowledgement_No":{"type":"string","description":"E-invoice acknowledgement number."},"GST_EInvoice_Acknowledgement_Date":{"type":"string","nullable":true,"description":"E-invoice acknowledgement date, `dd/MM/yyyy`; `null` when none."},"GST_EWay_Bill_No":{"type":"string","nullable":true,"description":"E-way bill number and date; `null` (or an empty number) when there is no e-way bill."},"GST_EWay_Bill_Date":{"type":"string","nullable":true,"description":"E-way bill number and date; `null` (or an empty number) when there is no e-way bill."},"InvoicePDFLink":{"type":"string","nullable":true,"description":"A link to the invoice PDF on the Aaptak e-bill service, when the invoice was sent there; otherwise `null`."},"TCS_Act_Name":{"type":"string","description":"TCS account, rate and amount collected on the invoice; empty / `0` when none."},"TCS_Percent":{"type":"number","description":"TCS account, rate and amount collected on the invoice; empty / `0` when none."},"TCS_Amount":{"type":"number","description":"TCS account, rate and amount collected on the invoice; empty / `0` when none."},"CC_Plus_CE_Name":{"type":"string","description":"Cost centre, cost element and their combined name on the invoice, or `(NIL)`."},"Cost_Center_Name":{"type":"string","description":"Cost centre, cost element and their combined name on the invoice, or `(NIL)`."},"Cost_Element_Name":{"type":"string","description":"Cost centre, cost element and their combined name on the invoice, or `(NIL)`."},"Credit_Card_Amount":{"type":"number","description":"How the return was settled; without a payment split the whole `Net_Amount` is shown as `Cash_Amount` (cash return) or `Credit_Amount` (credit return)."},"Discount_Amount":{"type":"number","description":"Total discount of the invoice in ₹, as a positive amount: the sum over all lines of `CD`, `TD`, `SP_CD`, `Scheme_Unit`, `Scheme_Rs`, `AdjustItem`, `AdjustPerUnit`, `SPDiscount` and `AdjustmentRupees` where they are negative."},"ItemCount":{"type":"integer","description":"Number of different item codes on the invoice."},"Patient_Name":{"type":"string","description":"Patient details (pharmacy). Filled only when your Logic ERP team has chosen these fields for the response; otherwise empty."},"Patient_Mobile_No":{"type":"string","description":"Patient details (pharmacy). Filled only when your Logic ERP team has chosen these fields for the response; otherwise empty."},"Shipping_Addres":{"type":"object","properties":{"Code":{"type":"integer","description":"Logic ERP's internal address number; `0` when there is no address."},"Cust_Code":{"type":"integer","description":"Internal number of the customer the address belongs to; `0` when not linked."},"Contact_Person_Name":{"type":"string","description":"Contact person."},"Phone_Number":{"type":"string","description":"Phone, mobile and e-mail at the address."},"Address_1":{"type":"string","description":"Address lines."},"Address_2":{"type":"string","description":"Address lines."},"Driving_Directions":{"type":"string","description":"Directions."},"City_Name":{"type":"string","description":"City, state, country and PIN code."},"Code_Type":{"type":"string","description":"Kind of address, as stored."},"Country_Name":{"type":"string","description":"City, state, country and PIN code."},"Email_Id":{"type":"string","description":"Phone, mobile and e-mail at the address."},"Location_Code":{"type":"integer","description":"Location, when used."},"Mobile_No":{"type":"string","description":"Phone, mobile and e-mail at the address."},"Pin_Code":{"type":"string","description":"City, state, country and PIN code."},"State_Name":{"type":"string","description":"City, state, country and PIN code."},"Company_Name":{"type":"string","description":"Company name at the address."},"Latitude":{"type":"string","description":"Map position, when kept."},"Longitude":{"type":"string","description":"Map position, when kept."},"Address_ID":{"type":"string","nullable":true,"description":"Logic ERP's address ID and the ID your system gave the address, if any."},"Complete_Address":{"type":"string","description":"The full address in one text, when kept."},"External_Address_Id":{"type":"string","description":"Logic ERP's address ID and the ID your system gave the address, if any."},"Location_Name":{"type":"string","nullable":true,"description":"Location, when used."},"State_Code":{"type":"integer","description":"Internal number of the state."},"Country_Code":{"type":"integer","description":"Always `0`."},"DisplayAddress":{"type":"string","description":"Mobile number and contact person joined with `-`."},"DeleteAddress":{"type":"boolean","description":"Always `false` here – ignore."},"SameAsShippingAddress":{"type":"boolean","description":"Always `false` here – ignore."},"Gst_No":{"type":"string","nullable":true,"description":"GSTIN at the address."}},"description":"The delivery address on the invoice (the name is spelt this way). See below."},"Billing_Address":{"type":"object","properties":{"Code":{"type":"integer","description":"Logic ERP's internal address number; `0` when there is no address."},"Cust_Code":{"type":"integer","description":"Internal number of the customer the address belongs to; `0` when not linked."},"Contact_Person_Name":{"type":"string","description":"Contact person."},"Phone_Number":{"type":"string","description":"Phone, mobile and e-mail at the address."},"Address_1":{"type":"string","description":"Address lines."},"Address_2":{"type":"string","description":"Address lines."},"Driving_Directions":{"type":"string","description":"Directions."},"City_Name":{"type":"string","description":"City, state, country and PIN code."},"Code_Type":{"type":"string","description":"Kind of address, as stored."},"Country_Name":{"type":"string","description":"City, state, country and PIN code."},"Email_Id":{"type":"string","description":"Phone, mobile and e-mail at the address."},"Location_Code":{"type":"integer","description":"Location, when used."},"Mobile_No":{"type":"string","description":"Phone, mobile and e-mail at the address."},"Pin_Code":{"type":"string","description":"City, state, country and PIN code."},"State_Name":{"type":"string","description":"City, state, country and PIN code."},"Company_Name":{"type":"string","description":"Company name at the address."},"Latitude":{"type":"string","description":"Map position, when kept."},"Longitude":{"type":"string","description":"Map position, when kept."},"Address_ID":{"type":"string","nullable":true,"description":"Logic ERP's address ID and the ID your system gave the address, if any."},"Complete_Address":{"type":"string","description":"The full address in one text, when kept."},"External_Address_Id":{"type":"string","description":"Logic ERP's address ID and the ID your system gave the address, if any."},"Location_Name":{"type":"string","nullable":true,"description":"Location, when used."},"State_Code":{"type":"integer","description":"Internal number of the state."},"Country_Code":{"type":"integer","description":"Always `0`."},"DisplayAddress":{"type":"string","description":"Mobile number and contact person joined with `-`."},"DeleteAddress":{"type":"boolean","description":"Always `false` here – ignore."},"SameAsShippingAddress":{"type":"boolean","description":"Always `false` here – ignore."},"Gst_No":{"type":"string","nullable":true,"description":"GSTIN at the address."}},"description":"The billing address on the invoice. See below."},"ListCreditCard":{"type":"array","items":{"type":"object"},"description":"Card payments by card type. See below."},"LstItems":{"type":"array","items":{"type":"object","properties":{"SL_Txn_Code":{"type":"integer","description":"Logic ERP's internal line number."},"Lot_Code":{"type":"integer","description":"Internal number of the lot (batch) sold."},"Lot_Number":{"type":"string","description":"Lot number."},"AddlItemCode":{"type":"string","description":"The item's additional code, for example a barcode."},"LogicUser_Code":{"type":"string","description":"Item code as shown in Logic ERP (`UserCode` in Get Item Master)."},"PackName":{"type":"string","description":"Pack (size) of the item."},"ItemName":{"type":"string","description":"Item name."},"ItemHDName":{"type":"string","description":"Item name with its colour, as shown in the item master."},"ItemDescription_1":{"type":"string","description":"Item description."},"ColorName":{"type":"string","description":"Colour, or `(NIL)`."},"CompanyName":{"type":"string","description":"Item's company (brand), or `(NIL)`."},"CF_1":{"type":"number","description":"The item's conversion factors."},"CF_2":{"type":"number","description":"The item's conversion factors."},"CF_3":{"type":"number","description":"The item's conversion factors."},"Weight":{"type":"number","description":"Always `0`."},"Item_Sale_Rate":{"type":"number","description":"MRP, sale rate and purchase rate in the item master today."},"Item_Sp_Rate_1":{"type":"number","description":"Special rates 1–5 in the item master today."},"Item_Sp_Rate_2":{"type":"number","description":"Special rates 1–5 in the item master today."},"Item_Sp_Rate_3":{"type":"number","description":"Special rates 1–5 in the item master today."},"Item_Sp_Rate_4":{"type":"number","description":"Special rates 1–5 in the item master today."},"Item_Sp_Rate_5":{"type":"number","description":"Special rates 1–5 in the item master today."},"Item_Pur_Rate":{"type":"number","description":"MRP, sale rate and purchase rate in the item master today."},"Item_MRP":{"type":"number","description":"MRP, sale rate and purchase rate in the item master today."},"HSN_Code":{"type":"string","description":"HSN code, serial number, description and unit of the item (`(NIL)` / empty when none)."},"Quantity":{"type":"number","description":"Totals of the return, as positive amounts."},"Lot_MRP":{"type":"number","description":"MRP, sale, purchase and basic rate of the lot."},"Rate":{"type":"number","description":"Rate on the line."},"Tax_Amt_1":{"type":"number","description":"Tax amounts of the three slots, in ₹. `Tax_Amt_3` includes `Surcharge`. In the sandbox's GST setup slot 1 holds CGST and slot 3 SGST or IGST; with a tax-inclusive region slot 2 holds the tax included in the rate as a negative amount."},"Tax_Amt_3":{"type":"number","description":"Tax amounts of the three slots, in ₹. `Tax_Amt_3` includes `Surcharge`. In the sandbox's GST setup slot 1 holds CGST and slot 3 SGST or IGST; with a tax-inclusive region slot 2 holds the tax included in the rate as a negative amount."},"MRP_SaleBill":{"type":"number","description":"MRP used on the line."},"Gross_Amt":{"type":"number","description":"Quantity × rate, in ₹."},"Net_Amt":{"type":"number","description":"Line total, in ₹."},"Round_Amt":{"type":"number","description":"Rounding on the line."},"Net_Rate":{"type":"number","description":"Net rate per unit."},"Sale_Amt":{"type":"number","description":"Taxable value of the line, in ₹."},"CD":{"type":"number","description":"Cash discount, trade discount and special cash discount amounts in ₹; a discount is a negative amount."},"TD":{"type":"number","description":"Cash discount, trade discount and special cash discount amounts in ₹; a discount is a negative amount."},"SP_CD":{"type":"number","description":"Cash discount, trade discount and special cash discount amounts in ₹; a discount is a negative amount."},"Scheme_Unit":{"type":"number","description":"Scheme discount per unit and in rupees (negative = discount)."},"Scheme_Rs":{"type":"number","description":"Scheme discount per unit and in rupees (negative = discount)."},"CD_Per":{"type":"number","description":"The percentages of those discounts."},"TD_Per":{"type":"number","description":"The percentages of those discounts."},"SP_CD_Per":{"type":"number","description":"The percentages of those discounts."},"Sale_Or_SR":{"type":"string","description":"`SL`."},"Lot_Sale_Rate":{"type":"number","description":"MRP, sale, purchase and basic rate of the lot."},"Lot_Pur_Rate":{"type":"number","description":"MRP, sale, purchase and basic rate of the lot."},"Lot_Basic_Rate":{"type":"number","description":"MRP, sale, purchase and basic rate of the lot."},"Lot_SP_Rate1":{"type":"number","description":"Special rates 1–5 of the lot."},"Lot_SP_Rate2":{"type":"number","description":"Special rates 1–5 of the lot."},"Lot_SP_Rate3":{"type":"number","description":"Special rates 1–5 of the lot."},"Lot_SP_Rate4":{"type":"number","description":"Special rates 1–5 of the lot."},"Lot_SP_Rate5":{"type":"number","description":"Special rates 1–5 of the lot."},"SO_Item_Order_ID":{"type":"string","description":"The order-line ID of the sale order line this line was made from; empty when none."},"Tax_Amt_2":{"type":"number","description":"Tax amounts of the three slots, in ₹. `Tax_Amt_3` includes `Surcharge`. In the sandbox's GST setup slot 1 holds CGST and slot 3 SGST or IGST; with a tax-inclusive region slot 2 holds the tax included in the rate as a negative amount."},"Tax3WithoutSur":{"type":"number","description":"Tax of slot 3 without surcharge, and the surcharge."},"Surcharge":{"type":"number","description":"Tax of slot 3 without surcharge, and the surcharge."},"ExciseUnit":{"type":"number","description":"Charges added on the line, in ₹."},"AdjustPerUnit":{"type":"number","description":"Other adjustments and special discount on the line (negative = discount)."},"AdjustItem":{"type":"number","description":"Other adjustments and special discount on the line (negative = discount)."},"Freight":{"type":"number","description":"Charges added on the line, in ₹."},"AdjustmentRupees":{"type":"number","description":"Other adjustments and special discount on the line (negative = discount)."},"SPDiscount":{"type":"number","description":"Other adjustments and special discount on the line (negative = discount)."},"DebitNote":{"type":"number","description":"Charges added on the line, in ₹."},"CreditNote":{"type":"number","description":"Charges added on the line, in ₹."},"Display":{"type":"number","description":"Charges added on the line, in ₹."},"Handling":{"type":"number","description":"Charges added on the line, in ₹."},"Postage":{"type":"number","description":"Charges added on the line, in ₹."},"ExcisePercentage":{"type":"number","description":"Despite its name, an amount: the market-fee charge on the line."},"Labour":{"type":"number","description":"Charges added on the line, in ₹."},"RRate":{"type":"number","description":"A second rate kept on the line; normally the same as `Rate`."},"Tax_1":{"type":"number","description":"Tax rates (%) of the three tax slots of the line, as set by the tax region."},"Tax_2":{"type":"number","description":"Tax rates (%) of the three tax slots of the line, as set by the tax region."},"Tax_3":{"type":"number","description":"Tax rates (%) of the three tax slots of the line, as set by the tax region."},"Agent_Name":{"type":"string","description":"The invoice's agent or salesman, or `NIL`."},"Agent_ShortName":{"type":"string","description":"The line's agent and its short name, or `NIL`."},"Item_Group_Name_1":{"type":"string","description":"Item's group."},"Lot_Sup_Code":{"type":"string","description":"Code and name of the supplier the lot was bought from."},"Lot_Sup_Name":{"type":"string","description":"Code and name of the supplier the lot was bought from."},"Lot_Bill_No":{"type":"string","description":"Purchase bill number and date of the lot."},"Lot_Purchase_Date":{"type":"string","description":"Purchase bill number and date of the lot."},"Lot_Expiry_Date":{"type":"string","description":"Expiry and manufacturing date of the lot; empty when none."},"Lot_Mfg_Date":{"type":"string","description":"Expiry and manufacturing date of the lot; empty when none."},"Scheme_Campaign_Group_Name":{"type":"string","description":"The scheme campaign applied on the line. Filled only when your Logic ERP team has switched on scheme campaigns for this endpoint; otherwise empty."},"Scheme_Campaign_Name":{"type":"string","description":"The scheme campaign applied on the line. Filled only when your Logic ERP team has switched on scheme campaigns for this endpoint; otherwise empty."},"Godown_Name":{"type":"string","description":"Godown the goods were taken from, or `(NIL)`."},"HSN_Serial_No":{"type":"string","description":"HSN code, serial number, description and unit of the item (`(NIL)` / empty when none)."},"HSN_Description":{"type":"string","description":"HSN code, serial number, description and unit of the item (`(NIL)` / empty when none)."},"HSN_UOM":{"type":"string","description":"HSN code, serial number, description and unit of the item (`(NIL)` / empty when none)."},"Packing":{"type":"string","description":"Packing description from the item master."},"Invoice_Prescription_Days":{"type":"string","description":"Prescription days (pharmacy); `\"0\"` unless patient details are chosen for the response."},"ListOtherAgents":{"type":"array","items":{"type":"object"},"description":"Further agents on the line. See below."}}},"description":"The item lines. See below."}}},"nullable":true,"description":"The records found; null when the call failed or nothing was found - read Message."},"Status":{"type":"boolean","description":"See the Status rules on this page and on How Every API Call Works."},"Message":{"type":"string","description":"Why the call failed, or a note. The reason may be followed by technical detail - read the first line."},"LastGlobalModifyCode":{"type":"integer","description":"The change-log bookmark (see How Every API Call Works)."},"resultSize":{"type":"string","description":"Size of the answer, for example \"2 KB\"."}}}}}},"401":{"description":"No login was sent."}}}}}}
```

### **Response fields**

Every field is the same as in the [response of Get Sale Invoices](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/sale/pull/get-sale-invoices.md) (`GetData` items, `Shipping_Addres`, `Billing_Address`, `ListCreditCard`, `LstItems`, `ListOtherAgents`). For a return:

| Field                                                                       | Value for a return                                                                                                                                     |
| --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `Type`                                                                      | `SR`.                                                                                                                                                  |
| `Bill_No`, `Doc_Prefix`, `Doc_Number`, `New_Bill_No`                        | The return's prefix and number, for example `ESR-2` and `2627/2/ESR-2`.                                                                                |
| `Account_Code`, `Account_Name`, `Customer_Code`                             | The party (or cash account) the goods came back from.                                                                                                  |
| `Quantity`, `Gross_Amount`, `Net_Amount`, `Total_Tax`                       | Totals of the return, as **positive** amounts.                                                                                                         |
| `Credit_Note_Bill_Amount`                                                   | The return's total (the same as `Net_Amount`): the credit note it creates.                                                                             |
| `Credit_Note_Amount`                                                        | Normally `0` (it is the credit notes adjusted against an invoice).                                                                                     |
| `Cash_Amount`, `Credit_Amount`, `Credit_Card_Amount`, `Gift_Voucher_Amount` | How the return was settled; without a payment split the whole `Net_Amount` is shown as `Cash_Amount` (cash return) or `Credit_Amount` (credit return). |
| `LstItems[].Sale_Or_SR`                                                     | `SR`.                                                                                                                                                  |
| `LstItems[].Quantity` and amounts                                           | Positive.                                                                                                                                              |

### **Example response**

```json
{
  "GetData": [
    {
      "Vouch_Code": 2210,
      "Bill_No": "ESR-2",
      "New_Bill_No": "2627/2/ESR-2",
      "Bill_Date": "15/04/2026",
      "Bill_Time": "15/04/2026 12:38 PM",
      "Account_Code": "C1045",
      "Account_Entry_Customer": "(NIL)",
      "Account_Entry_User_Code": "0",
      "Account_Name": "SHREE GANESH TEXTILES",
      "Customer_Code": "C1045",
      "Customer_Name": "SHREE GANESH TEXTILES",
      "Agent_Name": "NIL",
      "Quantity": 1.0,
      "Gross_Amount": 1200.0,
      "Net_Amount": 1260.0,
      "Total_Tax": "60",
      "Branch_Name": "LUDHIANA MAIN",
      "Branch_Code": 2,
      "Currency_Name": "INR",
      "Tax_Region_Name": "CGST/SGST",
      "Action_Code": "N",
      "Type": "SR",
      "Branch_Short_Name": "LDH",
      "Doc_Prefix": "ESR",
      "Doc_Number": 2,
      "RCU_Membership_Series": "",
      "RCU_Membership_Number": 0,
      "Retail_Cust_Name": "NIL NIL NIL",
      "Retail_Cust_Mobile_No": "0",
      "Retail_Cust_Email_ID": "",
      "SO_Order_No": "",
      "SO_Order_Date": "",
      "SO_Party_Order_No": "",
      "SO_Party_Order_Date": "",
      "Credit_Note_Bill_Amount": 1260.0,
      "Gr_Number": "",
      "Gr_Date": "",
      "Order_No": "",
      "Order_Date": "",
      "Remarks1": "Damaged in transit",
      "Cases": "",
      "Transport_Mode": "",
      "DNParty_Name": "(NIL)",
      "CNParty_Name": "(NIL)",
      "DISPParty_Name": "(NIL)",
      "HANDParty_Name": "(NIL)",
      "POSTParty_Name": "(NIL)",
      "DN_Desc": "",
      "CN_Desc": "",
      "Display_Desc": "",
      "Challan_Date": "",
      "Challan_no": "",
      "DD_Chq": "0",
      "DD_Chq_No": "",
      "DD_Chq_Amt": 0.0,
      "GR_Number_2": "",
      "GR_Date_2": "",
      "Issue_Time": "",
      "Removal_Time": "",
      "Trans_Name": "(NIL)",
      "Remarks2": "",
      "Remarks3": "",
      "Credit_Note_Amount": 0.0,
      "ST_Branch_Code": 0,
      "RCU_Create_Date": "",
      "RCU_State": "(NIL)",
      "RCU_Country": "(NIL)",
      "RCU_CountryCode": "",
      "Credit_Amount": 1260.0,
      "Cash_Amount": 0.0,
      "Gift_Voucher_Amount": 0.0,
      "Discount_Coupon_No": "",
      "Discount_Coupon_Amt": 0.0,
      "Bill_Cancelled": false,
      "GST_EInvoice_IRN_No": "",
      "GST_EInvoice_QR_Image": "",
      "GST_EInvoice_Acknowledgement_No": "",
      "GST_EInvoice_Acknowledgement_Date": null,
      "GST_EWay_Bill_No": null,
      "GST_EWay_Bill_Date": null,
      "InvoicePDFLink": null,
      "TCS_Act_Name": "",
      "TCS_Percent": 0.0,
      "TCS_Amount": 0.0,
      "CC_Plus_CE_Name": "(NIL)",
      "Cost_Center_Name": "(NIL)",
      "Cost_Element_Name": "(NIL)",
      "Credit_Card_Amount": 0.0,
      "Discount_Amount": 0.0,
      "ItemCount": 1,
      "Patient_Name": "",
      "Patient_Mobile_No": "",
      "Shipping_Addres": {
        "Code": 0, "Cust_Code": 0, "Contact_Person_Name": "", "Phone_Number": "", "Address_1": "", "Address_2": "",
        "Driving_Directions": "", "City_Name": "", "Code_Type": "", "Country_Name": "", "Email_Id": "", "Location_Code": 0,
        "Mobile_No": "", "Pin_Code": "", "State_Name": "", "Company_Name": "", "Latitude": "", "Longitude": "",
        "Address_ID": null, "Complete_Address": "", "External_Address_Id": "", "Location_Name": null, "State_Code": 0,
        "Country_Code": 0, "DisplayAddress": "-", "DeleteAddress": false, "SameAsShippingAddress": false, "Gst_No": null
      },
      "Billing_Address": {
        "Code": 0, "Cust_Code": 0, "Contact_Person_Name": "", "Phone_Number": "", "Address_1": "", "Address_2": "",
        "Driving_Directions": "", "City_Name": "", "Code_Type": "", "Country_Name": "", "Email_Id": "", "Location_Code": 0,
        "Mobile_No": "", "Pin_Code": "", "State_Name": "", "Company_Name": "", "Latitude": "", "Longitude": "",
        "Address_ID": null, "Complete_Address": "", "External_Address_Id": "", "Location_Name": null, "State_Code": 0,
        "Country_Code": 0, "DisplayAddress": "-", "DeleteAddress": false, "SameAsShippingAddress": false, "Gst_No": null
      },
      "ListCreditCard": [],
      "LstItems": [
        {
          "SL_Txn_Code": 4102,
          "Lot_Code": 24120,
          "Lot_Number": "L-2604",
          "AddlItemCode": "8901234567012",
          "LogicUser_Code": "KUR-1001-M",
          "PackName": "M",
          "ItemName": "COTTON KURTA",
          "ItemHDName": "COTTON KURTA BLUE",
          "ItemDescription_1": "Cotton kurta, straight fit",
          "ColorName": "BLUE",
          "CompanyName": "SHREE GANESH",
          "CF_1": 1.0,
          "CF_2": 1.0,
          "CF_3": 1.0,
          "Weight": 0.0,
          "Item_Sale_Rate": 1200.0,
          "Item_Sp_Rate_1": 0.0,
          "Item_Sp_Rate_2": 0.0,
          "Item_Sp_Rate_3": 0.0,
          "Item_Sp_Rate_4": 0.0,
          "Item_Sp_Rate_5": 0.0,
          "Item_Pur_Rate": 750.0,
          "Item_MRP": 1499.0,
          "HSN_Code": "62113990",
          "Quantity": 1.0,
          "Lot_MRP": 1499.0,
          "Rate": 1200.0,
          "Tax_Amt_1": 30.0,
          "Tax_Amt_3": 30.0,
          "MRP_SaleBill": 1499.0,
          "Gross_Amt": 1200.0,
          "Net_Amt": 1260.0,
          "Round_Amt": 0.0,
          "Net_Rate": 1200.0,
          "Sale_Amt": 1200.0,
          "CD": 0.0,
          "TD": 0.0,
          "SP_CD": 0.0,
          "Scheme_Unit": 0.0,
          "Scheme_Rs": 0.0,
          "CD_Per": 0.0,
          "TD_Per": 0.0,
          "SP_CD_Per": 0.0,
          "Sale_Or_SR": "SR",
          "Lot_Sale_Rate": 1200.0,
          "Lot_Pur_Rate": 750.0,
          "Lot_Basic_Rate": 750.0,
          "Lot_SP_Rate1": 0.0,
          "Lot_SP_Rate2": 0.0,
          "Lot_SP_Rate3": 0.0,
          "Lot_SP_Rate4": 0.0,
          "Lot_SP_Rate5": 0.0,
          "SO_Item_Order_ID": "",
          "Tax_Amt_2": 0.0,
          "Tax3WithoutSur": 30.0,
          "Surcharge": 0.0,
          "ExciseUnit": 0.0,
          "AdjustPerUnit": 0.0,
          "AdjustItem": 0.0,
          "Freight": 0.0,
          "AdjustmentRupees": 0.0,
          "SPDiscount": 0.0,
          "DebitNote": 0.0,
          "CreditNote": 0.0,
          "Display": 0.0,
          "Handling": 0.0,
          "Postage": 0.0,
          "ExcisePercentage": 0.0,
          "Labour": 0.0,
          "RRate": 1200.0,
          "Tax_1": 2.5,
          "Tax_2": 0.0,
          "Tax_3": 2.5,
          "Agent_Name": "NIL",
          "Agent_ShortName": "NIL",
          "Item_Group_Name_1": "KURTA",
          "Lot_Sup_Code": "S2001",
          "Lot_Sup_Name": "JAIPUR HANDLOOM HOUSE",
          "Lot_Bill_No": "JHH-118",
          "Lot_Purchase_Date": "02/04/2026",
          "Lot_Expiry_Date": "",
          "Lot_Mfg_Date": "",
          "Scheme_Campaign_Group_Name": "",
          "Scheme_Campaign_Name": "",
          "Godown_Name": "MAIN",
          "HSN_Serial_No": "62113990",
          "HSN_Description": "GARMENTS OF COTTON",
          "HSN_UOM": "PCS-PIECES",
          "Packing": "PCS",
          "Invoice_Prescription_Days": "0",
          "ListOtherAgents": []
        }
      ]
    }
  ],
  "Status": true,
  "Message": "",
  "LastGlobalModifyCode": 18901,
  "resultSize": "5 KB"
}
```

### **Messages you may see**

| Message                                                                                                              | Meaning                                                                                                                                                                                                    | What to do                                                                                            |
| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| *No Pending Sale Return found...* (with `Status: true`)                                                              | Nothing has been added to the change log after your bookmark.                                                                                                                                              | You are up to date. Call again later with the same bookmark.                                          |
| *No Record Found.* (with `Status: true`)                                                                             | No sale return matched: the batch held only invoices, stock transfers or returns outside your filters, nothing in the period was a return, or the numbers you sent are not returns of that financial year. | With a bookmark: store the new `LastGlobalModifyCode` and call again. Otherwise: check what you sent. |
| `Invalid code list: '…'` (with `Status: false`; the text you sent in place of …)                                     | `Branch_Codes_From` contains something other than numbers and commas.                                                                                                                                      | Send branch codes as numbers separated by commas.                                                     |
| `Invalid Challan_No : …` followed by the expected form (with `Status: false`; what you sent in place of …)           | `Challan_No` is not a challan prefix and number joined with `-`, or the part after `-` is not a number.                                                                                                    | Send the challan as prefix-number, for example `"GCH-154"`.                                           |
| `Invalid code in list: '…'. Only numeric codes are allowed.` (with `Status: false`; the part you sent in place of …) | `Doc_Codes` contains something other than numbers and commas.                                                                                                                                              | Send `Doc_Codes` as numbers separated by commas.                                                      |
| `API settings for this route are not configured for the API template.` (with `Status: false`)                        | The settings of Get Sale Invoices, which this endpoint uses, have not been saved for your API site.                                                                                                        | Ask your Logic ERP support team.                                                                      |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/sale/pull/get-sale-returns.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
