IMS Invoice Status Reset#
This API allows clients to reset section wise IMS actions efficiently with given data along with individual session data of supported returns. Make sure you have GST session established before making the call. We will internally manage to get the status of IMS reset and refresh of the session during the fetch of status. That’s the reason this is a long-running task (or an asynchronous call). The response of the request is a reference ID.
Given a reference ID, you could fetch its status using Status API. Once the status is complete. Use Result api. for getting the result.
Note
- Maximum allowed request json size 4MB.
Route
/enriched/gstn/{flynn-version}/ims-invoice-status-reset
- active ‘flynn-version’: v1.0
- method: PUT
URL Parameters#
| Name | Description | Type |
|---|---|---|
| flynn-version | version of the API for example, v1.0 |
string |
Headers#
All headers are mentioned in common GSTN headers.
Request#
Body consists of the payload guided by ‘GST API Documentation’. Please refer the following request body for reference :-
Sample request body
{
"rtin": "20MAYAS0100J1ZX",
"reqtyp": "RESET",
"invdata": {
"b2b": [
{
"stin": "24MAYAS0100J1JD",
"inum": "b1",
"inv_typ": "R",
"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": [
{
"stin": "24MAYAS0100J1JD",
"inum": "dn3",
"oinum": "dn2",
"inv_typ": "R",
"srcform": "R1",
"rtnprd": "012023",
"idt": "24-02-2023",
"oidt": "24-02-2023",
"val": 1000.1,
"pos": "07",
"txval": 1000.1,
"iamt": 20,
"camt": 20,
"samt": 20,
"cess": 0,
"prev_status": "A"
}
],
"b2bdn": [
{
"stin": "24MAYAS0100J1JD",
"nt_num": "dn2",
"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",
"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",
"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",
"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",
"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",
"srcform": "R1",
"idt": "24-02-2023",
"val": 1000,
"pos": "07",
"txval": 1000,
"iamt": 20,
"camt": 20,
"samt": 20,
"cess": 0,
"prev_status": "A"
}
]
}
}
Response#
Status Code: 200#
Successful response will an async task-id.
Using this task-id you will be able to fetch the status of the request.
Sample Response Body
{
"status": "1",
"data": {
"task-id": "2a51e392-529c-4b5a-bfd8-ca14d510a68d"
},
"error": null,
"info": null,
"additionalInfo": null,
"alert": null
}
Since, this is a long-running task. Result of the task is downloaded once the process is completed. To check the process status of the task, call status api. To get the result of the task, call result api.
Result API Response#
Result API response is unique for each API. Successful response will be the same payload as per the ‘GST API Documentation’.
Example
{
"status": "1",
"data": {
"status_cd": "PE",
"transTypCd": "SAV",
"proc_cnt": "10",
"err_cnt": "3",
"err_cd": "",
"err_msg": "",
"error_report": {
"b2b": [
{
"stin": "32TAAOA2947A1Z7",
"error_cd": "IMSSAV0010",
"error_msg": "Either previous action is incorrect/ invoice might have edited by supplier",
"inv": [
{
"rtnprd": "042023",
"inum": "invoice-b2b"
}
]
}
],
"dn": [
{
"stin": "32TAAOA2947A1Z7",
"error_cd": "IMSSAV0010",
"error_msg": "Either previous action is incorrect/ invoice might have edited by supplier",
"inv": [
{
"rtnprd": "042023",
"inum": "invoice-dn"
}
]
}
]
}
},
"error": null,
"info": null,
"additionalInfo": null,
"alert": null
}
Flow for integration#
- To establish GST session, first Request OTP
- Once you get the session request ID, use authentication API to Verify OTP with GSTN
- Now if you have successfully established a session, request to IMS Invoice Status Reset
- You will get async
task-idto track the status of the IMS Invoice Status Reset API. Use the task id to track the status - Once async task status states
completedyou can proceed to download the result - which will yield the final result
Note: We will take care of refreshing the GST session based on Taxpayer’s preferences set on the GSTN portal (ideally, keep it to 30 days).
You can call refresh session API explicitly if you wish to extend the session and use logout api to logout of the GSTN session. If client logs out when task processing is not yet complete it will yield into failure of the download jobs and client won’t get the desired results.