Dispute Document Bulk

Dispute Invoice Bulk API is used to Dispute the Simple Documents using the given request payload. This api provides Simple Document dispute feature for buyer

Route

/invx/apis/{iridessa-version}/orgs/{org-id}/document/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 dispute",
    "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": "b978f707-a8b6-4f76-b0dd-3777a65e2de4",
        "docNumber": "N92B2E8ADC2504AE",
        "docType": "100",
        "docDate": "04/04/2023",
        "sellerGstin": "27AAAPI3182M002",
        "sellerPAN": "AAAPI3182M",
        "buyerGstin": "27ACBPN2353E1ZX",
        "buyerPAN": "ACBPN2353E",
        "irdDocType": "SMP",
        "amount": 100.00,
        "acceptanceComments": null,
        "denialComments": null,
        "disputeComments": "test dispute",
        "status": "230",
        "createdByUserId": "3e193e19-0d70-4938-9698-287f8bd947fb",
        "createdOn": 1680603998447,
        "lastUpdatedByUserId": "2a2e6f94-6b87-4e74-9692-483ffc127b04",
        "lastUpdated": 1680603998520,
        "annotations": []
      },
      "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 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