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.

API Pricing Image

Overview

Submit a Job in GSTR2B for a return period (year and month) for the authenticated taxpayer (gstin).

Endpoint

HTTP MethodResource
POST/gsp/tax-payer/:gstin/gstrs/gstr-2b/:year/:month/async

API Endpoint  Contact Us  Free Trial

Request

Path Parameters

ParamTypeDescriptionExample
gstinstring15-character alpha-numeric unique identifier assigned to business entities registering under the GST regime22AAAAA0000A1Z5

Query Parameters

ParamTypeDescriptionExample
job_idstringJob ID obtained from posting GSTR2B Async request58D5E212-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
ParamTypeDescriptionExample
statusstringStatus of the Job of GSTR 2B
Possible value -
JOBQUEUED : Job is Queued
JOBDONE : Job is Completed/Done
JOBFAILED : Job is Failed
JOBCREATED : Job is Created
JOBQUEUED
gstr2b_urlstringURL where GSTR 2B could be downloadedhttps://..

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