Delete Invoice
Last updated
Last updated
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.
DELETE
Rate Limit : 1000 API requests per minute
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
There will be no request body for this API.
Request Body
HTTP Status Code: 200
Response Body
Document deleted successfully with document Id : 664d9cd63068491e7eceaff5
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
A valid document with {document_id} in path params should be present.
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.
Each customer is allowed to send a limited number of requests per minute to prevent server overload. If the limit is exceeded, the server will respond with a 429 Too Many Requests status code.
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.
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
HTTP Status Code | Description |
---|---|
Parameter | Data Type | Field Validations | Description |
---|---|---|---|
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
document_id
String
Should be a valid document id
Mandatory. Unique document id present in the upload api response.
einvoice-type
ENUM
SALES, PURCHASE, SALES_B2C
Default: SALES
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
429
Too many requests
Success Message
String
NA
NA
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.