GSTR-1 B2B

GSTR-1 is a sales return that is required to be filed by every GST-registered person or entity. Sandbox API for getting all business-to-business(B2B) invoice details for a return period of the authenticated taxpayer.

Suggest Edits

Overview

Get all B2B invoices for a return period for the authenticated taxpayer (gstin) for the particular year and month.
The result can be further filtered by adding from date and action_required. The action_required filter is used for filter invoices where the taxpayer has some pending actions.
You can also provide the ctin, the counter party's GSTIN for which you need the B2B invoices.

Endpoint

HTTP Method	Resource
`Get`	/gsp/tax-payer/{gstin}/gstrs/gstr-1/b2b/{year}/{month}

Request

Follow the below guidelines to pass GSTIN, year & month for getting all business-to-business(B2BA) invoice details.

Path Parameters

Follow the below guidelines to pass GSTIN, year & month for getting all business-to-business(B2B) invoice details.

Param	Type	Description	Example
gstin	`string`	15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime	22AAAAA0000A1Z5
year	`string`	Year for which B2B invoices need to be fetched.	2020
month	`string`	Month for which B2B invoices need to be fetched.	01

Query Parameters

Param	Type	Description	Example
ctin	`string`	Counter party GSTIN	22AABAA0000A1Z
action_required	`string`	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 taxpayer need to take action. Already accepted or uploaded invoices can be fetched by using filter value N.	Y
from	`string`	From Date (DD/MM/YYYY)	21/11/2020

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

curl --request GET \
     --url 'https://api.sandbox.co.in/gsp/tax-payer/22AAAAA0000A1Z5/gstrs/gstr-1/b2b/2020/01?ctin=22AABAA0000A1Z&action_required=Y&from=21%2F11%2F2020' \
     --header 'Authorization: xxxxxxxxxx' \
     --header 'accept: application/json' \
     --header 'x-api-key: xxxxxxxxxx' \
     --header 'x-api-version: 1.0'

❗️
Test Environment Not Available

Response

The response includes the following business-to-business(B2B) invoice details below

B2B Invoices

Param	Type	Description	Example
ctin	`string`	GSTIN/UID of the Receiver taxpayer/UN, Govt Bodies	06ADECO9084R5Z4
cfs	`string`	GSTR2 filing status of counter party	`Y` (Yes) or `N` (No)
List{inv}	Invoice Details	Refer to the Table below

Invoice Details

Param	Type	Description	Example
flag	`string`	Invoice Status	`N` - No Action
updby	`string`	Uploaded by	`R` - Receiver `S` - Supplier
chksum	`string`	Invoice Check sum value	AflJufPlFStqKBZ
inum	`string`	Supplier Invoice Number	S008400
idt	`string`	Supplier Invoice Date	03-02-2016
val	`num`	Supplier Invoice Value	10000.00
pos	`string`	Place of Supply (statecode)	04
rchrg	`string`	Reverse Charge	`Y`- Yes `N` - No
etin	`string`	EcomOperator	06ADECO9084R5Z5
inv_typ	`string`	Invoice type	`R` - Regular B2B Invoices `DE` - Deemed Exports `SEWP` - SEZ Exports with payment `SEWOP` - SEZ exports without payment `CBW` - Custom Bonded Warehouse
cflag	`string`	Counter Party Flag	`A` - Accepted `R` - Rejected `M` - Modified `N` - No action `U` - Uploaded `P` - Pending `DF` - Deferred `FR` - Forward
opd	`num`	Original Period (YYYY-MM)	2016-12
srctyp	`string`	Source Type of IRN	E-invoice
irn	`string`	IRN number	897ADG56RTY78956HYUG90BNHHIJK453GFTD99845672FDHHHSHGFH4567FG56TR
irngendate	`string`	IRN generation Date (DD-MM-YYYY)	03-02-2016
diff_percent	`num`	Differential percentage	.65 (65%)
list {itms}	Items	Refer to the table below

Items

Param	Type	Description	Example
num	`num`	Serial no	2
itm_det	Item Details	Refer to the table below

Item Details

Param	Type	Description	Example
rt	`num`	Rate of Invoice	10
txval	`num`	Taxable value of Goods or Service as per invoice	10000.00
iamt	`num`	IGST Amount as per invoice	650.00
camt	`num`	CGST Amount as per invoice	650.00
samt	`num`	SGST Amount as per invoice	650.00
csamt	`num`	Cess Amount as per invoice	650.00

Response Caching

Response caching is not available for this API. Learn more about our response caching mechanism here

Wallet Charges

Since GSTR-1 B2B is not a Paid API, no wallet charge will take place.

Versioning

This API is currently in major version 1.0. Refer to our versioning policies here

Updated 3 months ago