curl --request POST \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/{year}/{month} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"fp": "112023",
"gt": 3782969.01,
"cur_gt": 3782969.01,
"b2b": [
{
"ctin": "01AABCE2207R1Z5",
"inv": [
{
"inum": "S008400",
"idt": "24-12-2023",
"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
}
}
]
}
]
}
],
"b2ba": [
{
"ctin": "01AABCE2207R1Z5",
"inv": [
{
"oinum": "S008400",
"oidt": "24-12-2023",
"inum": "S008400",
"idt": "24-12-2023",
"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,
"camt": 0,
"samt": 0,
"csamt": 500
}
}
]
}
]
}
],
"b2cl": [
{
"pos": "05",
"inv": [
{
"inum": "92661",
"idt": "10-12-2023",
"val": 784586.33,
"etin": "27AHQPA8875L1CU",
"diff_percent": 0.65,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 5,
"txval": 10000,
"iamt": 325,
"csamt": 500
}
}
]
}
]
}
],
"b2cla": [
{
"pos": "06",
"inv": [
{
"oinum": "9266",
"oidt": "10-02-2023",
"diff_percent": 0.65,
"inum": "92661",
"idt": "10-12-2023",
"val": 784586.33,
"etin": "01AABCE5507R1C4",
"itms": [
{
"num": 1,
"itm_det": {
"rt": 5,
"txval": 10000,
"iamt": 833.33
}
}
]
}
]
}
],
"cdnr": [
{
"ctin": "01AAAAP1208Q1ZS",
"nt": [
{
"ntty": "C",
"nt_num": "533515",
"nt_dt": "23-12-2023",
"pos": "03",
"rchrg": "Y",
"inv_typ": "DE",
"val": 123123,
"diff_percent": 0.65,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 10,
"txval": 5225.28,
"iamt": 339.64,
"csamt": 789.52
}
}
]
}
]
}
],
"cdnra": [
{
"ctin": "01AAAAP1208Q1ZS",
"nt": [
{
"ntty": "C",
"ont_num": "533515",
"ont_dt": "23-09-2023",
"nt_num": "533515",
"nt_dt": "23-12-2023",
"diff_percent": 0.65,
"inv_typ": "DE",
"pos": "03",
"rchrg": "Y",
"val": 123123,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 10,
"txval": 5225.28,
"iamt": 845.22,
"camt": 0,
"samt": 0,
"csamt": 789.52
}
}
]
}
]
}
],
"b2cs": [
{
"sply_ty": "INTER",
"diff_percent": 0.65,
"rt": 5,
"typ": "E",
"etin": "01AABCE5507R1C4",
"pos": "05",
"txval": 110,
"iamt": 10,
"csamt": 10
},
{
"rt": 5,
"sply_ty": "INTER",
"diff_percent": 0.65,
"typ": "OE",
"txval": 100,
"iamt": 10,
"csamt": 10,
"pos": "05"
}
],
"b2csa": [
{
"omon": "122023",
"sply_ty": "INTER",
"diff_percent": 0.65,
"typ": "E",
"etin": "01AABCE5507R1C4",
"pos": "05",
"itms": [
{
"rt": 5,
"txval": 110,
"iamt": 10,
"camt": 0,
"samt": 0,
"csamt": 10
},
{
"rt": 12,
"txval": 110,
"iamt": 10,
"camt": 0,
"samt": 0,
"csamt": 10
}
]
}
],
"exp": [
{
"exp_typ": "WPAY",
"inv": [
{
"inum": "81542",
"idt": "12-02-2023",
"val": 995048.36,
"sbpcode": "ASB991",
"sbnum": "7896542",
"sbdt": "04-10-2023",
"itms": [
{
"txval": 10000,
"rt": 5,
"iamt": 833.33,
"csamt": 100
}
]
}
]
},
{
"exp_typ": "WOPAY",
"inv": [
{
"inum": "81542",
"idt": "12-02-2023",
"val": 995048.36,
"sbpcode": "ASB981",
"sbnum": "7896542",
"sbdt": "04-10-2023",
"itms": [
{
"txval": 10000,
"rt": 0,
"iamt": 0,
"csamt": 100
}
]
}
]
}
],
"expa": [
{
"exp_typ": "WPAY",
"inv": [
{
"oinum": "81542",
"oidt": "12-02-2023",
"inum": "81542",
"idt": "12-12-2023",
"val": 995048.36,
"sbpcode": "ASB995",
"sbnum": "1234567",
"sbdt": "04-10-2023",
"itms": [
{
"txval": 10000,
"rt": 5,
"iamt": 833.33,
"csamt": 100
}
]
}
]
}
],
"hsn": {
"data": [
{
"num": 1,
"hsn_sc": "1010",
"desc": "Goods Description",
"uqc": "kg",
"qty": 2.05,
"txval": 10.23,
"iamt": 14.52,
"csamt": 500,
"rt": 0.1
}
]
},
"nil": {
"inv": [
{
"sply_ty": "INTRB2B",
"expt_amt": 123.45,
"nil_amt": 1470.85,
"ngsup_amt": 1258.5
},
{
"sply_ty": "INTRB2C",
"expt_amt": 123.45,
"nil_amt": 1470.85,
"ngsup_amt": 1258.5
}
]
},
"txpd": [
{
"pos": "05",
"sply_ty": "INTER",
"diff_percent": 0.65,
"itms": [
{
"rt": 5,
"ad_amt": 100,
"iamt": 9400,
"csamt": 500
}
]
}
],
"txpda": [
{
"omon": "122023",
"pos": "05",
"sply_ty": "INTER",
"diff_percent": 0.65,
"itms": [
{
"rt": 5,
"ad_amt": 100,
"iamt": 9400,
"csamt": 500
}
]
}
],
"at": [
{
"pos": "05",
"sply_ty": "INTER",
"diff_percent": 0.65,
"itms": [
{
"rt": 5,
"ad_amt": 100,
"iamt": 9400,
"csamt": 500
}
]
}
],
"ata": [
{
"omon": "022017",
"pos": "05",
"sply_ty": "INTER",
"diff_percent": 0.65,
"itms": [
{
"rt": 5,
"ad_amt": 100,
"iamt": 9400,
"csamt": 500
}
]
}
],
"doc_issue": {
"doc_det": [
{
"doc_num": 1,
"docs": [
{
"num": 1,
"from": "20",
"to": "29",
"totnum": 20,
"cancel": 3,
"net_issue": 17
}
]
}
]
},
"cdnur": [
{
"typ": "B2CL",
"ntty": "C",
"nt_num": "533515",
"nt_dt": "23-12-2023",
"pos": "03",
"val": 64646,
"diff_percent": 0.65,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 10,
"txval": 5225.28,
"iamt": 339.64,
"csamt": 789.52
}
}
]
}
],
"cdnura": [
{
"ont_num": "533515",
"ont_dt": "23-09-2023",
"nt_num": "533515",
"nt_dt": "23-12-2023",
"ntty": "C",
"typ": "B2CL",
"pos": "03",
"val": 123123,
"diff_percent": 0.65,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 10,
"txval": 5225.28,
"iamt": 845.22,
"csamt": 789.52
}
}
]
}
]
}
'{
"code": 200,
"data": {
"status_cd": "1",
"data": {
"reference_id": "dfb8f5a1-04c3-4f95-bb60-e13ce9b7221c"
}
},
"timestamp": 1763446641000,
"transaction_id": "02b23947-f428-4deb-844d-c4e8456bb04d"
}Save GSTR-1
Authenticated tax payer can save entire GSTR-1 invoices by uploading json to GST portal
POST
/
gst
/
compliance
/
tax-payer
/
gstrs
/
gstr-1
/
{year}
/
{month}
curl --request POST \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/{year}/{month} \
--header 'Content-Type: application/json' \
--header 'authorization: <authorization>' \
--header 'x-api-key: <x-api-key>' \
--data '
{
"fp": "112023",
"gt": 3782969.01,
"cur_gt": 3782969.01,
"b2b": [
{
"ctin": "01AABCE2207R1Z5",
"inv": [
{
"inum": "S008400",
"idt": "24-12-2023",
"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
}
}
]
}
]
}
],
"b2ba": [
{
"ctin": "01AABCE2207R1Z5",
"inv": [
{
"oinum": "S008400",
"oidt": "24-12-2023",
"inum": "S008400",
"idt": "24-12-2023",
"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,
"camt": 0,
"samt": 0,
"csamt": 500
}
}
]
}
]
}
],
"b2cl": [
{
"pos": "05",
"inv": [
{
"inum": "92661",
"idt": "10-12-2023",
"val": 784586.33,
"etin": "27AHQPA8875L1CU",
"diff_percent": 0.65,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 5,
"txval": 10000,
"iamt": 325,
"csamt": 500
}
}
]
}
]
}
],
"b2cla": [
{
"pos": "06",
"inv": [
{
"oinum": "9266",
"oidt": "10-02-2023",
"diff_percent": 0.65,
"inum": "92661",
"idt": "10-12-2023",
"val": 784586.33,
"etin": "01AABCE5507R1C4",
"itms": [
{
"num": 1,
"itm_det": {
"rt": 5,
"txval": 10000,
"iamt": 833.33
}
}
]
}
]
}
],
"cdnr": [
{
"ctin": "01AAAAP1208Q1ZS",
"nt": [
{
"ntty": "C",
"nt_num": "533515",
"nt_dt": "23-12-2023",
"pos": "03",
"rchrg": "Y",
"inv_typ": "DE",
"val": 123123,
"diff_percent": 0.65,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 10,
"txval": 5225.28,
"iamt": 339.64,
"csamt": 789.52
}
}
]
}
]
}
],
"cdnra": [
{
"ctin": "01AAAAP1208Q1ZS",
"nt": [
{
"ntty": "C",
"ont_num": "533515",
"ont_dt": "23-09-2023",
"nt_num": "533515",
"nt_dt": "23-12-2023",
"diff_percent": 0.65,
"inv_typ": "DE",
"pos": "03",
"rchrg": "Y",
"val": 123123,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 10,
"txval": 5225.28,
"iamt": 845.22,
"camt": 0,
"samt": 0,
"csamt": 789.52
}
}
]
}
]
}
],
"b2cs": [
{
"sply_ty": "INTER",
"diff_percent": 0.65,
"rt": 5,
"typ": "E",
"etin": "01AABCE5507R1C4",
"pos": "05",
"txval": 110,
"iamt": 10,
"csamt": 10
},
{
"rt": 5,
"sply_ty": "INTER",
"diff_percent": 0.65,
"typ": "OE",
"txval": 100,
"iamt": 10,
"csamt": 10,
"pos": "05"
}
],
"b2csa": [
{
"omon": "122023",
"sply_ty": "INTER",
"diff_percent": 0.65,
"typ": "E",
"etin": "01AABCE5507R1C4",
"pos": "05",
"itms": [
{
"rt": 5,
"txval": 110,
"iamt": 10,
"camt": 0,
"samt": 0,
"csamt": 10
},
{
"rt": 12,
"txval": 110,
"iamt": 10,
"camt": 0,
"samt": 0,
"csamt": 10
}
]
}
],
"exp": [
{
"exp_typ": "WPAY",
"inv": [
{
"inum": "81542",
"idt": "12-02-2023",
"val": 995048.36,
"sbpcode": "ASB991",
"sbnum": "7896542",
"sbdt": "04-10-2023",
"itms": [
{
"txval": 10000,
"rt": 5,
"iamt": 833.33,
"csamt": 100
}
]
}
]
},
{
"exp_typ": "WOPAY",
"inv": [
{
"inum": "81542",
"idt": "12-02-2023",
"val": 995048.36,
"sbpcode": "ASB981",
"sbnum": "7896542",
"sbdt": "04-10-2023",
"itms": [
{
"txval": 10000,
"rt": 0,
"iamt": 0,
"csamt": 100
}
]
}
]
}
],
"expa": [
{
"exp_typ": "WPAY",
"inv": [
{
"oinum": "81542",
"oidt": "12-02-2023",
"inum": "81542",
"idt": "12-12-2023",
"val": 995048.36,
"sbpcode": "ASB995",
"sbnum": "1234567",
"sbdt": "04-10-2023",
"itms": [
{
"txval": 10000,
"rt": 5,
"iamt": 833.33,
"csamt": 100
}
]
}
]
}
],
"hsn": {
"data": [
{
"num": 1,
"hsn_sc": "1010",
"desc": "Goods Description",
"uqc": "kg",
"qty": 2.05,
"txval": 10.23,
"iamt": 14.52,
"csamt": 500,
"rt": 0.1
}
]
},
"nil": {
"inv": [
{
"sply_ty": "INTRB2B",
"expt_amt": 123.45,
"nil_amt": 1470.85,
"ngsup_amt": 1258.5
},
{
"sply_ty": "INTRB2C",
"expt_amt": 123.45,
"nil_amt": 1470.85,
"ngsup_amt": 1258.5
}
]
},
"txpd": [
{
"pos": "05",
"sply_ty": "INTER",
"diff_percent": 0.65,
"itms": [
{
"rt": 5,
"ad_amt": 100,
"iamt": 9400,
"csamt": 500
}
]
}
],
"txpda": [
{
"omon": "122023",
"pos": "05",
"sply_ty": "INTER",
"diff_percent": 0.65,
"itms": [
{
"rt": 5,
"ad_amt": 100,
"iamt": 9400,
"csamt": 500
}
]
}
],
"at": [
{
"pos": "05",
"sply_ty": "INTER",
"diff_percent": 0.65,
"itms": [
{
"rt": 5,
"ad_amt": 100,
"iamt": 9400,
"csamt": 500
}
]
}
],
"ata": [
{
"omon": "022017",
"pos": "05",
"sply_ty": "INTER",
"diff_percent": 0.65,
"itms": [
{
"rt": 5,
"ad_amt": 100,
"iamt": 9400,
"csamt": 500
}
]
}
],
"doc_issue": {
"doc_det": [
{
"doc_num": 1,
"docs": [
{
"num": 1,
"from": "20",
"to": "29",
"totnum": 20,
"cancel": 3,
"net_issue": 17
}
]
}
]
},
"cdnur": [
{
"typ": "B2CL",
"ntty": "C",
"nt_num": "533515",
"nt_dt": "23-12-2023",
"pos": "03",
"val": 64646,
"diff_percent": 0.65,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 10,
"txval": 5225.28,
"iamt": 339.64,
"csamt": 789.52
}
}
]
}
],
"cdnura": [
{
"ont_num": "533515",
"ont_dt": "23-09-2023",
"nt_num": "533515",
"nt_dt": "23-12-2023",
"ntty": "C",
"typ": "B2CL",
"pos": "03",
"val": 123123,
"diff_percent": 0.65,
"itms": [
{
"num": 1,
"itm_det": {
"rt": 10,
"txval": 5225.28,
"iamt": 845.22,
"csamt": 789.52
}
}
]
}
]
}
'{
"code": 200,
"data": {
"status_cd": "1",
"data": {
"reference_id": "dfb8f5a1-04c3-4f95-bb60-e13ce9b7221c"
}
},
"timestamp": 1763446641000,
"transaction_id": "02b23947-f428-4deb-844d-c4e8456bb04d"
}Request body schema
View request body schema
Headers
GST taxpayer access token. For token-generation steps, refer to the Generate Taxpayer Session recipe, then pass the token in the authorization header.
API version
API key for identification
Body
application/json
Sample Payload. Clear to manually input values
The fp value provided in the request.
The gt value provided in the request.
The cur gt value provided in the request.
The b2b value provided in the request.
Show child attributes
Show child attributes
The b2ba value provided in the request.
Show child attributes
Show child attributes
The b2cl value provided in the request.
Show child attributes
Show child attributes
The b2cla value provided in the request.
Show child attributes
Show child attributes
The cdnr value provided in the request.
Show child attributes
Show child attributes
The cdnra value provided in the request.
Show child attributes
Show child attributes
The b2cs value provided in the request.
Show child attributes
Show child attributes
The b2csa value provided in the request.
Show child attributes
Show child attributes
The exp value provided in the request.
Show child attributes
Show child attributes
The expa value provided in the request.
Show child attributes
Show child attributes
The hsn value provided in the request.
Show child attributes
Show child attributes
The nil value provided in the request.
Show child attributes
Show child attributes
The txpd value provided in the request.
Show child attributes
Show child attributes
The txpda value provided in the request.
Show child attributes
Show child attributes
The at value provided in the request.
Show child attributes
Show child attributes
The ata value provided in the request.
Show child attributes
Show child attributes
The doc issue value provided in the request.
Show child attributes
Show child attributes
The cdnur value provided in the request.
Show child attributes
Show child attributes
The cdnura value provided in the request.
Show child attributes
Show child attributes
Response
200 - application/json
200 Success / AUTH117 GSTR-1 is already filed
- Option 1
- Option 2
A GSTN success or GSTN business-failure response. Both variants use HTTP 200.
The HTTP status code reported in the response body.
Available options:
200 Example:
200
The response timestamp in Unix epoch milliseconds.
Example:
1763446641000
The transaction identifier used to trace the request.
Example:
"41bb8041-fb83-4654-8d75-85a19f329158"
The GSTN success wrapper.
Show child attributes
Show child attributes