Dispute Document

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

Route

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

- 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":"2e63f8bc-b89a-43e1-bb7d-f2dde82f97f6",
  "comments":"test Dispute",
  "action":"dpt"
}

Response

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

200

Sample response body

{
  "status": "1",
  "data": {
    "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": []
  },
  "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