Save GSTR-3B

curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-3b/{year}/{month} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "gstin": "29HJKPS9689A8Z4",
  "ret_period": "112018",
  "eco_dtls": {
    "eco_sup": {
      "txval": 0,
      "iamt": 0,
      "camt": 0,
      "samt": 0,
      "csamt": 0
    },
    "eco_reg_sup": {
      "txval": 0
    }
  },
  "inward_sup": {
    "isup_details": [
      {
        "intra": 0,
        "ty": "GST",
        "inter": 0
      },
      {
        "intra": 0,
        "ty": "NONGST",
        "inter": 0
      }
    ]
  },
  "sup_details": {
    "osup_nil_exmp": {
      "txval": 0
    },
    "osup_nongst": {
      "txval": 0
    },
    "osup_zero": {
      "csamt": 0,
      "iamt": 0,
      "txval": 0
    },
    "osup_det": {
      "samt": 0,
      "csamt": 0,
      "camt": 0,
      "iamt": 0,
      "txval": 0
    },
    "isup_rev": {
      "samt": 0,
      "csamt": 0,
      "camt": 0,
      "iamt": 0,
      "txval": 0
    }
  },
  "intr_ltfee": {
    "intr_details": {
      "csamt": 0,
      "samt": 0,
      "camt": 0,
      "iamt": 0
    }
  },
  "inter_sup": {
    "comp_details": [],
    "uin_details": [],
    "unreg_details": []
  },
  "itc_elg": {
    "itc_avl": [
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "IMPG",
        "iamt": 0
      },
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "IMPS",
        "iamt": 0
      },
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "ISRC",
        "iamt": 0
      },
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "ISD",
        "iamt": 0
      },
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "OTH",
        "iamt": 0
      }
    ],
    "itc_rev": [
      {
        "csamt": 0,
        "samt": 0,
        "camt": 0,
        "ty": "RUL",
        "iamt": 0
      },
      {
        "csamt": 0,
        "samt": 0,
        "camt": 0,
        "ty": "OTH",
        "iamt": 0
      }
    ],
    "itc_net": {
      "csamt": 0,
      "samt": 0,
      "camt": 0,
      "iamt": 0
    },
    "itc_inelg": [
      {
        "csamt": 0,
        "samt": 0,
        "camt": 0,
        "ty": "RUL",
        "iamt": 0
      },
      {
        "csamt": 0,
        "samt": 0,
        "camt": 0,
        "ty": "OTH",
        "iamt": 0
      }
    ]
  }
}
'

{
  "code": 200,
  "data": {
    "status_cd": "1",
    "data": {
      "reference_id": "ab2b2eae-974d-40e2-a721-8c4987af92d0"
    }
  },
  "timestamp": 1763446641000,
  "transaction_id": "a43cfcd6-9a48-4be9-82fd-0816070999db"
}

POST

gst

compliance

tax-payer

gstrs

gstr-3b

{year}

{month}

