Skip to content

Annotate Simple Document Bulk#

Annotate Simple Document Bulk API is used to add an Annotation to the Simple Document using the given request payload. This api Helps with collaboration between buyer and seller

Route

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

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

URL Parameters#

Name Description Type
iridessa-version version of the API
for example, v1		 string
org-id theodore organisation id string
doc-id document id string

Headers#

All headers are mentioned in common headers

Request#

Please refer the following request body for reference-

Sample request body

[
  {
    "docId": "010217a4-4fa2-4bec-9271-9df07fff2700",
    "comments": "test annotation",
    "action": "ano"
  }
]

Response#

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

200#

Sample response body

{
  "status": "1",
  "data": [
    {
      "itemStatus": "1",
      "itemData": {
        "id": "23bfe7ef-205a-4b53-ad8e-ec8c3d6a4ccc",
        "docNumber": "S38616F0EA46C4D1",
        "docType": "100",
        "docDate": "04/04/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": 1680603702048,
        "lastUpdatedByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "lastUpdated": 1680603782946,
        "annotations": [
          {
            "annotation": "test annotation",
            "createByOrg": "2420916c-93d5-430f-819f-5ed7d12ffa63",
            "createBy": "3e193e19-0d70-4938-9698-287f8bd947fb",
            "createdOn": 1680603782949
          }
        ]
      },
      "itemErrors": null,
      "itemInfo": null,
      "itemKey": null
    }
  ],
  "error": null,
  "info": null
}

400 BAD REQUEST#

Sample Response Body

{
  "error": {
    "message": "err-incorrect-update-action",
    "type": "ClientError",
    "args": {
      "message": "action ano on state 260.kotlin"
    }
  }
}

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: April 7, 2023