E-Invoice

Learn more about payouts APIs and their usage.

If supply is made through E-Commerce then GSTIN of E-Commerce operator can be mentioned hereGuidelines

Below are some of the points you must be aware of while calling Payouts APIs:

  • All API requests and responses are in JSON format.

  • POST requests should include ContentType: application/json

  • All API response have status, message, and data.

  • Swipez uses API keys to allow access to the API. Once you have signed up at our merchant site, you will be able to see your AccessKey and SecretKey.

Quick Refer

Authentication

Calling the Authentication APIs allows you to get and verify bearer tokens returned by Swipez. Swipez require these token for all further communication.

  • Swipez libraries automatically call the Authorize API and internally store the token.

  • Do not store the token in an insecure manner. Regenerating a new token does not invalidate the already generated token. Token generated from one IP address cannot be used from a different IP address.

  • Token generated is valid for 60 Min . Please ensure that you get a new token by calling the authorize API once the token has expired.

Rate limiting

The API is rate limited per user. You will receive a 429 HTTP status code if you exceed the rate limit. The rate limit is 30 requests per minute per user and is subject to change.

Get token

POST /api/token

This endpoint allows you to get API token.

Request Body

{
    "success": {
        "token": "<GENERATED TOEKN>"
    }
}

Sample code

curl --location --request POST '<BASE URL>/api/token' \
--form 'access_key_id="<GET ACCESS KEY ID FROM YOUR ACCOUNT>"' \
--form 'secret_access_key="<GET SECRET ACCESS KEY FROM YOUR ACCOUNT>"'

Save E-invoice

POST /api/v1/einvoice/save

This endpoint allows you to add E-invoice.

Headers

Request Body

