Get Document by Document Params

Get Document by Doc Params API is used to Get a Document using the given Document Params.

Route

/invx/apis/{iridessa-version}/orgs/{org-id}/edocuments?{irn}&{buyergstin}&{sellergstin}&{orgidrole}&{doctype}

- active 'iridessa-version': v1
- method: GET

URL Parameters

Name	Description	Type
iridessa-version	version of the API for example, v1	string
org-id	theodore organisation id	string
irn	IRN of the Document	string
buyergstin	gstin of the buyer	string
sellergstin	gstin of the seller	string
orgidrole	role of the org for example, seller	string
doctype	type of the document for example, 100	string

Response

Successful response will have the response in “data” attribute as a json.

200

Sample response body

{
  "status": "1",
  "data": [
    {
      "itemStatus": "1",
      "itemData": {
        "id": "feaa09a5-2fc3-4040-95ac-1053389a848b",
        "irn": "643e0329bee3ccb77db5d126eb3192ec309c6896441d6082fd669c08d3339a42",
        "docNumber": "JC2FCEEF5928B459",
        "docType": "100",
        "docDate": "24/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "buyerGstin": "27ACBPN2353E1ZX",
        "irdDocType": "POST",
        "registeredOn": 1674560999000,
        "ewbNo": 241009845984,
        "ewbDate": 1674561000000,
        "ewbValidTill": 1674671340000,
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": null,
        "disputeComments": null,
        "cancellationComments": null,
        "cancellationReason": null,
        "status": "200",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674560941061,
        "lastUpdatedByUserId": null,
        "lastUpdated": null,
        "annotations": [],
        "irnResponse": null
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    },
    {
      "itemStatus": "1",
      "itemData": {
        "id": "70bbea80-65f0-44fa-82c2-6ea67ad37753",
        "irn": "90a0d707eed66112f5a8a746f7250007b1573aae21dfc1bc2374ac047e496f37",
        "docNumber": "UBBC64CE56B2342D",
        "docType": "100",
        "docDate": "24/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "buyerGstin": "27ACBPN2353E1ZX",
        "irdDocType": "POST",
        "registeredOn": 1674560969000,
        "ewbNo": 271009845983,
        "ewbDate": 1674560940000,
        "ewbValidTill": 1674671340000,
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": null,
        "disputeComments": null,
        "cancellationComments": "test cancellation",
        "cancellationReason": "3",
        "status": "240",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674560913081,
        "lastUpdatedByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "lastUpdated": 1674560914305,
        "annotations": [],
        "irnResponse": null
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    }
  ],
  "error": null,
  "info": null
}

Note

status field in document is the state of the Document generated. Different Document states are as bellow -

• 100 -> DRAFT
• 120 -> REGISTRATIONFAILED
• 200 -> CREATED
• 210 -> ACCEPTED
• 220 -> DENIED
• 230 -> DISPUTED
• 240 -> CANCELLED
• 250 -> FROZEN
• 260 -> DELETE

---

Last update: January 25, 2023