EFILE Information Endpoints

/api/partner/1.0/{product}/documents/{documentId}/efileinfo (GET)

Endpoint authentication

When adopting OAuth 2.0 as an authentication method, the below security requirements are needed in order to trigger this endpoint:

  • The user must fulfill the below security roles requirements; if he fails to obtain access to all the necessary security roles, an error 403: Insufficient privileges to execute this request is returned:

    • The user must acquire access to at least one of the following security roles; he needs to have access to the security role corresponding to the product included in the URL:

      • Tax – Access T1 Product

      • Tax – Access T2 Product

      • Tax – Access T3 Product

      • Tax – Access Forms Product

        • In addition, the user cannot get the EFile history of a document if he does not have access to the below security role:

          • Tax – T1 – Returns – EFILE, Access transmission history

          • Tax – T2 – Returns – EFILE, Access transmission history

          • Tax – T3 – Returns – EFILE, Access transmission history

          • Tax – TF – Returns – EFILE, Access transmission history

  • This endpoint validates against the user’s contact security and document visibility. If the user does not have access to the document provided in the URL or the contact associated to this document, an error 404: Resource not found in the system is returned.

Endpoint description

Retrieve the EFILE information of a specific document. The product (T1, T2, T3, TF) and the GUID of the document must be included in the URL.

Model

N/A

Properties

N/A

Examples

Example of T1 returns transmitted for the main taxpayer and spouse, and a T1135 form transmitted for the main taxpayer only:

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/T1/documents/40862a7f-2b04-4ae5-a61f-7fe7c018bf88/efileinfo

Request body

N/A

Response body

{

"result": {

"t1": [

{

"returnId": 0,

"transmissions": [

{

"transmissionDate": "2020-10-08T13:44:08Z",

"transmitterName": "John Lacasse",

"firstName": "Donna",

"lastName": "Five",

"dcn": "B123456TXP9CZ",

"revisionCode": "",

"status": "Accepted",

"confirmationNumber": "A070AOFB",

"message": "The 2019 tax return for Donna Five has been successfully received and has been processed by the Canada Revenue Agency. 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: A070AOFB-B123456TXP9CZ",

"resultCode": "180",

"errors": []

}]

},

{

"returnId": 1,

"transmissions": [

{

"transmissionDate": "2020-10-08T14:54:52Z",

"transmitterName": "John Lacasse",

"firstName": "Herman",

"lastName": "Singh",

"dcn": "B123456TXP9CZ",

"revisionCode": "",

"status": "Accepted",

"confirmationNumber": "90719NOP",

"message": "The 2019 tax return for Herman Singh has been successfully received and has been processed by the Canada Revenue Agency. 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: 90719NOP-B123456TXP9CZ",

"resultCode": "180",

"errors": []

}]

}],

"t1135": [

{

"returnId": 0,

"transmissions": [

{

"transmissionDate": "2020-10-08T13:44:07Z",

"transmitterName": "John Lacasse",

"firstName": "Donna",

"lastName": "Five",

"dcn": "B123456TXP9CZ",

"revisionCode": "",

"status": "Accepted",

"confirmationNumber": "H0IYAA6Y",

"message": "Thank you for using EFILE. The 2019 tax form for Donna Five has been successfully received by the Canada Revenue Agency. Please keep this confirmation number and DCN for your records: H0IYAA6Y - B123456TXP9CZ",

"resultCode": "480",

"errors": []

}]

}]

},

"errors": []

}

Example of a T2 return transmitted with 2 attachments:

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/T2/documents/40862a7f-2b04-4ae5-a61f-7fe7c018bf00/efileinfo

Request body

N/A

Response body

{

"result": {

"t2": [

{

"returnId": 0,

"transmissions": [

{

"transmissionDate": "2023-03-08T20:03:30Z",

"transmitterName": "John Lacasse",

"name": "Hegmann, Dach and Ondricka",

"status": "Accepted",

"confirmationNumber": "CCH2088",

"attachments": [

{

"transmissionDate": "2023-03-08T15:03:35-05:00",

"confirmationNumber": "CCH05163433",

"fileName": "Elections.xlsx",

"status": "Accepted",

"errors": []

},

{

"transmissionDate": "2023-03-08T15:03:35-05:00",

"confirmationNumber": "CCH70183766",

"fileName": "InformationSlips.docx",

"status": "Accepted",

"errors": []

}],

"message": "Please keep this confirmation number for your records. Your return will be verified using the same criteria that we apply to other filing methods. You are required to keep all information for six years.",

"resultCode": "",

"errors": []

}]

}]

},

"errors": []

}

Important

To add precisions in the EFILE information endpoint responses, the taxpayer index is now returned via the “returnId” property and the transmissions are returned via the “transmissions” object.

/api/partner/1.0/efileIdentificationProfiles (GET)

Endpoint authentication

When adopting OAuth 2.0 as an authentication method, the below security requirements are needed in order to trigger this endpoint:

  • The user must fulfill the below security roles requirements; if he fails to obtain access to all the necessary security roles, an error 403: Insufficient privileges to execute this request is returned:

    • The user must acquire access to at least one of the following security roles;

      • Tax – Access T1 Product

      • Tax – Access T2 Product

      • Tax – Access T3 Product

      • Tax – Access Forms Product

    • In addition, the user cannot get the list of Electronic Services Identification Profiles if he does not have access to the below security role:

      • Tax – Settings – Access Firm EFILE information

Endpoint description

Returns a list of electronic services identification profiles that can be used to EFILE a return.

Model

N/A

Properties

N/A

Examples

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/efileIdentificationProfiles

Request body

N/A

Response body

{

“result”: [

{ “id”: 56,

“name”: “Marc Lacasse”,

“description”: ”A description”,

“lastUpdated”: “2021-09-29T15:15:48Z”,

“isDefault”: [

"40c07188-8c27-4c31-8182-ae2604cf9659"

}

],

“errors”: []

}