.png%3Falt%3Dmedia%26token%3Defeac660-e2da-45e4-b0d4-af3da505ef72){kind=spacer}
.png%3Falt%3Dmedia%26token%3Defeac660-e2da-45e4-b0d4-af3da505ef72){kind=spacer}
E-Invoicing API Reference
ClearTax E-Invoicing has 2 environments:
- 1.Sandbox Environment
- 2.Production Environment
For testing, it is recommended to always use the sandbox environment.
For API requests to the sandbox environment, use the below information.
For API requests to the sandbox environment, use the below information.
API Type | Hostname | IP |
|---|---|---|
E-Invoicing | https://api-sandbox.clear.in | 75.2.104.91 AND 99.83.130.139 |
Please note that 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-sandbox.cleartax.in
Port: 443
TLS Versions Supported: TLS 1.2, TLS 1.1, and TLS 1.0.
For detailed information on how to download the host, intermediate, and root certificates, you can always refer to How to get SSL Certificate. Alternatively, you can also download the certificates directly from the below links.
API Type | Certificate(s) |
|---|---|
E-Invoicing | wildcard.clear.in.cer go-daddy-intermediate.cer go-daddy-root.cer |
The following SSL certificates are supported for backward compatibility with the old hostname (https://einvoicing.internal.cleartax.co). In case you are implementing it for the first time, ignore the below certificates.
API Type | Certificate(s) |
|---|---|
E-Invoicing | wildcard.internal.cleartax.co.cer amazon intermediate.cer amazon root.cer |
For API requests to the production environment, use the below information.
API Type | Hostname | IP |
|---|---|---|
E-Invoicing | https://api.clear.in
| 13.248.191.113 AND 76.223.59.133 |
For implementations done prior to 1st May 2022, the following additional hostnames will have to be whitelisted.
API Type | Hostname | IP |
|---|---|---|
E-Invoicing | https://api-einv.cleartax.in | 76.223.59.133 AND 13.248.191.113 |
Please note that 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
TLS Versions Supported: TLS 1.2, TLS 1.1, and TLS 1.0.
For detailed information on how to download the host, intermediate, and root certificates, you can always refer to How to get SSL Certificate. Alternatively, you can also download the certificates directly from the below links.
For hostname | Certificate(s) |
|---|---|
api.clear.in | wildcard.clear.in.cer go-daddy-intermediate.cer go-daddy-root.cer |
For implementations done prior to 1st May 2022, where the hostname is
api-einv.cleartax.in, the following SSL certificates may be required and are listed here for reference only.For hostname | Certificate(s) |
|---|---|
api-einv.cleartax.in (before 3rd August 2022) | api-einv.cleartax.in.cer rapidssl_tls_dv_rsa_mixed.cer DigiCert.cer |
api-einv.cleartax.in (from 3rd August 2022) | api-einv.cleartax.in.cer rapidssl_intermediate.cer digicert_root.cer |
ClearTax E-Invoicing provides 2 kinds of APIs:
- 1.Government Compatible APIs
- 2.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 |
Last modified 6mo ago