GST Return status

Headers

Authorization

string

required

Taxpayer access token

x-api-version

string

default:1.0.0

API version

x-api-key

string

required

API key for identification

Path Parameters

year

string

required

Year e.g. 2020

Example:

"{{year}}"

month

string

required

Year e.g. 2020

Example:

"{{month}}"

Query Parameters

reference_id

string

required

required Reference ID

Example:

"{{reference_id}}"

Response

200 - application/json

200 GSTR-1 save processed / 200 GSTR-1 save processed with error / 200 GSTR-1 reset processed / 200 GSTR-3B save processed / 200 GSTR-9 save processed / 200 GSTR-9 save processed with error / RET191350 HSN code is not valid as per AATO / RET191353 The UQC entered is not valid / RET191355 The Quantity entered is not valid / RET191175 Enter GST rate as per the rate list / RET191106 Error in JSON structure / RET191251 RESET is under process / 200 Reset Request Received

code

number

Example:

200

data

object

Show child attributes

data.data

object

Show child attributes

data.data.action

string

Example:

"SAVE"

data.data.error_report

object

Show child attributes

data.data.error_report.at

object[]

Show child attributes

data.data.error_report.at.error_cd

string

Example:

"RET191114"

data.data.error_report.at.error_msg

string

Example:

"Invalid POS"

data.data.error_report.at.itms

object[]

Show child attributes

data.data.error_report.at.itms.ad_amt

number

Example:

100

data.data.error_report.at.itms.csamt

number

Example:

500

data.data.error_report.at.itms.iamt

number

Example:

9400

data.data.error_report.at.itms.rt

number

Example:

5

Example:

[
  {
    "ad_amt": 100,
    "csamt": 500,
    "iamt": 9400,
    "rt": 5
  }
]

data.data.error_report.at.pos

string

Example:

"05"

data.data.error_report.at.sply_ty

string

Example:

"INTER"

Example:

[
  {
    "error_cd": "RET191114",
    "error_msg": "Invalid POS",
    "itms": [
      {
        "ad_amt": 100,
        "csamt": 500,
        "iamt": 9400,
        "rt": 5
      }
    ],
    "pos": "05",
    "sply_ty": "INTER"
  }
]

data.data.error_report.b2b

object[]

Show child attributes

data.data.error_report.b2b.ctin

string

Example:

"05CGDPP1321G1ZV"

data.data.error_report.b2b.error_cd

string

Example:

"RET191114"

data.data.error_report.b2b.error_msg

string

Example:

"Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date."

data.data.error_report.b2b.inv

object[]

Show child attributes

data.data.error_report.b2b.inv.etin

string

Example:

"01AABCE5507R1Z4"

data.data.error_report.b2b.inv.idt

string

Example:

"24-11-2016"

data.data.error_report.b2b.inv.inum

string

Example:

"S008400"

data.data.error_report.b2b.inv.inv_typ

string

Example:

"R"

data.data.error_report.b2b.inv.itms

object[]

Show child attributes

data.data.error_report.b2b.inv.itms.itm_det

object

Show child attributes

data.data.error_report.b2b.inv.itms.itm_det.csamt

number

Example:

500

data.data.error_report.b2b.inv.itms.itm_det.iamt

number

Example:

833.33

data.data.error_report.b2b.inv.itms.itm_det.rt

number

Example:

5

data.data.error_report.b2b.inv.itms.itm_det.txval

number

Example:

10000

data.data.error_report.b2b.inv.itms.num

number

Example:

1

Example:

[
  {
    "itm_det": {
      "csamt": 500,
      "iamt": 833.33,
      "rt": 5,
      "txval": 10000
    },
    "num": 1
  }
]

data.data.error_report.b2b.inv.pos

string

Example:

"06"

data.data.error_report.b2b.inv.rchrg

string

Example:

"N"

data.data.error_report.b2b.inv.val

number

Example:

729248.16

Example:

[
  {
    "etin": "01AABCE5507R1Z4",
    "idt": "24-11-2016",
    "inum": "S008400",
    "inv_typ": "R",
    "itms": [
      {
        "itm_det": {
          "csamt": 500,
          "iamt": 833.33,
          "rt": 5,
          "txval": 10000
        },
        "num": 1
      }
    ],
    "pos": "06",
    "rchrg": "N",
    "val": 729248.16
  }
]

Example:

