HomeGST API

GST API India

GST API India for return filing, reconciliation and compliance

Connect your ERP or software to GST APIs for taxpayer lookup, return filing and amendments, purchase reconciliation, IMS, notices, ledgers, and e-Invoice data.

GST filing workflows

Returns and amendments

Purchase data and IMS

Notices and ledgers

Free Sandbox Access Explore API Docs

Workflow Snapshot

Live

GSTIN Lookup

Supported

Return Filing

Available

IMS & Ledgers

153

API Endpoints

200 OKSample Response

{
  "gstin": "29AADCT2727Q1Z2",
  "legal_name": "ABC Corp Pvt Ltd",
  "status": "Active",
  "state": "Karnataka"
}

GST APIs for your complete workflow

From taxpayer search to filing and reconciliation, choose the API groups your business needs.

Search and authentication

Public taxpayer search, return tracking, OTP authentication, and session management.

Returns and amendments

GSTR-1, GSTR-1A, and GSTR-3B APIs for retrieving, saving, and filing return data.

Purchase data and credits

GSTR-2A, GSTR-2B, and GSTR-2X APIs for purchase records and TDS/TCS credit workflows.

Composition and annual returns

GSTR-4A, GSTR-4 Annual, GSTR-9, and GSTR-9C API groups.

IMS and e-Invoice data

Invoice Management System records and actions, plus GST e-Invoice details and downloads.

Notices, ledgers and status

GST notices, cash and ITC ledgers, return status, preferences, and file downloads.

GST filing guides and API resources

Use the filing guides and reference documentation to plan your integration.

GSTR-1 Filing Help Document

Step-by-step GSTR-1 filing process through API.

Open PDF guide

GSTR-3B Filing Help Document

Step-by-step GSTR-3B filing process through API.

Open PDF guide

GST API Released List

Contact our team for the latest GST API release and version information.

Request release information

GST API Reference Documentation

GST developer portal reference for taxpayer return APIs.

Open API reference

API Workflow

How GST API Works

Authenticate, retrieve GST records, prepare return data, and file returns through documented API workflows.

Authentication

Request an OTP, then obtain a GST auth token

POST /authentication/authtoken

02Primary

GSTIN Details

Query GSTIN to retrieve complete taxpayer and business details

GET /public/search

03Primary

GST Filing Status

Check filing activity, active status, and compliance information

GET /public/rettrack

Purchase Data

Retrieve GSTR-2B data for purchase reconciliation

GET /gstr2b/all

Data Points Retrieved

Complete GST API information available via API

Legal Name

Trade Name

Registration Date

Status

Sales Summary

Purchase Summary

Primary Operations

Flow Direction

153 Endpoints Available

API Reference

Available Endpoints

Explore 153 listed GST endpoints, grouped by workflow for public search, authentication, filings, ledgers, IMS, notices, and e-Invoice data.

Public API

GET/public/search

Search taxpayer details

GET/public/pref

Get GST preference details

GET/public/rettrack

View and track return status

Authentication

POST/authentication/otprequest

Request OTP for GST authentication

POST/authentication/authtoken

Generate GST auth token using OTP

POST/authentication/logout

Logout authenticated GST session

GET/authentication/otpforevc

Generate OTP for EVC flow

GST e-Invoice

GET/gst/einvoice/irnlist

Get IRN list

GET/gst/einvoice/irndtl

Get IRN details

GET/gst/einvoice/irnjsons

Get IRN JSON

GET/gst/einvoice/einvhsn

Get e-Invoice HSN summary

GET/gst/einvoice/filedetl

Get e-Invoice file details

POST/gst/einvoice/filedtl

Download e-Invoice file

GSTR-2A

GET/gstr2a/b2b

Get B2B invoices

GET/gstr2a/b2ba

Get amended B2B invoices

GET/gstr2a/cdn

Get credit and debit note invoices

GET/gstr2a/cdna

Get amended credit and debit note invoices

GET/gstr2a/img

Get import of goods invoices

GET/gstr2a/imgsez

Get import of goods from SEZ invoices

GET/gstr2a/isd

Get ISD details

GET/gstr2a/tcs

Get TCS credit details

GET/gstr2a/tds

Get TDS credit details

GET/gstr2a/ecom

Get e-commerce invoices

GET/gstr2a/ecoma

Get amended e-commerce invoices

GET/gstr2a/amdhist

Get amendment history

GSTR-2B

GET/gstr2b/all

Get GSTR-2B details

PUT/gstr2b/gen2b

Generate GSTR-2B on demand

GET/gstr2b/get2b

Get GSTR-2B generation status

GSTR-2X

GET/gstr2x/tdstcs

GSTR2X - Get TDS-TCS Credit Details

PUT/gstr2x/retsave

GSTR2X - Save

POST/gstr2x/retfile

GSTR2X - File Return

GSTR-1

GET/gstr1/b2b

