Delete Document Bulk#

Delete Simple Documents API is used to Delete the Simple Document using the given request payload. This api provides Simple Document delete feature for buyer

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": "c3b993f2-81ab-41d4-b54e-e32a79bb7c64",
    "action": "del"
  }
]

Response#

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

Sample response body

{
  "status": "1",
  "data": [
    {
      "id": "ec3dbb8e-59f0-49f0-b753-91dcb3e63cf4",
      "docNumber": "T3F3A7C6E5128449",
      "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": "260",
      "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
      "createdOn": 1674560972556,
      "lastUpdatedByUserId": "2a2e6f94-6b87-4e74-9692-483ffc127b04",
      "lastUpdated": 1674560972639,
      "annotations": []
    }
  ],
  "error": null,
  "info": null
}

Sample Response Body

{
  "error": {
    "message": "err-incorrect-update-action",
    "type": "ClientError",
    "args": {
      "message": "action dpt 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