GSTR-1 B2CL

GSTR-1 is a sales return that is required to be filed by every GST-registered person or entity. Sandbox API for getting large business-to-consumer(B2CL) invoice(more than 2.5 lakhs) details for a return period of the authenticated taxpayer.

API Pricing Image

Overiew

  • Get all B2C Large invoices for a return period for the authenticated taxpayer(gstin) for the particular year and month.
  • You also need to provide the state_code.

Endpoint

HTTP MethodResource
Get/gsp/tax-payer/{gstin}/gstrs/gstr-1/b2cl/{year}/{month}?state_code={}state_code{}

API Endpoint  Contact Us  Free Trial

Request

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

Path Parameters

ParamTypeDescriptionExample
gstinstring15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime22AAAAA0000A1Z5
yearstringYear for which Large B2B invoices need to be fetched.2020
monthstringMonth for which Large B2B invoices need to be fetched.01

Query Parameters

ParamTypeDescriptionExample
state_codestringState Code24

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/b2cl/2020/01?state_code=24' \
     --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 Large B2B invoices details below

  • B2CL Invoices
ParamTypeDescriptionExample
posstringPlace of Supply02
List{inv}Invoice DetailsRefer to the Table below
  • Invoice Details
ParamTypeDescriptionExample
flagstringInvoice StatusN - No Action
chksumstringInvoice Check sum valueAflJufPlFStqKBZ
inumstringSupplier Invoice NumberS008400
idtstringSupplier Invoice Date03-02-2016
valnumSupplier Invoice Value10000.00
etinstringEcomOperator06ADECO9084R5Z5
inv_typstringInvoice type"R- Regular B2B Invoices, DE – Deemed Exports, SEWP – SEZ Exports with payment,
SEWOP – SEZ exports without payment
CBW - Custom Bonded Warehouse"
opdnumOriginal Period
(YYYY-MM)
2016-12
diff_percentnumDifferential percentage.65 (65%)
list {itms}ItemsRefer to the table below
  • Items
ParamTypeDescriptionExample
numnumSerial no2
itm_detItem DetailsRefer to the table below
  • Item Details
ParamTypeDescriptionExample
rtnumRate of Invoice5
txvalnumTaxable value of Goods or Service as per invoice10000.00
iamtnumIGST Amount as per invoice650.00
csamtnumCess Amount as per invoice650.00

Response Caching

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

Wallet Charges

Since GSTR-1 B2CL is a Paid API, a wallet charge of INR 0.25 + GST per API call will be applicable.

Versioning

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