Smart Templates error list

The Smart Templates plugin returns consistent and structured error responses. This helps you quickly understand what went wrong and how to fix it.

Error format

{  
   "code": "<error_code>",  
   "title": "<error_title>",  
   "message": "<error_message>"  
}

Field definitions

  • code – A stable, unique identifier for the error. Useful for programmatic handling and support requests.
  • title – A short, human-readable summary of the issue.
  • message – Detailed guidance to help you resolve the error.

This structure ensures you always get actionable feedback when something doesn’t go as expected.


Smart Template errors


The following errors can occur when interacting with the Smart Template endpoints. Each error follows our standard structure, making it easier to debug and respond to issues programmatically.

Refer to the table below for a list of possible error codes, what they mean, and how to resolve them.


400

CodeTitleMessage
TPL-0001Missing required fieldsOne or more required fields are missing. Please ensure all required fields like description, template, and outputFormat are included.
TPL-0002Invalid file formatThe uploaded file must be a .tpl file. Other formats are not supported.
TPL-0003Invalid output formatThe outputFormat field must be one of: html, csv, or xml.
TPL-0004Invalid headerOne or more header values are missing or incorrectly formatted. Please verify required headers %VALUE.
TPL-0005Invalid File UploadedThe file you submitted is invalid. Please check the uploaded file with error: %VALUE
TPL-0007Error File Content InvalidThe file content is invalid because is not %s. Please check the uploaded file.
TPL-0008Invalid Map FieldsThe field on template file is invalid. Invalid field %s on %s.
TPL-0009Invalid Path ParameterPath parameters is in an incorrect format. Please check the following parameter %v and ensure they meet the required format before trying again.
TPL-0010Update Output format without template FileCan not update output format without passing template file. Please check information passed and try again.
TPL-0012Invalid templateIDThe specified templateID is not a valid UUID. Please check the value passed.
TPL-0013Invalid ledgerIDThe specified ledgerID inside ledger ID list is not a valid UUID. Please check the value passed %v.
TPL-0014Missing required fieldsThe fields mapped on template file is missing on tables schema. Please check the fields passed '%v'.
TPL-0015Unexpected Fields in the RequestThe request body contains more fields than expected. Please send only the allowed fields as per the documentation. The unexpected fields are listed in the fields object.
TPL-0016Missing Fields in RequestYour request is missing one or more required fields. Please refer to the documentation to ensure all necessary fields are included in your request.
TPL-0020Invalid Date Format ErrorThe 'initialDate', 'finalDate', or both are in the incorrect format. Please use the 'yyyy-mm-dd' format and try again.
TPL-0021Invalid Final Date ErrorThe 'finalDate' cannot be earlier than the 'initialDate'. Please verify the dates and try again.
TPL-0023Invalid Date Range ErrorBoth 'initialDate' and 'finalDate' fields are required and must be in the 'yyyy-mm-dd' format. Please provide valid dates and try again
TPL-0024Pagination Limit ExceededThe pagination limit exceeds the maximum allowed of %v items per page. Please verify the limit and try again.
TPL-0025Invalid Sort OrderThe 'sort_order' field must be 'asc' or 'desc'. Please provide a valid sort order and try again.
TPL-0026Metadata Key Length ExceededThe metadata value %v exceeds the maximum allowed length of %v characters. Please use a shorter value.
TPL-0027Metadata Value Length ExceededThe metadata value %v exceeds the maximum allowed length of %v characters. Please use a shorter value.
TPL-0028Invalid Metadata NestingThe metadata object cannot contain nested values. Please ensure that the value %v is not nested and try again.
TPL-0029Report status not FinishedThe Report is not ready to download. Report is processing yet.
TPL-0030Missing Schema TableThere is a schema table missing. Please check your template file passed.

404

CodeTitleMessage
TPL-0006Error File EmptyThe file you submitted is empty. Please check the uploaded file.
TPL-0011Entity Not FoundNo %v entity was found for the given ID. Please make sure to use the correct ID for the entity you are trying to manage.
TPL-0017Bad RequestThe server could not understand the request due to malformed syntax. Please check the listed fields and try again.
TPL-0019Invalid Query ParameterOne or more query parameters are in an incorrect format. Please check the following parameters '%v' and ensure they meet the required format before trying again.
TPL-0022Date Range Exceeds Limit ErrorThe range between 'initialDate' and 'finalDate' exceeds the permitted limit of %v months. Please adjust the dates and try again.
TPL-0026Report not foundNo report was found for the provided ID.

500

CodeTitleMessage
TPL-0018Internal Server ErrorThe server encountered an unexpected error. Please try again later or contact support.