HTTP Error Messages

The following is the list of HTTP error codes for which a precision was added as well as additional messages to ensure that you can better understand why the request resulted in a HTTP error:

HTTP status code	Type	Messages	Description of the error
400 Bad request	Client error	{Missing Field Name} is required.	Error returned when a mandatory field is not included in a request.
		Request is invalid.	Error returned when the request does not respect the JSON structure.
		Return status ID is invalid.	Error returned when a return status ID is invalid and does not respect the GUID structure.
		Return ID: {ReturnId} is invalid.	Error returned when a return ID provided in the body of a request is invalid.
		Document ID: {id} is invalid.	Error returned when a document ID provided in the body of a roll forward request is invalid and does not respect the GUID structure.
		Cannot pass "FirstName" and "LastName" parameters together with "Name." Pass either "FirstName" and "LastName" or "Name" only.	Error returned when sending a request to create a Forms document using the firstName, lastName and name parameters: For Individual and Sole Proprietor contact types, provide only the firstName and lastName parameters. For all other contact types, provide only the name parameter.
		Cannot pass both "newClient" and "existingClientCode" parameters at the same time.	Error returned when the newClient parameter is provided in the same request as the existingClientCode parameter. The newClient parameter is used to create a new contact while the existingClientCode parameter is used for an existing contact.
		T1: Invalid sin. Expected format is ######### T2: Invalid business number. Expected format is #########RC#### T3: Invalid account number. Expected format is T######## TF: Invalid tax reference number. Expected format is {expectedFormat} Note: The expected format of the tax reference number for the Forms product varies depending on the type of contact. Here is the expected format of each type: Individual and Sole proprietor = "#########" Trust & Estate - Testamentary and Trust Inter-Vivos = "T########" Corporation = "#########RC####" Non-profit Organization = "#########RR####" Partnership = "#########RZ####" Other = "#########AA####"	Error returned when a request is sent to create a Forms document for a new contact and the tax reference number provided does not comply with the format expected.
		'newClient' parameter is required if the parameter "existingClientCode" is not included in the request.	Error returned when both newClient and existingClientCode parameters are missing in a request to create a new document.
		The date entered in the "overridePrintedDate" parameter must be in the ISO-8601 format: YYYY-MM-DD.	Error returned when the date entered in the overridePrintedDate parameter is provided in a format other than the ISO-8601 format.
		The language must be English or French.	Error returned when the language set is other than French or English.
		The print format with ID: '{id}' was not found for {product}-{Year}.	Error returned when a print format ID does not exist for the product and version requested.
		Print format ID: {id} is invalid.	Error returned when a print format ID is invalid and does not respect the structure of a GUID.
		Cannot include more than 20 documents per request.	Error returned when more than 20 documents are included in a request using the "Print a batch of documents to PDF endpoint"
		Cannot roll forward more than 200 documents per request.	Error returned when more than 200 documents are included in a request using the "Roll forward" endpoint.
		Preparer profile with ID: '{id}' not found for {product} product.	Error returned when a preparer profile ID cannot be found for the specified product.
		Electronic services identification profile with ID: '{id}' not found.	Error returned when an electronic services identification profile cannot be found.
		The {product} product is not supported by this endpoint.	Error returned when using an endpoint not supported in the specified product.
		The data type is invalid.	Error returned when an invalid data type is input with the "Print document slips to PDF" endpoint.
		Review filter : ‘{filterName}’ is invalid.	Error returned when an invalid filter name is input with the “Review Filter” endpoint.
		The '{dataType}' data type cannot be used with the '{formName}' form.	Error returned when using the data type requested is not supported for a particular form.
		The '{formName}' form is not supported for printing in this version of the {product} product.	Error returned when using a form that is not supported by the version of the document.
		Cannot filter the column with ID: {columnID}.	Error returned when attempting to filter on a column that does not support filtering. See the List of column IDs to use for filtering and sorting for more details.
		Cannot sort the column with ID: {columnID}.	Error returned when attempting to sort on a column that does not support sorting. See the List of column IDs to use for filtering and sorting for more details.
		The column with ID: {columnID} is invalid.	Error returned when attempting to sort or filter on a columnID that does not exist.
		The sortOrder {sortOrderDeclared} is invalid.	Error returned when the sortOrder input is invalid.
		Product ID: {id} is invalid.	Error returned when the product type input is invalid.
		The perPage parameter value entered must be within the accepted range (1-500)	Error returned when the value provided with the perPage parameter is not between 1 and 500.
		The value used to filter on the column with id {columnID} is invalid.	Error returned when filtering on a column using a string value that does not correspond to an existing value.
		The type of value entered with the '{columnID} column ID is invalid. Provide a {valueType} value type.	Error returned when filtering on a column with the wrong type of value. See the List of column IDs to use for filtering and sorting for the type of value to use per column.
		Label ID is invalid.	Error returned when the Label ID in the request body is not valid and does not fit the structure of a GUID.
		Label with ID: ‘{id}’ not found for [product] product.	Error returned when the Label in the request body does not exist for the product specified in the URL.
		The sorting functionality is currently not available. Remove the 'sortColumn' parameter from the request and launch the request again.	Error returned when the sort function is currently not available. The parameters sortColumn and sortOder must be removed from the request and the request must be resent.
		The provided documents cannot belong to different tax years.	Error returned when attempting to couple a document with another where both documents belong to different tax years.
		The provided documents cannot belong to different product types.	Error returned when attempting to couple a document with another where both documents belong to different product types.
		The taxpayer must be spouse or dependant.	Error returned when the property taxpayer is set to a value other than spouse or dependant.
