List of Errors and Messages

Status codes and messages (Response body)

Unhandled status code
Cell-level status codes
Validation-level status codes
Document- and return- level status codes
Contact-level status codes
Roll forward-level status codes
Print- and publish-level status codes
Return Assignees level status codes

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:

The social insurance number is invalid.
The business number is invalid. It must be in the #########RC#### format and differ from #########RC0000.
The postal code is invalid.
The phone number is invalid. Enter it in this format: ##########
The tax shelter identification number is invalid. Enter it in this format: TS######.
The tax shelter identification number is invalid. Enter it in this format: QAF#######
The partnership identification number is invalid. Enter it in this format: ##########SP####.
The Québec sales tax number is invalid. Enter it in this format: ##########TQ####.
The business number is invalid. Enter it in this format: #########RZ####.
The Québec identification number is invalid. It must be in the following format: ##########XX####.
The Alberta Corporate Account Number is invalid.
The Québec enterprise number is invalid.
The Québec identification number is invalid.
The Saskatchewan capital tax account number is invalid.
The RQ employer account number is invalid.
The number of characters cannot exceed {X}
The date format is invalid. Enter it in this format: YYYY-MM-DD.
Invalid XLAT value
The number is invalid. Enter a valid numerical value with a maximum of 2 decimals.

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:

The bankruptcy year must be YYYY.
The electronic filer number is invalid. Enter it in this format: ANNNN.
The business number is invalid.
The taxation year must begin before YYYY.
The taxation year start date cannot be later than the taxation year end date.

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.
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	Resource {resourceId} not found in the system.	Error returned when a document, provided in the body of a request, is not found in the system or is invalid and does not respect the structure of a GUID.
312	Error	A production label cannot be associated with a plannerdocument {documentId}.	Error returned when attempting to create a planner return with a label of Production mode.
316	Error	Document {documentId} and label {labelId} do not belong to the same product type.	Error returned when attempting to update the label of a document where both the document and the label belong to different product types.

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.
403	Error	Client code is already in use by another contact.	Error returned when the client code is already in use by another contact.
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.	The “Error” code type is returned in the ““errors”: []” property of the response with an errorCode and an errorMessage. The “Warning” and “Success” code types are returned in the ““result”:[]” property of the response with a resultCode and resultMessage. The scenarios getting a “Warning” code type do not always result in a document being rolled forward. For example, when the document is that of a deceased main taxpayer, which will result in the document not being rolled forward. In that case, the “rolledForwardDocumentIds” parameter will be returned empty in the response. Example: { "result": [ { "sourceDocumentId": "d639dd78-1771-48a2-b9f2-7186812e1551", "rolledForwardDocumentIds": [], "resultMessage": "Taxpayer data not rolled forward: Deceased last year.", "resultCode": 503 } ], "errors": [] }
501	Success	Document rolled forward.
502	Success	Document rolled forward from other software format.
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.
507	Error	The document contains data from a TP1 return; this data has not been rolled forward.
508	Success	Spouse data rolled forward in separate document: taxpayer and spouse separated last year.
509	Success	New dependant document(s) created.
510	Error	Document not used last year.
511	Warning	Dependant data not rolled forward : Deceased last year.
512	Error	Roll forward failed.
513	Error	Roll forward from other software format 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.
519	Error	Document not found.
520	Error	The document format is not valid.
521	Error	Taxation period not supported.
522	Error	Document is password-protected.
523	Error	Cannot Roll forward the document because it is a planner document.
524	Error	Cannot Roll forward the document because it was created with an unsupported version of the program.
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.
527	Error	Cannot complete operation: the Roll forward generated more than one document.
528	Warning	Document not rolled-forward: it includes an early-documented return for a deceased taxpayer.
529	Error	The account number is not valid.

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.
604	Error	The return cannot be published because the contact is not subscribed to the portal.	Error returned when a contact is not subscribed to the Portal.
605	Error	Year or period included in the request for document {documentId} is invalid.	Error returned when the year or period in the request is invalid.
606	Error	The jurisdiction for document {documentId} with return ID {returnId} must be FED, QC or/and AB.	Error returned when the jurisdiction of a document is invalid.
607	Error	The product access is missing for document {documentId} with return ID {returnId}.	Error returned when the user includes a jurisdiction value where he does not have access to the corresponding product.
608	Error	The jurisdiction {jurisdiction} is not valid for document {documentId} with return ID {returnId}.	Error returned when the document does not meet the requirements to be eligible or valid for the jurisdiction.
609	Error	The language for document {documentId} with return id {returnId} must be English or French.	Error returned when attempting to print to PDF or publish to Portal using a language other than English or French.

Return Assignees level status codes

Code	Type	Message	Description
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.
803	Error	The user ID {id} provided for the reviewer is not valid.	Error returned when updating the Reviewer assignee with a Reviewer Id that is not set as a Reviewer in the user settings.
804	Error	The user ID {id} provided for the preparer is not valid.	Error returned when updating the Preparer assignee with a Preparer Id that is not set as a Preparer in the user settings.
805	Error	The user ID {id} provided for the manager is not valid.	Error returned when updating the Manager assignee with a Manager Id that is not set as a manager in the user settings.