Poll Job
GSTR 2B is an auto-drafted document that will act as an Input Tax Credit (ITC) statement for taxpayers. Sandbox API to poll the job submitted for GSTR 2B for a return period of the authenticated taxpayer.
Overview
Submit a Job in GSTR2B for a return period (year
and month
) for the authenticated taxpayer (gstin
).
Endpoint
HTTP Method | Resource |
---|---|
POST | /gsp/tax-payer/:gstin/gstrs/gstr-2b/:year/:month/async |
Request
Path Parameters
Param | Type | Description | Example |
---|---|---|---|
gstin | string | 15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime | 22AAAAA0000A1Z5 |
Query Parameters
Param | Type | Description | Example |
---|---|---|---|
job_id | string | Job ID obtained from posting GSTR2B Async request | 58D5E212-165B-4CA0-909B-C86B9CEE0111 |
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-2b/async?job_id=58D5E212-165B-4CA0-909B-C86B9CEE0111' \
--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 GSTR-2B Async details below
job
entity
Param | Type | Description | Example |
---|---|---|---|
status | string | Status of the Job of GSTR 2B Possible value - JOBQUEUED : Job is QueuedJOBDONE : Job is Completed/DoneJOBFAILED : Job is FailedJOBCREATED : Job is Created | JOBQUEUED |
gstr2b_url | string | URL where GSTR 2B could be downloaded | https://.. |
Response Caching
Response caching is not available for this API. Learn more about our response caching mechanism here
Wallet Charges
Since GSTR-2B Async Submit Job is a Paid API, a wallet charge as per the response size will be applicable, for more information contact support.
Versioning
This API is currently in major version 1.0. Refer to our versioning policies here
Updated 5 months ago