[
  {
    "ctin": "05CGDPP1321G1ZV",
    "error_cd": "RET191114",
    "error_msg": "Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date.",
    "inv": [
      {
        "etin": "01AABCE5507R1Z4",
        "idt": "24-11-2016",
        "inum": "S008400",
        "inv_typ": "R",
        "itms": [
          {
            "itm_det": {
              "csamt": 500,
              "iamt": 833.33,
              "rt": 5,
              "txval": 10000
            },
            "num": 1
          }
        ],
        "pos": "06",
        "rchrg": "N",
        "val": 729248.16
      }
    ]
  }
]

data.data.error_report.b2cl

object[]

Show child attributes

data.data.error_report.b2cl.error_cd

string

Example:

"RET191114"

data.data.error_report.b2cl.error_msg

string

Example:

"Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date."

data.data.error_report.b2cl.inv

object[]

Show child attributes

data.data.error_report.b2cl.inv.etin

string

Example:

"27AHQPA8875L1ZU"

data.data.error_report.b2cl.inv.idt

string

Example:

"10-01-2016"

data.data.error_report.b2cl.inv.inum

string

Example:

"92661"

data.data.error_report.b2cl.inv.itms

object[]

Show child attributes

data.data.error_report.b2cl.inv.itms.itm_det

object

Show child attributes

data.data.error_report.b2cl.inv.itms.itm_det.csamt

number

Example:

500

data.data.error_report.b2cl.inv.itms.itm_det.iamt

number

Example:

833.33

data.data.error_report.b2cl.inv.itms.itm_det.rt

number

Example:

5

data.data.error_report.b2cl.inv.itms.itm_det.txval

number

Example:

10000

data.data.error_report.b2cl.inv.itms.num

number

Example:

1

Example:

[
  {
    "itm_det": {
      "csamt": 500,
      "iamt": 833.33,
      "rt": 5,
      "txval": 10000
    },
    "num": 1
  }
]

data.data.error_report.b2cl.inv.val

number

Example:

784586.33

Example:

[
  {
    "etin": "27AHQPA8875L1ZU",
    "idt": "10-01-2016",
    "inum": "92661",
    "itms": [
      {
        "itm_det": {
          "csamt": 500,
          "iamt": 833.33,
          "rt": 5,
          "txval": 10000
        },
        "num": 1
      }
    ],
    "val": 784586.33
  }
]

data.data.error_report.b2cl.pos

string

Example:

"05"

Example:

[
  {
    "error_cd": "RET191114",
    "error_msg": "Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date.",
    "inv": [
      {
        "etin": "27AHQPA8875L1ZU",
        "idt": "10-01-2016",
        "inum": "92661",
        "itms": [
          {
            "itm_det": {
              "csamt": 500,
              "iamt": 833.33,
              "rt": 5,
              "txval": 10000
            },
            "num": 1
          }
        ],
        "val": 784586.33
      }
    ],
    "pos": "05"
  }
]

data.data.error_report.b2cs

object[]

Show child attributes

data.data.error_report.b2cs.csamt

number

Example:

10

data.data.error_report.b2cs.error_cd

string

Example:

"RET191114"

data.data.error_report.b2cs.error_msg

string

Example:

"Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date."

data.data.error_report.b2cs.etin

string

Example:

"20ABCDE7588L1ZJ"

data.data.error_report.b2cs.iamt

number

Example:

10

data.data.error_report.b2cs.pos

string

Example:

"05"

data.data.error_report.b2cs.rt

number

Example:

5

data.data.error_report.b2cs.sply_ty

string

Example:

"INTER"

data.data.error_report.b2cs.txval

number

Example:

110

data.data.error_report.b2cs.typ

string

Example:

"E"

Example:

[
  {
    "csamt": 10,
    "error_cd": "RET191114",
    "error_msg": "Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date.",
    "etin": "20ABCDE7588L1ZJ",
    "iamt": 10,
    "pos": "05",
    "rt": 5,
    "sply_ty": "INTER",
    "txval": 110,
    "typ": "E"
  }
]

data.data.error_report.cdnr

object[]

Show child attributes

data.data.error_report.cdnr.ctin

string

Example:

"01AAAAP1208Q1ZS"

data.data.error_report.cdnr.error_cd

string

Example:

"RET191115"

data.data.error_report.cdnr.error_msg

string

Example:

"Date is Invalid. Date of note cannot exceed the current tax period ."

data.data.error_report.cdnr.nt

object[]

Show child attributes

data.data.error_report.cdnr.nt.idt

string

Example:

"23-09-2016"

data.data.error_report.cdnr.nt.inum

string

Example:

"915914"

data.data.error_report.cdnr.nt.itms

object[]

Show child attributes

data.data.error_report.cdnr.nt.itms.itm_det

object

Show child attributes

data.data.error_report.cdnr.nt.itms.itm_det.csamt

