Analytics
GSTR-1 B2B
Copy
curl --request GET \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month} \
--header 'Authorization: <authorization>' \
--header 'x-api-key: <x-api-key>'Copy
{
"code": 200,
"data": {
"data": {
"b2b": [
{
"cfs": "N",
"ctin": "07ABCCD6123D1YZ",
"inv": [
{
"cflag": "N",
"chksum": "4b571a762c1c17818ff448fef1d690c95931868b72299f0671936720ba427fcd",
"flag": "U",
"idt": "29-12-2023",
"inum": "78618",
"inv_typ": "R",
"irn": "qoycq59t30429eb5dfa38d3b6efa65346dcff127abf439c76e3afd8fo3vtf9rn",
"irngendate": "03-01-2024",
"itms": [
{
"itm_det": {
"camt": 0,
"csamt": 0,
"iamt": 719.82,
"rt": 18,
"samt": 0,
"txval": 3999
},
"num": 1
}
],
"pos": "07",
"rchrg": "N",
"srctyp": "e-Invoice",
"updby": "S",
"val": 4718.82
}
]
}
]
},
"status_cd": "1"
},
"timestamp": 1763446641000,
"transaction_id": "25411a6e-3fa0-4e49-b5d6-d27efc595237"
}GSTR-1 Documents
GSTR-1 B2B
Get all B2B invoices for a return period for authenticated taxpayer
GET
/
gst
/
compliance
/
tax-payer
/
gstrs
/
gstr-1
/
b2b
/
{year}
/
{month}
GSTR-1 B2B
Copy
curl --request GET \
--url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-1/b2b/{year}/{month} \
--header 'Authorization: <authorization>' \
--header 'x-api-key: <x-api-key>'Copy
{
"code": 200,
"data": {
"data": {
"b2b": [
{
"cfs": "N",
"ctin": "07ABCCD6123D1YZ",
"inv": [
{
"cflag": "N",
"chksum": "4b571a762c1c17818ff448fef1d690c95931868b72299f0671936720ba427fcd",
"flag": "U",
"idt": "29-12-2023",
"inum": "78618",
"inv_typ": "R",
"irn": "qoycq59t30429eb5dfa38d3b6efa65346dcff127abf439c76e3afd8fo3vtf9rn",
"irngendate": "03-01-2024",
"itms": [
{
"itm_det": {
"camt": 0,
"csamt": 0,
"iamt": 719.82,
"rt": 18,
"samt": 0,
"txval": 3999
},
"num": 1
}
],
"pos": "07",
"rchrg": "N",
"srctyp": "e-Invoice",
"updby": "S",
"val": 4718.82
}
]
}
]
},
"status_cd": "1"
},
"timestamp": 1763446641000,
"transaction_id": "25411a6e-3fa0-4e49-b5d6-d27efc595237"
}Headers
Taxpayer access token
API key for identification
API version
Path Parameters
Year e.g. 2020
Example:
"{{year}}"
Month e.g. 01
Example:
"{{month}}"
Query Parameters
optional Status filter for filtering the invoices. Possible values: Y or N. Status filter for filtering the invoices. Use filter value Y to fetches the invoices where tax payer need to take action. Already accepted or uploaded invoices can be fetched by using filter value N.
Example:
"{{action_required}}"
From Date (DD/MM/YYYY)
Example:
"{{from}}"
optional Counter party GSTIN
Example:
"{{gstin}}"
Response
200 - application/json
200 Success / 200 Filtered by counterparty GSTIN / RET11416 No data found
Example:
200
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
"N"
Example:
"07ABCCD6123D1YZ"
Show child attributes
Show child attributes
Example:
"N"
Example:
"4b571a762c1c17818ff448fef1d690c95931868b72299f0671936720ba427fcd"
Example:
"U"
Example:
"29-12-2023"
Example:
"78618"
Example:
"R"
Example:
"qoycq59t30429eb5dfa38d3b6efa65346dcff127abf439c76e3afd8fo3vtf9rn"
Example:
"03-01-2024"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
0
Example:
0
Example:
719.82
Example:
18
Example:
0
Example:
3999
Example:
1
Example:
[
{
"itm_det": {
"camt": 0,
"csamt": 0,
"iamt": 719.82,
"rt": 18,
"samt": 0,
"txval": 3999
},
"num": 1
}
]Example:
"07"
Example:
"N"
Example:
"E-Invoice"
Example:
"S"
Example:
4718.82
Example:
[
{
"cflag": "N",
"chksum": "4b571a762c1c17818ff448fef1d690c95931868b72299f0671936720ba427fcd",
"flag": "U",
"idt": "29-12-2023",
"inum": "78618",
"inv_typ": "R",
"irn": "qoycq59t30429eb5dfa38d3b6efa65346dcff127abf439c76e3afd8fo3vtf9rn",
"irngendate": "03-01-2024",
"itms": [
{
"itm_det": {
"camt": 0,
"csamt": 0,
"iamt": 719.82,
"rt": 18,
"samt": 0,
"txval": 3999
},
"num": 1
}
],
"pos": "07",
"rchrg": "N",
"srctyp": "e-Invoice",
"updby": "S",
"val": 4718.82
}
]Example:
[
{
"cfs": "N",
"ctin": "07ABCCD6123D1YZ",
"inv": [
{
"cflag": "N",
"chksum": "4b571a762c1c17818ff448fef1d690c95931868b72299f0671936720ba427fcd",
"flag": "U",
"idt": "29-12-2023",
"inum": "78618",
"inv_typ": "R",
"irn": "qoycq59t30429eb5dfa38d3b6efa65346dcff127abf439c76e3afd8fo3vtf9rn",
"irngendate": "03-01-2024",
"itms": [
{
"itm_det": {
"camt": 0,
"csamt": 0,
"iamt": 719.82,
"rt": 18,
"samt": 0,
"txval": 3999
},
"num": 1
}
],
"pos": "07",
"rchrg": "N",
"srctyp": "e-Invoice",
"updby": "S",
"val": 4718.82
}
]
},
{
"cfs": "N",
"ctin": "07ABCPA2123G1YZ",
"inv": [
{
"cflag": "N",
"chksum": "d2cd7bfe59317de95d0877e4277c40f2fcb8b60df6641f18c1761908254e19f3",
"flag": "U",
"idt": "31-12-2023",
"inum": "78765",
"inv_typ": "R",
"irn": "qoycq59t3048fcd0d59cf0eb907b573f32a35d574dd8e00df859078fo3vtf9rn",
"irngendate": "03-01-2024",
"itms": [
{
"itm_det": {
"camt": 0,
"csamt": 0,
"iamt": 242.84,
"rt": 18,
"samt": 0,
"txval": 1349.1
},
"num": 1
}
],
"pos": "07",
"rchrg": "N",
"srctyp": "e-Invoice",
"updby": "S",
"val": 1591.94
}
]
},
{
"cfs": "N",
"ctin": "29ABCCN2123R1YZ",
"inv": [
{
"cflag": "N",
"chksum": "1145dc69e5e5c1ec523c9eaaf1f892cb9f2523affb3d7724adcfd14c2f9e2804",
"flag": "U",
"idt": "05-12-2023",
"inum": "78306",
"inv_typ": "R",
"irn": "qoycq59t3011f5b90098dab3b6f5266d61d034989ab2f446c1f4cf8fo3vtf9rn",
"irngendate": "03-01-2024",
"itms": [
{
"itm_det": {
"camt": 0,
"csamt": 0,
"iamt": 359.82,
"rt": 18,
"samt": 0,
"txval": 1999
},
"num": 1
}
],
"pos": "29",
"rchrg": "N",
"srctyp": "e-Invoice",
"updby": "S",
"val": 2358.82
}
]
},
{
"cfs": "N",
"ctin": "29ABCPM7123J1YZ",
"inv": [
{
"cflag": "N",
"chksum": "8c63db5e463121ea3940920995500f8b68fafae91eb88628d524f72f31828349",
"flag": "U",
"idt": "22-12-2023",
"inum": "78309",
"inv_typ": "R",
"irn": "qoycq59t30f42d280bf0b63e7fd6f897d3eb4e499a47be05499e538fo3vtf9rn",
"irngendate": "03-01-2024",
"itms": [
{
"itm_det": {
"camt": 0,
"csamt": 0,
"iamt": 899.82,
"rt": 18,
"samt": 0,
"txval": 4999
},
"num": 1
}
],
"pos": "29",
"rchrg": "N",
"srctyp": "e-Invoice",
"updby": "S",
"val": 5898.82
}
]
}
]Example:
"1"
Example:
1763446641000
Example:
"8a8a7de9-a3bc-42f2-836d-6ddb854fdc94"
Was this page helpful?
āI