Upload E-Invoice

Upload E-Invoice API is used for validation & persistence of Invoice Data with CT, additional actions on the Invoice can be done later using documentId. Particularly useful for B2C Invoice Flow, where Customer Details might not be available for E-Invoice Generation or the Invoice is to be consolidated.

Request Method

POST

Request URL

{{HOST}}/einvoice/v1/documents/upload

Rate Limit : 1000 API requests per minute

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. Used for Debugging Support Issues
Content-Type	String	application/json	application/json

Request Path Params

There are no path paramaters for this API.

Request Query Params

Parameter	Data Type	Field Validations	Description
einvoice-type	ENUM	SALES, PURCHASE, SALES_B2C	Mandatory. API is available only for SALES_B2C Disabled for other E-Invoice Types

Request Body

Parameter	Data Type	Field Validations	Description
Documents	Array	MinListLength: 1 MaxListLength: 10	Mandatory. List of Documents
Version	String		Mandatory. MY_GENERATE_UBL_2_1_V1

Documents Object

Parameter	Data Type	Field Validations	Description
DocumentData	String	NA	Mandatory. Base64 of the document data shared below
DocumentFormat	ENUM	JSON	Mandatory. Describes the data received is in the JSON Format
UniqueIdentifier	String	NA	Mandatory. Unique identifier formed with concatenation of TIN, Document Number, Document Type, Fiscal Year fields with _ Example: C948329382_INV-101_INV_2024
CustomFields	Object	NA	Map of Custom fields with key-value pair eg : ( { “Internal Number” : “INV000012” })

DocumentData object is similar to the Generate E-Invoice Request Body.

AccountingCustomerParty, Delivery Details are optional for SALES B2C Documents.

If present, the Details are validated as per LHDN validations.

Sample Request

Request Body

{
    "Documents": [
        {
            "DocumentData": "{
    "InvoiceTypeCode": {
        "Value": "01"
    },
    "IssueDate": "2024-06-03",
    "IssueTime": "18:30:00",
    "DocumentCurrencyCode": "MYR",
    "Id": "TEST-SALES-004",
    "AccountingSupplierParty": {
        "Party": {
            "Contact": {
                "ElectronicMail": "general@plus.com.my",
                "Telephone": "6032230090"
            },
            "IndustryClassificationCode": {
                "Value": "01111",
                "Name": "Other service activities n.e.c."
            },
            "PartyIdentification": [
                {
                    "Id": {
                        "SchemeID": "TIN",
                        "Value": "C58746708080"
                    }
                },
                {
                    "Id": {
                        "SchemeID": "BRN",
                        "Value": "202401021128"
                    }
                },
                {
                    "Id": {
                        "SchemeID": "SST",
                        "Value": "NA"
                    }
                },
                {
                    "Id": {
                        "SchemeID": "TTX",
                        "Value": "NA"
                    }
                }
            ],
            "PartyLegalEntity": {
                "RegistrationName": "XYZ"
            },
            "PostalAddress": {
                "AddressLine": [
                    {
                        "Line": "Menara Korporat"
                    },
                    {
                        "Line": "Persada PLUS"
                    },
                    {
                        "Line": "Persimpangan Bertingkat Subang KM15"
                    }
                ],
                "CityName": "Lebuhraya Baru Lembah Klang",
                "Country": {
                    "IdentificationCode": {
                        "CountryCode": "MYS"
                    }
                },
                "CountrySubentityCode": "10",
                "PostalZone": "47301"
            }
        }
    },
    "InvoiceLine": [
        {
            "Id": "1",
            "InvoicedQuantity": {
                "Quantity": 1,
                "UnitCode": "KGS"
            },
            "Item": {
                "CommodityClassification": [
                    {
                        "ItemClassificationCode": {
                            "ListID": "CLASS",
                            "Value": "011"
                        }
                    }
                ],
                "Description": "Repair and maintenance",
                "OriginCountry": {
                    "IdentificationCode": {
                        "CountryCode": "MYS"
                    }
                }
            },
            "ItemPriceExtension": {
                "Amount": {
                    "CurrencyID": "MYR",
                    "Value": "120000"
                }
            },
            "AllowanceCharge": [
                {
                    "ChargeIndicator": false,
                    "MultiplierFactorNumeric": 0.10,
                    "AllowanceChargeReason": "Sample",
                    "Amount": {
                        "CurrencyID": "MYR",
                        "Value": "12000.00"
                    }
                },
                {
                    "ChargeIndicator": true,
                    "MultiplierFactorNumeric": 0,
                    "AllowanceChargeReason": "Sample",
                    "Amount": {
                        "CurrencyID": "MYR",
                        "Value": "0.00"
                    }
                }
            ],
            "Price": {
                "PriceAmount": {
                    "CurrencyID": "MYR",
                    "Value": "108000.00"
                }
            },
            "LineExtensionAmount": {
                "CurrencyID": "MYR",
                "Value": "108000"
            },
            "TaxTotal": {
                "TaxAmount": {
                    "CurrencyID": "MYR",
                    "Value": "8640.00"
                },
                "TaxSubtotal": [
                    {
                        "TaxAmount": {
                            "CurrencyID": "MYR",
                            "Value": "8640.00"
                        },
                        "TaxableAmount": {
                            "CurrencyID": "MYR",
                            "Value": "108000.00"
                        },
                        "TaxCategory": {
                            "Id": "01"
                        }
                    }
                ]
            }
        }
    ],
    "AllowanceCharge": [
        {
            "ChargeIndicator": false,
            "AllowanceChargeReason": "Sample Description",
            "Amount": {
                "Value": 8000,
                "CurrencyID": "MYR"
            }
        },
        {
            "ChargeIndicator": true,
            "AllowanceChargeReason": "Sample Description",
            "Amount": {
                "Value": 0,
                "CurrencyID": "MYR"
            }
        }
    ],
    "TaxTotal": [
        {
            "TaxAmount": {
                "CurrencyID": "MYR",
                "Value": "10000.00"
            },
            "TaxSubtotal": [
                {
                    "TaxableAmount": {
                        "CurrencyID": "MYR",
                        "Value": "100000.00"
                    },
                    "TaxAmount": {
                        "CurrencyID": "MYR",
                        "Value": "10000.00"
                    },
                    "TaxSubtotal": [
                        {
                            "TaxAmount": {
                                "CurrencyID": "MYR",
                                "Value": "10000.00"
                            },
                            "TaxCategory": {
                                "Id": "01"
                            }
                        }
                    ]
                }
            ]
        }
    ],
    "LegalMonetaryTotal": {
        "LineExtensionAmount": {
            "CurrencyID": "MYR",
            "Value": "108000.00"
        },
        "AllowanceTotalAmount": {
            "CurrencyID": "MYR",
            "Value": "8000.00"
        },
        "ChargeTotalAmount": {
            "CurrencyID": "MYR",
            "Value": "0.00"
        },
        "TaxExclusiveAmount": {
            "CurrencyID": "MYR",
            "Value": "100000.00"
        },
        "TaxInclusiveAmount": {
            "CurrencyID": "MYR",
            "Value": "110000.00"
        },
        "PrepaidAmount": {
            "CurrencyID": "MYR",
            "Value": "0.00"
        },
        "PayableAmount": {
            "CurrencyID": "MYR",
            "Value": "110000.00"
        },
        "PayableRoundingAmount": {
            "Value": "0.00"
        }
    },
    "PaymentMeans": {
        "PaymentMeansCode": "4"
    },
    "PaymentTerms": {
        "Note": "Payment Method is cash"
    }
}",
            "DocumentFormat": "JSON",
            "UniqueIdentifier": "C58746708080_TEST-SALES-001_01_2024",
            "CustomFields": {
                "Internal Number": "INV00001234561687"
            }
        }
    ],
     "version": "MY_GENERATE_UBL_2_1_V1"
}

