ClearTax Docs
Subscribe for Updates
  • Introduction to ClearTax APIs
  • ☁️Clear Finance Cloud
    • Introduction to Clear Finance Cloud
    • Learn Clear Finance Cloud Basics
      • API client
      • Access token
      • FTP client
      • How to get Custom Upload Template ID?
    • CFC API Reference
      • Resources and Masters
        • Sale Document Line Object
        • Purchase Document Line Object
      • Generate Access Token API
      • Ingestion API
        • Ingest Documents via File
          • Get Pre-signed URL
          • Upload File to Storage
          • Trigger File Ingestion
          • Get File Ingestion Status
        • (Deprecated) Ingest Documents via JSON
    • Notifications
  • 🇮🇳GLS API
    • GLS API Reference
      • Resources and Masters
      • Advanced Ingestion API Reference
        • Get Pre-signed URL
        • Upload File to Storage
        • Create Ingestion Activity
        • Get Ingestion Activity Status
  • 🇮🇳GST API
    • Introduction to GST API
    • GST 2.0 API Reference
      • Upload Documents
    • GST FTP Magnet
  • 🇮🇳Max ITC API
    • Introduction to Max ITC API
    • Getting Started with Max ITC API
    • Max ITC API Reference
      • Resources and Masters
        • Input and output templates
        • Error Code Master
        • Learn Max ITC API Architecture
      • Max ITC APIs
        • Fetch Max ITC Configuration
        • Upload Purchase Documents
          • Ingest PR via File
          • (Deprecated) Ingest PR via JSON
        • Trigger Max ITC Workflow
        • Get Max ITC Results
        • Postman Collection
    • Max ITC FTP Magnet
  • 🇮🇳TDS API
    • Introduction to TDS API
    • TDS API Reference
      • Resources and Masters
        • Deduction Document Line Objects
        • Output Template(Error)
      • TDS APIs
        • Upload Deductions
          • Ingest Deductions via File
            • Get Pre-signed URL
            • Upload File to Storage
            • Trigger File Ingestion
            • Get File Ingestion Status
          • (Deprecated) Ingest Deductions via JSON
  • 🇮🇳E-Invoicing API
    • Introduction to E-Invoicing API
    • Learn E-Invoicing API Basics
      • How to get E-Invoicing User Auth Token?
      • How to scan the E-Invoice QR code?
      • How to add GSTIN to E-Invoicing?
        • Clear IRP API Credentials
    • Learn E-waybill API Basics
    • E-Invoicing API Reference
      • Setting up your account
      • Clear Schema
        • Generate IRN
        • Cancel IRN
        • Get E-Invoice PDF
        • Get E-Invoice by IRN
        • Generate E-Waybill by IRN
        • Generate E-Waybill for Non-IRN documents
        • Bulk Generate E-Waybill for Non-IRN documents
        • Cancel E-Waybill
        • Get E-Waybill PDF
        • Update E-Waybill Transporter ID
        • Update E-Waybill Part-B
        • Extend E-Waybill Validity
        • Generate/Regenerate Consolidated EWB
        • Get Consolidated EWB PDF
        • Initiate Multi-Vehicle E-Waybills
        • Update EWB Status from NIC
        • Download E-waybills by Others
        • Get E-Waybill Download Status
        • Get E-Waybills
        • Get latest E-Waybill status from Government
        • Generate B2C Payment QR Code
          • Generate B2C Payment QR Code (Lite)
        • Get Signed PDF
        • Sign PDF API Base 64 Encoded
        • Send an E-Invoice via Email
        • Get Invoice Details
      • Government Schema
        • Generate IRN
        • Cancel IRN
        • Get Invoice by IRN
        • Generate E-Waybill by IRN
      • Resources and Masters
        • E-Invoice Object
        • Country Code Master
        • State Code Master
        • Pincode Master
        • Pincode State Mapping Pattern
        • Port Code Master
        • Currency Code Master
        • UQC Master
        • Tax Rates
        • Error Codes
    • E-Invoicing FTP Magnet
  • 🇮🇳Invoicing API
    • Invoicing API Reference
      • Create an Invoice
      • Create Document (Non-Sale)
      • Download PDF of a Document
      • Get Document details
      • Resources and Master
        • Country Master
        • State Master
        • Pincode Master
        • Port Master
        • Currency Master
        • Unit Master
        • Document Types
        • Supply Types
  • 🇲🇾E-INVOICING MALAYSIA API
    • E-Invoicing Malaysia API Reference
      • Resources and Masters
        • Error resolution guide
        • Frequently asked questions (FAQs)
        • E-Invoice Object
      • Generate Access Token API
      • Malaysia E-Invoicing APIs
        • Generate E-Invoice for a Document
        • Status Check for Submitted E-Invoice
        • Cancel E-Invoice
        • Upload E-Invoice
        • Get Documents
        • Get E-Invoice PDF
        • Get Document via UUID
        • Delete Invoice
        • Send Bulk Email
        • Search Taxpayer Tin API
  • E-Invoicing FTP Magnet (XML)
  • E-Invoicing FTP Magnet (Excel)
  • 🇸🇦E-Invoicing KSA API
    • Introduction to E-Invoicing KSA API
    • Learn E-Invoicing KSA API Basics
      • How to get E-Invoicing KSA Auth Token?
      • How to add a VAT number to KSA E-Invoicing Account?
      • How to add Branch for existing Vat to KSA E-Invoicing Account ?
      • How to register a device for a VAT?
      • How to generate OTP on ERAD Portal?
      • How to get Print Template ID?
      • KSA E-Invoicing Integration Architecture
    • E-Invoicing KSA API Reference
      • Resources and Masters
        • E-Invoice Object
        • Error Details Object
        • Data Types
        • Code Lists
        • Common Errors and Resolution
      • Authentication
      • Generate Access Token API
      • KSA E-Invoicing APIs
        • Generate E-Invoice
          • Additional Standard (B2B) E-Invoice Examples
          • Additional Simplified (B2C) E-Invoice Examples
        • Generate E-Invoice Async
        • Generate E-Invoice via XML
        • Send Signed E-Invoice XML To ZATCA
        • Get Bulk Invoice Lite
        • Get Invoice
        • Get E-Invoice PDF
        • Get E-Invoice PDF/A-3 with PDF API
        • Register Device
        • Get PCSID Generation Status
        • Renew PCSID
        • Generate E-Invoice (Phase I)
        • Generate QR Code (Phase I)
        • Generate Device ID
        • Generate CSID and PCSID
        • Send E-Invoice via Email
        • Add Business units API
    • E-Invoicing KSA FTP Magnet
    • E-Invoicing KSA XML reporting FTP Magnet
  • 🧩Add-ons and Extensions
    • SAP Add-on
      • SAP Connectivity Checklist
        • Steps to import SSL/TLS certificates in SAP
        • Steps to check ICM settings in SAP
        • Steps to test connectivity in SAP
        • Steps to troubleshoot connectivity issues in SAP
    • Tally Add-on
  • Microsoft Dynamics 365(F&O)
  • General
    • Go-Live Cutover Activity Checklist
    • How to check DNS resolution?
    • How to check hostname reachability?
    • How to check if hostname is trusted?
    • How to get the SSL certificate of a host?
  • ⭐GST GSP API
    • Introduction to GST GSP API
    • Getting Started with GST GSP API
    • GST GSP API Reference
      • Sample API
    • Migrating from Karvy GST GSP
  • ⭐E-Waybill GSP API
    • Introduction to E-Waybill GSP API
    • Getting Started with EWB GSP API
      • How to register EWB GSP on NIC?
      • Sandbox GSTIN for EWB GSP
    • E-Waybill GSP API Reference
      • Sample API
    • Migrating from Karvy EWB GSP
  • ⭐E-Invoicing GSP API
    • Introduction to E-Invoicing GSP API
    • Getting Started with EINV GSP API
      • How to register EINV GSP on IRP?
      • Sandbox GSTIN for EINV GSP
    • E-Invoicing GSP API Reference
      • Sample API
  • Subscribe for Updates
  • 🚫(Deprecated) GST 1.0 API
    • (Deprecated) Introduction to GST API
    • (Deprecated) Learn GST API Basics
    • (Deprecated) Getting Started with GST API
      • (Deprecated) How to set up ClearTax account?
      • (Deprecated) How to authenticate API requests?
      • (Deprecated) How to upload an invoice from File?
      • (Deprecated) How to create custom import template?
    • (Deprecated) GST 1.0 API Reference
      • Taxpayer Information
      • (Deprecated) Invoices
      • (Deprecated) Bills of Supply
      • (Deprecated) Credit Debit Notes (CDN)
      • (Deprecated) Advances
      • (Deprecated) Resources and Masters
        • (Deprecated) How to read GST error response
        • (Deprecated) Unit of Measurement master
        • (Deprecated) State master
        • (Deprecated) Document Classification/Section Name master
      • (Deprecated) Items
      • (Deprecated) Contacts
      • (Deprecated) GST File Upload API Reference
  • 🚫Deprecated E-Waybill API
    • (Deprecated) Introduction to E-Waybill API
    • (Deprecated) Learn E-Waybill API Basics
    • (Deprecated) Getting Started with E-Waybill API
    • (Deprecated) E-Waybill API Reference
      • (Deprecated) Resources and Masters
        • (Deprecated) Unit Master
        • (Deprecated) State Master
        • (Deprecated) Error Master
      • (Deprecated) E-Waybill JSON API Reference
        • (Deprecated) Generating E-Waybill
        • (Deprecated) Getting E-Waybill
        • (Deprecated) Updating E-Waybill
        • (Deprecated) Extending Validity of E-Waybill
        • (Deprecated) Multi-vehicle E-Waybill
        • (Deprecated) Printing E-Waybill
        • (Deprecated) Cancelling E-Waybill
        • (Deprecated) Generating Consolidated E-Waybill
        • (Deprecated) Getting Consolidated E-Waybill
        • (Deprecated) Regenerating Consolidated E-Waybill
        • (Deprecated) Printing Consolidated E-Waybill
      • (Deprecated) E-Waybill File Upload API Reference
        • (Deprecated) Creating or Updating Documents
        • (Deprecated) Getting Upload Status
        • (Deprecated) Getting Upload Validation
        • (Deprecated) Getting Upload History
        • (Deprecated) Rate Limiting & Best Practices
    • (Deprecated) E-Waybill FTP Magnet