{
  "status": "SUCCESS",
  "message": "operation performed successfully",
  "response": {
    "qrCode": "iVBORw0KGgoAAAANSUhEUgAAAPoAAAD6AQAAAACgl2eQAAAHfklEQVR42u2ZzYpdOw6FBZoK9CoGTQ1+dYOnBr2KQFODejmQqknT2z1penALAknly8nZlrV+TlH9569J/wD/AP9zIKgdV21kRqm7x5TNk2QQPwJZdqxZp+rmZEVSIt54jHwFuI1GPaibjjZq7p4iIdrsGbA5W3KObhQ7zYelSuZ/AXSOPunw8EkzTgs+Zr7egWqdJKMdoQwOGSvIhfz3HD6AwBn/26/fWXwAVacvvE/tti38tMp0Txm/9+EDiOjFHKxSGrRzZ+M2a6/Nr8Cc1hpr20S8zFaRUt++x3gEanKSci45zmv1Gn0V7xrxCkTf6bPxDt4dL902HrObtPRXwNhkp7bCm7Tk7V5u2ZvxI5Ajcx3ua9tYk+Iok1Yna/oKOLWm4kXlA0PCbc3sXpKvQJ37a7Q9SGeT07bGHrH3ykcgZpdkWYOarD7LT80xVGmsV4Bi4JglMPS1G23D8pym/nMfvoCTBAXBiHV5qxJISC2bxX8P6hOofSBb1LyfPdauKRi9mGjWI5AbM17VaFruNQ/2fqXtye6PwOlpQwmXhqFAwl25t2WunR+BaozvCx6wihIPWx2X3xdk9REIm9CsvaDevsN7c/zpUKnnI1DEXD6Zl3pAEhnfwJUNIn8ETgbEh3FI2NpYtpJjmOP4xiMQuObB1iZmbVY7C+qOLTB7BlbARlaOMSElG54CZ8AI82f9v4DTiAhbay1wZUPp2oG31UgfAbwSVA+WuqO3kNlxTjBG0fJXQEgNV2RBtTBoqVSMDJK4X4HQyZI0ZTSNeXVgYvQsZK9AOW3p5Qoba+JbsPsMfXetZyAi+5jQU45cLWBn/QRgfgROs7C1p2PXRI0Twu7dHdf2EQi60km1ETCwQt36hAiYYJcfgeuJss5ISIjBUXWH5sQ/+3vlPoGYuC2am05DuCmCPa5UHN6PNX8BiWBBLQdm7WdWu3tUUCHq4xXQs/sQOoXDXTTCI7diVn/H/QkgHsmeR1NHZ4Elt4CA5bBhj0DUVX+bPHNKIi36Ysf8ScYjgN1PN+cSSMiEDuMZXaDGP4vzBcDDmuGA98D6FHKmdt/VFGr2CBRWZGXiqh9kTmVFVEw1wUm9Aow5H6SqoQfvdyM8qkKM4c2PAKy5xjhYeTd4opwS3P91qOsjgEQlh/CAO3YsMXae+zSfqx6BgB3waozrJniTQ3rD/d1YQHsFIMVxVoadyRG+kbaQ/hxDfAQON/QGWACUkLE7uUB02Mrvpf0AkJKX04ryawRaAXtyjDsjHwHYQXUlhNTZgkSgQexENslfgYmEgNO+GWvfOz8ROelAkOoRQGzeJrJRwlx5DdgbGgA2IccjEEjpyP+InHNPeMpRvL0DPfwJe1/AuS1sIReUIuxAiF2bFCPAvgLRseuRhOOKWbXmDGVBIxmvwMF9Zxp+s2LPxFH1SoII/ES1L6B0m+OpfKOKwghCkRiPbR31CrTeNZceW2MwRmVXPZri6xFA+RI5yImGJoxCrVhFXB5lW49AtnHPlrCtG730uhNkuTB3fwRCEPZjOuIBDsh7oHtggUXPKwBHmZAeQw8OmMtqtaClm0Z/BhQmAm+1gfy+m1d2CTSC9XOSX0AKmtc5C7EZ4d8Rk/rA+of+leJPIE6cJojKI32F3I8pWKCr80eKPwGBlWn2a9FLW1ojRK6p+xk4fHqnree435iFVuttnrm6PwI4WfLczpDBHjUOBl2CEvFzkl8AHhM2PANHhohxC/VA2Ej/3c0v4BAymqIsEBc6IbRoEly6NeZHACaC1oa4Ng4kfO7ihD+gYEY9Arj3cAL4z58W4R0loi30Kfu1gw8gkKkUjrQGDB4HBXdNwe9RZx6BM+nWSKye0eTWEcQJbRIPm49AIGjGqIG4hhe+jbJQrbtor0fg4M/INZZ4yZ63AzJKxMJ3n4FxkGkUGti0AW3IBvg9gnc+AnEGxjJykKk1ZAMkRcSTDNJXYAdqHNpgawoVYt9XylXWzkfgEOk+affjJk144sDeo0bJ0VfgCmZB+4234Lri5BuURJjqEUCBwk13rIliXxBXYSdYHUzgFUjUwBXoUQJv3RDTPfgK6Z8m9gQcOAgbDBEGciPWWmYJi3wHYk2UHybFlC0w7pOY+i2V/giUjNU7sm4b90MjhoS2NjcCyisQZyKUoUoOJBxp50xDj8t9/tbJTwBn2ife2bSFvypBWMol93n9EcChnH6m3o/fFvLZvE+KBz+/1vwBoAQLShxGnveYeC9ae6v8hL1v4MoH4j+3+8npQBlKONL92ClfARyQKeXqyCl2BVAtMHSIwiNQmDL6XHcUyTX2hhh2Pfh/fz6f/ARuVJwN0udxfz7QBR0ADQAF/xWAIUTClCfGheRPji7FCJA/H6J+AXhZ0on6gFqMcOWwM9sEm/yxgy/gz49I5A4Kd+TGA2gqZg0tWa8A20AgQGVABcFL2/lTphbReAbQXLDzc2ihfqFD4NxHp/xrrA9AD7ofPOLvaKJbIqzVWAgJ4xWAkeLqQ8YIZRRJ834CBSX8/YjjCwjYQJ7pfV0J2zH6xOagBBx7BP75yeA/wP8V8C/LfRb3Y34pFQAAAABJRU5ErkJggg==",
    "no": "1809961",
    "id": 51587,
    "genBy": "amit.nandha@irisbusiness.com",
    "genByName": "Amit Nandha",
    "status": "ACT",
    "ackNo": 112010005963729,
    "ackDt": "2020-09-19 00:23:00",
    "irn": "0c3e498d5cb6380ceb2c8fe7a0d27702662bc9742d2d0aa6c11e3daead23362f",
    "signedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVEQzU3REUxMzU4QjMwMEJBOUY3OTM0MEE2Njk2ODMxRjNDODUwNDciLCJ0eXAiOiJKV1QiLCJ4NXQiOiI3Y1Y5NFRXTE1BdXA5NU5BcG1sb01mUElVRWMifQ.eyJkYXRhIjoie1wiQWNrTm9cIjoxMTIwMTAwMDU5NjM3MjksXCJBY2tEdFwiOlwiMjAyMC0wOS0xOSAwMDoyMzowMFwiLFwiSXJuXCI6XCIwYzNlNDk4ZDVjYjYzODBjZWIyYzhmZTdhMGQyNzcwMjY2MmJjOTc0MmQyZDBhYTZjMTFlM2RhZWFkMjMzNjJmXCIsXCJWZXJzaW9uXCI6XCIxLjAxXCIsXCJUcmFuRHRsc1wiOntcIlRheFNjaFwiOlwiR1NUXCIsXCJTdXBUeXBcIjpcIkIyQlwiLFwiUmVnUmV2XCI6XCJOXCIsXCJJZ3N0T25JbnRyYVwiOlwiTlwifSxcIkRvY0R0bHNcIjp7XCJUeXBcIjpcIklOVlwiLFwiTm9cIjpcIjE4MDk5NjFcIixcIkR0XCI6XCIyOC8wOC8yMDIwXCJ9LFwiU2VsbGVyRHRsc1wiOntcIkdzdGluXCI6XCIyOUFBQUNJOTI2MFIwMDBcIixcIkxnbE5tXCI6XCJOQUhBUlNQR01JTExTTFREKFBMT1QtMzczKVwiLFwiVHJkTm1cIjpcIk5BSEFSU1BHTUlMTFNMVEQoUExPVC0zNzMpXCIsXCJBZGRyMVwiOlwiKFBST1AuTkFIQVJTUEdNSUxMU0xURC4pXCIsXCJBZGRyMlwiOlwiSEVBRE9GRklDRVwiLFwiTG9jXCI6XCJMVURISUFOQVwiLFwiUGluXCI6NTg3MjAxLFwiU3RjZFwiOlwiMjlcIn0sXCJCdXllckR0bHNcIjp7XCJHc3RpblwiOlwiMjNBQUFDTjU3MTBEMVo0XCIsXCJMZ2xObVwiOlwiTkFIQVJTUEdNSUxMU0xURC5VTklULUVYVFwiLFwiVHJkTm1cIjpcIk5BSEFSU1BHTUlMTFNMVEQuVU5JVC1FWFRcIixcIlBvc1wiOlwiMjdcIixcIkFkZHIxXCI6XCJWSUxMU0lNUkFJLE1BTkRJREVFUCxcIixcIkxvY1wiOlwiTUFORElERUVQXCIsXCJQaW5cIjo0NTc4ODcsXCJQaFwiOlwiMDc0ODAyMzMwOTFcIixcIlN0Y2RcIjpcIjIzXCJ9LFwiSXRlbUxpc3RcIjpbe1wiSXRlbU5vXCI6MCxcIlNsTm9cIjpcIjEwXCIsXCJJc1NlcnZjXCI6XCJOXCIsXCJIc25DZFwiOlwiNjMxMFwiLFwiUXR5XCI6MS4wMCxcIkZyZWVRdHlcIjowLjAwMCxcIlVuaXRcIjpcIk5PU1wiLFwiVW5pdFByaWNlXCI6MjUwMDAwLjAwLFwiVG90QW10XCI6MjUwMDAwLjAwLFwiRGlzY291bnRcIjowLjAwLFwiUHJlVGF4VmFsXCI6MC4wMCxcIkFzc0FtdFwiOjI1MDAwMC4wMCxcIkdzdFJ0XCI6MC4wMCxcIklnc3RBbXRcIjowLjAwLFwiQ2dzdEFtdFwiOjAuMDAsXCJTZ3N0QW10XCI6MC4wMCxcIkNlc1J0XCI6MC4wMCxcIkNlc0FtdFwiOjAuMDAsXCJDZXNOb25BZHZsQW10XCI6MC4wMCxcIlN0YXRlQ2VzUnRcIjowLjAwLFwiU3RhdGVDZXNBbXRcIjowLjAwLFwiT3RoQ2hyZ1wiOjAuMDAsXCJUb3RJdGVtVmFsXCI6MjUwMDAwLjAwLFwiQXR0cmliRHRsc1wiOlt7XCJObVwiOlwiMDAwMDEwXCIsXCJWYWxcIjpcIjAuMDBcIn1dfV0sXCJWYWxEdGxzXCI6e1wiQXNzVmFsXCI6MjUwMDAwLjAwLFwiQ2dzdFZhbFwiOjAuMDAsXCJJZ3N0VmFsXCI6MC4wMCxcIkNlc1ZhbFwiOjAuMDAsXCJTdENlc1ZhbFwiOjAuMDAsXCJEaXNjb3VudFwiOjAuMDAsXCJPdGhDaHJnXCI6MC4wMCxcIlJuZE9mZkFtdFwiOjAuMDAsXCJUb3RJbnZWYWxcIjoyNTAwMDAuMDAsXCJUb3RJbnZWYWxGY1wiOjAuMDB9LFwiUGF5RHRsc1wiOntcIkNyRGF5XCI6MCxcIlBhaWRBbXRcIjowLjAwLFwiUGF5bXREdWVcIjowLjAwfSxcIlJlZkR0bHNcIjp7fSxcIkV3YkR0bHNcIjp7XCJUcmFuc0lkXCI6XCIyOUFBQUNJOTI2MFIwMDBcIixcIlRyYW5zTmFtZVwiOlwiQUJDXCIsXCJUcmFuc01vZGVcIjpcIjFcIixcIkRpc3RhbmNlXCI6OTU2LFwiVHJhbnNEb2NOb1wiOlwiMTAyOVwiLFwiVHJhbnNEb2NEdFwiOlwiMjgvMDgvMjAyMFwiLFwiVmVoTm9cIjpcIk1IMDFZVTEyMzRcIixcIlZlaFR5cGVcIjpcIlJcIn19IiwiaXNzIjoiTklDIn0.HilzZ9FaMBOdyQ1mmDiNrZcb7-Zm3vYUaJyHBzMVw258S1QuG11W4aA48q9KV_Ck-0DEmGsJlj37K2klLRfSu5TVZL1RtclkiLvGCIDFVH-AR8VX5pvuGi6gUfPvfcUNn2b9WA7Qiafe63sn2FIQzSTLBXU9hETuN54hlckwOJ0rnkdYLee5m7BjwaGgeEcQnCM4I2CHJuDBy2wj73iERXRTbp_w0vADQCz48huOYNtkULXeL3FbIa3EbNp8fZgKqEV8tmje1oqAvmTRxm89h2OOEALEoBwLxisuydLY_-W3i0osQvmXB57fTfc5o8OGOSa8V-c9JdkwUbnwlKznAw",
    "signedQrCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IkVEQzU3REUxMzU4QjMwMEJBOUY3OTM0MEE2Njk2ODMxRjNDODUwNDciLCJ0eXAiOiJKV1QiLCJ4NXQiOiI3Y1Y5NFRXTE1BdXA5NU5BcG1sb01mUElVRWMifQ.eyJkYXRhIjoie1wiU2VsbGVyR3N0aW5cIjpcIjI5QUFBQ0k5MjYwUjAwMFwiLFwiQnV5ZXJHc3RpblwiOlwiMjNBQUFDTjU3MTBEMVo0XCIsXCJEb2NOb1wiOlwiMTgwOTk2MVwiLFwiRG9jVHlwXCI6XCJJTlZcIixcIkRvY0R0XCI6XCIyOC8wOC8yMDIwXCIsXCJUb3RJbnZWYWxcIjoyNTAwMDAuMDAsXCJJdGVtQ250XCI6MSxcIk1haW5Ic25Db2RlXCI6XCI2MzEwXCIsXCJJcm5cIjpcIjBjM2U0OThkNWNiNjM4MGNlYjJjOGZlN2EwZDI3NzAyNjYyYmM5NzQyZDJkMGFhNmMxMWUzZGFlYWQyMzM2MmZcIixcIklybkR0XCI6XCIyMDIwLTA5LTE5IDAwOjIzOjAwXCJ9IiwiaXNzIjoiTklDIn0.szP6ZIees02yz4j4-AIiuTjdiJTYRZPqz9QK4lcZPvx5yY6awP5DG3wn7DuLFA4VMU4KJ4rNN2tv1lSkKM9EHYgCqivj7qCNt9J5KGZAwjSc4RH8MWbUrz3KLvRC_dc5EVGlYqeAsQFdW9DWqf_w8o7PsitwJ8yPaz-KUo07Qr95djEubynB7u7e3crw6t706aPrmRqmCNF-Hne5ZYfe0yQK7xjkWMob9j-G9geCeLUoNwNygFGPnoFvMIm1tk5OAfxTnXSZR1mW14kd8v1eArWlFViZHWmCcngCsnBken5cIUQWW_pPxK3H5_YD2ZzTHn9G9zNaPTslKnhJoG0KWA",
    "EwbNo": "191008719181",
    "EwbDt": "2020-09-19 00:24:00",
    "EwbValidTill": "2020-09-29 23:59:00"
  }
}

