E-Invoicing API Reference
ClearTax E-Invoicing has 2 environments:
Sandbox Environment
Production Environment
For testing, it is recommended to always use the sandbox environment.
For API requests to the sandbox environment, use the below information.
Host:
https://einvoicing.internal.cleartax.co
Please note, the above URL is for API requests only. The corresponding frontend web application URL where you can log in and verify the data is https://e-invoicing-frontend-staging-pub-cf.internal.cleartax.co/​
Port: 443
IP: ClearTax recommends using the hostname always. In case you do not use public DNS, for the E-Invoicing sandbox environment, below are the IPs that the hostname has to resolve to.
75.2.104.91
AND 99.83.130.139
SSL Certificate:
Our root Certifying Authority is "Amazon Root CA 1". You can get the CER or PEM file directly from Amazon's website here: https://www.amazontrust.com/repository/ or download it here.
In case you want to add the SSL certificate of our sandbox host to your trust manager, you can download it here.
Host:
https://api-einv.cleartax.in
Please note, the above URL is for API requests only. The corresponding frontend web application URL where you can log in and verify the data is https://einv.cleartax.in/​
Port: 443
IP: ClearTax recommends using the hostname always. In case you do not use public DNS, for the E-Invoicing production environment, below are the IPs that the hostname has to resolve to.
76.223.59.133
AND 13.248.191.113
SSL Certificate:
In case you want to add the SSL certificate of our sandbox host to your trust manager, you can download it here.
ClearTax E-Invoicing provides 2 kinds of APIs:
Government Compatible APIs
ClearTax E-Invoicing APIs
These are synchronous APIs that cater to basic e-invoicing functionalities and the schema is compatible with the schema provided by the government.
Generate IRN
Cancel IRN
Get Invoice by IRN
These APIs are available for consumption in the staging environment.
Actions | Government Compatible API |
ClearTax API |
Generating IRN | Y | Y |
Ability to send Custom fields | N | Y |
Retry IRN Generation (for invoices failed due to IRP failures) | N | Y |
Invoice Validation | Y | Y |
Generating IRN (Bulk) | N | Y |
Canceling IRN | Y | Y |
Getting IRN details | Y | Y |
Printing E-invoice | Y | Y |