number

Example:

789.52

data.data.error_report.cdnr.nt.itms.itm_det.iamt

number

Example:

845.22

data.data.error_report.cdnr.nt.itms.itm_det.rt

number

Example:

10

data.data.error_report.cdnr.nt.itms.itm_det.txval

number

Example:

5225.28

data.data.error_report.cdnr.nt.itms.num

number

Example:

1

Example:

[
  {
    "itm_det": {
      "csamt": 789.52,
      "iamt": 845.22,
      "rt": 10,
      "txval": 5225.28
    },
    "num": 1
  }
]

data.data.error_report.cdnr.nt.nt_dt

string

Example:

"23-09-2016"

data.data.error_report.cdnr.nt.nt_num

string

Example:

"533515"

data.data.error_report.cdnr.nt.ntty

string

Example:

"C"

data.data.error_report.cdnr.nt.p_gst

string

Example:

"N"

data.data.error_report.cdnr.nt.rsn

string

Example:

"Post Sale Discount"

data.data.error_report.cdnr.nt.val

number

Example:

123123

Example:

[
  {
    "idt": "23-09-2016",
    "inum": "915914",
    "itms": [
      {
        "itm_det": {
          "csamt": 789.52,
          "iamt": 845.22,
          "rt": 10,
          "txval": 5225.28
        },
        "num": 1
      }
    ],
    "nt_dt": "23-09-2016",
    "nt_num": "533515",
    "ntty": "C",
    "p_gst": "N",
    "rsn": "Post Sale Discount",
    "val": 123123
  }
]

Example:

[
  {
    "ctin": "01AAAAP1208Q1ZS",
    "error_cd": "RET191115",
    "error_msg": "Date is Invalid. Date of note cannot exceed the current tax period .",
    "nt": [
      {
        "idt": "23-09-2016",
        "inum": "915914",
        "itms": [
          {
            "itm_det": {
              "csamt": 789.52,
              "iamt": 845.22,
              "rt": 10,
              "txval": 5225.28
            },
            "num": 1
          }
        ],
        "nt_dt": "23-09-2016",
        "nt_num": "533515",
        "ntty": "C",
        "p_gst": "N",
        "rsn": "Post Sale Discount",
        "val": 123123
      }
    ]
  }
]

data.data.error_report.cdnur

object[]

Show child attributes

data.data.error_report.cdnur.error_cd

string

Example:

"RET191115"

data.data.error_report.cdnur.error_msg

string

Example:

"Date is Invalid. Date of note cannot exceed the current tax period ."

data.data.error_report.cdnur.idt

string

Example:

"23-09-2016"

data.data.error_report.cdnur.inum

string

Example:

"915914"

data.data.error_report.cdnur.itms

object[]

Show child attributes

data.data.error_report.cdnur.itms.itm_det

object

Show child attributes

data.data.error_report.cdnur.itms.itm_det.csamt

number

Example:

789.52

data.data.error_report.cdnur.itms.itm_det.iamt

number

Example:

845.22

data.data.error_report.cdnur.itms.itm_det.rt

number

Example:

10

data.data.error_report.cdnur.itms.itm_det.txval

number

Example:

5225.28

data.data.error_report.cdnur.itms.num

number

Example:

1

Example:

[
  {
    "itm_det": {
      "csamt": 789.52,
      "iamt": 845.22,
      "rt": 10,
      "txval": 5225.28
    },
    "num": 1
  }
]

data.data.error_report.cdnur.nt_dt

string

Example:

"23-09-2016"

data.data.error_report.cdnur.nt_num

string

Example:

"533515"

data.data.error_report.cdnur.ntty

string

Example:

"C"

data.data.error_report.cdnur.p_gst

string

Example:

"N"

data.data.error_report.cdnur.rsn

string

Example:

"Post Sale Discount"

data.data.error_report.cdnur.typ

string

Example:

"B2CL"

data.data.error_report.cdnur.val

number

Example:

64646

Example:

[
  {
    "error_cd": "RET191115",
    "error_msg": "Date is Invalid. Date of note cannot exceed the current tax period .",
    "idt": "23-09-2016",
    "inum": "915914",
    "itms": [
      {
        "itm_det": {
          "csamt": 789.52,
          "iamt": 845.22,
          "rt": 10,
          "txval": 5225.28
        },
        "num": 1
      }
    ],
    "nt_dt": "23-09-2016",
    "nt_num": "533515",
    "ntty": "C",
    "p_gst": "N",
    "rsn": "Post Sale Discount",
    "typ": "B2CL",
    "val": 64646
  }
]