Get B2B invoices

GET/gstr1/b2ba

Get amended B2B invoices

GET/gstr1/b2cs

Get B2CS invoices

GET/gstr1/b2csa

Get amended B2CS invoices

GET/gstr1/b2cl

Get B2CL invoices

GET/gstr1/b2cla

Get amended B2CL invoices

GET/gstr1/exp

Get export invoices

GET/gstr1/expa

Get amended export invoices

GET/gstr1/cdnr

Get CDNR invoices

GET/gstr1/cdnra

Get amended CDNR invoices

GET/gstr1/cdnur

Get CDNUR invoices

GET/gstr1/cdnura

Get amended CDNUR invoices

GET/gstr1/nil

Get nil rated details

GET/gstr1/at

Get AT details

GET/gstr1/ata

Get amended AT details

GET/gstr1/txp

Get TXP details

GET/gstr1/txpa

Get amended TXP details

GET/gstr1/supeco

Get supply through e-commerce details

GET/gstr1/supecoa

Get amended supply through e-commerce details

GET/gstr1/ecom

Get e-commerce details

GET/gstr1/ecoma

Get amended e-commerce details

GET/gstr1/retsum

Get GSTR-1 Summary

GET/gstr1/hsnsum

Get HSN summary

GET/gstr1/validatehsnsum

Validate HSN summary

GET/gstr1/dociss

Get document issued details

GET/gstr1/einvoice

Get e-Invoices mapped to GSTR-1

PUT/gstr1/save

Save GSTR-1 data

POST/gstr1/reset

Reset GSTR-1 data for a period

POST/gstr1/retfile

File GSTR-1 Return

GSTR-1A

GET/gstr1a/b2b

Get GSTR-1A B2B invoices

GET/gstr1a/b2ba

Get GSTR-1A amended B2B invoices

GET/gstr1a/b2cs

Get GSTR-1A B2CS invoices

GET/gstr1a/b2csa

Get GSTR-1A amended B2CS invoices

GET/gstr1a/b2cl

Get GSTR-1A B2CL invoices

GET/gstr1a/b2cla

Get GSTR-1A amended B2CL invoices

GET/gstr1a/exp

Get GSTR-1A export invoices

GET/gstr1a/expa

Get GSTR-1A amended export invoices

GET/gstr1a/cdnr

Get GSTR-1A CDNR invoices

GET/gstr1a/cdnra

Get GSTR-1A amended CDNR invoices

GET/gstr1a/cdnur

Get GSTR-1A CDNUR invoices

GET/gstr1a/cdnura

Get GSTR-1A amended CDNUR invoices

GET/gstr1a/nilrated

Get GSTR-1A nil rated details

GET/gstr1a/at

Get GSTR-1A AT details

GET/gstr1a/ata

Get GSTR-1A amended AT details

GET/gstr1a/txp

Get GSTR-1A TXP details

GET/gstr1a/txpa

Get GSTR-1A amended TXP details

GET/gstr1a/supeco

Get GSTR-1A supply through e-commerce details

GET/gstr1a/supecoa

Get GSTR-1A amended supply through e-commerce details

GET/gstr1a/ecom

Get GSTR-1A e-commerce details

GET/gstr1a/ecoma

Get GSTR-1A amended e-commerce details

GET/gstr1a/retsum

Get GSTR-1A Summary

GET/gstr1a/hsnsum

Get GSTR-1A HSN Summary

GET/gstr1a/docissu

Get GSTR-1A document issued details

PUT/gstr1a/save

Save GSTR-1A data

POST/gstr1a/reset

Reset GSTR-1A data for a period

POST/gstr1a/retfile

File GSTR-1A Return

GSTR-3B

GET/gstr3b/retsum

Get GSTR-3B Summary

GET/gstr3b/autoliab

Get auto populated liability details

GET/gstr3b/closingbal

Get ITC reversal balance

GET/gstr3b/rcmopnbal

Get RCM opening balance

GET/gstr3b/syscalcintrst

Get system calculated interest

GET/gstr3b/openingbal

Get opening balance

PUT/gstr3b/save

Save GSTR-3B data

PUT/gstr3b/retbkp

Get return breakup

PUT/gstr3b/offset

Offset liability

POST/gstr3b/cmpint

Recompute interest

POST/gstr3b/saveob

Save opening balance

POST/gstr3b/savercbopenbal

Save RCM opening balance

POST/gstr3b/vald

Validate auto calculated data

POST/gstr3b/retfile

File GSTR-3B Return

GSTR-4A

GET/gstr4a/b2b

Get GSTR4A B2B Details

GET/gstr4a/b2ba

Get GSTR4A B2BA Details

GET/gstr4a/cdnr

Get GSTR4A CDNR Details

GET/gstr4a/cdnra

Get GSTR4A CDNRA Details

GET/gstr4a/tds

