Delete Invoice
This API allows you to delete an invoice from ClearTax database before it's submitted to LHDN for generation. It takes the document id for the document to be deleted as the input and returns the status of the activity, along with error messages, if any.
Request Method
DELETE
Request URL
Request Headers
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
x-cleartax-auth-token | String | Cannot be empty | Mandatory. User auth token. |
x-clear-tin | String | Cannot be empty | Mandatory. TIN of the entity |
x-clear-branch | String | Should be a valid branch from the user account | Optional. Branch name (store name) added in the user account which maps to a TIN of the entity. |
x-request-id | UUID | Should be unique for every request | Optional. Unique request ID. |
Content-Type | String | application/json | application/json |
Request Path Params
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
document_id | String | Should be a valid document id | Mandatory. Unique document id present in the upload api response. |
Request Query Params
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
einvoice-type | ENUM | SALES, PURCHASE, SALES_B2C | Default: SALES |
Request Body
There will be no request body for this API.
Sample Request
Request Body
Response Status Codes
HTTP Status Code | Description |
---|---|
200 | For a successful status check |
400 | For any kind of invalid payload issues |
401 | If the user is not authenticated for the operation |
403 | If the user is not authorized for the operation |
Response Schema
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
Success Message | String | NA | NA |
Error Details Object
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
ErrorCode | String | Cannot be null | A code to identify the error. Error codes are published below. |
ErrorMessage | String | Cannot be null | Human readable error message. |
ErrorSource | String | LHDN, CLEARTAX | Source of the error. |
ErrorPath | String | NA | If it is a validation error of a request data, it will point to the request data field. Example below. |
Sample Response (Success)
HTTP Status Code: 200
Response Body
Document deleted successfully with document Id : 664d9cd63068491e7eceaff5
Sample Response (Error)
Case1: Document not present with document id passed
HTTP Status Code
200
Response Body
Case 2: When document is already submitted to the LHDN
HTTP Status Code
200
Response Body
API Validations
A valid document with {document_id} in path params should be present.
API Constraints
This API needs to be authenticated with a valid user authentication token. If the auth token is not present or is invalid, the API will return HTTP Status Code 401.
If the auth token is valid, but the user does not have the authorization to generate e-invoice for a document, then the API will return HTTP Status Code 403. The user, whose auth token is used, should have an Admin role for the particular TIN used in the request.
Last updated