> For the complete documentation index, see [llms.txt](https://docs.cleartax.in/cleartax-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.cleartax.in/cleartax-docs/e-invoicing-api/e-invoicing-api-reference/cleartax-e-invoicing-apis-xml-schema/b2b-e-invoicing-apis/get-invoice-details.md).
# Get Invoice Details
You can use this API to fetch the IRN details from Clear Database either by providing IRN or a combination of Document Number, Type, Date and Seller GSTIN.
### Request Method
GET
### Request URL
```
{{host}}/einv/v1/einvoices/detail
```
### Request Headers
| Parameter | Data Type | Field Validations | Description |
| --------------------- | --------- | ----------------- | ------------------------------------------------------------------------ |
| x-cleartax-auth-token | String | Cannot be empty | Mandatory. User auth token. |
| gstin | String | Cannot be empty | Mandatory. This is the GSTIN of the business, as registered on ClearTax. |
### Request Path Params
This API does not require any path parameters. All required inputs are sent via query parameters or headers.
### Request Query Params
| Parameter | Data Type | Field Validations | Description |
| -------------- | --------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| irn | String | Optional | The Invoice Reference Number (IRN) of the e-invoice. Either irn OR the below document details are mandatory. |
| documentNumber | String | Mandatory if irn is not supplied | Invoice/Document number of the transaction. |
| documentType | String | Mandatory if irn is not supplied | Type of the document (INV, CRN, DBN, etc.). |
| documentDate | String | Mandatory if irn is not supplied | Invoice/Document date in dd/mm/yyyy format. |
| sellerGstin | String | Mandatory if irn is not supplied | Seller's GSTIN associated with the transaction. |
### Request Body
No request body is required for this API; all required parameters are passed as query parameters or headers.
### Response Status Codes
| HTTP Status Code | Description |
| ---------------- | ---------------------------------------------------------------------------- |
| 200 | For a successfully processed request (may be a success or validation error). |
| 401 | If the user is not authenticated for the operation. |
| 403 | If the user is not authorized for the operation. |
| 500 | If there are any unhandled exceptions on the Clear side. |
### Response Schema
| Parameter | Data Type | Field Validations | Description |
| ------------ | ------------ | ----------------- | ----------------------------------------------------------------------- |
| success | Boolean | - | True. when there is success.
False. When there is some error.
|
| errorDetails | Error Detail | - | When there is some failure. This will contain error details. |
#### Error Detail Object
| Parameter | Data Type | Field Validations | Description |
| -------------- | --------- | ---------------------------------- | ------------------------------------------------------------ |
| error\_code | String | - | - |
| error\_message | String | - | Description, stating the reason due to which request failed. |
| error\_source | String | ENUM(
CLEARTAX,
GOVT)
| Source from which error has come. |
### Sample Request and Response
#### Request:
N/A
#### Response - Success:
**HTTP Status Code - 200**
```json
{
"EinvoiceDetails": {
"Version": "1.1",
"Irn": "1e60d7816bfcac5418e06f6ce58f6ba3518494f0c006da93a5db9f78418de8e6",
"TranDtls": {
"TaxSch": "GST",
"RegRev": "N",
"SupTyp": "B2B",
"IgstOnIntra": "N"
},
"DocDtls": {
"Typ": "INV",
"No": "IC2000",
"Dt": "17/04/2025"
},
"SellerDtls": {
"Gstin": "29AAFCD5862R000",
"LglNm": "NIC Company Pvt Ltd",
"TrdNm": "NIC Industries",
"Addr1": "5th block, kuvempu layout",
"Addr2": "kuvempu layout",
"Loc": "GANDHINAGAR",
"Pin": 560037,
"Stcd": "29",
"Ph": "9000000000",
"Em": "abc@gmail.com"
},
"BuyerDtls": {
"Gstin": "29AWGPV7107B1Z1",
"LglNm": "XYZ Company Pvt Ltd",
"TrdNm": "XYZ Industries",
"Pos": "12",
"Addr1": "7th block, kuvempu layout",
"Addr2": "kuvempu layout",
"Loc": "GANDHINAGAR",
"Pin": 562160,
"Stcd": "29",
"Ph": "91111111111",
"Em": "xyz@yahoo.com"
},
"DispDtls": {
"Nm": "ABC company pvt ltd",
"Addr1": "7th block, kuvempu layout",
"Addr2": "kuvempu layout",
"Loc": "Banagalore",
"Pin": 562160,
"Stcd": "29"
},
"ShipDtls": {
"Gstin": "29AWGPV7107B1Z1",
"LglNm": "CBE company pvt ltd",
"TrdNm": "kuvempu layout",
"Addr1": "7th block, kuvempu layout",
"Addr2": "kuvempu layout",
"Loc": "Banagalore",
"Pin": 562160,
"Stcd": "29"
},
"ItemList": [
{
"SlNo": "1",
"PrdDesc": "Rice",
"IsServc": "N",
"HsnCd": "10019920",
"Barcde": "123456",
"Qty": 100.345,
"FreeQty": 10.000,
"Unit": "BAG",
"UnitPrice": 99.545,
"TotAmt": 9988.84,
"Discount": 10.00,
"PreTaxVal": 1.00,
"AssAmt": 9978.84,
"GstRt": 12.00,
"IgstAmt": 1197.46,
"CgstAmt": 0.00,
"SgstAmt": 0.00,
"CesRt": 5.00,
"CesAmt": 498.94,
"CesNonAdvlAmt": 10.00,
"StateCesRt": 12.00,
"StateCesAmt": 1197.46,
"StateCesNonAdvlAmt": 5.00,
"OthChrg": 10.00,
"TotItemVal": 12897.70,
"OrdLineRef": "3256",
"OrgCntry": "AG",
"PrdSlNo": "12345",
"BchDtls": {
"Nm": "123456",
"ExpDt": "01/08/2020",
"WrDt": "01/09/2020"
},
"AttribDtls": [
{
"Nm": "Rice",
"Val": "10000"
}
]
}
],
"ValDtls": {
"AssVal": 9978.84,
"CgstVal": 0.00,
"SgstVal": 0.00,
"IgstVal": 1197.46,
"CesVal": 508.94,
"StCesVal": 1202.46,
"Discount": 10.00,
"OthChrg": 20.00,
"RndOffAmt": 0.30,
"TotInvVal": 12908.00,
"TotInvValFc": 12897.70
},
"PayDtls": {
"Nm": "ABCDE",
"AccDet": "5697389713210",
"Mode": "Cash",
"FinInsBr": "SBIN11000",
"PayTerm": "100",
"PayInstr": "Gift",
"CrTrn": "test",
"DirDr": "test",
"CrDay": 100,
"PaidAmt": 10000.00,
"PaymtDue": 5000.00
},
"RefDtls": {
"InvRm": "TEST",
"DocPerdDtls": {
"InvStDt": "01/08/2020",
"InvEndDt": "01/09/2020"
},
"PrecDocDtls": [
{
"InvNo": "DOC/002",
"InvDt": "01/08/2020",
"OthRefNo": "123456"
}
],
"ContrDtls": [
{
"RecAdvRefr": "Doc/003",
"RecAdvDt": "01/08/2020",
"TendRefr": "Abc001",
"ContrRefr": "Co123",
"ExtRefr": "Yo456",
"ProjRefr": "Doc-456",
"PORefr": "Doc-789",
"PORefDt": "01/08/2020"
}
]
},
"AddlDocDtls": [
{
"Url": "https://einv-apisandbox.nic.in",
"Docs": "Test Doc",
"Info": "Document Test"
}
],
"ExpDtls": {
"ShipBNo": "A-248",
"ShipBDt": "01/08/2020",
"Port": "INABG1",
"RefClm": "N",
"ForCur": "AED",
"CntCode": "AE"
},
"EwbDtls": {
"TransId": "12AWGPV7107B1Z1",
"TransName": "XYZ EXPORTS",
"TransMode": "1",
"Distance": 100,
"TransDocNo": "Doc01",
"TransDocDt": "17/04/2025",
"VehNo": "ka123456",
"VehType": "R"
}
},
"CustomFields": {
"customfieldLable1": "CustomFieldValue1",
"customfieldLable2": "CustomFieldValue2",
"customfieldLable3": "CustomFieldValue3"
},
"GovtResponse": {
"Success": "Y",
"AckNo": 112510223447367,
"AckDt": "2025-04-17 13:56:00",
"Irn": "1e60d7816bfcac5418e06f6ce58f6ba3518494f0c006da93a5db9f78418de8e6",
"SignedInvoice": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjNCRTE3RTUxNDE5MjUyMjY0N0YwMUZEQkZGNTI3MUFENTI2OEQ3MzUiLCJ4NXQiOiJPLUYtVVVHU1VpWkg4Ql9iXzFKeHJWSm8xelUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJOSUMgU2FuZGJveCIsImRhdGEiOiJ7XCJBY2tOb1wiOjExMjUxMDIyMzQ0NzM2NyxcIkFja0R0XCI6XCIyMDI1LTA0LTE3IDEzOjU2OjAwXCIsXCJJcm5cIjpcIjFlNjBkNzgxNmJmY2FjNTQxOGUwNmY2Y2U1OGY2YmEzNTE4NDk0ZjBjMDA2ZGE5M2E1ZGI5Zjc4NDE4ZGU4ZTZcIixcIlZlcnNpb25cIjpcIjEuMVwiLFwiVHJhbkR0bHNcIjp7XCJUYXhTY2hcIjpcIkdTVFwiLFwiU3VwVHlwXCI6XCJCMkJcIixcIlJlZ1JldlwiOlwiTlwiLFwiSWdzdE9uSW50cmFcIjpcIk5cIn0sXCJEb2NEdGxzXCI6e1wiVHlwXCI6XCJJTlZcIixcIk5vXCI6XCJJQzIwMDBcIixcIkR0XCI6XCIxNy8wNC8yMDI1XCJ9LFwiU2VsbGVyRHRsc1wiOntcIkdzdGluXCI6XCIyOUFBRkNENTg2MlIwMDBcIixcIkxnbE5tXCI6XCJOSUMgQ29tcGFueSBQdnQgTHRkXCIsXCJUcmRObVwiOlwiTklDIEluZHVzdHJpZXNcIixcIkFkZHIxXCI6XCI1dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiR0FOREhJTkFHQVJcIixcIlBpblwiOjU2MDAzNyxcIlN0Y2RcIjpcIjI5XCIsXCJQaFwiOlwiOTAwMDAwMDAwMFwiLFwiRW1cIjpcImFiY0BnbWFpbC5jb21cIn0sXCJCdXllckR0bHNcIjp7XCJHc3RpblwiOlwiMjlBV0dQVjcxMDdCMVoxXCIsXCJMZ2xObVwiOlwiWFlaIENvbXBhbnkgUHZ0IEx0ZFwiLFwiVHJkTm1cIjpcIlhZWiBJbmR1c3RyaWVzXCIsXCJQb3NcIjpcIjEyXCIsXCJBZGRyMVwiOlwiN3RoIGJsb2NrLCBrdXZlbXB1IGxheW91dFwiLFwiQWRkcjJcIjpcImt1dmVtcHUgbGF5b3V0XCIsXCJMb2NcIjpcIkdBTkRISU5BR0FSXCIsXCJQaW5cIjo1NjIxNjAsXCJQaFwiOlwiOTExMTExMTExMTFcIixcIkVtXCI6XCJ4eXpAeWFob28uY29tXCIsXCJTdGNkXCI6XCIyOVwifSxcIkRpc3BEdGxzXCI6e1wiTm1cIjpcIkFCQyBjb21wYW55IHB2dCBsdGRcIixcIkFkZHIxXCI6XCI3dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiQmFuYWdhbG9yZVwiLFwiUGluXCI6NTYyMTYwLFwiU3RjZFwiOlwiMjlcIn0sXCJTaGlwRHRsc1wiOntcIkdzdGluXCI6XCIyOUFXR1BWNzEwN0IxWjFcIixcIkxnbE5tXCI6XCJDQkUgY29tcGFueSBwdnQgbHRkXCIsXCJUcmRObVwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkFkZHIxXCI6XCI3dGggYmxvY2ssIGt1dmVtcHUgbGF5b3V0XCIsXCJBZGRyMlwiOlwia3V2ZW1wdSBsYXlvdXRcIixcIkxvY1wiOlwiQmFuYWdhbG9yZVwiLFwiUGluXCI6NTYyMTYwLFwiU3RjZFwiOlwiMjlcIn0sXCJJdGVtTGlzdFwiOlt7XCJJdGVtTm9cIjowLFwiU2xOb1wiOlwiMVwiLFwiSXNTZXJ2Y1wiOlwiTlwiLFwiUHJkRGVzY1wiOlwiUmljZVwiLFwiSHNuQ2RcIjpcIjEwMDE5OTIwXCIsXCJCYXJjZGVcIjpcIjEyMzQ1NlwiLFwiUXR5XCI6MTAwLjM0NSxcIkZyZWVRdHlcIjoxMC4wLFwiVW5pdFwiOlwiQkFHXCIsXCJVbml0UHJpY2VcIjo5OS41NDUsXCJUb3RBbXRcIjo5OTg4Ljg0LFwiRGlzY291bnRcIjoxMC4wMCxcIlByZVRheFZhbFwiOjEuMDAsXCJBc3NBbXRcIjo5OTc4Ljg0LFwiR3N0UnRcIjoxMi4wMDAsXCJJZ3N0QW10XCI6MTE5Ny40NixcIkNnc3RBbXRcIjowLjAwLFwiU2dzdEFtdFwiOjAuMDAsXCJDZXNSdFwiOjUuMDAwLFwiQ2VzQW10XCI6NDk4Ljk0LFwiQ2VzTm9uQWR2bEFtdFwiOjEwLjAwLFwiU3RhdGVDZXNSdFwiOjEyLjAwMCxcIlN0YXRlQ2VzQW10XCI6MTE5Ny40NixcIlN0YXRlQ2VzTm9uQWR2bEFtdFwiOjUuMDAsXCJPdGhDaHJnXCI6MTAuMDAsXCJUb3RJdGVtVmFsXCI6MTI4OTcuNzAsXCJPcmRMaW5lUmVmXCI6XCIzMjU2XCIsXCJPcmdDbnRyeVwiOlwiQUdcIixcIlByZFNsTm9cIjpcIjEyMzQ1XCIsXCJCY2hEdGxzXCI6e1wiTm1cIjpcIjEyMzQ1NlwiLFwiRXhwRHRcIjpcIjAxLzA4LzIwMjBcIixcIldyRHRcIjpcIjAxLzA5LzIwMjBcIn0sXCJBdHRyaWJEdGxzXCI6W3tcIk5tXCI6XCJSaWNlXCIsXCJWYWxcIjpcIjEwMDAwXCJ9XX1dLFwiVmFsRHRsc1wiOntcIkFzc1ZhbFwiOjk5NzguODQsXCJDZ3N0VmFsXCI6MC4wMCxcIlNnc3RWYWxcIjowLjAwLFwiSWdzdFZhbFwiOjExOTcuNDYsXCJDZXNWYWxcIjo1MDguOTQsXCJTdENlc1ZhbFwiOjEyMDIuNDYsXCJEaXNjb3VudFwiOjEwLjAwLFwiT3RoQ2hyZ1wiOjIwLjAwLFwiUm5kT2ZmQW10XCI6MC4zMCxcIlRvdEludlZhbFwiOjEyOTA4LjAwLFwiVG90SW52VmFsRmNcIjoxMjg5Ny43MH0sXCJQYXlEdGxzXCI6e1wiTm1cIjpcIkFCQ0RFXCIsXCJBY2NEZXRcIjpcIjU2OTczODk3MTMyMTBcIixcIk1vZGVcIjpcIkNhc2hcIixcIkZpbkluc0JyXCI6XCJTQklOMTEwMDBcIixcIlBheVRlcm1cIjpcIjEwMFwiLFwiUGF5SW5zdHJcIjpcIkdpZnRcIixcIkNyVHJuXCI6XCJ0ZXN0XCIsXCJEaXJEclwiOlwidGVzdFwiLFwiQ3JEYXlcIjoxMDAsXCJQYWlkQW10XCI6MTAwMDAuMDAsXCJQYXltdER1ZVwiOjUwMDAuMDB9LFwiUmVmRHRsc1wiOntcIkludlJtXCI6XCJURVNUXCIsXCJEb2NQZXJkRHRsc1wiOntcIkludlN0RHRcIjpcIjAxLzA4LzIwMjBcIixcIkludkVuZER0XCI6XCIwMS8wOS8yMDIwXCJ9LFwiUHJlY0RvY0R0bHNcIjpbe1wiSW52Tm9cIjpcIkRPQy8wMDJcIixcIkludkR0XCI6XCIwMS8wOC8yMDIwXCIsXCJPdGhSZWZOb1wiOlwiMTIzNDU2XCJ9XSxcIkNvbnRyRHRsc1wiOlt7XCJSZWNBZHZSZWZyXCI6XCJEb2MvMDAzXCIsXCJSZWNBZHZEdFwiOlwiMDEvMDgvMjAyMFwiLFwiVGVuZFJlZnJcIjpcIkFiYzAwMVwiLFwiQ29udHJSZWZyXCI6XCJDbzEyM1wiLFwiRXh0UmVmclwiOlwiWW80NTZcIixcIlByb2pSZWZyXCI6XCJEb2MtNDU2XCIsXCJQT1JlZnJcIjpcIkRvYy03ODlcIixcIlBPUmVmRHRcIjpcIjAxLzA4LzIwMjBcIn1dfSxcIkFkZGxEb2NEdGxzXCI6W3tcIlVybFwiOlwiaHR0cHM6Ly9laW52LWFwaXNhbmRib3gubmljLmluXCIsXCJEb2NzXCI6XCJUZXN0IERvY1wiLFwiSW5mb1wiOlwiRG9jdW1lbnQgVGVzdFwifV0sXCJFeHBEdGxzXCI6e1wiU2hpcEJOb1wiOlwiQS0yNDhcIixcIlNoaXBCRHRcIjpcIjAxLzA4LzIwMjBcIixcIlBvcnRcIjpcIklOQUJHMVwiLFwiUmVmQ2xtXCI6XCJOXCIsXCJGb3JDdXJcIjpcIkFFRFwiLFwiQ250Q29kZVwiOlwiQUVcIn0sXCJFd2JEdGxzXCI6e1wiVHJhbnNJZFwiOlwiMTJBV0dQVjcxMDdCMVoxXCIsXCJUcmFuc05hbWVcIjpcIlhZWiBFWFBPUlRTXCIsXCJUcmFuc01vZGVcIjpcIjFcIixcIkRpc3RhbmNlXCI6MTAwLFwiVHJhbnNEb2NOb1wiOlwiRG9jMDFcIixcIlRyYW5zRG9jRHRcIjpcIjE3LzA0LzIwMjVcIixcIlZlaE5vXCI6XCJrYTEyMzQ1NlwiLFwiVmVoVHlwZVwiOlwiUlwifX0ifQ.Uq-MhHL58ttkcHFdwcSedPgR77qdolfhvexAO5lTwcFxPHPHYiJSsaWKHk8nB8V0BWV-ER7OCMyJKssVUV58psZkrlauaOjwo8DGbH99NNUCR_8rS5eUTXUM8cXe-_nuNrxC_lrF2Zuv48Z6HJd1H7mvbPMOzOPlyD5Ew5zNrmfb405ynXpmaHGTgFAvZFXMzWqxMQA7sfvogyil-GxEVrEeynZ_jCJgWBpY6XuS_j7v03pVRyXTTY7iFgOqwSOaPsk7gOuI_zKtx95WyxvrbqV1RyuLMSnBGEgG_HMSut4y4SRhMT2OJ4gP5_wNQr67ghwtBATrT6CIlvi2FJf-Ew",
"SignedQRCode": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjNCRTE3RTUxNDE5MjUyMjY0N0YwMUZEQkZGNTI3MUFENTI2OEQ3MzUiLCJ4NXQiOiJPLUYtVVVHU1VpWkg4Ql9iXzFKeHJWSm8xelUiLCJ0eXAiOiJKV1QifQ.eyJpc3MiOiJOSUMgU2FuZGJveCIsImRhdGEiOiJ7XCJTZWxsZXJHc3RpblwiOlwiMjlBQUZDRDU4NjJSMDAwXCIsXCJCdXllckdzdGluXCI6XCIyOUFXR1BWNzEwN0IxWjFcIixcIkRvY05vXCI6XCJJQzIwMDBcIixcIkRvY1R5cFwiOlwiSU5WXCIsXCJEb2NEdFwiOlwiMTcvMDQvMjAyNVwiLFwiVG90SW52VmFsXCI6MTI5MDguMDAsXCJJdGVtQ250XCI6MSxcIk1haW5Ic25Db2RlXCI6XCIxMDAxOTkyMFwiLFwiSXJuXCI6XCIxZTYwZDc4MTZiZmNhYzU0MThlMDZmNmNlNThmNmJhMzUxODQ5NGYwYzAwNmRhOTNhNWRiOWY3ODQxOGRlOGU2XCIsXCJJcm5EdFwiOlwiMjAyNS0wNC0xNyAxMzo1NjowMFwifSJ9.ObpczVawxQQoa5t_-hmUPwad_rL1SvhXHGDgHnoFEZUJJQsaMZGpw-F9E17PxhPjGx5--uhwJxFWQ5d3_zu_zlpd9Y4MA7QXPyb_nY_sK4B2EwqOKDqNticqLNxq09RpsMgCcWGOvBRx_apyxH-IMhxHGz--z4EY_f3ub_5klcxO-CJsYJAy_MtGz3jIZgCBlvGGde4nymwnBUmabRlgLMWvuZroVNcQuzPIhdePmX4mYs7fDs32pAeEj4kFdsAABbjEJmByjhq76NCFNlRb1nDFup9ZVi4C90rAkUO60dBEf2zKam_k8RuDQXXS3qgnSk3yyFkxvDNoQndP4a-ucQ",
"Status": "ACT",
"EwbNo": 111011453524,
"EwbDt": "2025-04-17 13:56:00",
"EwbValidTill": "2025-04-18 23:59:00"
},
"InvoiceStatus": "GENERATED",
"Gstin": "29AAFCD5862R000",
"Id": "6800bb0905ab13797131df3a",
"EwbStatus": "GENERATED"
}
```
#### Response - Failure:
**HTTP Status Code - 200**
```json
{
"ErrorDetails": [
{
"ErrorCode": "300102",
"ErrorMessage": "You don't have any data present for the selected Document Details",
"ErrorSource": "CLEARTAX"
}
]
}
```
### API Validations
1. If irn is provided, other document-based parameters (documentNumber, documentType, documentDate, and sellerGstin) are not necessary.
2. If irn is not provided, all document-based parameters are required (documentNumber, documentType, documentDate, and sellerGstin).
3. Missing or invalid query parameters and headers will result in a 400 Bad Request error.
### API Constraints
1. Either the irn OR full document details (documentNumber, documentType, documentDate, and sellerGstin)) should be provided, but not both at the same time.
2. Only one e-invoice detail retrieval is allowed per API call.
3. Correct header parameters (gstin and x-cleartax-auth-token) are mandatory.