Skip to content

GSTN SAVE Call

URL#

Refer to API Ecosystem and NIC API document to form the correct URL.

The below example is provided for version: v2.2

The HTTP method required is: PUT

The endpoint you shall be accessing is: <base_url>/gus/taxpayerapi/v2.2/returns/gstr1

Headers#

The headers will look somewhat like follows.

Name Value
clientid <your-client-id>
client-secret <your-client-secret>
state-cd <first-two-digits-of-your-gstin>
ip-usr XXX.XXX.XXX.XXX
txn <random-transaction-id>
gstin <your-gstin>
ret_period <return-period>
accept application/json
auth-token <your-authorization-token>
username <your-username>
Content-Type application/json
X-Asp-Auth-Token <your-X-Asp-Auth-Token>
X-Asp-Auth-Signature <your-X-Asp-Auth-Signature>

Note that the details of how to construct the X-Asp-Auth-Token is covered in greater details in Building a Vayana GSP Auth Token

Request Payload#

To Understand how Request and Response payloads should be, refer to GST Developer Portal

The initial payload shall be like follows

{
      "ctin": "counter_Party_Gstin",
      "inv": "invoices"
    }
The values will be like follows
{
      "ctin": "01AABCE2207R1Z5",
      "inv": [
        {
          "inum": "S008400",
          "idt": "24-11-2016",
          "val": 729248.16,
          "pos": "06",
          "rchrg": "N",
          "etin": "01AABCE5507R1C4",
          "inv_typ": "R",
          "diff_percent": 0.65,
          "itms": [
            {
              "num": 1,
              "itm_det": {
                "rt": 5,
                "txval": 10000,
                "iamt": 325,
                "csamt": 500
              }
            }
          ]
        }
      ]
    }

This request has to be dispatched upon which you will get a response from the server that if all is successful will look somewhat like follows

Response payload#

{
  "reference_id": "LAPN24235325555"
}

What you need to save#

We suggest you store these values so that you don’t face any problems in the future. These values are

  • username and/or gstin: This is the username for which the following values have been generated
  • reference_id given you in the response payload