|
Description
|
For Sandbox
|
For Production
|
|
BaseURL
|
https://gstsandbox.charteredinfo.com
|
https://gstapi.charteredinfo.com
|
Note : Only works in Production.
API List: For more details like Request Body Json, Response Json, Json Schema, Excel Attribute List, ... , etc. refer GST Developer portal
|
API Details
|
Method
|
API Action
|
URL/Header Parameter
|
URL
|
|
Get IRN List
|
GET
|
IRNLIST
|
[Common Header Parameters], rtnprd={}, suptyp={ B2B / SEZWP / SEZWOP / DEXP / EXPWP / EXPWOP }, stin={} or rtin={}
|
BaseURL/taxpayerapi/v1.0/einvoice
|
|
Get File Details
|
GET
|
FILEDETL
|
[Common Header Parameters], token={}
|
BaseURL/taxpayerapi/v1.0/einvoice
|
|
Get IRN Details
|
GET
|
IRNDTL
|
[Common Header Parameters], irn={}
|
BaseURL/taxpayerapi/v1.0/einvoice
|
|
Get IRN JSON
|
GET
|
IRNJSON
|
[Common Header Parameters], rtnprd={}, suptyp={ B2B / SEZWP / SEZWOP / DEXP / EXPWP / EXPWOP }, stin={} or rtin={}
|
BaseURL/taxpayerapi/v1.0/einvoice/getIrnJson
|
|
Get Einvoice HSN Summary
|
GET
|
EINVHSN
|
[Common Header Parameters]
|
BaseURL/taxpayerapi/v1.0/einvoice
|
GSTN has released e-Invoice JSON download functionality which is accessible through Taxpayer APIs for all GSP partners
This functionality can be accessed through three APIs
1. Get IRN List – To get access token for a given return period, supply type and supplier/recipient.
Sample Sandbox URL:
https://gstsandbox.charteredinfo.com/taxpayerapi/dec/v1.0/einvoice?action=IRNLIST&gstin=27AANCS2882A1Z9&rtnprd=102023&username=MH_NT2.2274&suptyp=B2B&stin=27AANCS2882A1Z9&ret_period=102023
Sample Success Response:
{
"est": "30",
"token": "dfe6d4ab05aa4ec991fe7bf2fdcdafe8"
}
2. Get IRN Details – To get e-Invoice standard JSON with signed payloads for a specific IRN.
Sample Sandbox URL:
https://gstsandbox.charteredinfo.com/taxpayerapi/dec/v1.0/einvoice?action=IRNDTL&gstin=27AANCS2882A1Z9&MH_NT2.2274&irn=9a151372827d97f7496fb2ce4dc48d6ec9c48e277661cf206257e60901ef6530
Sample Success Response:
{
"RequestDate": "2023-10-18 14:18:42",
"data": {
"AckNo": 172313650118675,
"AckDt": "2023-10-14 16:58:00",
"Irn": "9a151372827d97f7496fb2ce4dc48d6ec9c48e277661cf206257e60901ef6530",
"SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCNThFQTVFNkY0QUFDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGciLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxNzIzMTM2NTAxMTg2NzUsXCJBY2tEdFwiOlwiMjAyMy0xMC0xNCAxNjo1ODowMFwiLFwiSXJuXCI6XCI5YTE1MTM3MjgyN2Q5N2Y3NDk2ZmIyY2U0ZGM0OGQ2ZWM5YzQ4ZTI3NzY2MWNmMjA2MjU3ZTYwOTAxZWY2NTMwXCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiQjJCXCIsXCJSZWdSZXZcIjpcIk5cIn0sXCJEb2NEdGxzXCI6e1wiVHlwXCI6XCJJTlZcIixcIk5vXCI6XCJUS0QyMzI0MTIzM1wiLFwiRHRcIjpcIjE0LzEwLzIwMjNcIn0sXCJTZWxsZXJEdGxzXCI6e1wiR3N0aW5cIjpcIjA3QUFDQ0MxNTk2UTFaNFwiLFwiTGdsTm1cIjpcIkNoYXJ0ZXJlZCBJbmZvcm1hdGlvbiBTeXN0ZW1zIFByaXZhdGUgTGltaXRlZFwiLFwiVHJkTm1cIjpcIkNoYXJ0ZXJlZCBJbmZvcm1hdGlvbiBTeXN0ZW1zIFByaXZhdGUgTGltaXRlZFwiLFwiQWRkcjFcIjpcIjIyMi0yMjMsIER1cmdhIENoYW5iZXJzLCAxMzMzLTM0LCBcIixcIkFkZHIyXCI6XCJEZXNoIEJhbmRodSBHdXB0YSBSYW9kLCBLYXJvbGJhZ2gsXCIsXCJMb2NcIjpcIk5ldyBEZWxoaVwiLFwiUGluXCI6MTEwMDA1LFwiU3RjZFwiOlwiMDdcIixcIlBoXCI6XCIwMTE0NTAzNzE3N1wiLFwiRW1cIjpcInRheHByb2RlbGhpQHRheHByby5jby5pblwifSxcIkJ1eWVyRHRsc1wiOntcIkdzdGluXCI6XCIwN0FJRVBEOTM3M0sxWllcIixcIkxnbE5tXCI6XCJBQURJIEluZm90ZWNoXCIsXCJQb3NcIjpcIjA3XCIsXCJBZGRyMVwiOlwiMzAxXFx1MDAyNjMxMSwgM3JkIEZsb29yLCBCLTYsIExheG1pIENvbXBsZXhcIixcIkFkZHIyXCI6XCJTdWJoYXNoIENob3drTGF4bWkgTmFnYXJcIixcIkxvY1wiOlwiRGVsaGlcIixcIlBpblwiOjExMDA5MixcIlBoXCI6XCIwOTgxMDUzNzAyNlwiLFwiRW1cIjpcImFzaHdpbkBhYWRpd2ViLmNvbVwiLFwiU3RjZFwiOlwiMDdcIn0sXCJTaGlwRHRsc1wiOntcIkdzdGluXCI6XCIwN0FJRVBEOTM3M0sxWllcIixcIkxnbE5tXCI6XCJBQURJIEluZm90ZWNoXCIsXCJBZGRyMVwiOlwiMzAxXFx1MDAyNjMxMSwgM3JkIEZsb29yLCBCLTYsIExheG1pIENvbXBsZXhcIixcIkFkZHIyXCI6XCJTdWJoYXNoIENob3drTGF4bWkgTmFnYXJcIixcIkxvY1wiOlwiRGVsaGlcIixcIlBpblwiOjExMDA5MixcIlN0Y2RcIjpcIjA3XCJ9LFwiSXRlbUxpc3RcIjpbe1wiSXRlbU5vXCI6MCxcIlNsTm9cIjpcIjFcIixcIklzU2VydmNcIjpcIk5cIixcIlByZERlc2NcIjpcIkhZUDIwMDMgVVNCIFRva2VuXCIsXCJIc25DZFwiOlwiODQ3MzMwOTlcIixcIlF0eVwiOjEwMDAwLjAsXCJGcmVlUXR5XCI6MC4wLFwiVW5pdFwiOlwiTk9TXCIsXCJVbml0UHJpY2VcIjoyMTEuODY0LFwiVG90QW10XCI6MjExODY0NC4wNyxcIkRpc2NvdW50XCI6MC4wLFwiUHJlVGF4VmFsXCI6MjExODY0NC4wNyxcIkFzc0FtdFwiOjIxMTg2NDQuMDcsXCJHc3RSdFwiOjE4LjAsXCJJZ3N0QW10XCI6MC4wLFwiQ2dzdEFtdFwiOjE5MDY3Ny45NixcIlNnc3RBbXRcIjoxOTA2NzcuOTYsXCJDZXNSdFwiOjAuMCxcIkNlc0FtdFwiOjAuMCxcIkNlc05vbkFkdmxBbXRcIjowLjAsXCJTdGF0ZUNlc1J0XCI6MC4wLFwiU3RhdGVDZXNBbXRcIjowLjAsXCJTdGF0ZUNlc05vbkFkdmxBbXRcIjowLjAsXCJPdGhDaHJnXCI6MC4wLFwiVG90SXRlbVZhbFwiOjI0OTk5OTkuOTl9XSxcIlZhbER0bHNcIjp7XCJBc3NWYWxcIjoyMTE4NjQ0LjA3LFwiQ2dzdFZhbFwiOjE5MDY3Ny45NixcIlNnc3RWYWxcIjoxOTA2NzcuOTYsXCJJZ3N0VmFsXCI6MC4wLFwiT3RoQ2hyZ1wiOjAuMCxcIlJuZE9mZkFtdFwiOjAuMDEsXCJUb3RJbnZWYWxcIjoyNTAwMDAwLjB9LFwiRXdiRHRsc1wiOntcIlRyYW5zSWRcIjpcIjA3QUFDQ0MxNTk2UTFaNFwiLFwiVHJhbnNOYW1lXCI6XCJDaGFydGVyZWQgSW5mb3JtYXRpb24gU3lzdGVtcyBQcml2YXRlIExpbWl0ZWRcIixcIlRyYW5zTW9kZVwiOlwiMVwiLFwiRGlzdGFuY2VcIjowLFwiVmVoTm9cIjpcIkRMMDFMVjkxMDdcIixcIlZlaFR5cGVcIjpcIlJcIn19IiwiaXNzIjoiTklDIn0=.KvHNuQOLY81CSFV2_zhRvGV1DE9KRk0LWqUKu6N3xUehK1V8TN2yuy0qrwlF3UaZCWljhtNFVWXzYAy_dX1bOC0OdDu52BuID454oVdisN7mx32dCHLgM3Lp3LwIJubsRLBD280DjC7D0u2jZxgoraTOWm8OGQ3v7oJSo9zcE_gcdD4eMzTIRzxAYQEkWAFYmPL2WIfjVS3jSW9ml4rekMYlDP0cU_EnQ_IJbeeIOlBuo8oi5d38Oo1xKXOJZwbETE1AMAe6Te_6sEmGrO_3PTbKPV57XhTfYJX0WWc4BqU3ahSttgkPdVx9CYip0Y7TdDXq6oMSwqlOompvjEGGqA",
"SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkI4RDYzRUNCNThFQTVFNkY0QUFDM0Q1MjQ1NDNCMjI0NjY2OUIwRjgiLCJ4NXQiOiJ1TlkteTFqcVhtOUtyRDFTUlVPeUpHWnBzUGciLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjA3QUFDQ0MxNTk2UTFaNFwiLFwiQnV5ZXJHc3RpblwiOlwiMDdBSUVQRDkzNzNLMVpZXCIsXCJEb2NOb1wiOlwiVEtEMjMyNDEyMzNcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTQvMTAvMjAyM1wiLFwiVG90SW52VmFsXCI6MjUwMDAwMC4wLFwiSXRlbUNudFwiOjEsXCJNYWluSHNuQ29kZVwiOlwiODQ3MzMwOTlcIixcIklyblwiOlwiOWExNTEzNzI4MjdkOTdmNzQ5NmZiMmNlNGRjNDhkNmVjOWM0OGUyNzc2NjFjZjIwNjI1N2U2MDkwMWVmNjUzMFwiLFwiSXJuRHRcIjpcIjIwMjMtMTAtMTQgMTY6NTg6MDBcIn0iLCJpc3MiOiJOSUMifQ.L3jJ4oaB4yyfpEYgYrVaMYBbDCMsg0UA9rUBzD092kLOKlq7LzTX01lTOukr3dFP5pVwDmC4IoOQw1g0tIyXJfsaleMrlLDsQ_HTQJo1lk8QYabhy59Xpi3zeIMhFoz8DE9hJnElsYXhwtzs0G-Zqwla431oAiqaKJ2w6kdHF8zSoLimqtH-OMI9rg1uFvDfzVyFtOYE0_qMeeMeAtLdAtGHlYIqorjvCiLSN7nE_WAXG88uJ06OX4CTJPm6g3Df6RHP03Wy--oZsw3Y2qxx_5AqzuyHXDFubpfLoJjWhqbKjVBcGm7NB6WgvcBB4mL26eCE5C-XbK5htqxvLjCrvg",
"Status": "ACT"
}
}
3. Get File Details - To fetch list of JSON files having IRNs and basic details without signed payloads based on token from Get IRN List API.
Sample Sandbox URL:
https://gstsandbox.charteredinfo.com/taxpayerapi/dec/v1.0/einvoice?action=FILEDETL&gstin=27AANCS2882A1Z9&token=dfe6d4ab05aa4ec991fe7bf2fdcdafe8&username=MH_NT2.2274&ret_period=102023
Sample Success Response:
{
"ek": "vFnF2punW59JbI+mYRMqUdZ40+Jsiy3ts6vyT24/Ly4=",
"urls": [
{
"ic": 5,
"ul": "https://uatfiles.gst.gov.in/einvdownloads/16122023/EXCEL/dfe6d4ab05aa4ec991fe7bf2fdcdafe8/27AANCS2882A2Z8_102023_1_Generated.tar.gz?md5=UgwIopl4siaRFfBOvEbs9A&expires=1702880898",
"hash": "9a151372827d97f7496fb2ce4dc48d6ec9c48e277661cf206257e60901ef6530"
}
],
"fc": 1
}
4. Get IRN Json – This API is to get list of IRN Jsons
Sample Sandbox URL:
https://gstsandbox.charteredinfo.com/taxpayerapi/dec/v1.0/einvoice/getIrnJson?action=IRNJSON&gstin=27AANCS2882A1Z9&rtnprd=102024&username=MH_NT2.2274&suptyp=B2B&stin=27AANCS2882A1Z9&ret_period=102024
Sample Success Response:
{"est":"30","token":"55e93db02b07489dbe8e718884d2b9ea"}
Access flow of APIs :
Get IRN List → Get File details → Get IRN details (for each IRN from file details)
Return period includes previous six months and current month. And it is to be supplied as individual month in Get IRN List API.
