GSTR-2A B2B

Get all B2B invoices in GSTR-2A for a return period for authenticated taxpayer

GET /gst/compliance/tax-payer/gstrs/gstr-2a/b2b/{year}/{month}

GSTR-2A B2B

cURL

curl --request GET \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-2a/b2b/{year}/{month} \
  --header 'authorization: <authorization>' \
  --header 'x-api-key: <x-api-key>'

import requests

url = "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-2a/b2b/{year}/{month}"

headers = {
    "authorization": "<authorization>",
    "x-api-key": "<x-api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {authorization: '<authorization>', 'x-api-key': '<x-api-key>'}
};

fetch('https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-2a/b2b/{year}/{month}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-2a/b2b/{year}/{month}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "authorization: <authorization>",
    "x-api-key: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-2a/b2b/{year}/{month}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("authorization", "<authorization>")
	req.Header.Add("x-api-key", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-2a/b2b/{year}/{month}")
  .header("authorization", "<authorization>")
  .header("x-api-key", "<x-api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-2a/b2b/{year}/{month}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["authorization"] = '<authorization>'
request["x-api-key"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

200

200 Success

{
  "code": 200,
  "data": {
    "status_cd": "1",
    "data": {
      "b2b": [
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "24ABCPD9123Q1YZ",
          "fldtr1": "11-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "15479fc2ca8939a16a0ad1714f804e32199489fa2bcc34dbc3693e075ab0a923",
              "idt": "01-12-2023",
              "inum": "23-24/126",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 175.5,
                    "csamt": 0,
                    "iamt": 0,
                    "rt": 18,
                    "samt": 175.5,
                    "txval": 1950
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 2301
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "06ABCCG0123D1YZ",
          "fldtr1": "11-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "ce60dfa45192a4f3a3d1d6c983d700dded0033b2a17600aa1c41cb287a8b1803",
              "idt": "31-12-2023",
              "inum": "4883379355",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "csamt": 0,
                    "iamt": 2197.29,
                    "rt": 18,
                    "txval": 12207.14
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 14404.43
            },
            {
              "chksum": "67d3cec7423b2176bef9962f36667a297a0bd8836fc86bbca2777bd7898d862d",
              "idt": "31-12-2023",
              "inum": "4884148871",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "csamt": 0,
                    "iamt": 24.64,
                    "rt": 18,
                    "txval": 136.9
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 161.54
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "24ABCCB2123P1YZ",
          "fldtr1": "10-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "7851ccb28bef36326547ccd147a1ea0e914dbe085f8eaa0b05486e97d2c1745c",
              "idt": "01-12-2023",
              "inum": "GJI0611330220210",
              "inv_typ": "R",
              "irn": "qoycq59t3004161d2a8006b1cafe7213ccaa4014120722fa5eb2d68854a04af8",
              "irngendate": "02-12-2023",
              "itms": [
                {
                  "itm_det": {
                    "camt": 26.91,
                    "iamt": 0,
                    "rt": 18,
                    "samt": 26.91,
                    "txval": 299
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "val": 352.82
            },
            {
              "chksum": "853539a3357c5c81b129df310ac02e55bc5fd2026f7c179be3f4c2feca677237",
              "idt": "01-12-2023",
              "inum": "GJI0611330353886",
              "inv_typ": "R",
              "irn": "qoycq59t30487cf5110f295d37bdc8e4ce316455a9fc480004671ed20811f35c",
              "irngendate": "01-12-2023",
              "itms": [
                {
                  "itm_det": {
                    "camt": 900,
                    "iamt": 0,
                    "rt": 18,
                    "samt": 900,
                    "txval": 10000
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "val": 11800
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "24ABCPL3123J1YZ",
          "fldtr1": "13-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "639caff03a1810e4d078216813b9f3cc0fad85f65f3eb8ce371494b4ce60c458",
              "idt": "30-10-2023",
              "inum": "76",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 450,
                    "rt": 18,
                    "samt": 450,
                    "txval": 5000
                  },
                  "num": 1800
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 5900
            },
            {
              "chksum": "ae4e297bb07db8ce3d376a60354ead6ac03ca2e12e665a92b7d8752fd8f63c25",
              "idt": "31-10-2023",
              "inum": "77",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 472.5,
                    "rt": 18,
                    "samt": 472.5,
                    "txval": 5250
                  },
                  "num": 1800
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 6195
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "27ABCCU4123C1YZ",
          "fldtr1": "11-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "4a331460e9605b817bfce2a5ad68bce81ff9bef5197bedc22968f73039b9098f",
              "idt": "22-12-2023",
              "inum": "PAN-V/27/424",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "csamt": 0,
                    "iamt": 2160,
                    "rt": 18,
                    "samt": 0,
                    "txval": 12000
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 14160
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "24ABCCB2123G1YZ",
          "fldtr1": "10-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "6491b64316c38b79606b4225f75dd141614a4f44c6449f20db436250aacfd5db",
              "idt": "22-12-2023",
              "inum": "FBBL2424B29715",
              "inv_typ": "R",
              "irn": "qoycq59t303eb4d1cab56c71027d971cbf0eeb1530e14fc31f996cd101d49842",
              "irngendate": "23-12-2023",
              "itms": [
                {
                  "itm_det": {
                    "camt": 2700,
                    "iamt": 0,
                    "rt": 18,
                    "samt": 2700,
                    "txval": 30000
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "val": 35400
            },
            {
              "chksum": "2cd3d2eb24045ede76d4932c7aaede1a11f3ff1a2c9f92e551fef7093009add6",
              "idt": "12-12-2023",
              "inum": "HT2424I001454703",
              "inv_typ": "R",
              "irn": "qoycq59t309f77a9bb8318a7931b1540e8f29052ee672f9525bcb10938d8e3e1",
              "irngendate": "12-12-2023",
              "itms": [
                {
                  "itm_det": {
                    "camt": 359.91,
                    "iamt": 0,
                    "rt": 18,
                    "samt": 359.91,
                    "txval": 3999
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "val": 4718.82
            },
            {
              "chksum": "b024ee4dca59e40216ed28160b90240d73f959ab2f683e5f412c11248befeca6",
              "idt": "18-12-2023",
              "inum": "HT2424I001485717",
              "inv_typ": "R",
              "irn": "qoycq59t30b3ceed1dbc3f1129ada8d1032de76a8e5d9232cc7ae75641369580",
              "irngendate": "18-12-2023",
              "itms": [
                {
                  "itm_det": {
                    "camt": 359.91,
                    "iamt": 0,
                    "rt": 18,
                    "samt": 359.91,
                    "txval": 3999
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "val": 4718.82
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "24ABCPK3123G1YZ",
          "fldtr1": "10-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "6df0d792c4a275b9ae291facbf71dff1c645dc2dc1840baf61feb7fbf1956fb8",
              "idt": "31-12-2023",
              "inum": "GIN0003609",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 35.1,
                    "rt": 18,
                    "samt": 35.1,
                    "txval": 390
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 460
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "36ABCPH8123R1YZ",
          "fldtr1": "08-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "497d558440c623ce31e6f00af1b8cd40334c7ef2d8c5ba4586698950f1c6a07a",
              "idt": "02-12-2023",
              "inum": "08",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "iamt": 288,
                    "rt": 18,
                    "txval": 1600
                  },
                  "num": 1800
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 1887
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "33ABCCZ4123M2YZ",
          "fldtr1": "11-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "4a40811683d7324a026c4cc57d6c9091cdd72110d38979133c4519f70d3f1052",
              "idt": "10-12-2023",
              "inum": "102324229636",
              "inv_typ": "R",
              "irn": "qoycq59t30c9eacb3701114023ed746e0e2c4f38a2a88a525b10467d94b379ee",
              "irngendate": "11-12-2023",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "csamt": 0,
                    "iamt": 518.4,
                    "rt": 18,
                    "samt": 0,
                    "txval": 2880
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "val": 3398.4
            },
            {
              "chksum": "7b869627113a641ec26e037e8a43ce813c778615d6306e08ac96a1c231143edf",
              "idt": "11-12-2023",
              "inum": "102324230047",
              "inv_typ": "R",
              "irn": "qoycq59t30b4128b0b6343c13b5dd21b2d3084f08f30d1a0f8389984fd2615b1",
              "irngendate": "11-12-2023",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "csamt": 0,
                    "iamt": 432,
                    "rt": 18,
                    "samt": 0,
                    "txval": 2400
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "val": 2832
            },
            {
              "chksum": "219acfe29f93805dff06f6d5a480be29bcc9ead5e870604fd706a28dc5d138ce",
              "idt": "25-12-2023",
              "inum": "102324243574",
              "inv_typ": "R",
              "irn": "qoycq59t307ae1cebb53e68135e8d42c53e2d9792b8b7bd543f01ab0da203bc6",
              "irngendate": "26-12-2023",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "csamt": 0,
                    "iamt": 50.17,
                    "rt": 18,
                    "samt": 0,
                    "txval": 278.71
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "val": 328.88
            },
            {
              "chksum": "231c3c2cdd8453e8d01baa2c9f2def14892db3c3004c18de16f4d82cb7ba6df7",
              "idt": "27-12-2023",
              "inum": "102324245907",
              "inv_typ": "R",
              "irn": "qoycq59t30b5bdd11a0876f41ae60132a0caa589b508aedf4dc86a7df8f16b17",
              "irngendate": "28-12-2023",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "csamt": 0,
                    "iamt": 44.59,
                    "rt": 18,
                    "samt": 0,
                    "txval": 247.74
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "srctyp": "e-Invoice",
              "val": 292.33
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "29ABCCR4123K1YZ",
          "fldtr1": "11-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "c5d125323e779d687ee02308001099bdb55f3afaefd36da570cb0eec4e5061ed",
              "idt": "10-12-2023",
              "inum": "141519",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "iamt": 403,
                    "rt": 18,
                    "txval": 2240
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 2643
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "27ABCCI0123E1YZ",
          "fldtr1": "10-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "64aec8aebbf45c388d77bc8a03b38895e73ec5d89a44c18cbc9703a44b419a65",
              "idt": "12-12-2023",
              "inum": "NPS/1224/0088766",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "csamt": 0,
                    "iamt": 54,
                    "rt": 18,
                    "samt": 0,
                    "txval": 300
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 354
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "29ABCCR4123K1YZ",
          "fldtr1": "10-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "a15e9083d654cb370ff7add0ef93fe072a8a1a1c5ad96ee569941a5cd433a71e",
              "idt": "21-12-2023",
              "inum": "INV-000764",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "iamt": 1890,
                    "rt": 18,
                    "txval": 10500
                  },
                  "num": 1800
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 12390
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "24ABCPM7123B2YZ",
          "fldtr1": "09-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "be4342e9e49709abc9e5f11d3098212e6db62df15a960973b580361d458f1ba8",
              "idt": "03-10-2023",
              "inum": "VPDL-331",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 80.2,
                    "csamt": 0,
                    "rt": 12,
                    "samt": 80.2,
                    "txval": 1336.62
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 1497
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "27ABCCN2123N1YZ",
          "fldtr1": "11-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "8d829a556dcde2e34abe140562131b7bea4aec7eeb2f9ac0ebc668582eaddeb0",
              "idt": "19-12-2023",
              "inum": "OPV/997000175687",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "csamt": 0,
                    "iamt": 3813.56,
                    "rt": 18,
                    "samt": 0,
                    "txval": 21186.44
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 25000
            }
          ]
        },
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "29ABCCR4123J1YZ",
          "fldtr1": "11-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "chksum": "75d98911ec2350b650c79a157760948606fd89837d623d16a19e7b1b4343c457",
              "idt": "31-12-2023",
              "inum": "4XCFPHNO3URQ1223",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "iamt": 1496.86,
                    "rt": 18,
                    "txval": 8315.9
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 12711.98
            },
            {
              "chksum": "89e0c717a02ff5666d1f7a5a59fed3a0a368c96036ad88248902b1eaf6b87a73",
              "idt": "31-12-2023",
              "inum": "GSDKTASVXEXU1223",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "iamt": 7384.13,
                    "rt": 18,
                    "txval": 41022.9
                  },
                  "num": 1
                }
              ],
              "pos": "24",
              "rchrg": "N",
              "val": 52865.55
            }
          ]
        }
      ]
    }
  },
  "timestamp": 1763446641000,
  "transaction_id": "ade7daa4-4ece-4549-8c02-ee84c2873cad"
}

Response schema

For successful responses, these resources describe the GSTN payload at data.data.

View JSON schema

View Excel field reference

Headers

authorization · string · required

GST taxpayer access token. For token-generation steps, refer to the Generate Taxpayer Session recipe, then pass the token in the authorization header.

x-api-key · string · required

API key for identification

x-api-version · string · default: 1.0.0

API version

Path Parameters

year · string · required

month · string · required

Query Parameters

from · string

Filter to fetch data from specified date. E.g., 28/01/2025

Example:

"29/01/2025"

counterparty_gstin · string

Filter by supplier / counterparty GSTIN

Example:

"{{gstin}}"

Response

200 - application/json

200 Success / RET13509 No data found

Option 1

Option 2

A GSTN success or GSTN business-failure response. Both variants use HTTP 200.

code · enum<integer> · required

The HTTP status code reported in the response body.

Available options: 200

Example:

200

timestamp · integer<int64> · required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

transaction_id · string · required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

data · object · required

The GSTN success wrapper.

Show child attributes