curl --request POST \
  --url https://api.sandbox.co.in/gst/compliance/tax-payer/gstrs/gstr-3b/{year}/{month} \
  --header 'Content-Type: application/json' \
  --header 'authorization: <api-key>' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "gstin": "29HJKPS9689A8Z4",
  "ret_period": "112018",
  "eco_dtls": {
    "eco_sup": {
      "txval": 0,
      "iamt": 0,
      "camt": 0,
      "samt": 0,
      "csamt": 0
    },
    "eco_reg_sup": {
      "txval": 0
    }
  },
  "inward_sup": {
    "isup_details": [
      {
        "intra": 0,
        "ty": "GST",
        "inter": 0
      },
      {
        "intra": 0,
        "ty": "NONGST",
        "inter": 0
      }
    ]
  },
  "sup_details": {
    "osup_nil_exmp": {
      "txval": 0
    },
    "osup_nongst": {
      "txval": 0
    },
    "osup_zero": {
      "csamt": 0,
      "iamt": 0,
      "txval": 0
    },
    "osup_det": {
      "samt": 0,
      "csamt": 0,
      "camt": 0,
      "iamt": 0,
      "txval": 0
    },
    "isup_rev": {
      "samt": 0,
      "csamt": 0,
      "camt": 0,
      "iamt": 0,
      "txval": 0
    }
  },
  "intr_ltfee": {
    "intr_details": {
      "csamt": 0,
      "samt": 0,
      "camt": 0,
      "iamt": 0
    }
  },
  "inter_sup": {
    "comp_details": [],
    "uin_details": [],
    "unreg_details": []
  },
  "itc_elg": {
    "itc_avl": [
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "IMPG",
        "iamt": 0
      },
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "IMPS",
        "iamt": 0
      },
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "ISRC",
        "iamt": 0
      },
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "ISD",
        "iamt": 0
      },
      {
        "samt": 0,
        "csamt": 0,
        "camt": 0,
        "ty": "OTH",
        "iamt": 0
      }
    ],
    "itc_rev": [
      {
        "csamt": 0,
        "samt": 0,
        "camt": 0,
        "ty": "RUL",
        "iamt": 0
      },
      {
        "csamt": 0,
        "samt": 0,
        "camt": 0,
        "ty": "OTH",
        "iamt": 0
      }
    ],
    "itc_net": {
      "csamt": 0,
      "samt": 0,
      "camt": 0,
      "iamt": 0
    },
    "itc_inelg": [
      {
        "csamt": 0,
        "samt": 0,
        "camt": 0,
        "ty": "RUL",
        "iamt": 0
      },
      {
        "csamt": 0,
        "samt": 0,
        "camt": 0,
        "ty": "OTH",
        "iamt": 0
      }
    ]
  }
}
'

{
  "code": 200,
  "data": {
    "status_cd": "1",
    "data": {
      "reference_id": "ab2b2eae-974d-40e2-a721-8c4987af92d0"
    }
  },
  "timestamp": 1763446641000,
  "transaction_id": "a43cfcd6-9a48-4be9-82fd-0816070999db"
}

Request body schema

View request body schema

Authorizations

authorization

string

header

required

GST taxpayer access token returned by Verify OTP.

x-api-key

string

header

required

Sandbox API key from your Sandbox account.

Headers

x-api-version

string

default:1.0.0

API version

Path Parameters

year

integer<int32>

required

Year of the return period.

month

integer<int32>

required

Month of the return period.

Body

application/json

JSON raw body

inward_sup

object

The inward sup value provided in the request.

Show child attributes

sup_details

object

The sup details value provided in the request.

Show child attributes

intr_ltfee

object

The intr ltfee value provided in the request.

Show child attributes

inter_sup

object

The inter sup value provided in the request.

Show child attributes

itc_elg

object

The itc elg value provided in the request.

Show child attributes

gstin

string

Supplier GSTIN

ret_period

string

Return Period

eco_dtls

object

Supplied notified under section 9(5) of the CGST Act, 2017

Show child attributes

Response

200 - application/json

GSTN response. data.status_cd is "1" for success and "0" for a business error.

Option 1
GSTN business error

A GSTN success or GSTN business-failure response. Both variants use HTTP 200.

code

enum<integer>

required

The HTTP status code reported in the response body.

Available options:

200

Example:

200

timestamp

integer<int64>

required

The response timestamp in Unix epoch milliseconds.

Example:

1763446641000

transaction_id

string

required

The transaction identifier used to trace the request.

Example:

"41bb8041-fb83-4654-8d75-85a19f329158"

data

object

required

The GSTN success wrapper.

Show child attributes

Analytics

Compliance

Annexures

Request body schema

View request body schema

Authorizations

Headers

Path Parameters

Body

Response

​Request body schema

View request body schema

Authorizations

Headers

Path Parameters

Body

Response

Request body schema