This API enables the submits the e-invoicing payload for generation of LHDN compliant e-invoices. This is a bulk API which supports submitting an array of documents in one call to LHDN. This API will also share the document through the PEPPOL network if it's enabled for sharing.
Request Method
POST
Request URL
Copy https://api-sandbox.my.cleartax.com/einvoice/v1/documents/generate
Parameter Data Type Field Validations Description Mandatory. User auth token.
Mandatory. TIN of the entity
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.
Should be unique for every request
Optional. Unique request ID.
Used for Debugging Support Issues
Request Path Params
There are no path parameters for this API.
Request Query Params
Parameter Data Type Field Validations Description Default: false
Will only run Validations
SALES, PURCHASE, SALES_B2C
Request Body
Parameter Data Type Field Validations Description MinListLength: 1
MaxListLength: 10
Mandatory. List of Documents
Mandatory. MY_GENERATE_UBL_2_1_V1
Documents Object
Parameter Data Type Field Validations Description Mandatory. Base64 of the document data shared below
Mandatory. Describes the data received is in the JSON Format or in the XML Format.
Mandatory. Identifier provided by the user to distinctly identify the document at their end. Generally formed with concatenation of TIN, Document Number, Document Type, Fiscal Year fields with _
Example: C948329382_INV-101_INV_2024
Map of Custom fields with key-value pair eg : ( {
“Internal Number” : “INV000012”
})
Custom Fields Object
This is a custom object of key-value pairs that can be used to display custom fields in custom output PDF templates or in certain reports.
For example:
Copy {
"country_of_origin" : "IN" ,
"total_containers" : "3"
}
Sample Request
Request Body
Copy {
"Documents" : [
{
"DocumentData": "{
    "InvoiceTypeCode": {
        "Value": "01"
    },
    "InvoicePeriod": {
        "StartDate": "2024-06-03",
        "EndDate": "2024-06-03",
        "Description": "Monthly"
    },
    "BillingReference": [
        {
            "AdditionalDocumentReference": {
                "Id": ""
            }
        }
    ],
    "IssueDate": "2024-06-03",
    "IssueTime": "18:30:00",
    "DocumentCurrencyCode": "MYR",
    "Id": "TEST-SALES-001",
    "AccountingCustomerParty": {
        "Party": {
            "Contact": {
                "ElectronicMail": "info@gmail.com",
                "Telephone": "6032230090"
            },
            "PartyIdentification": [
                {
                    "Id": {
                        "SchemeID": "TIN",
                        "Value": "C5896234040"
                    }
                },
                {
                    "Id": {
                        "SchemeID": "BRN",
                        "Value": "199501010666"
                    }
                },
                {
                    "Id": {
                        "SchemeID": "SST",
                        "Value": "NA"
                    }
                }
            ],
            "PartyLegalEntity": {
                "RegistrationName": "Defmacro Software Pvt Ltd"
            },
            "PostalAddress": {
                "AddressLine": [
                    {
                        "Line": "Level 33"
                    },
                    {
                        "Line": "Ilham Tower"
                    },
                    {
                        "Line": " 8 Jalan Binjai"
                    }
                ],
                "CityName": " 8 Jalan Binjai",
                "Country": {
                    "IdentificationCode": {
                        "CountryCode": "MYS"
                    }
                },
                "CountrySubentityCode": "14",
                "PostalZone": "50450"
            }
        }
    },
    "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"
            }
        }
    },
    "Delivery": {
        "DeliveryParty": {
            "Contact": {
                "ElectronicMail": "info@olivestouch.com",
                "Telephone": "6032230090"
            },
            "PartyIdentification": [
                {
                    "Id": {
                        "SchemeID": "TIN",
                        "Value": "C5896234040"
                    }
                },
                {
                    "Id": {
                        "SchemeID": "BRN",
                        "Value": "199501010666"
                    }
                },
                {
                    "Id": {
                        "SchemeID": "SST",
                        "Value": "NA"
                    }
                }
            ],
            "PartyLegalEntity": {
                "RegistrationName": "CAMPBELL SOUP SOUTHEAST ASIA SDN BHD"
            },
            "PostalAddress": {
                "AddressLine": [
                    {
                        "Line": "Level 33"
                    },
                    {
                        "Line": "Ilham Tower"
                    },
                    {
                        "Line": " 8 Jalan Binjai"
                    }
                ],
                "CityName": " 8 Jalan Binjai",
                "Country": {
                    "IdentificationCode": {
                        "CountryCode": "MYS"
                    }
                },
                "CountrySubentityCode": "14",
                "PostalZone": "50450"
            }
        }
    },
    "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": "Service charge",
            "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"
                    },
                    "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 - Document Details - Decoded (JSON)
Sample Request - Document Details - Decoded (XML)
Response Status Codes
HTTP Status Code Description For successfully submitted document or with validation errors
For any kind of Invalid Payload issues
If the user is not authenticated for the operation
If the user is not authorized for the operation
Response Schema
Parameter Data Type Field Validations Description Mandatory. Indicates the request was successful or not
Optional.
Error list from ClearTax
Document Details Object
Parameter Data Type Field Validations Description Unique document id generated in database
Mandatory. Same uniqueId as shared in the request
Unique identifier provided in the input request.
Indicates, if the request for this document was successfully processed or not
Mandatory. Cleartax reference Id used for further actions. Should be persisted in ERP
Optional.
Error list from ClearTax/LHDN
Optional.
Warning list from ClearTax
Sample Response (Success)
HTTP Status Code
200
Response Body
Copy {
"ErrorDetails" : null ,
"Success" : true ,
"DocumentResponses" : [
{
"DocumentId" : "665f28c2f626dc2cac32abea" ,
"Success" : "true" ,
"UniqueId" : "C58746708080_TEST-SALES-001_01_2024" ,
"Uuid" : "Y4K7SPNCBE8FAQSCWDEEVHZH10" ,
"InternalId" : null ,
"ErrorDetails" : [] ,
"WarningDetails" : null ,
"UniqueIdentifier" : null
}
]
}
Sample Response (Error)
HTTP Status Code: 400
Response Body
Copy {
"ErrorDetails" : null ,
"Success" : true ,
"DocumentResponses" : [
{
"DocumentId" : null ,
"Success" : false ,
"UniqueId" : "C10709273050_20240410035_01_2024" ,
"Uuid" : null ,
"InternalId" : null ,
"ErrorDetails" : [
{
"ErrorCode" : "ERR-10001" ,
"ErrorMessage" : "Supplier TIN null is not matching the TIN present in the account" ,
"ErrorSource" : "CLEARTAX"
}
] ,
"WarningDetails" : [
{
"Code" : null ,
"Message" : null
}
]
}
]
}
API Validations
Currently there are no known validations.
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 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.