Sample code

curl --location --request POST '<BASE URL>/api/v1/einvoice/save' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userGstin": "01AAACI9260R002",
    "pobCode": null,
    "supplyType": "O",
    "ntr": "Inter",
    "docType": "RI",
    "catg": "B2B",
    "dst": "O",
    "trnTyp": "REG",
    "no": "AG/03-09/4565",
    "dt": "28-03-2021",
    "refinum": null,
    "refidt": null,
    "pos": "27",
    "diffprcnt": null,
    "etin": null,
    "rchrg": "N",
    "sgstin": "01AAACI9260R002",
    "strdNm": "TEST Company",
    "slglNm": "TEST PROD",
    "sbnm": "Testing",
    "sflno": "ABC",
    "sloc": "BANGALOR32",
    "sdst": "BENGALURU",
    "sstcd": "01",
    "spin": "192233",
    "sph": "123456111111",
    "sem": "abc123@gmail.com",
    "bgstin": "02AAACI9260R002",
    "btrdNm": "TEST ENTERPRISES",
    "blglNm": "TEST PRODUCT",
    "bbnm": "ABCD12345",
    "bflno": "abc",
    "bloc": "Jijamat",
    "bdst": "BANGALORE",
    "bstcd": "02",
    "bpin": "174001",
    "bph": "989898111111",
    "bem": "abc123@gmail.com",
    "dgstin": null,
    "dtrdNm": null,
    "dlglNm": null,
    "dbnm": null,
    "dflno": null,
    "dloc": null,
    "ddst": null,
    "dstcd": null,
    "dpin": null,
    "dph": null,
    "dem": null,
    "togstin": null,
    "totrdNm": null,
    "tolglNm": null,
    "tobnm": null,
    "toflno": null,
    "toloc": null,
    "todst": null,
    "tostcd": null,
    "topin": null,
    "toph": null,
    "toem": null,
    "sbnum": null,
    "sbdt": null,
    "port": null,
    "expduty": 1234,
    "cntcd": null,
    "forCur": null,
    "invForCur": null,
    "taxSch": "GST",
    "totinvval": 4262.73,
    "totdisc": 10,
    "totfrt": null,
    "totins": null,
    "totpkg": null,
    "totothchrg": 20,
    "tottxval": 3322.45,
    "totiamt": 930.28,
    "totcamt": 0,
    "totsamt": 0,
    "totcsamt": 0,
    "totstcsamt": 0,
    "rndOffAmt": 0,
    "sec7act": "N",
    "invStDt": null,
    "invEndDt": null,
    "invRmk": null,
    "omon": null,
    "odty": null,
    "oinvtyp": "B2CL",
    "octin": null,
    "userIRN": null,
    "payNm": null,
    "acctdet": null,
    "pa":null,
    "mode": null,
    "ifsc": null,
    "payTerm": null,
    "payInstr": null,
    "crTrn": null,
    "dirDr": null,
    "crDay": null,
    "balAmt": null,
    "paidAmt": null,
    "payDueDt": null,
    "transId": null,
    "subSplyTyp": "Supply",
    "subSplyDes": null,
    "kdrefinum": null,
    "kdrefidt": null,
    "transMode": null,
    "vehTyp": null,
    "transDist": "",
    "transName": null,
    "transDocNo": null,
    "transDocDate": null,
    "vehNo": null,
    "clmrfnd": null,
    "rfndelg": null,
    "boef": null,
    "fy": null,
    "refnum": null,
    "pdt": null,
    "ivst": null,
    "cptycde": null,
    "gen1": "abcd",
    "gen2": "abcd",
    "gen3": "abcd",
    "gen4": "abcd",
    "gen5": "abcd",
    "gen6": "abcd",
    "gen7": "abcd",
    "gen8": "abcd",
    "gen9": "abcd",
    "gen10": "abcd",
    "gen11": "abcd",
    "gen12": "abcd",
    "gen13": "abcd",
    "gen14": "PJTCG001",
    "gen15": "abcd",
    "gen16": "abcd",
    "gen17": "abcd",
    "gen18": "abcd",
    "gen19": "abcd",
    "gen20": "abcd",
    "gen21": "abcd",
    "gen22": "abcd",
    "gen23": "abcd",
    "gen24": "abcd",
    "gen25": "abcd",
    "gen26": "abcd",
    "gen27": "abcd",
    "gen28": "abcd",
    "gen29": "abcd",
    "gen30": "abcd",
    "pobewb": "Null",
    "pobret": "Null",
    "tcsrt": "null",
    "tcsamt": 0,
    "pretcs": 0,
    "genIrn": true,
    "genewb": "N",
    "signedDataReq": true,
    "itemList": [
      {
        "barcde": null,
        "bchExpDt": null,
        "bchWrDt": null,
        "bchnm": null,
        "camt": 0,
        "cesNonAdval": 0,
        "stCesNonAdvl": 0,
        "crt": 0,
        "csamt": 0,
        "csrt": 0,
        "disc": 0,
        "freeQty": 0,
        "hsnCd": "73041190",
        "iamt": 930.28,
        "irt": 28,
        "isServc": null,
        "itmgen1": null,
        "itmgen2": null,
        "itmgen3": null,
        "itmgen4": null,
        "itmgen5": null,
        "itmgen6": null,
        "itmgen7": null,
        "itmgen8": null,
        "itmgen9": null,
        "itmgen10": null,
        "itmVal": 4252.73,
        "num": "00001",
        "ordLineRef": null,
        "orgCntry": null,
        "othchrg": 0,
        "prdDesc": null,
        "prdNm": "SEAMLESS STEEL TUBE 10X2 -U71889903",
        "prdSlNo": null,
        "preTaxVal": 0,
        "qty": 1,
        "rt": 28,
        "samt": 0,
        "srt": 0,
        "stcsamt": 0,
        "stcsrt": 0,
        "sval": 3322.45,
        "txp": null,
        "txval": 3322.45,
        "unit": "NOS",
        "unitPrice": 3322.451,
        "invItmOtherDtls": [
          {
            "attNm": "aaa",
            "attVal": "aaa"
          },
          {
            "attNm": "xyz",
            "attVal": "2300"
          }
        ]
      }
    ],
    "invOthDocDtls": [
      {
        "url": "www.google.com",
        "docs": "This is the url",
        "infoDtls": "abcd"
      }
    ],
    "invRefPreDtls": [
      {
        "oinum": null,
        "oidt": null,
        "othRefNo": null
      }
    ],
    "invRefContDtls": [
      {
        "raref": null,
        "radt": null,
        "tendref": null,
        "contref": null,
        "extref": null,
        "projref": null,
        "poref": null,
        "porefdt": null
      }
    ]
  }'

