API Documentation

This API helps to generate E-Invoice.

Generate E-Invoice API plays an important role in the generation of an e-invoice. The taxpayer shall enter the details of their invoice into the accounting/peripheral system. The data is then sent through the API to the Invoice Registration Portal (IRP). The invoice shall get registered under the IRP, an IRN gets generated, and the invoice is sent back as part of the API response along with the digitally signed e-invoice and QR Code.

Data to Test Integration

HeaderData
SELLER-GSTIN24AAAPI3182M002
IRP-USERNAMEtest_24_001
IRP-PASSWORDTrial63$value

Authorization

Authorization will be of Basic Type. Key Value and Secret Value shall be entered as authorization tokens.

Key Valuehylo_1242_bf18f7c9e196ae89
Secret Value$2a$10$vhAGOlRBeAkMN9w5DpKIJ.bvF

SAMPLE REQUEST

{
    "EInvoiceRequest": {
        "Version": "1.1",
        "Irn": "",
        "TranDtls": {
            "TaxSch": "GST",
            "SupTyp": "B2B",
            "RegRev": "N",
            "IgstOnIntra": "N"
        },
        "DocDtls": {
            "Typ": "INV",
            "No": "175G/597753",
            "Dt": "21/07/2023"
        },
        "SellerDtls": {
            "Gstin": "24AAAPI3182M002",
            "LglNm": "India Inc.",
            "Addr1": "43/3 WHITEFIELD",
            "Loc": "Bharuch",
            "Pin": 320008,
            "Stcd": "24"
        },
        "BuyerDtls": {
            "Gstin": "24AAACC1206D1ZM",
            "LglNm": "ABC India",
            "Pos": "24",
            "Addr1": "Building 3C Tower A",
            "Addr2": "6th Floor 22256 Kings Way",
            "Loc": "AHMEDABAD",
            "Pin": 380007,
            "Stcd": "24"
        },
        "ValDtls": {
            "AssVal": 140,
            "CgstVal": 8.4,
            "SgstVal": 8.4,
            "IgstVal": 0,
            "CesVal": 0,
            "StCesVal": 0,
            "TotInvVal": 156.8
        },
        "DispDtls": {
            "Nm": "India Inc.",
            "Addr1": "43/3 WHITEFIELD",
            "Loc": "Bharuch",
            "Pin": 320008,
            "Stcd": "24"
        },
        "ShipDtls": {
            "Gstin": "24AAACC1206D1ZM",
            "LglNm": "ABC India",
            "TrdNm": "ABC India",
            "Addr1": "Building 3C Tower A",
            "Addr2": "6th Floor 22256 Kings Way",
            "Loc": "AHMEDABAD",
            "Pin": 380007,
            "Stcd": "24"
        },
        "RefDtls": {
            "DocPerdDtls": {
                "InvStDt": "21/07/2023",
                "InvEndDt": "31/07/2023"
            }
        },
        "ItemList": [
            {
                "SlNo": "1",
                "PrdDesc": "Room Rent",
                "IsServc": "Y",
                "HsnCd": "996311",
                "UnitPrice": 140,
                "TotAmt": 140,
                "AssAmt": 140,
                "GstRt": 12,
                "TotItemVal": 156.8,
                "Qty": 1,
                "FreeQty": 0,
                "Unit": "UNT",
                "Discount": 0,
                "PreTaxVal": 0,
                "SgstAmt": 8.4,
                "CgstAmt": 8.4,
                "IgstAmt": 0,
                "CesRt": 0,
                "CesAmt": 0,
                "StateCesRt": 0,
                "StateCesAmt": 0,
                "StateCesNonAdvlAmt": 0,
                "CesNonAdvlAmt": 0,
                "OthChrg": 0
            }
        ],
        "EwbDtls": {
            "Distance": 0
        }
    }
}

Sample Response

