> 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/push/save-gr-details-for-sale-invoices.md).

# Save GR Details for Sale Invoices

Records the **dispatch (GR) details** of one or more **sale invoices** when the goods are handed to a transporter. A GR (goods receipt, also called LR – lorry receipt) is the transporter's consignment note. One request creates one **GR document** in Logic ERP – a numbered list of the invoices sent together – and writes the transport details onto **each invoice**: transporter, GR number and date, vehicle, delivery address, weight, cases, box size, shipping label and tracking link. To change details later, use [Edit GR Details of Sale Invoices](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/sale/push/edit-gr-details-of-sale-invoices.md).

### **Endpoint**

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

The response and the common messages 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).

Field names are matched without regard to upper/lower case; fields not listed below are ignored. Note the spelling `Transpoter_Name`.

### **Request fields**

| Field                                                                                                                                                        | Type   | Required       | Default | Meaning                                                                                                                                                                                         |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | -------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `Doc_Prefix`                                                                                                                                                 | text   | **Yes**        | –       | Prefix of the GR document, for example `"LR"`. Stored in capitals. The document number is the next free number for this prefix in the branch – you cannot choose it.                            |
| `Doc_Date`                                                                                                                                                   | date   | No             | today   | Date of the GR document, `yyyy-MM-dd`. A value that is not a date is replaced by today's date.                                                                                                  |
| `Remarks`                                                                                                                                                    | text   | No             | empty   | Remarks of the GR document.                                                                                                                                                                     |
| `BranchCode`                                                                                                                                                 | number | One of the two | `0`     | The branch of the invoices (`Branch_Code` in [Get Branch Info](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/masters/pull/get-branch-info.md)). |
| `BranchShortName`                                                                                                                                            | text   | One of the two | empty   | The branch short name, used when `BranchCode` is `0`.                                                                                                                                           |
| `ListBills`                                                                                                                                                  | list   | **Yes**        | –       | The invoices sent with this GR, one entry each. See the table below. Send at least one.                                                                                                         |
| `Ext_Doc_No`, `Doc_Remarks_1`, `Doc_Remarks_2`, `Pickup_Date`, `Pickup_Delv_Date`, `Pickup_Stage`, `Estimated_Delv_Days`, `Non_Delv_Reason`, `Non_Delv_Date` | –      | No             | –       | **Ignored** – accepted but not saved (see the known issue below).                                                                                                                               |
| `EditEntry`                                                                                                                                                  | text   | No             | `"0"`   | **Ignored.** To change a saved GR use the edit endpoint.                                                                                                                                        |
| `DisplayError`                                                                                                                                               | text   | No             | `"0"`   | `"1"` = `Message` carries the full technical detail when the save fails.                                                                                                                        |

**`ListBills`**

Identify each invoice in **one** of three ways, tried in this order: `BillSeries` with `BillNumber`, then `NewBillNo`, then `BillNo`.

