IRISGST - API Documentation (2024)

REST APIs for GST, Eway Bill and E-invoicing for taxpayers to integrate directly orvia system integrators.

Integration with Data APIs

Integration for Upload Files

Using IRIS Topaz

The taxpayers system can connect to the NIC system using the IRIS Topaz APIs. The following imagegives an high level view of the interaction between the parties involved i.e. taxpayers systems,IRIS Topaz and NIC systems

Using IRIS Peridot

IRIS Peridot is currently making available the common APIs of GST. These APIs do not require anyuser consent and can be accessed only via GSPs.

More information on data available in these APIs

Taxpayer Search - https://irisgst.com/kb/search-taxpayer/

Return Status - https://irisgst.com/kb/taxpayer-return-status/

Using IRIS Credixo

In IRIS Credixo, any request for information is referred to as Order. There will be severaltypes of Orders. The Order Type covered in this document is GST Data.

IRIS Team will set-up the account for the lender and create the first Admin user. The Admin userwill need to complete the sign-up process. The Admin user can invite other users to access theaccount. User sign-up and management will be done through the web interface of IRIS Credixo.

High level Process Flow for IRIS Credixo API.

Using IRIS Zircon

IRIS IRP is platform for invoice registration. IRIS IRP offers basic e-invoicing APIs and value-added APIs that extend beyond e-invoicing.

Solution providers can sign-up directly on IRIS IRP platform and get access to APIs. More info is available here

Option to get IRIS IRP APIs via IRIS GSP gateway (Zircon) is also available. Solution providers who operate from outside India and do not have Indian IP, can connect to IRIS IRP through GSP gateway. These are passthrough APIs and can be managed using your existing Zircon credentials

High level Integration process

Using IRIS ASAP

IRIS ASAP offers a powerful solution for improving Procure-to-Pay processes. It automates tasks, ensures accuracy, and boosts working capital, leading to better financial management and operations. Key features include real-time invoice processing, GST validation, and centralized document management with strict access controls. It also helps optimize resources and synchronize ledgers for maximum efficiency.

IRIS ASAP is ERP agnostic. Organizations can integrate APIs to push data to IRIS platform and also keep information between ERP and IRIS platform in sync.

APIs for Master Data

The Masters maintained in ERP systems need to use while processing the purchase invoices. Hence Master Data sync between ERP and IRIS platform is necessary. Push mechanism is defined for updates wherein ERPs need to push data at periodic frequency to IRIS ASAP

Masters covered in IRIS ASAP are listed here (create a wiki page and publish list of Masters, along with short description. recommended frequency of pushing data can also be mentioned, whether full data or incremental data etc.)

Using IRIS Sapphire

IRIS Sapphire APIs for GST compliance. Invoices and data from taxpayers systems can be sent toIRIS GST using APIs. Taxpayers will need to use the credentials set on IRIS system and businesshierarchy needs to be set-up on IRIS.For any upload of data to Government system or fetch of data from there (such as GSTR 2A), thesession with GST system via OTP process needs to be established.