Get All Documents For an Organisation#

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

Route

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

- 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": "e3d25212-c8a2-49ea-9dd0-c310ad22b82f",
        "docNumber": "E81E8601D8A0A48A",
        "docType": "100",
        "docDate": "24/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "sellerPAN": "AAAPI3182M",
        "buyerGstin": "27ACBPN2353E1ZX",
        "buyerPAN": "ACBPN2353E",
        "irdDocType": "SMP",
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": null,
        "disputeComments": null,
        "status": "270",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674560857793,
        "lastUpdatedByUserId": null,
        "lastUpdated": null,
        "annotations": []
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    },
    {
      "itemStatus": "1",
      "itemData": {
        "id": "5a009781-2bc1-4607-a6fa-51260d74bd0f",
        "docNumber": "Y3DCD15EA02F04EA",
        "docType": "100",
        "docDate": "24/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "sellerPAN": "AAAPI3182M",
        "buyerGstin": "27ACBPN2353E1ZX",
        "buyerPAN": "ACBPN2353E",
        "irdDocType": "SMP",
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": null,
        "disputeComments": null,
        "status": "270",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674560829791,
        "lastUpdatedByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "lastUpdated": 1674560829876,
        "annotations": [
          {
            "annotation": "test annotation",
            "createByOrg": "2420916c-93d5-430f-819f-5ed7d12ffa63",
            "createBy": "3e193e19-0d70-4938-9698-287f8bd947fb",
            "createdOn": 1674560829880
          }
        ]
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    },
    {
      "itemStatus": "1",
      "itemData": {
        "id": "657e6035-44b5-47d8-87be-57ef5fe1f4ef",
        "docNumber": "R14D9C349A5ED47F",
        "docType": "100",
        "docDate": "24/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "sellerPAN": "AAAPI3182M",
        "buyerGstin": "27ACBPN2353E1ZX",
        "buyerPAN": "ACBPN2353E",
        "irdDocType": "SMP",
        "amount": 100.00,
        "acceptanceComments": "test acceptance",
        "denialComments": null,
        "disputeComments": null,
        "status": "210",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674560800994,
        "lastUpdatedByUserId": "2a2e6f94-6b87-4e74-9692-483ffc127b04",
        "lastUpdated": 1674560801347,
        "annotations": []
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    },
    {
      "itemStatus": "1",
      "itemData": {
        "id": "c57ba74c-5983-4517-ae54-c19bb180217e",
        "docNumber": "B3A475C477B764CC",
        "docType": "100",
        "docDate": "24/01/2023",
        "sellerGstin": "27AAAPI3182M002",
        "sellerPAN": "AAAPI3182M",
        "buyerGstin": "27ACBPN2353E1ZX",
        "buyerPAN": "ACBPN2353E",
        "irdDocType": "SMP",
        "amount": 100.00,
        "acceptanceComments": "test acceptance",
        "denialComments": null,
        "disputeComments": null,
        "status": "210",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1674560768782,
        "lastUpdatedByUserId": "2a2e6f94-6b87-4e74-9692-483ffc127b04",
        "lastUpdated": 1674560769194,
        "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: March 30, 2023