Powered by GitBook
On this page
  • SAP CPI Customers
  • Prerequisites
  • Register ClearTax as GSP on NIC
  • Download ClearTax GSP SSL certificate
  • Obtain Externalized Parameters
  • Step by step guide
  • Error Codes
  • Other ERP or Mode

Was this helpful?

  1. E-Waybill GSP API

Migrating from Karvy EWB GSP

PreviousSample APINextIntroduction to E-Invoicing GSP API

Last updated 1 year ago

Was this helpful?

Karvy EWB GSP is acquired by ClearTax. The current Karvy APIs will be deprecated by 30th June 2020. Migrate now.

SAP CPI Customers

If you are currently using Karvy iflow in your SAP CPI, you can migrate to ClearTax quickly by following the below steps.

Prerequisites

  1. SAP EWB GSP Integration Guide (.pdf file).

  2. SAP Cloud Integration Platform - Integration Flow Content package (.zip file).

  3. SAP Cloud Integration Platform - Router Content package (.zip file).

  4. NIC server public key (Sandbox and Production) (.zip file).

  5. Register ClearTax as GSP on NIC.

  6. ClearTax GSP SSL certificate (Sandbox and Production) (.cer file).

  7. Externalized Parameters (Sandbox and Production)

There is no change in points 1 to 4 above.

