21522152

About

  • Get a summary in GSTR2B for a return period (year and month) for the authenticated taxpayer (gstin).

Endpoint

HTTP Method

Resource

Description

GET

/gsp/tax-payer/{gstin}/gstrs/gstr-2b/{year}/{month}

Takes in gstin, year and month and returns GSTR-2B summary.

API EndpointAPI Endpoint

Request

Path Parameters

Param

Type

Description

Example

gstin

string

15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime

AAAAA0000A

year

string

Year for which Advance Tax needs to be fetched.

2020

month

string

Month for which Advance Tax needs to be fetched.

01

Query Parameter

Param

Type

Description

Example

file_number

int32

If total number of documents across sections of GSTR2B cross the specified limit then data will be maintained as chunks and summary data will be returned along with file count

2

Once the values are added, Your curl will look something like this

curl --request GET \
     --url https://api.sandbox.co.in/gsp/tax-payer/AAAAA0000A/gstrs/gstr-2b/2020/01 \
     --header 'Accept: application/json' \
     --header 'Authorization: xxxxxxxxx' \
     --header 'x-api-key: xxxxxxxxx' \
     --header 'x-api-version: 1.0'

Response

  • data entity

Param

Type

Description

Example

itcsumm

object

ITC summary

itcavl

object

ITC Available Summary

Under itcsumm entity, Refer to itcavl entity

rtnprd

string

Return Period

082021

docdata

object

Document data

refer to docdata entity

gendt

string

GSTR2B generation date

14-09-2021

gstin

string

GSTIN of the Receiver

24AAACJ3770E2ZZ

version

string

Version no

1.0

cpsumm

object

Supplier wise summary

refer to cpsumm entity

  • itcavl entity

Param

Type

Description

Example

nonrevsup

object

Non reverse charge supplies

refer to nonrevsup entity

  • nonrevsup entity

Param

Type

Description

Example

cgst

num

CGST

15867.66

sgst

num

SGST

15867.66

igst

num

IGST

128921.15

cess

num

CESS

0

b2b

object

B2B Summary

refer to b2b entity below

  • b2b entity (under nonrevsup entity)

Param

Type

Description

Example

cgst

num

CGST

15867.66

sgst

num

SGST

15867.66

igst

num

IGST

128921.15

cess

num

CESS

0

  • docdata entity

Param

Type

Description

Example

b2b

object

B2B Summary

refer to b2b entity below

  • b2b entity (under docdata entity)

Param

Type

Description

Example

inv

object

trdnm

string

Trade/Legal name of the supplier

PNATH CORPORATIO

supfildt

string

Date of filing GSTR1/5 of supplier

12-08-2021

supprd

string

Filing period of GSTR1/5 of supplier

072021

ctin

string

Gstin of the supplier

24AAAPA1234G1ZR

  • inv

Param

Type

Description

Example

dt

string

Invoice Date

08-07-2021

val

num

Invoice Value

8100

rev

enum

Supply attracts reverse charge

N

itcavl

enum

ITC Availability

Y

diff_percent

num

Applicable % of tax rate

1

pos

string

Place of supply

24

typ

enum

Invoice Type

R

inum

string

Invoice Number

190

rsn

enum

Reason for ITC Unavailability

itms

object

Items

Refer to itms entity

  • itms entity

Param

Type

Description

Example

sgst

num

SGST Amount as per invoice

147.62

rt

num

Tax Rate

5

num

num

Item Number

1

txval

num

Total Taxable value

5904.76

cgst

num

CGST Amount as per invoice

147.62

cess

num

CESS Amount as per invoice

0

  • cpsumm entity

Param

Type

Description

Example

b2b

object

B2B Summary

refer to b2b entity below

  • b2b entity (under cpsumm entity)

Param

Type

Description

Example

ttldocs

string

Total Documents

1

trdnm

string

Trade/Legal name of the supplier

PNATH CORPORATIO

supfildt

string

Date of filing GSTR1/5 of supplier

12-08-2021

supprd

string

Filing period of GSTR1/5 of supplier

072021

txval

num

Total Taxable Value

7389.14

ctin

string

Gstin of the supplier

24AAAPA1234G1ZR

sgst

num

Total SGST Value

355.43

cgst

num

Total CGST Value

355.43

igst

num

Total IGST Value

0

cess

num

Total CESS Value

0


Did this page help you?