# Goods Receipt Note

## Fetch Goods Receipt Notes(GRN)

<mark style="color:blue;">`GET`</mark> `/wms/goods-receipt-note`

Use this api to get the details of a single or multiple GRNs like items received, quantity and price etc against the purchase order(This is not mandatory, sometimes we receive inventory without purchase order and that is called Blind Receiving).&#x20;

**Note:** In order to reduce the amount of data returned, Either time range on **created date, modified date,** **delivery date** or **receiving number** is mandatory is mandatory when invoking this API.

#### Query Parameters

| Name                  | Type   | Description                                                                                                                                                                                                                                                            |
| --------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| po\_number            | String | Purchase order number against which GRN(s) received.                                                                                                                                                                                                                   |
| receiving\_number     | String | Receiving number of the GRN                                                                                                                                                                                                                                            |
| description           | String | Full or partial description text of matching purchase order                                                                                                                                                                                                            |
| site                  | String | Site id which received the inventory for the GRN                                                                                                                                                                                                                       |
| site\_name            | String | Site name which received the inventory for the GRN                                                                                                                                                                                                                     |
| status                | String | <p>Status of the GRN. </p><p>Ex:New, In-Progress, Completed, Expired </p>                                                                                                                                                                                              |
| delivery\_date\_start | String | <p>Delivery date start which is inclusive to filter the result based on.</p><p><strong>Note:</strong> This works only if both <strong>delivery\_date\_start</strong> and <strong>delivery\_date\_end</strong> are provided. </p><p><strong>Ex:</strong> 2022-01-01</p> |
| delivery\_date\_end   | String | <p>Delivery date end which is inclusive to filter the result based on.</p><p><strong>Note:</strong> This works only if both <strong>delivery\_date\_start</strong> and <strong>delivery\_date\_end</strong> are provided.</p><p><strong>Ex:</strong> 2022-01-01</p>    |
| invoice\_number       | String | Invoice number for the GRN.                                                                                                                                                                                                                                            |

#### Headers

| Name                                       | Type   | Description                              |
| ------------------------------------------ | ------ | ---------------------------------------- |
| API\_KEY<mark style="color:red;">\*</mark> | string | API key obtained by the Customer/Partner |

{% tabs %}
{% tab title="200 Successful Result" %}

```json
{
    "count": 1,
    "previous": null,
    "next": 0,
    "result": [
        {
            "id": 1,
            "sku_lines": [
                {
                    "id": 9,
                    "sku": "Sample 123456",
                    "pack_config": {
                        "id": 4,
                        "tracking_level": "Each",
                        "created_date": "2021-07-30T17:53:01.396745+05:30",
                        "modified_date": "2021-07-30T17:53:01.397988+05:30",
                        "name": "Box of 25",
                        "each_volume": 1,
                        "each_weight": 250,
                        "tag_volume": 1,
                        "use_each_volume": true,
                        "use_tag_volume": false,
                        "uom": null,
                        "created_by": 108434,
                        "modified_by": 108434,
                        "each_dimension": null,
                        "customer": 40082
                    },
                    "created_date": "2022-05-26T12:47:45.228470+05:30",
                    "modified_date": "2022-05-26T12:47:45.228611+05:30",
                    "status": "New",
                    "qty": 77.0,
                    "qty_received": 6.0,
                    "price_per_qty": 22.0,
                    "item_desc": "Nice quality",
                    "created_by": null,
                    "modified_by": null,
                    "purchase_order": 941,
                    "maximum_retail_price": 25.0,
                    "discount": 3.0,
                    "discount_percentage": 12.0
                }
            ],
            "created_date": "2021-09-18T18:24:56.142039+05:30",
            "modified_date": "2021-09-18T18:24:58.238885+05:30",
            "po_number": "180921125456141585",
            "receiving_number": "RN180921125456590192",
            "invoice_number": null,
            "description": null,
            "delivery_date": "2021-09-18T18:24:56.141581+05:30",
            "expiry_date": null,
            "status": "Completed",
            "total_price": 0,
            "batch": null,
            "serial_number": null,
            "file": "http://localhost/media/uploads/documents/wmss/purchaseorder_1/2021-09-18/1W4MYRU/RN180921125456590192.PDF",
            "created_by": 109050,
            "modified_by": 109050,
            "supplier": 4,
            "site": 7
        }
    ]
}
```

{% endtab %}

{% tab title="401 Unauthorised / Wrong api key" %}

```json
{
  "status": "FAIL",
  "message": "Unauthorized"
}
```

{% endtab %}

{% tab title="500 Unexpected error" %}

```json
{
  "status": "FAIL",
  "message": "Unexpected error"
}
```

{% endtab %}

{% tab title="200: OK No data for the filter criteria" %}

```javascript
{
    "count": 1,
    "previous": null,
    "next": 0,
    "result": []
}
```

{% endtab %}
{% endtabs %}