Register ClearTax as GSP on NIC

For the list of sandbox GSTIN username and password, .

To register ClearTax as GSP in NIC portal for production, follow this guide:

Download ClearTax GSP SSL certificate

You can download the SSL certificates below:

Obtain Externalized Parameters

You need to change only 3 parameters: karvyclient_secret, karvy_auth_url and karvy_ewaybill_url.

Sandbox

Update the following parameters with the new values:

Parameter

Value

karvyclientid

<same karvyclientid as before>

karvyclient_secret

<please check your email or write to integrations-support@cleartax.in>

karvy_auth_url

https://api-sandbox.clear.in/ewb-gsp/v1.03/auth

https://ewb-gsp-staging.internal.cleartax.co/ewb-sandbox/v1.03/authenticate

karvy_ewaybill_url

https://api-sandbox.clear.in/ewb-gsp/v1.03/ewayapi

https://ewb-gsp-staging.internal.cleartax.co/ewb-sandbox/v1.03/ewayapi

Production

Update the following parameters with the new values:

Parameter

Value

karvyclientid

<same karvyclientid as before>

karvyclient_secret

<please write to integrations-support@cleartax.in>

karvy_auth_url

https://api.clear.in/ewb-gsp/v1.03/auth

https://ewb-gsp.cleartax.in/ewb/v1.03/authenticate