Sample Request - Upload Document Details - Decoded

Response Status Codes

HTTP Status Code	Description
200	For successfully submitted document or with validation errors
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

Response Schema

Parameter	Data Type	Field Validations	Description
Success	Boolean	true/false	Mandatory. Indicates the request was successful or not
DocumentResponses	Array	NA	NA
ErrorDetails	Array<ErrorDetail>	Error details	Optional. Error list from ClearTax

Document Details Object

Parameter	Data Type	Field Validations	Description
DocumentId	String	NA	Unique document id generated in database
UniqueId	String	NA	Mandatory. Same uniqueId as shared in the request
Success	Boolean	true/false	Indicates, if the request for this document was successfully processed or not
ErrorDetails	Array<ErrorDetail>	Error details	Optional. Error list from ClearTax/LHDN
WarningDetails	Array<ErrorDetail>	Warning details	Optional. Warning list from ClearTax

ErrorDetails

Parameter	Data Type	Field Validations	Description
ErrorCode	String	NA	Error Code
ErrorMessage	String	NA	Error Message
ErrorSource	ErrorSource	CLEARTAX / GOVT	Error Source
Path	String	NA	Path of the Error

WarningDetails

Parameter	Data Type	Field Validations	Description
Code	String	NA	Warning Code
Message	String	NA	Warning Message

Sample Response (Success)

HTTP Status Code

200

Response Body

{
    "ErrorDetails": null,
    "Success": "true",
    "DocumentResponses": [
        {
            "DocumentId": "66694ab91fe33e3be063dc57",
            "Success": "true",
            "UniqueId": "C58746708080_TEST-SALES-004_01_2024",
            "ErrorDetails": null,
            "WarningDetails": null
        }
    ]
}

Sample Response (Error)

HTTP Status Code: 400

Response Body

{
    "ErrorDetails": null,
    "Success": "true",
    "DocumentResponses": [
        {
            "DocumentId": null,
            "Success": "false",
            "UniqueId": "C58746708080_TEST-SALES-004_01_2024",
            "ErrorDetails": [
                {
                    "ErrorCode": "ibr-cl-15",
                    "ErrorMessage": "[ibr-cl-15]-Origin country codes in an invoice (ibt-159) MUST be coded using ISO code list 3166-1",
                    "ErrorSource": "CLEARTAX",
                    "Path": "Invoice.InvoiceLine[0].Item[0].OriginCountry[0].IdentificationCode"
                }
            ],
            "WarningDetails": null
        }
    ]
}

API Validations

Currently there are no known validations.

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

3. If the auth token is valid, but the user does not have the authorization to generate an 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