data.data.error_report.doc_issue

object

Show child attributes

data.data.error_report.doc_issue.doc_det

object[]

Show child attributes

data.data.error_report.doc_issue.doc_det.doc_num

number

Example:

1

data.data.error_report.doc_issue.doc_det.docs

object[]

Show child attributes

data.data.error_report.doc_issue.doc_det.docs.cancel

number

Example:

3

data.data.error_report.doc_issue.doc_det.docs.from

string

Example:

"20"

data.data.error_report.doc_issue.doc_det.docs.net_issue

number

Example:

17

data.data.error_report.doc_issue.doc_det.docs.num

number

Example:

1

data.data.error_report.doc_issue.doc_det.docs.to

string

Example:

"29"

data.data.error_report.doc_issue.doc_det.docs.totnum

number

Example:

20

Example:

[
  {
    "cancel": 3,
    "from": "20",
    "net_issue": 17,
    "num": 1,
    "to": "29",
    "totnum": 20
  }
]

Example:

[
  {
    "doc_num": 1,
    "docs": [
      {
        "cancel": 3,
        "from": "20",
        "net_issue": 17,
        "num": 1,
        "to": "29",
        "totnum": 20
      }
    ]
  }
]

data.data.error_report.doc_issue.error_cd

string

Example:

"ERRORCODE"

data.data.error_report.doc_issue.error_msg

string

Example:

"ERRORMESSAGE"

data.data.error_report.error_cd

string

Example:

"RET191106"

data.data.error_report.error_msg

string

Example:

"Error in Json structure validation."

data.data.error_report.exp

object[]

Show child attributes

data.data.error_report.exp.error_cd

string

Example:

"RET191114"

data.data.error_report.exp.error_msg

string

Example:

"Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date."

data.data.error_report.exp.exp_typ

string

Example:

"WPAY"

data.data.error_report.exp.inv

object[]

Show child attributes

data.data.error_report.exp.inv.idt

string

Example:

"12-02-2016"

data.data.error_report.exp.inv.inum

string

Example:

"81542"

data.data.error_report.exp.inv.itms

object[]

Show child attributes

data.data.error_report.exp.inv.itms.iamt

number

Example:

833.33

data.data.error_report.exp.inv.itms.rt

number

Example:

5

data.data.error_report.exp.inv.itms.txval

number

Example:

10000

Example:

[{ "iamt": 833.33, "rt": 5, "txval": 10000 }]

data.data.error_report.exp.inv.sbdt

string

Example:

"04-10-2016"

data.data.error_report.exp.inv.sbnum

number

Example:

7896542

data.data.error_report.exp.inv.sbpcode

string

Example:

"ASB991"

data.data.error_report.exp.inv.val

number

Example:

995048.36

Example:

[
  {
    "idt": "12-02-2016",
    "inum": "81542",
    "itms": [{ "iamt": 833.33, "rt": 5, "txval": 10000 }],
    "sbdt": "04-10-2016",
    "sbnum": 7896542,
    "sbpcode": "ASB991",
    "val": 995048.36
  }
]

Example:

[
  {
    "error_cd": "RET191114",
    "error_msg": "Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date.",
    "exp_typ": "WPAY",
    "inv": [
      {
        "idt": "12-02-2016",
        "inum": "81542",
        "itms": [{ "iamt": 833.33, "rt": 5, "txval": 10000 }],
        "sbdt": "04-10-2016",
        "sbnum": 7896542,
        "sbpcode": "ASB991",
        "val": 995048.36
      }
    ]
  }
]

data.data.error_report.hsn

object

Option 1 · object
Option 2 · object[]
Option 3 · object[]
Option 4 · object[]

Show child attributes

data.data.error_report.hsn.data

object[]

Show child attributes

data.data.error_report.hsn.data.csamt

number

Example:

500

data.data.error_report.hsn.data.desc

string

Example:

"Goods Description"

data.data.error_report.hsn.data.hsn_sc

string

Example:

"1009"

data.data.error_report.hsn.data.iamt

number

Example:

14.52

data.data.error_report.hsn.data.num

number

Example:

1

data.data.error_report.hsn.data.qty

number

Example:

2.05

data.data.error_report.hsn.data.txval

number

Example:

10.23

data.data.error_report.hsn.data.uqc

string

Example:

"kg"

data.data.error_report.hsn.data.val

number

Example:

995048.36

Example:

[
  {
    "csamt": 500,
    "desc": "Goods Description",
    "hsn_sc": "1009",
    "iamt": 14.52,
    "num": 1,
    "qty": 2.05,
    "txval": 10.23,
    "uqc": "kg",
    "val": 995048.36
  }
]

