Save IMS Action

Route

/basic/gstn/{flynn-version}/taxpayerapi/{gstn-api-version}/returns/ims/SAVE

• active ‘flynn-version’: v1.0
• method: PUT

Headers

All required headers to make an authenticated API call.

Request

Body consists of the payload guided by ‘GST API Documentation’.

Please refer the following request body for reference-

Sample request body

{
  "rtin": "24SHUBH3221U1Z1",
  "reqtyp": "SAVE",
  "invdata": {
    "b2b": [
      {
        "stin": "24MAYAS0100J1JD",
        "inum": "b1",
        "inv_typ": "R",
        "action": "A",
        "srcform": "R1",
        "rtnprd": "012023",
        "idt": "23-01-2023",
        "val": 1000,
        "pos": "24",
        "txval": 100,
        "iamt": 20,
        "camt": 20,
        "samt": 20,
        "cess": 0,
        "prev_status": "A"
      }
    ],
    "b2ba": [
      {
        "oinum": "ab2",
        "oidt": "24-02-2023",
        "stin": "24MAYAS0100J1JD",
        "rtnprd": "012023",
        "inum": "b1a",
        "action": "A",
        "inv_typ": "R",
        "srcform": "R1",
        "idt": "24-02-2023",
        "val": 1000,
        "pos": "07",
        "txval": 100,
        "iamt": 20,
        "camt": 20,
        "samt": 20,
        "cess": 0,
        "prev_status": "A"
      }
    ],
    "b2bdn": [
      {
        "stin": "24MAYAS0100J1JD",
        "nt_num": "dn2",
        "action": "A",
        "inv_typ": "R",
        "srcform": "R1",
        "rtnprd": "012023",
        "nt_dt": "24-02-2023",
        "val": 1000.1,
        "pos": "07",
        "txval": 1000.1,
        "iamt": 20,
        "camt": 20,
        "samt": 20,
        "cess": 0,
        "prev_status": "A"
      }
    ],
    "b2bdna": [
      {
        "stin": "24MAYAS0100J1JD",
        "ont_num": "ca2",
        "ont_dt": "24-02-2023",
        "nt_num": "dn2",
        "action": "A",
        "inv_typ": "R",
        "srcform": "R1",
        "rtnprd": "012023",
        "nt_dt": "24-02-2023",
        "val": 1000.1,
        "pos": "07",
        "txval": 1000.1,
        "iamt": 20,
        "camt": 20,
        "samt": 20,
        "cess": 0,
        "prev_status": "A"
      }
    ],
    "b2bcn": [
      {
        "stin": "24MAYAS0100J1JD",
        "nt_num": "dn2",
        "action": "A",
        "inv_typ": "R",
        "srcform": "R1",
        "rtnprd": "012023",
        "nt_dt": "24-02-2023",
        "val": 1000.1,
        "pos": "07",
        "txval": 1000.1,
        "iamt": 20,
        "camt": 20,
        "samt": 20,
        "cess": 0,
        "prev_status": "A"
      }
    ],
    "b2bcna": [
      {
        "stin": "24MAYAS0100J1JD",
        "ont_num": "ca2",
        "ont_dt": "24-02-2023",
        "nt_num": "dn2",
        "action": "A",
        "inv_typ": "R",
        "srcform": "R1",
        "rtnprd": "012023",
        "nt_dt": "24-02-2023",
        "val": 1000.1,
        "pos": "07",
        "txval": 1000.1,
        "iamt": 20,
        "camt": 20,
        "samt": 20,
        "cess": 0,
        "prev_status": "A"
      }
    ],
    "ecom": [
      {
        "stin": "24MAYAS0100J1JD",
        "rtnprd": "012023",
        "inum": "sd3",
        "action": "A",
        "srcform": "R1",
        "idt": "24-02-2023",
        "val": 1000,
        "pos": "07",
        "txval": 1000,
        "iamt": 20,
        "camt": 20,
        "samt": 20,
        "cess": 0,
        "prev_status": "A"
      }
    ],
    "ecoma": [
      {
        "stin": "24MAYAS0100J1JD",
        "oinum": "get5",
        "oidt": "24-02-2023",
        "rtnprd": "012023",
        "inum": "sd3",
        "action": "A",
        "srcform": "R1",
        "idt": "24-02-2023",
        "val": 1000,
        "pos": "07",
        "txval": 1000,
        "iamt": 20,
        "camt": 20,
        "samt": 20,
        "cess": 0,
        "prev_status": "A"
      }
    ]
  }
}

Response

200

Successful response will be the same payload as per the ‘GST API Documentation’.

Example

{
  "status": "1",
  "data": {
    "reference_id": "0032e479bcb644c"
  },
  "error": null,
  "info": null,
  "additionalInfo": null,
  "alert": null
}

Errors

Invalid GSTIN Format

{
  "status": "0",
  "data": null,
  "error": {
    "message": "err-invalid-gstin-format",
    "type": "ClientRequest",
    "args": {
      "parameter-name": "gstin"
    }
  },
  "info": null,
  "additionalInfo": null,
  "alert": null
} 

Invalid GSTN API Version

{
  "status": "0",
  "data": null,
  "error": {
    "message": "err-invalid-gst-returns-api-version",
    "type": "ClientRequest",
    "args": {
      "version": "v8.0"
    }
  },
  "info": null,
  "additionalInfo": null,
  "alert": null
}   

GSTN Error

{
  "status": "0",
  "data": null,
  "error": {
    "message": "err-gstn-returned-error",
    "type": "Gstn",
    "args": {
      "gstn-err": {
        "status-code": "0",
        "error-code": "RET11402",
        "message": "Unauthorized User"
      }
    }
  },
  "info": null,
  "additionalInfo": null,
  "alert": null
}

Response Status	Description
400	Invalid GSTIN format in the request
400	Invalid GSTN API Version
404	Invalid GSTIN
502	Error at GSTN end

Common Errors

check here for other common errors.