Breaking changes

Endpoint impacted

Description of the breaking change

Get EFILE information for a specific document.

The structure of the responses coming from the EFILE info endpoint has changed from:

Prior to v31:

{

"result": {

"t1": {

"0": [

{

"transmissionDate": "2021-01-14T16:40:02Z",

"transmitterName": "John Lacasse",

"firstName": "Paul C",

"lastName": "Three",

"dcn": "B123456TXP9CZ",

"revisionCode": "",

"message": "182-04 - The 2019 tax return for PAUL C THREE has been successfully received by the Canada Revenue Agency and is being processed. The CRA may perform a pre-assessment verification on this return. If so, the processing may be delayed and supporting documentation may be requested. Please do not submit any documentation unless it is requested. The same selection criteria for verifying income tax returns are used for both paper and electronic versions. Your client needs to keep all tax information slips and documents for six years after you filed the tax return. Please keep this confirmation number and DCN for your records: FDDYFOB9-B123456TXP9CZ",

"resultCode": "182",

"errors": [],

"status": "Accepted",

"confirmationNumber": "FDDYFOB9"

}

...

After v31:

{

"result": {

"t1": [

{

"returnId": 0,

"transmissions": [

{

"transmissionDate": "2021-01-14T16:40:02Z",

"transmitterName": "John Lacasse",

"firstName": "Paul C",

"lastName": "Three",

"dcn": "B123456TXP9CZ",

"revisionCode": "",

"message": "182-04 - The 2019 tax return for PAUL C THREE has been successfully received by the Canada Revenue Agency and is being processed. The CRA may perform a pre-assessment verification on this return. If so, the processing may be delayed and supporting documentation may be requested. Please do not submit any documentation unless it is requested. The same selection criteria for verifying income tax returns are used for both paper and electronic versions. Your client needs to keep all tax information slips and documents for six years after you filed the tax return. Please keep this confirmation number and DCN for your records: FDDYFOB9-B123456TXP9CZ",

"resultCode": "182",

"errors": [],

"status": "Accepted",

"confirmationNumber": "FDDYFOB9"

}

...

Get the list of documents along with their metadata (e.g. EFILE status) from the return manager of a specific taxation period.
  • The endpoint now uses the HTTP POST method.
  • The request body is now required.
  • The modifiedSince parameter was removed and replaced by the filtering capability on the date_modified column.
  • The route of the endpoint was modified to /api/partner/1.0/{product}/documents/getList.

For more information on this endpoint, please consult the following pages: