Get All Documents For an Organisation

Get All Documents For an Organisation API is used to Get all Documents linked with Organisation using the given Organisation Id.

Route

/iridessa/apis/{iridessa-version}/orgs/{org-id}/document

- 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

Headers

All headers are mentioned in common headers

Response

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

Sample response body

{
  "status": "1",
  "data": [
    {
      "itemStatus": "1",
      "itemData": {
        "id": "956361fb-c524-49e4-b682-93bfb8a0c8a0",
        "docNumber": "L18015371E1E245D",
        "docType": "100",
        "docDate": "23/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "buyerGstin": "27ACBPN2353E1ZX",
        "irdDocType": "PRE",
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": null,
        "disputeComments": null,
        "status": "100",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674449904185,
        "lastUpdatedByUserId": null,
        "lastUpdated": null,
        "annotations": []
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    },
    {
      "itemStatus": "1",
      "itemData": {
        "id": "ba771e77-61fa-47aa-81e8-c5cd992e5a04",
        "docNumber": "IF06CA4495AF9419",
        "docType": "100",
        "docDate": "23/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "buyerGstin": "27ACBPN2353E1ZX",
        "irdDocType": "PRE",
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": null,
        "disputeComments": null,
        "status": "100",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674449772446,
        "lastUpdatedByUserId": null,
        "lastUpdated": null,
        "annotations": []
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    },
    {
      "itemStatus": "1",
      "itemData": {
        "id": "b7370a21-cdf0-4370-8edf-1d5cdeaaf962",
        "docNumber": "L823EB23153E0471",
        "docType": "100",
        "docDate": "23/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "buyerGstin": "27ACBPN2353E1ZX",
        "irdDocType": "PRE",
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": null,
        "disputeComments": "test dispute",
        "status": "230",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674449745819,
        "lastUpdatedByUserId": "2a2e6f94-6b87-4e74-9692-483ffc127b04",
        "lastUpdated": 1674449745897,
        "annotations": []
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    },
    {
      "itemStatus": "1",
      "itemData": {
        "id": "2eca87f4-00da-44da-ad2e-ce2b94cb75ed",
        "docNumber": "D0FAA50CCCA894BC",
        "docType": "100",
        "docDate": "23/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "buyerGstin": "27ACBPN2353E1ZX",
        "irdDocType": "PRE",
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": null,
        "disputeComments": "test dispute",
        "status": "230",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674449714458,
        "lastUpdatedByUserId": "2a2e6f94-6b87-4e74-9692-483ffc127b04",
        "lastUpdated": 1674449714543,
        "annotations": []
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    },
    {
      "itemStatus": "1",
      "itemData": {
        "id": "335ed787-9029-4bbc-bdf9-bf876e931b27",
        "docNumber": "O634E50A3EC68492",
        "docType": "100",
        "docDate": "23/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "buyerGstin": "27ACBPN2353E1ZX",
        "irdDocType": "PRE",
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": "test deny",
        "disputeComments": null,
        "status": "220",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674449686366,
        "lastUpdatedByUserId": "2a2e6f94-6b87-4e74-9692-483ffc127b04",
        "lastUpdated": 1674449686448,
        "annotations": []
      },
      "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