karvy_ewaybill_url

https://api.clear.in/ewb-gsp/v1.03/ewayapi

https://ewb-gsp.cleartax.in/ewb/v1.03/ewayapi

The following parameters will remain the same in both sandbox and production.

Parameter

Value

nicpkalias

niccert

nic_token_expiry

300

Note: NIC public key alias value is alias you have entered as same as the alias of the NIC public key certificate you deployed (niccert).

Step by step guide

In your Subaccount > Applications > Subscriptions corresponding to your sandbox (pre-production), select the Web UI URL something like: https://xxx-xxx.xxx.xxx.hana.ondemand.com/itspaces

Step 1 – Add and deploy keystore

To deploy keystore, in SCPI Web UI URL, go to Monitor > Manage Security > Keystore > Add keystore (add an alias and select the ClearTax SSL certificate) > Deploy > Confirm.

Note: To perform above operation, you need to be a tenant administrator with role AuthGroup.Administrator.

Step 2 – Test connection

To check the connectivity with GSP, in SCPI Web UI URL, go to Monitor > Manage Security > Connectivity Tests > TLS > Enter the ClearTax EWB GSP base URL without https (ewb-gsp-staging.internal.cleartax.co for sandbox and ewb-gsp.cleartax.in for production) and port > Send. The reponse should be successful.

Step 3 – Update and deploy GSP iflow

In SCPI Web UI URL, To update the GSP iflow, go to Design > select E-Waybill package > Artifacts > against the gsp iflow, click on actions icon > configure > Define the externalized parameters as provided by ClearTax. Once parameters are updated, click save and then deploy.

After successful deployment, check the integration flows are in Started state by choosing Monitor > Manage Integration Content.

Step 4 – Add user credentials per GSTIN from NIC provided by your GSP .

In SCPI Web UI URL, To add user credentials, go to Monitor > Manage Security > Security Material > Add > User Credentials > Deploy.

You can follow the same steps to configure production environment also.

We highly recommend you to test the entire flow with all scenarios in the sandbox environment before moving to production.

In case there is any change in the API in the future, you will have to update the iFlow which will be provided by ClearTax.

Error Codes

Other ERP or Mode

If you are using SAP but not CPI, OR if you are not using SAP, please follow this guide:

In case you need root certificate, you can download it from .

In case you have received an error code from NIC, you can check the description of the code here:

⭐
click here
How to register EWB GSP on NIC?
https://docs.ewaybillgst.gov.in/apidocs/api-error-codes-list.html
Getting Started with EWB GSP API
1KB
EWB_GSP_SSL_Sandbox.cer
ClearTax EWB GSP Sandbox SSL
1KB
wildcard.cleartax.in.cer
ClearTax EWB GSP Production SSL
here