E-invoice cancel

POST /api/v1/einvoice/cancel

This endpoint allows you to cancel invoice.

Headers

{"status":"SUCCESS","message":"operation performed successfully","response":{"irn":"a287f526ec393d69a6202156d285e2e508902dedda1ed3daeadda8a5c2696a6d","cancelDate":"2020-02-06 19:30:00"},"fieldErrors":null,"errors":null}

Sample code

curl --location --request POST '<BASE URL>/api/v1/einvoice/cancel' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
	"irn":"a287f526ec393d69a6202156d285e2e508902dedda1ed3daeadda8a5c2696a6d",
	"cnlRsn":"1",
	"cnlRem":"Wrong entry",
	"userGstin":"01AAACI9260R002"
}'

E-invoice list

POST /api/v1/einvoice/list

This endpoint allows you to get invoice list.

Headers

{
  "status": "SUCCESS",
  "message": "Einvoices filtered successfully",
  "response": {
    "data": [
      {
        "einvId": 371,
        "docType": "RI",
        "catg": "B2B",
        "docNo": "P001",
        "docDt": "01/01/2020",
        "bgstin": "33GSPTN0121G1ZP",
        "btrdNm": "Big basket Ltd",
        "invStatus": "UPLOADED",
        "totinvval": 22356,
        "numItems": 0,
        "hasError": true,
        "hasWarning": true
      }
    ],
    "pageNumber": 0,
    "numberOfElements": 1,
    "totalElements": 1,
    "totalPages": 1
  },
  "fieldErrors": null,
  "errors": null
}

