Skip to main content
POST
india.gst.return-operation.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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 a return save, prepare, file, 2B generation or IMS action.

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

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