Status Check for Submitted E-Invoice

Request Method

GET

Request URL

https://api-sandbox.my.cleartax.com/einvoice/v1/documents/{document_id}/status

Request Headers

ParameterData TypeField ValidationsDescription

x-clear-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

ParameterData TypeField ValidationsDescription

document_id

String

Should be a valid document id

Mandatory

Request Query Params

ParameterData TypeField ValidationsDescription

einvoice-type

ENUM

SALES, PURCHASE, SALES_B2C

Default: SALES

Request Body

There will be no request body for this API.

Sample Request

Request Body

NA

Response Status Codes

HTTP Status CodeDescription

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

ParameterData TypeField ValidationsDescription

Success

Boolean

true/false

Identifies whether the request processing was successful or not

DocumentId

String

NA

DocumentId generated by ClearTax uniquely identifies the document.

Status

String

VALID/

INVALID/

SUBMITTED/

NOT_SUBMITTED/

CANCELLED

Mandatory. Status of Document Processing

VALID: E-Invoice is generated for the document and is Valid.

INVALID: E-Invoice has validation errors from LHDN

SUBMITTED: E-Invoice Generation is in Progress

NOT_SUBMITTED: E-Invoice is not submitted for the Document

UUID

String

NA

Unique document ID in e-Invoice, shared by LHDN for the document

LongId

String

NA

Unique long temporary Id that can be used to query document data anonymously

QrCode

String

NA

QrCode generated by Cleartax using unique longId and UUID.

InternalId

String

NA

Internal ID used in submission for the document to LHDN, link document number

DateTimeValidated

DateTime

NA

The date and time when the document passed all validations and moved to the valid state.

CancelDateTime

DateTime

NA

Refer to the document cancellation that has been initiated by the taxpayer “issuer” of the document on the system, will be in UTC format

RejectRequestDateTime

DateTime

NA

Refer to the document rejection request that has been initiated by the taxpayer “receiver” of the document on the system, will be in UTC format

ErrorDetails

Array

NA

Optional. List of error objects.

Error Details Object

ParameterData TypeField ValidationsDescription

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

{
    "ErrorDetails": null,
    "Success": "true",
    "DocumentId": "665f28c2f626dc2cac32abea",
    "Status": "VALID",
    "Uuid": "Y4K7SPNCBE8FAQSCWDEEVHZH10",
    "LongId": "VM9Q54DM9E739A1HWDEEVHZH10tz32Xq1717512387",
    "QrCode": "iVBORw0KGgoAAAANSUhEUgAAASwAAAEsAQAAAABRBrPYAAADMElEQVR4Xu2YW67bMAxEuQPuf5fcAcszdIpEN0D7U4yBWvBNFOm44GsoodF/MyrOla/jwY7xYMd4sGM82DH+N6wiYmYR2dlRGVmZ/GTDjc1TWTWTqGYClZlsuLEKtsZuzOaFlFvJxg0w1gcNwsqYb5y5BzYbWA8+rnTh0R0wkWP/mN0QvIMPR+ot2ISzvo74oayv4x9iO8tQlGV4NpJ52/Rhs0/GZzvVXvhRzPLlow0rBJLScK0r9MLZknS8WFOVU5ZNZ2b2Kk9EY8bozbNIq1Expl4puHr31IE1LYbILp5SUKrtpB8rOh5fKSDJP5L5lLMFW24WUQxFqTrlLJEHVkzmNtoNug1nyRbnoXoDhtHYT/ZnRlCpSZxZH4xY02WQB+WJhENBDpbfVe/ApA3uKhPWlhsh9bw8cGKcGluHBHl2mJJ6pmZMB0dSl03S9x1c0bXPjm1JUpnEl19EHY27sSKKfCYlgIpVpxt2Lya9yPhph7If3fAWn16sKEiWkXGqPLH90rcZoyITfB7YxJ3Gnw8XPFghY0Sjk1ayCW4GN8BK1wEVIhWQvDRrrC5gxIJ6pALwBTkDJcEl6lasSTUxhVSBMpGI6NRmjCxzsSO+Go1oLsiLaXXMJrBUJjHlQx55MaX+glWiMn7d0D9jxJo6pN8Q4j1KKAaYj7L0YPzH4RgvsfBwAP+GvNiMhEM7zSUvCPm2bjdWpHrTjj+FN/Me0Ht4HRhpJraF+QkUnCL8XYAPe7UaeAaLm/RPyTgwPpPwimJ3nUmuyXZM96ekDocnpqoE/tyYBpLB8n3WeoJuxihJTrKRy3yjbHTTWxJujHvU2P3aIaqxgQ3WnBiEcp/0ZnKvAG9hmrFay4MI4wguhW5Wn5KxYNolzSQdd1rHidq1G6MdoxFuw3ndC4izIu3FmICqtcyEuCrChNyPMdvoBlNyriLYfSOGqU0VBq4oxmQ9rsPEi/Hozl57+JJ9Ht5yY9hd9BXCO+kuYWfqfRgdkMY3mkHHhaCTYrgBFkTzqoFkEyeoATPGk9xZ8ATVKLZo6AKMGJYnJrPJJe+Ks/zxYn8cD3aMBzvGgx3jwY7xYMeoX71e3DIZBrOSAAAAAElFTkSuQmCC",
    "InternalId": "TEST-SALES-001",
    "DateTimeValidated": "2024-06-04T14:46:28",
    "CancelDateTime": "null",
    "RejectRequestTime": "null"
}

Sample Response (Error)

HTTP Status Code

200

Response Body

{
    "Success": "false",
    "ErrorDetails": [
        {
            "ErrorCode": "DOC-NF-001",
            "ErrorMessage": "You don't have any data present for the selected Document Details",
            "ErrorSource": "CLEARTAX"
        }
    ]
}

API Validations

  1. A valid document with {document_id} in path params should be present.

API Constraints

  1. 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.

  2. 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