Get GSTR4A TDS Details

GSTR-4 Annual

GET/gstr4x/autopop

GSTR4 Annual - Get Auto Populated Details

GET/gstr4x/txios

GSTR4 Annual - Get Inward Outward Supply Details

GET/gstr4x/cmptds

GSTR4 Annual - Get TDSCMP Summary Details

GET/gstr4x/validategstr4x

GSTR4 Annual - Get Validate Liability Details

GET/gstr4x/validateaato

GSTR4 Annual - Get Validate Turnover Details

GET/gstr4x/getsum

GSTR4 Annual - Get Summary Details

PUT/gstr4x/save4x

GSTR4 Annual - Save

POST/gstr4x/retfile

GSTR4 Annual - File Return

GSTR-9

GET/gstr9/getdet

Get GSTR-9 details

GET/gstr9/getautocal

Get auto calculated details

GET/gstr9/getHsndetails

Get GSTR-9 HSN details

GET/gstr9/get8adetails

Get GSTR-9 8A details

PUT/gstr9/retsave

Save GSTR-9 data

PUT/gstr9/create8adetails

Create updated 8A details

POST/gstr9/retfile

File GSTR-9 Return

GSTR-9C

GET/gstr9c/retsum

Get GSTR-9C Summary

GET/gstr9c/getrecds

Get GSTR-9C records

POST/gstr9c/retfile

File GSTR-9C Return

PUT/gstr9c/retsave

Save GSTR-9C data

IMS

PUT/ims/save

Save IMS data

PUT/ims/reset

Reset IMS data

GET/ims/status

Get IMS status

GET/ims/invoices

Get section-wise IMS invoices

GET/ims/invoicescount

Get section-wise IMS invoice count

GET/ims/supplierInvoices

Get supplier invoices in IMS

GET/ims/rejectedInvoices

Get rejected IMS invoices

GET/ims/getfile

Get IMS file token

POST/ims/DownloadFIle

Download IMS file

Ledger

GET/ledgers/cashdtl

Get cash ledger details

GET/ledgers/itc

Get ITC ledger details

GET/ledgers/tax

Get tax ledger details

GET/ledgers/bal

Get ITC balance

GET/ledgers/itcblocktrandetls

Get ITC block transaction details

GET/ledgers/revrclmdtl

Get reversal reclaimed details

GET/ledgers/negliabstmt

Get negative liability statement

GET/ledgers/rcmldg

Get RCM liability ledger

GET/ledgers/nonReturnLedger

Get non-return ledger details

All API Overview

GET/all/newretstatus

Get new return status

GET/all/filedet

Get processed file details

GET/all/returnFillingStatus

Get return filing status

GET/all/getPreference

Get preference details

GET/all/getDocumentDownload

Get document download details

PUT/all/savePreference

Save GST preferences

POST/all/newProcessFile

Start new file process

Return Files

POST/return/downloadfile

Download GST return file

Notices

GET/notices/noticelist

Get notice list

GET/notices/noticedetails

Get notice details

Use Cases

Powering Business Filing & Validation

See how businesses use our GST API to manage filings, validate vendors, and assess risk.

Vendor Onboarding

Instantly validate vendor GST details during onboarding to reduce compliance risk and avoid fraudulent suppliers.

GSTIN validationCompliance checkAuto-fill details

Invoice Validation

Validate GST data on purchase invoices before claiming Input Tax Credit and sync filing workflows faster.

ITC validationReturn status checkGST filing

Risk Assessment

Assess business risk by analyzing GST filings, sales and purchase data, and compliance track record.

Filing historySales dataRisk indicators

FAQ

GST API Questions.

Common questions about GST API integration, sandbox access, bulk processing, and ERP compatibility.

What is a GST API?

A GST API allows businesses to automate GST-related processes such as invoice generation, GST verification, return filing, and compliance workflows.

How does GST API integration work?

The API connects ERP, accounting, or billing software with GST systems for automated data exchange and compliance processing.

Who can use GST APIs?

GST APIs can be used by enterprises, ERP providers, SaaS platforms, accounting software companies, and businesses managing GST operations.

Does PeriOne support bulk GST processing?

Yes, PeriOne APIs support bulk processing for invoices, GST verification, and compliance-related transactions.

Is sandbox testing available for GST APIs?

Yes, sandbox access is available for testing and development before moving to production environments.

Which ERP systems are supported?

PeriOne supports GST integration with SAP, Oracle, Tally, and custom ERP systems.

Is GST API integration secure?

Yes, PeriOne APIs use secure authentication and encrypted communication for safe and reliable transactions.

Does PeriOne provide GST API documentation?

Yes, detailed GST API documentation with request and response examples is available for developers and integration teams.

Start Building Today

Ready to connect your GST workflows?

Start in sandbox, confirm the data contract your team needs, and then move the validated flow into production.

Free Sandbox Access Explore API Docs