401 Unauthorized Client error	Client error	You are not authorized to execute this action.	Error returned when an authentication is required to use an endpoint: Error returned when the Web API key is not provided or is invalid when using the Web API Keys authentication method. Error returned when either one of the session, access token, refresh token is not valid or the user does not have access to the API Administration security role.
403 Forbidden	Client error	Insufficient privileges to execute this request.	Error returned when the access is insufficient: Error returned when the Web API key provided is of Read-only type and the action requires the user to write in the system while using the Web API Keys authentication method. For example, creating a new document requires a Read-write type Web API key. Error returned when the user fails to obtain access to all the security roles required to trigger a certain endpoint while using the OAuth 2.0 authentication method. For example, retrieving the list of T1 labels while the user does not have access to the Tax – Access T1 Product security role.
		You do not have access to this product.	Error returned when the request targets a product for which the Web API is not active.
		You do not have access to the TP1 product.	Error returned when attempting to use the TP1 product when the TP1 product is not active for the site.
		You do not have access to the TP-646 product.	Error returned when attempting to use the TP-646 product when the TP-646 product is not active for the site.
404 Not found	Client error	Resource ID '{resourceId}' not found in the system.	Error returned when a resource provided is not found. For example, the GUID of a document that was deleted is provided in a request for the GetData endpoint.
		Return ID '{returnId}' not found for document ID {documentId}.	Error returned when the provided returnId does not exist for a specific document.
		ReturnStatus ID '{resourceId}' not found in the system for the specified product.	Error returned when the returnStatusId provided does not exist for a specific product.
		Requested endpoint not found.	Error returned when targeting an endpoint that does not exist.
		Resource not found in the system.	Error returned when targeting a resource to which user does not have contact security access or return visibility access.
405 Method not allowed	Client error	The requested resource does not support http method '{Method}'.	Error returned when the HTTP verb used to send the request is not supported by the endpoint.
409 Conflict	Client error	Concurrent access. Re-submit request.	Error returned when the sent request could not be executed because of another action that occurred at the same time.
429 Too many requests	Client error	Request limit has been reached. Try again later.	Error returned when the number of requests limit per minute or second was reached.
500 Internal Server Error	Server error	Something went wrong while processing your request. We apologize for the inconvenience.	Error returned when the server could not correctly handle the request.
503 Service Unavailable	Server error	The service is currently not available. Try again later.	Error returned when the server is unable to handle the request due to a temporary overload or scheduled maintenance.