GEgetswipe
Document V2

Cancel a document

Changed on

Cancels an active document by its hash_id. The document remains in your account with a cancelled status.

delete/v2/doc/{doc_hash_id}

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/doc/{doc_hash_id}
  • Auth
    HTTP bearer

Path parameters

doc_hash_idstring required

The hash id of the document to be cancelled

Query parameters

cancel_einvoiceinteger

Set to 1 if you want to cancel a document with e-invoice

Response

Success

successboolean
messagestring

Success Message

error_codestring

Error Code

errorsobject

Error details

Example response

{
  "success": true,
  "message": "Message",
  "data": {
    "hash_id": "SL123"
  }
}

Changes