Get GSTR-2A B2BA

Get GSTR-2A B2BA

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

{
  "code": 200,
  "data": {
    "data": {
      "b2ba": [
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "24ABCCR0123M1YZ",
          "fldtr1": "10-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "aspd": "Oct-23",
              "atyp": "D",
              "chksum": "6a93632fb89ac2028409a04ef1b538d38e9e50503b69c1ddd182570d61615aea",
              "idt": "25-10-2023",
              "inum": "RN1/FAMA-16557",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "iamt": 0,
                    "rt": 18,
                    "samt": 0,
                    "txval": 0.01
                  },
                  "num": 1418
                }
              ],
              "oidt": "25-10-2023",
              "oinum": "RN1/FAMA-16557",
              "pos": "24",
              "rchrg": "N",
              "val": 0.01
            }
          ]
        }
      ]
    },
    "status_cd": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "28ddcef3-cea8-449b-bc59-7aac885e6216"
}

GET

gst

compliance

tax-payer

gstrs

gstr-2a

b2ba

{year}

{month}

Get GSTR-2A B2BA

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

{
  "code": 200,
  "data": {
    "data": {
      "b2ba": [
        {
          "cfs": "Y",
          "cfs3b": "Y",
          "ctin": "24ABCCR0123M1YZ",
          "fldtr1": "10-Jan-24",
          "flprdr1": "Dec-23",
          "inv": [
            {
              "aspd": "Oct-23",
              "atyp": "D",
              "chksum": "6a93632fb89ac2028409a04ef1b538d38e9e50503b69c1ddd182570d61615aea",
              "idt": "25-10-2023",
              "inum": "RN1/FAMA-16557",
              "inv_typ": "R",
              "itms": [
                {
                  "itm_det": {
                    "camt": 0,
                    "iamt": 0,
                    "rt": 18,
                    "samt": 0,
                    "txval": 0.01
                  },
                  "num": 1418
                }
              ],
              "oidt": "25-10-2023",
              "oinum": "RN1/FAMA-16557",
              "pos": "24",
              "rchrg": "N",
              "val": 0.01
            }
          ]
        }
      ]
    },
    "status_cd": "1"
  },
  "timestamp": 1763446641000,
  "transaction_id": "28ddcef3-cea8-449b-bc59-7aac885e6216"
}

Headers

Authorization

string

required

Taxpayer access token

x-api-key

string

required

API key for identification

x-api-version

string

default:1.0.0

API version

Path Parameters

year

string

required

Year e.g. 2020

Example:

"{{year}}"

month

string

required

Month e.g. 01

Example:

"{{month}}"

Query Parameters

counterparty_gstin

string

optional Counter party GSTIN

Example:

"{{ctin}}"

Response

200 - application/json

200 Success / RET13509 No data found

code

number

Example:

200

data

object

Show child attributes

data.data

object

Show child attributes

data.data.b2ba

object[]

Show child attributes

data.data.b2ba.cfs

string

Example:

"Y"

data.data.b2ba.cfs3b

string

Example:

"Y"

data.data.b2ba.ctin

string

Example:

"24ABCCR0123M1YZ"

data.data.b2ba.fldtr1

string

Example:

"10-Jan-24"

data.data.b2ba.flprdr1

string

Example:

"Dec-23"

data.data.b2ba.inv

object[]

Show child attributes

data.data.b2ba.inv.aspd

string

Example:

"Oct-23"

data.data.b2ba.inv.atyp

string

Example:

"D"

data.data.b2ba.inv.chksum

string

Example:

"6a93632fb89ac2028409a04ef1b538d38e9e50503b69c1ddd182570d61615aea"

data.data.b2ba.inv.idt

string

Example:

"25-10-2023"

data.data.b2ba.inv.inum

string

Example:

"RN1/FAMA-16557"

data.data.b2ba.inv.inv_typ

string

Example:

"R"

data.data.b2ba.inv.itms

object[]

Show child attributes

data.data.b2ba.inv.itms.itm_det

object

Show child attributes

data.data.b2ba.inv.itms.itm_det.camt

number

Example:

0

data.data.b2ba.inv.itms.itm_det.iamt

number

Example:

0

data.data.b2ba.inv.itms.itm_det.rt

number

Example:

18

data.data.b2ba.inv.itms.itm_det.samt

number

Example:

0

data.data.b2ba.inv.itms.itm_det.txval

number

Example:

0.01

data.data.b2ba.inv.itms.num

number

Example:

1418

Example:

[
  {
    "itm_det": {
      "camt": 0,
      "iamt": 0,
      "rt": 18,
      "samt": 0,
      "txval": 0.01
    },
    "num": 1418
  }
]

data.data.b2ba.inv.oidt

string

Example:

"25-10-2023"

data.data.b2ba.inv.oinum

string

Example:

"RN1/FAMA-16557"

data.data.b2ba.inv.pos

string

Example:

"24"

data.data.b2ba.inv.rchrg

string

Example:

"N"

data.data.b2ba.inv.val

number

Example:

0.01

Example:

[
  {
    "aspd": "Oct-23",
    "atyp": "D",
    "chksum": "6a93632fb89ac2028409a04ef1b538d38e9e50503b69c1ddd182570d61615aea",
    "idt": "25-10-2023",
    "inum": "RN1/FAMA-16557",
    "inv_typ": "R",
    "itms": [
      {
        "itm_det": {
          "camt": 0,
          "iamt": 0,
          "rt": 18,
          "samt": 0,
          "txval": 0.01
        },
        "num": 1418
      }
    ],
    "oidt": "25-10-2023",
    "oinum": "RN1/FAMA-16557",
    "pos": "24",
    "rchrg": "N",
    "val": 0.01
  }
]

Example:

[
  {
    "cfs": "Y",
    "cfs3b": "Y",
    "ctin": "24ABCCR0123M1YZ",
    "fldtr1": "10-Jan-24",
    "flprdr1": "Dec-23",
    "inv": [
      {
        "aspd": "Oct-23",
        "atyp": "D",
        "chksum": "6a93632fb89ac2028409a04ef1b538d38e9e50503b69c1ddd182570d61615aea",
        "idt": "25-10-2023",
        "inum": "RN1/FAMA-16557",
        "inv_typ": "R",
        "itms": [
          {
            "itm_det": {
              "camt": 0,
              "iamt": 0,
              "rt": 18,
              "samt": 0,
              "txval": 0.01
            },
            "num": 1418
          }
        ],
        "oidt": "25-10-2023",
        "oinum": "RN1/FAMA-16557",
        "pos": "24",
        "rchrg": "N",
        "val": 0.01
      }
    ]
  }
]

data.error

object

Show child attributes

data.error.error_cd

string

Example:

"RET13509"

data.error.message

string

Example:

"No document found for the provided Inputs"

data.status_cd

string

Example:

"1"

timestamp

number

Example:

1763446641000

transaction_id

string

Example:

"28ddcef3-cea8-449b-bc59-7aac885e6216"

GSTR-2A B2B

GSTR-2A CDN

⌘I

Analytics

Compliance

Headers

Path Parameters

Query Parameters

Response