Skip to main content
POST
india.gst.return.file

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by india.gst.consent.create.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
form
enum<string>
required

GST return form. A source declines forms whose selected operation is not published.

Available options:
GSTR1,
GSTR1A,
GSTR2,
GSTR2A,
GSTR2B,
GSTR3,
GSTR3B,
GSTR4,
GSTR4A,
GSTR4ANNUAL,
GSTR5,
GSTR6,
GSTR6A,
GSTR7,
GSTR8,
GSTR9,
GSTR9A,
GSTR9C,
CMP08,
ITC03,
ITC04,
GSTR2X
period
string
required

Return period as YYYY-MM.

Required string length: 1 - 7
Pattern: ^20[0-9]{2}-(0[1-9]|1[0-2])$
method
enum<string>
required

File with an EVC OTP or a signature made by the builder.

Available options:
evc,
signature
pan
string
required

Authorised signatory PAN.

Required string length: 1 - 10
Pattern: ^[A-Z]{5}[0-9]{4}[A-Z]$
otp
string

EVC OTP.

Required string length: 1 - 10
Pattern: ^[0-9]{4,10}$
signature
string

Base64 PKCS7 signature of the current return content; never a private key.

Required string length: 1 - 2000000

Response

The result

status
enum<string>
required

Government operation state; processing is not a filed return.

Available options:
processing,
accepted,
rejected,
filed
form
enum<string>

GST return form. A source declines forms whose selected operation is not published.

Available options:
GSTR1,
GSTR1A,
GSTR2,
GSTR2A,
GSTR2B,
GSTR3,
GSTR3B,
GSTR4,
GSTR4A,
GSTR4ANNUAL,
GSTR5,
GSTR6,
GSTR6A,
GSTR7,
GSTR8,
GSTR9,
GSTR9A,
GSTR9C,
CMP08,
ITC03,
ITC04,
GSTR2X
period
string

Return period as YYYY-MM.

Required string length: 1 - 7
Pattern: ^20[0-9]{2}-(0[1-9]|1[0-2])$
arn
string

Government acknowledgement reference number.

Required string length: 1 - 40
ref
string

Reference to what this call created. Pass it as ref to the matching document or operation follow-up.