Sample code

curl --location --request POST '<BASE URL>/api/v1/einvoice/list' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "gstin": "01AAACI9260R002",
    "docNo": [
        "12369"
    ],
    "fromDt": "19/02/2020",
    "toDt": "19/02/2020",
    "btrdNm": "Aamir Traders",
    "catg": [
        "B2B"
    ],
    "docType": [
        "RI"
    ],
    "invStatus": [
        "UPLOADED",
        "IRN_GENERATED"
    ],
    "irnStatus": [
        "ACT",
        "CAN"
    ],
    "totinvval": {
        "gt": "8000"
    },
    "itemCount": {
        "gt": "0"
    },
    "hasError": false,
    "hasWarning": true,
    "page": 0,
    "size": 50
}'

Get invoice details

GET /api/v1/einvoice/details

This endpoint allows you to get the invoice details.

Query Parameters

Headers

Request Body

{
    "status": "SUCCESS",
    "message": "Einvoice ftched successfully",
    "response": {
      "einvId": 332,
      "supplyType": "O",
      "docType": "RI",
      "catg": "B2B",
      "docNo": "123652",
      "docDt": "12/05/2019",
      "trnTyp": "REG",
      "bgstin": "28AAACG0569P1Z3",
      "btrdNm": "LAKSHMI ENTERPRISES",
      "itemList": [
        {
          "prdNm": "WHEAT AND MESLIN",
          "prdDesc": "WHEAT AND MESLIN",
          "hsnCd": "1001",
          "qty": 2,
          "unit": "BAG",
          "unitPrice": 100,
          "sval": 200,
          "txval": 205,
          "rt": 18,
          "iamt": 0,
          "camt": 0,
          "samt": 0,
          "csamt": 1,
          "stcsamt": 2,
          "errors": [
            {
              "errorId": 1920,
              "fieldName": "txval",
              "type": "ERROR",
              "description": "If docTyp = RI/BS then Assessable amount/ Taxable amount should be item Total Amount - Discount + Other charges.",
              "lineItemIdFk": 1196
            },
            {
              "errorId": 1921,
              "fieldName": "rt",
              "type": "ERROR",
              "description": "Tax rates and amounts should not be present for Nil exempt and Non-gst supplies.",
              "lineItemIdFk": 1196
            },
            {
              "errorId": 1922,
              "fieldName": "crt",
              "type": "ERROR",
              "description": "CGST rate should not be filled for inter-state transactions.",
              "lineItemIdFk": 1196
            },
            {
              "errorId": 1923,
              "fieldName": "srt",
              "type": "ERROR",
              "description": "SGST rate should not be filled for inter-state transactions.",
              "lineItemIdFk": 1196
            }
          ],
          "hasError": false,
          "hasWarning": false
        }
      ],
      "irnStatus": "ACT",
      "totinvval": 12400,
      "hasError": false,
      "hasWarning": false,
      "ntr": "INTER",
      "dst": "O",
      "rchrg": "Y",
      "pos": 4,
      "etin": "37BZNPM9430M1KL",
      "sgstin": "29ACQPN4602B000",
      "strdNm": "AMBIKA CEMENTS",
      "sbno": "1",
      "sbnm": "AMBIKA CEMENTS",
      "sflno": "2",
      "sloc": "BENGALURU",
      "sdst": "BENGALURU",
      "sstcd": 29,
      "spin": 560090,
      "sph": 9898989898,
      "sem": "abc123@gmail.com",
      "bbno": "785",
      "bbnm": "test",
      "bflno": "ab",
      "bloc": "BANGALORE",
      "bdst": "BANGALORE",
      "bstcd": 29,
      "bpin": 560054,
      "bph": 9898989898,
      "bem": "abc123@gmail.com",
      "dstcd": 0,
      "dpin": 0,
      "dph": 9898989898,
      "tostcd": 0,
      "topin": 0,
      "toph": 0,
      "cntcd": "IN",
      "taxSch": "GST",
      "tottxval": 10000,
      "totiamt": 0,
      "totcamt": 1200,
      "totsamt": 1200,
      "totstcsamt": 0,
      "totcsNonAdVal": 0,
      "sec7act": "Y",
      "crDay": 0,
      "ackNo": 10100041122,
      "ackDt": "2020-02-05T11:56:00.000+0000",
      "irn": "fa1a2a58b37173b241f2bea41f97621e125fbd9cd982eed64fc3ae2b4abe95a5"
    },
    "fieldErrors": null,
    "errors": null
  }
curl --location --request GET '<BASE URL>/api/v1/einvoice/details?einvId=2133' \
--header 'Authorization: Bearer <TOKEN>' \
--header 'Content-Type: application/json' \

Sample code

Last updated