{
    "Code": "0",
    "Message": "E-Invoice generated successfully",
    "Status": "APPROVED",
    "EInvoice": {
        "AckNo": "162410050911888",
        "AckDt": "2024-09-05 02:06:29",
        "Irn": "f0219ca5071a8dcd0e78b2011da5dfe0eddd7614491bb90b85cce2591c8a68f0",
        "SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxNjI0MTAwNTA5MTE4ODgsXCJBY2tEdFwiOlwiMjAyNC0wOS0wNSAwMjowNjoyOVwiLFwiSXJuXCI6XCJmMDIxOWNhNTA3MWE4ZGNkMGU3OGIyMDExZGE1ZGZlMGVkZGQ3NjE0NDkxYmI5MGI4NWNjZTI1OTFjOGE2OGYwXCIsXCJWZXJzaW9uXCI6XCIxLjFcIixcIlRyYW5EdGxzXCI6e1wiVGF4U2NoXCI6XCJHU1RcIixcIlN1cFR5cFwiOlwiQjJCXCIsXCJSZWdSZXZcIjpcIk5cIixcIklnc3RPbkludHJhXCI6XCJOXCJ9LFwiRG9jRHRsc1wiOntcIlR5cFwiOlwiSU5WXCIsXCJOb1wiOlwiMTc1Ry81OTc3NTNcIixcIkR0XCI6XCIyMS8wNy8yMDIzXCJ9LFwiU2VsbGVyRHRsc1wiOntcIkdzdGluXCI6XCIyNEFBQVBJMzE4Mk0wMDJcIixcIkxnbE5tXCI6XCJJbmRpYSBJbmMuXCIsXCJBZGRyMVwiOlwiNDMvMyBXSElURUZJRUxEXCIsXCJMb2NcIjpcIkJoYXJ1Y2hcIixcIlBpblwiOjMyMDAwOCxcIlN0Y2RcIjpcIjI0XCJ9LFwiQnV5ZXJEdGxzXCI6e1wiR3N0aW5cIjpcIjI0QUFBQ0MxMjA2RDFaTVwiLFwiTGdsTm1cIjpcIkFCQyBJbmRpYVwiLFwiUG9zXCI6XCIyNFwiLFwiQWRkcjFcIjpcIkJ1aWxkaW5nIDNDIFRvd2VyIEFcIixcIkFkZHIyXCI6XCI2dGggRmxvb3IgMjIyNTYgS2luZ3MgV2F5XCIsXCJMb2NcIjpcIkFITUVEQUJBRFwiLFwiUGluXCI6MzgwMDA3LFwiU3RjZFwiOlwiMjRcIn0sXCJEaXNwRHRsc1wiOntcIk5tXCI6XCJJbmRpYSBJbmMuXCIsXCJBZGRyMVwiOlwiNDMvMyBXSElURUZJRUxEXCIsXCJMb2NcIjpcIkJoYXJ1Y2hcIixcIlBpblwiOjMyMDAwOCxcIlN0Y2RcIjpcIjI0XCJ9LFwiU2hpcER0bHNcIjp7XCJHc3RpblwiOlwiMjRBQUFDQzEyMDZEMVpNXCIsXCJMZ2xObVwiOlwiQUJDIEluZGlhXCIsXCJUcmRObVwiOlwiQUJDIEluZGlhXCIsXCJBZGRyMVwiOlwiQnVpbGRpbmcgM0MgVG93ZXIgQVwiLFwiQWRkcjJcIjpcIjZ0aCBGbG9vciAyMjI1NiBLaW5ncyBXYXlcIixcIkxvY1wiOlwiQUhNRURBQkFEXCIsXCJQaW5cIjozODAwMDcsXCJTdGNkXCI6XCIyNFwifSxcIkl0ZW1MaXN0XCI6W3tcIkl0ZW1Ob1wiOjAsXCJTbE5vXCI6XCIxXCIsXCJJc1NlcnZjXCI6XCJZXCIsXCJQcmREZXNjXCI6XCJSb29tIFJlbnRcIixcIkhzbkNkXCI6XCI5OTYzMTFcIixcIlF0eVwiOjEsXCJVbml0XCI6XCJVTlRcIixcIlVuaXRQcmljZVwiOjE0MCxcIlRvdEFtdFwiOjE0MCxcIkFzc0FtdFwiOjE0MCxcIkdzdFJ0XCI6MTIsXCJDZ3N0QW10XCI6OC40LFwiU2dzdEFtdFwiOjguNCxcIlN0YXRlQ2VzTm9uQWR2bEFtdFwiOjAsXCJUb3RJdGVtVmFsXCI6MTU2Ljh9XSxcIlZhbER0bHNcIjp7XCJBc3NWYWxcIjoxNDAsXCJDZ3N0VmFsXCI6OC40LFwiU2dzdFZhbFwiOjguNCxcIlRvdEludlZhbFwiOjE1Ni44fSxcIlJlZkR0bHNcIjp7XCJEb2NQZXJkRHRsc1wiOntcIkludlN0RHRcIjpcIjIxLzA3LzIwMjNcIixcIkludkVuZER0XCI6XCIzMS8wNy8yMDIzXCJ9fSxcIkV4cER0bHNcIjp7XCJSZWZDbG1cIjpcIk5cIn0sXCJFd2JEdGxzXCI6e1wiRGlzdGFuY2VcIjowfX0iLCJpc3MiOiJOSUMgU2FuZGJveCJ9.iG8R3GH4WvCZrv9qvpU4KKWHMCw0dMA3corH3QMcvyOUnfxfo4kHVZze6oj4MtM89b-A-03jdv7bJriT4R1-SID7belXVuYupjhudeJW418gaGc-rpMqAWGvBiAD6gtjoVpLkB8FP4PZzKJsqkUtHFea0ptD9X17LHexIbNXWuijmZHvC5i4cD_E2C1CbzilKK9l23kt1DFcfKDHGzL9CT9ci1u-eo9B-SGSVK0nG2kiRh0inuboGm0sKPXc5gM3J6kKP5PQ_GNJ0Q-V0rr0kGgFX6xfpCJ5uejRU3AATD0-dz7K4zoL281XvoYjID49AYZaQyWoHFDT-jmGnv29VA",
        "SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjE1MTNCODIxRUU0NkM3NDlBNjNCODZFMzE4QkY3MTEwOTkyODdEMUYiLCJ4NXQiOiJGUk80SWU1R3gwbW1PNGJqR0w5eEVKa29mUjgiLCJ0eXAiOiJKV1QifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI0QUFBUEkzMTgyTTAwMlwiLFwiQnV5ZXJHc3RpblwiOlwiMjRBQUFDQzEyMDZEMVpNXCIsXCJEb2NOb1wiOlwiMTc1Ry81OTc3NTNcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMjEvMDcvMjAyM1wiLFwiVG90SW52VmFsXCI6MTU2LjgsXCJJdGVtQ250XCI6MSxcIk1haW5Ic25Db2RlXCI6XCI5OTYzMTFcIixcIklyblwiOlwiZjAyMTljYTUwNzFhOGRjZDBlNzhiMjAxMWRhNWRmZTBlZGRkNzYxNDQ5MWJiOTBiODVjY2UyNTkxYzhhNjhmMFwiLFwiSXJuRHRcIjpcIjIwMjQtMDktMDUgMDI6MDY6MjlcIn0iLCJpc3MiOiJOSUMgU2FuZGJveCJ9.0kKa5tzpfFqzYA1uaQvLwZQbUTUS-iXkaeLUwdtmciiL1lFNbnNuX3zxjSiludBM8yqEYNeP22lLShJZwkDPpKpr71xDXE6DswIr1T_Hf6PmohRpa9lKDFdJsOQD9dwRlTJvX0KPrUliPxYSdycNd27hGuzzjKkdQM_udeM-Y28sQ2nPFhjAzSm8-O29oXKM-t5Za8rkqbHXoKvgkE_o71ZLhTSy3kTWZ8gDb3AfKzAUVCSYdOBRGLEbKRCc8n-6SXjka9Ikcbpk_XXfP76Gmonz6YzOIqaYBPLKlS_2iGYdLpDxVusdd0jfqfC8giir9zQbNfQf2uRxMexC22lKoQ",
        "Status": "ACT"
    }
}

Questions? Contact Us 📧 [email protected]

Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!