Skip to content

Dispute Invoice#

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

Route

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

- 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": "d8fabae2-e809-4d2e-90f5-5c551832a437",
    "irn": null,
    "docNumber": "M14FE6164463F8ZA",
    "docType": "100",
    "docDate": "01/02/2022",
    "sellerGstin": "27AAAPI3182M002",
    "buyerGstin": "27ACBPN2353E1ZX",
    "irdDocType":"POST",
    "registeredOn": null,
    "ewbNo": null,
    "ewbDate" : null,
    "ewbValidTill" : null,
    "amount": 100,
    "acceptanceComments": null,
    "denialComments": null,
    "disputeComments": "test dispute",
    "cancellationComments": null,
    "cancellationReason": null,
    "status": "230",
    "createdByUserId": "76c747b5-79d4-4417-891b-f385a690250b",
    "createdOn": 1653013484020,
    "lastUpdatedByUserId": "76c747b5-79d4-4417-891b-f385a690250b",
    "lastUpdated": 1653013520149,
    "annotations": [],
    "irnResponse" : 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 240.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