| Field                                                                                     | Type       | Required              | Default                   | Meaning                                                                                                                                                                                        |
| ----------------------------------------------------------------------------------------- | ---------- | --------------------- | ------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `BillSeries`                                                                              | text       | One of the three ways | empty                     | Bill series of the invoice, for example `"ESL"`. Used with `BillNumber`. **Recommended.**                                                                                                      |
| `BillNumber`                                                                              | number     | With `BillSeries`     | `0`                       | Invoice number within the series, for example `346`.                                                                                                                                           |
| `NewBillNo`                                                                               | text       | One of the three ways | empty                     | The printed invoice number, for series that use their own number format (for example `"2627/ESL-346"`).                                                                                        |
| `BillNo`                                                                                  | text       | One of the three ways | empty                     | Series and number joined by a hyphen, for example `"ESL-346"`.                                                                                                                                 |
| `GR_Number_1`                                                                             | text       | No                    | keeps the invoice's value | The GR / LR number given by the transporter.                                                                                                                                                   |
| `GR_Date_1`                                                                               | date       | No                    | keeps the invoice's value | Date of `GR_Number_1`, `yyyy-MM-dd`. Saved only when `GR_Number_1` is also sent.                                                                                                               |
| `GR_Number_2`, `GR_Date_2`                                                                | text, date | No                    | keeps the invoice's value | A second GR number and its date, used the same way.                                                                                                                                            |
| `Transpoter_Name`                                                                         | text       | No                    | keeps the invoice's value | Transporter, exactly as named in Logic ERP's transport list. It must exist. Left empty, the invoice keeps its transporter.                                                                     |
| `Agent_Name`                                                                              | text       | No                    | keeps the invoice's value | Agent (salesman / broker) of the invoice, exactly as named in Logic ERP. It must exist. Left empty, the invoice keeps its agent.                                                               |
| `Vehicle_No`                                                                              | text       | No                    | keeps the invoice's value | Vehicle number. A new value is also added to Logic ERP's list of vehicle numbers.                                                                                                              |
| `Transport_Mode`                                                                          | text       | No                    | keeps the invoice's value | Mode of transport, for example `"ROAD"`. A new value is also added to Logic ERP's list of transport modes.                                                                                     |
| `Weight`, `Cases`, `Pvt_Mark`                                                             | text       | No                    | keep the invoice's value  | Weight, number of cases or packages, and private mark.                                                                                                                                         |
| `Challan_No`, `Challan_Date`                                                              | text, date | No                    | keep the invoice's value  | The transporter's challan number and date. The date is saved only with a number.                                                                                                               |
| `Issue_Time`, `Removal_Time`                                                              | text       | No                    | keep the invoice's value  | Times of issue and of removal of the goods, for example `"06:49 PM"`. A value that is not a time is refused. When the invoice has no issue time yet, the time the invoice was created is used. |
| `Delivery_At`, `Delivery_Add1`, `Delivery_Add2`                                           | text       | No                    | keep the invoice's value  | Delivery place and address lines.                                                                                                                                                              |
| `Doc_Remarks`                                                                             | text       | No                    | empty                     | Remark for this invoice inside the GR document.                                                                                                                                                |
| `Packing_Box_Length`, `Packing_Box_Width`, `Packing_Box_Height`, `Packing_Box_Net_Weight` | number     | No                    | keep the invoice's value  | Box size and net weight. Saved only when above `0`.                                                                                                                                            |
| `ShippingLabel`, `TrackingUrl`                                                            | text       | No                    | keep the invoice's value  | Shipping label reference and the tracking link.                                                                                                                                                |
| `BillDate`, `Remarks1`, `Remarks2`, `Remarks3`, `Way_Bill_No`, `GRN_Prefix`, `GRN_Number` | –          | No                    | –                         | **Ignored.** The way bill number is assigned by Logic ERP (see the rules).                                                                                                                     |

### **Rules Logic ERP applies**

