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.
Overiew
- Get all B2C Large invoices for a return period for the authenticated taxpayer(
gstin) for the particularyearandmonth. - You also need to provide the
state_code.
Endpoint
| HTTP Method | Resource |
|---|---|
Get | /gsp/tax-payer/{gstin}/gstrs/gstr-1/b2cl/{year}/{month}?state_code={}state_code{} |
Request
Follow the below guidelines to pass GSTIN, year & month for getting large business-to-consumer(B2CL) invoice details.
Path Parameters
| 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 Large B2B invoices need to be fetched. | 2020 |
| month | string | Month for which Large B2B invoices need to be fetched. | 01 |
Query Parameters
| Param | Type | Description | Example |
|---|---|---|---|
| state_code | string | State Code | 24 |
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
| Param | Type | Description | Example |
|---|---|---|---|
| pos | string | Place of Supply | 02 |
| List{inv} | Invoice Details | Refer to the Table below |
- Invoice Details
| Param | Type | Description | Example |
|---|---|---|---|
| flag | string | Invoice Status | N - No Action |
| 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 |
| 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" |
| opd | num | Original Period (YYYY-MM) | 2016-12 |
| 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 | 5 |
| txval | num | Taxable value of Goods or Service as per invoice | 10000.00 |
| iamt | num | IGST 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 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
Updated 5 months ago