data.data.error_report.hsn.error_cd

string

Example:

"RET191114"

data.data.error_report.hsn.error_msg

string

Example:

"Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date."

data.data.error_report.nil

object

Show child attributes

data.data.error_report.nil.error_cd

string

Example:

"RET191114"

data.data.error_report.nil.error_msg

string

Example:

"Date is Invalid. Date of invoice cannot exceed the current tax period and be older than 18 months or older than registration date."

data.data.error_report.nil.inv

object[]

Show child attributes

data.data.error_report.nil.inv.expt_amt

number

Example:

123.45

data.data.error_report.nil.inv.ngsup_amt

number

Example:

1258.5

data.data.error_report.nil.inv.nil_amt

number

Example:

1470.85

data.data.error_report.nil.inv.sply_ty

string

Example:

"INTRB2B"

Example:

[
  {
    "expt_amt": 123.45,
    "ngsup_amt": 1258.5,
    "nil_amt": 1470.85,
    "sply_ty": "INTRB2B"
  },
  {
    "expt_amt": 123.45,
    "ngsup_amt": 1258.5,
    "nil_amt": 1470.85,
    "sply_ty": "INTRB2C"
  }
]

data.data.error_report.table17

object

Show child attributes

data.data.error_report.table17.items

object[]

Show child attributes

data.data.error_report.table17.items.camt

number

Example:

48287.66

data.data.error_report.table17.items.csamt

number

Example:

0

data.data.error_report.table17.items.error_cd

string

Example:

"RET91708"

data.data.error_report.table17.items.error_msg

string

Example:

"The reported tax amount differs with the computed value by more than Rs. 10/-. Please report the correct tax amount within the acceptable range to proceed with the record"

data.data.error_report.table17.items.hsn_sc

string

Example:

"997331"

data.data.error_report.table17.items.iamt

number

Example:

0

data.data.error_report.table17.items.isconcesstional

string

Example:

"N"

data.data.error_report.table17.items.rt

number

Example:

18

data.data.error_report.table17.items.samt

number

Example:

48287.66

data.data.error_report.table17.items.txval

number

Example:

536762

Example:

[
  {
    "camt": 48287.66,
    "csamt": 0,
    "error_cd": "RET91708",
    "error_msg": "The reported tax amount differs with the computed value by more than Rs. 10/-. Please report the correct tax amount within the acceptable range to proceed with the record",
    "hsn_sc": "997331",
    "iamt": 0,
    "isconcesstional": "N",
    "rt": 18,
    "samt": 48287.66,
    "txval": 536762
  },
  {
    "camt": 207620.5,
    "csamt": 0,
    "error_cd": "RET91708",
    "error_msg": "The reported tax amount differs with the computed value by more than Rs. 10/-. Please report the correct tax amount within the acceptable range to proceed with the record",
    "hsn_sc": "998232",
    "iamt": 5676040.91,
    "isconcesstional": "N",
    "rt": 18,
    "samt": 207620.5,
    "txval": 33840209.41
  }
]

data.data.error_report.txpd

object[]

Show child attributes

data.data.error_report.txpd.error_cd

string

Example:

"RET191114"

data.data.error_report.txpd.error_msg

string

Example:

"Invalid POS"

data.data.error_report.txpd.itms

object[]

Show child attributes

data.data.error_report.txpd.itms.ad_amt

number

Example:

100

data.data.error_report.txpd.itms.csamt

number

Example:

500

data.data.error_report.txpd.itms.iamt

number

Example:

9400

data.data.error_report.txpd.itms.rt

number

Example:

5

Example:

[
  {
    "ad_amt": 100,
    "csamt": 500,
    "iamt": 9400,
    "rt": 5
  }
]

data.data.error_report.txpd.pos

string

Example:

"05"

data.data.error_report.txpd.sply_ty

string

Example:

"INTER"

Example:

[
  {
    "error_cd": "RET191114",
    "error_msg": "Invalid POS",
    "itms": [
      {
        "ad_amt": 100,
        "csamt": 500,
        "iamt": 9400,
        "rt": 5
      }
    ],
    "pos": "05",
    "sply_ty": "INTER"
  }
]

data.data.form_typ

string

Example:

"R1"

data.data.status_cd

string

Example:

"P"

data.status_cd

string

Example:

"1"

timestamp

number

Example:

1763446641000

transaction_id

string

Example:

"dc8e3fd8-6e7e-49aa-9c79-16b473f05e34"

Analytics

Compliance

Headers

Path Parameters

Query Parameters

Response