List of Errors and Messages
Status codes and messages (Response body)
Contents
Unhandled status code
Code |
Type |
Message |
Description |
9999 |
Error |
An unexpected error has occurred. |
The request sent caused an unexpected error. |
Cell-level status codes
Code |
Type |
Message |
Description |
101 |
Error |
Cell not found in data structure. |
Error returned when a cell path was not found in the return data structure. It can be returned with any endpoint that accepts the “cellPath” parameter. |
102 |
Error |
Cannot change the value of a protected cell. |
Error returned when attempting to edit a protected cell value. It can be returned with the Setdata endpoint. |
103 |
Error |
Cannot change the value of a cell with a spreadsheet. |
Error returned when attempting to edit a cell with a spreadsheet. It can be returned with the Setdata endpoint. |
104 |
Error |
Cannot change the value of a cell with a breakdown. |
Error returned when attempting to edit a cell with a breakdown. It can be returned with the Setdata endpoint. |
105 |
Error |
Cell not part of or is not a multi-copy entity. |
Error returned where a cell path is found (i.e., error 101 will not be returned) but the form is not a repeatable form. |
106 |
Error |
Wildcards not supported in set SetData endpoint. |
Error returned when attempting to use a wildcard (*) in the SetData endpoint, which is not supported. |
108 |
Error |
There are no occurrences of this multi-copy entity in the document {DocumentID}. |
Error returned when getting the value of a repeatable form using the * wildcard when the form has no occurrence in the document. |
Validation-level status codes
Code |
Type |
Message |
Description |
202 |
Error |
There are many possible messages with this error code, here are some examples:
|
Error returned when the value is accepted but is in the wrong format (mask validation) or when a string is entered in a numerical cell. The error and messages can be returned with the Setdata endpoint. |
203 |
Error |
There are many possible messages with this error code, here are a few examples:
|
Error returned when the value is accepted and pushed to the return, but the value is rejected in the calculations because of a tax validation or constraint. The error and messages can be returned with the Setdata endpoint. |
Document- and return- level status codes
Code |
Type |
Message |
Description |
301 |
Error |
Document with id : '{id}' is locked. |
Error returned when attempting to modify a locked return. This error can be returned using the Setdata endpoint. |
302 |
Error |
Year or period included in the request is invalid. |
Error returned when the year or period covered is invalid for the Documents endpoint. For example, 2030 cannot be covered as there is no version supporting it. |
303 |
Error |
T1 planner document can only be created for {Latest}. |
Error returned when attempting to create a Planner document, using the documents endpoint, in a year that does not support the Planner mode. The only year that supports the Planner mode is the latest T1 version. Example:
|
304 |
Error |
Return status ID {returnStatusId} is inactive and cannot be assigned to the return(s). |
Error returned when attempting to set an inactive return status using the Returnstatus endpoints. Only active return statuses can be assigned. |
305 |
Error |
ReturnID '{returnId}' not found for document ID {DocumentID}. |
Error returned when the requested return ID does not exist for the target document. This error can be returned with any endpoint that supports the “returnId” property and for which elements are batch-processed. |
306 |
Error |
Document with ID ‘{GUID}’ not found in the system. |
Error returned when a document, provided in the body of a request, is not found in the system. |
307 |
Error |
Document ID ‘{id}’ is invalid. |
Error returned when a Document ID provided in the body of a request is not valid and does not respect the structure of a GUID.
|
308 |
Error |
Preparer profile with ID: ‘{id}’ not found for the year or period of the document with ID: ‘{id}’ |
Error returned when the preparer profile ID is not found for the year or period corresponding to the document included in a request to change a preparer profile. |
309 |
Error |
Cursor parameter value is invalid. |
Error returned when the value provided with the cursor parameter is invalid. |
310 |
Error |
This contact type does not match the existing contact type. |
Error returned when the contact type provided does not match with the contact type of the existing contact provided. This error should not occur for a new contact. |
311 |
Error |
Label ID ‘{labelId}’ is inactive and cannot be assigned to the return(s). |
Error returned when attempting to set a label that would be inactive for the given site. Only active labels can be assigned. |
312 |
Error |
A production label cannot be associated with a planner return. |
Error returned when attempting to create a planner return with a label of Production mode. |
Contact-level status codes
Code |
Type |
Message |
Description |
401 |
Error |
Contact type is invalid for the specified product. |
Error returned when attempting to create a return for an existing contact of an incorrect type for the product. This error can be returned with the Documents endpoint. |
402 |
Error |
Tax reference number is already in use by another contact. |
Error returned when the tax reference number is already in use by another contact. It can happen by setting the tax reference number using the Setdata endpoint or by creating a return using the Documents endpoint. |
403 |
Error |
Client code is already in use by another contact. |
Error returned when the client code is already in use by another contact. This error can be returned by the Documents endpoint. |
404 |
Error |
Group1 and/or group2 is deactivated. |
Error returned when the Group1 and/or Group2 is deactivated. It occurs when the user sets the group1Id and/or group2Id when creating a new document with a new contact but this group is deactivated. |
405 |
Error |
The group option {groupId} is hidden. |
Error returned when the group option (other than -1) is hidden (if both options are hidden in the combination, the error is returned for the first group). It occurs when the user sets the group option to hidden when creating a new document with a new contact. This error can only occur if the groups are activated. |
406 |
Error |
group1Id and/or group2Id does not exist. |
Error returned when the group1Id and/or group2Id property does not exist. This error can only occur if the groups are activated. |
Roll forward level status codes
Code |
Type |
Message |
Description |
500 |
Error |
An error occurred while trying to rollforward this document. |
|
501 |
Success |
Document rolled forward. |
|
503 |
Warning |
Taxpayer data not rolled forward: Deceased last year. |
|
504 |
Warning |
Document not rolled forward: The taxpayer was in pre-bankruptcy last year. |
|
505 |
Warning |
Spouse data not rolled forward: Deceased last year. |
|
506 |
Warning |
Document not rolled forward: The spouse was in pre-bankruptcy last year. |
|
508 |
Success |
Spouse data rolled forward in separate document: taxpayer and spouse separated last year. |
|
509 |
Success |
New dependant document(s) created. |
|
511 |
Warning |
Dependant data not rolled forward : Deceased last year. |
|
512 |
Error |
Roll forward failed. |
|
514 |
Warning |
Both taxpayer and spouse deceased last year. |
|
515 |
Warning |
Document not rolled forward: The taxpayer and the spouse were in pre-bankruptcy last year. |
|
516 |
Warning |
Taxpayer deceased last year. |
|
517 |
Warning |
Taxpayer in pre-bankruptcy last year. |
|
518 |
Error |
An error occurred during the Roll forward process. |
|
521 |
Error |
Taxation period not supported. |
|
523 |
Error |
Cannot Roll forward the document because it is a planner document. |
|
525 |
Warning |
The taxation year has been shortened to allow filing with the current version of the program. |
|
526 |
Warning |
The trust was wound up last year. |
Print- and publish-level status codes
Code |
Type |
Message |
Description |
601 |
Error |
Web API print features are not supported for {product} {Year}. |
Error returned when attempting to use a print feature in a year or period that is not print-supported. |
602 |
Error |
The PDF file cannot be generated because it is empty. |
Error returned when the PDF cannot be generated because it is empty. |
603 |
Error |
The '{formName}' form is invalid for this version of the {product} product. |
Error returned when the form name is invalid for the product. |
Return Assignees level status codes
Code |
Type |
Message |
Description |
801 |
Error |
The assignee value cannot be empty. |
Error returned when the user does not provide a value for either one of the three assignees. |
802 |
Error |
The user ID '{id}' provided for the partner is not valid. |
Error returned when the user provides a value to the Partner assignee and this value does not correspond to a user that is set as a partner. |