* **Which invoices.** Every invoice must belong to the branch and to the **current financial year** – the year containing today's date on the server, whatever `Doc_Date` says. If any invoice is not found, nothing is saved.
* **One GR per invoice.** An invoice already listed in another GR document cannot be added again; nothing is saved and the message lists those invoices. To change its details, use [Edit GR Details of Sale Invoices](https://kb.logicerp.com/logic-erp-learning-hub-tutorials-and-best-practices/api-documentation/sale/push/edit-gr-details-of-sale-invoices.md).
* **What is saved.** A GR document is created with `Doc_Prefix`, the next number, `Doc_Date`, `Remarks` and the list of invoices. On each invoice the transport details are written. A field you leave empty keeps the value the invoice already has.
* **Agent.** The agent you send becomes the agent of the invoice and of its accounting entries. Without `Agent_Name` the invoice keeps its agent.
* **Way bill.** When a transporter is given and Logic ERP holds pre-loaded way bill (air waybill) numbers for that transporter in the branch, the next unused one is linked to the invoice and marked as used.
* **GR number 2 by configuration.** If your Logic ERP team has set the GR screen to copy the GR document number into the second GR number, a number is filled in for invoices where you leave `GR_Number_2` empty. It is built from the GR screen's default prefix and its next number, so it may not match the `Doc_Prefix` and number of the GR document you created; send `GR_Number_2` yourself if it must match.
* **All or nothing.** The GR document and all invoice updates are saved together; if one invoice fails, nothing is saved.
* Each invoice gets an audit-trail entry.

> **Known issue – extra GR document fields are not saved.** `Ext_Doc_No`, `Doc_Remarks_1`, `Doc_Remarks_2` and the pickup and non-delivery fields are accepted but not stored. In particular a GR saved here cannot later be found by `Ext_Doc_No`; use the GR prefix and number returned in `LastSavedDocNo`.

> **Known issue – failure after saving.** When automatic export of stock-transfer documents is switched on for your company, Logic ERP runs it after the GR is saved. If that step fails, the answer is `Status: false` although the GR document **was saved**. Do not simply resend: a resend fails with *… Bills belongs to another Document…*. Check the invoices in Logic ERP first.

### **Example request**

```json
{
  "Doc_Prefix": "LR",
  "Doc_Date": "2026-10-28",
  "Remarks": "Dispatch to Ludhiana",
  "BranchCode": 2,
  "ListBills": [
    {
      "BillSeries": "ESL",
      "BillNumber": 346,
      "GR_Number_1": "LDH45821",
      "GR_Date_1": "2026-10-28",
      "Transpoter_Name": "SHREE GANESH ROADLINES",
      "Agent_Name": "AMIT KUMAR",
      "Vehicle_No": "PB10AB1234",
      "Transport_Mode": "ROAD",
      "Cases": "3",
      "Weight": "42 KG",
      "Issue_Time": "06:45 PM",
      "Delivery_At": "LUDHIANA",
      "Delivery_Add1": "SHOP 12, GHUMAR MANDI",
      "Packing_Box_Length": 60,
      "Packing_Box_Width": 40,
      "Packing_Box_Height": 40,
      "Packing_Box_Net_Weight": 42,
      "TrackingUrl": "https://track.example.in/LDH45821"
    }
  ]
}
```

### **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**. This really saves in the sandbox, so use test values like the example. The example's invoice already belongs to a GR document, so sending it unchanged is refused; save a new test invoice first and put its number in the request.

## Save GR Details for Sale Invoices

> Records the dispatch (GR) details of one or more sale invoices when the goods are handed to a transporter. A GR (goods receipt, also called LR – lorry receipt) is the transporter's consignment note. One request creates one GR document in Logic ERP – a numbered list of the invoices sent together – and writes the transport details onto each invoice: transporter, GR number and date, vehicle, delivery address, weight, cases, box size, shipping label and tracking link. To change details later, use Edit GR Details of Sale Invoices.

```json
{"openapi":"3.0.3","info":{"title":"Logic ERP API","version":"1.0"},"tags":[{"name":"Sale - Push"}],"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":{"/SaveGREntryAgainstSale":{"post":{"tags":["Sale - Push"],"operationId":"SaveGREntryAgainstSale","summary":"Save GR Details for Sale Invoices","description":"Records the dispatch (GR) details of one or more sale invoices when the goods are handed to a transporter. A GR (goods receipt, also called LR – lorry receipt) is the transporter's consignment note. One request creates one GR document in Logic ERP – a numbered list of the invoices sent together – and writes the transport details onto each invoice: transporter, GR number and date, vehicle, delivery address, weight, cases, box size, shipping label and tracking link. To change details later, use Edit GR Details of Sale Invoices.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"Doc_Prefix":{"type":"string","description":"Prefix of the GR document, for example `\"LR\"`. Stored in capitals. The document number is the next free number for this prefix in the branch – you cannot choose it."},"Doc_Date":{"type":"string","description":"Date of the GR document, `yyyy-MM-dd`. A value that is not a date is replaced by today's date."},"Remarks":{"type":"string","description":"Remarks of the GR document."},"BranchCode":{"type":"integer","description":"The branch of the invoices (`Branch_Code` in Get Branch Info)."},"ListBills":{"type":"array","items":{"type":"object","properties":{"BillSeries":{"type":"string","description":"Bill series of the invoice, for example `\"ESL\"`. Used with `BillNumber`. Recommended."},"BillNumber":{"type":"integer","description":"Invoice number within the series, for example `346`."},"GR_Number_1":{"type":"string","description":"The GR / LR number given by the transporter."},"GR_Date_1":{"type":"string","description":"Date of `GR_Number_1`, `yyyy-MM-dd`. Saved only when `GR_Number_1` is also sent."},"Transport_Mode":{"type":"string","description":"Mode of transport, for example `\"ROAD\"`. A new value is also added to Logic ERP's list of transport modes."},"Cases":{"type":"string","description":"Weight, number of cases or packages, and private mark."}}},"description":"The invoices sent with this GR, one entry each. See the table below. Send at least one."}}}}}},"responses":{"200":{"description":"Always HTTP 200. Check Status and Message.","content":{"application/json":{"schema":{"type":"object","properties":{"LastSavedDocNo":{"type":"string","description":"The GR document number: prefix and number joined by a hyphen, for example `\"LR-8\"`."},"Status":{"type":"boolean","description":"`true` when the GR document was saved."},"Message":{"type":"string","description":"`\"Success\"` when saved; otherwise the reason."},"LastSavedCode":{"type":"integer","description":"Logic ERP's internal number of the GR document."},"request_ID":{"type":"string","description":"The ID of this request – quote it to support."}}}}}},"401":{"description":"No login was sent."}}}}}}
```

### **Response**

| Field            | Type         | Meaning                                                                             |
| ---------------- | ------------ | ----------------------------------------------------------------------------------- |
| `Status`         | true / false | `true` when the GR document was saved.                                              |
| `Message`        | text         | `"Success"` when saved; otherwise the reason.                                       |
| `LastSavedCode`  | number       | Logic ERP's internal number of the GR document.                                     |
| `LastSavedDocNo` | text         | The GR document number: prefix and number joined by a hyphen, for example `"LR-8"`. |
| `request_ID`     | text         | The ID of this request – quote it to support.                                       |

### **Example response**

```json
{
  "LastSavedDocNo": "LR-8",
  "Status": true,
  "Message": "Success",
  "LastSavedCode": 214,
  "request_ID": "3f9a1c62-7d4e-4b28-a5c0-1e8b6d2f9a47"
}
```

### **Messages you may see**

| Message                                                   | Meaning                                                                                                                                              | What to do                                                |
| --------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- |
| `Invalid Doc_Prefix....`                                  | `Doc_Prefix` is empty.                                                                                                                               | Send a prefix.                                            |
| `Unable to Retrive Bill No.…-… BranchCode : …`            | An invoice was not found in the branch and the current financial year (the message shows `BillSeries`-`BillNumber`, even when you used another way). | Check the series, number and branch.                      |
| `Unable to found Transpoter Name : …`                     | No transporter with that name.                                                                                                                       | Use the name exactly as in Logic ERP.                     |
| `Unable to found Agent : …`                               | No agent with that name.                                                                                                                             | Use the name exactly as in Logic ERP.                     |
| `… Bills belongs to another Document. Cannot Retrived...` | The listed invoices are already in another GR document.                                                                                              | Use the edit endpoint for them, or leave them out.        |
| `An item with the same key has already been added.`       | The same invoice appears twice in `ListBills`.                                                                                                       | List each invoice once.                                   |
| `Invalid Issue_Time : …`, `Invalid Removal_Time : …`      | `Issue_Time` or `Removal_Time` is not a time.                                                                                                        | Send a time such as `"06:49 PM"`, or leave the field out. |
| `Branch_Short_Name : … not exists.`                       | `BranchShortName` does not exist.                                                                                                                    | Check the short name.                                     |


---

# 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/push/save-gr-details-for-sale-invoices.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.
