TF - Documents Endpoints

/api/partner/1.0/tf/documents/getList (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 the following security role:

      • Tax – Access Forms Product

    • When the user has access to the below security role, he is able to use the property customReturnManagerFilterIds in the request body to filter the results based on the custom filter Id(s) provided. In case the user does not have access to the said security role and he tries to apply a filter, an error 403: Insufficient privileges to execute this request is returned:

      • Tax – Return Manager – Custom Filters - Apply

    • Whenever the user has access to the below optional security role, he is able to get the value of the taxReferenceNumber property for TF documents. In case the user does not have access to the said security role, the taxReferenceNumber property will be returned as empty in all the retrieved documents:

      • Tax – TF - Return Manager – View Account Number Column

  • This endpoint validates against the user’s contact security and document visibility. If the user does not have access to a given document or to the contact associated to this document, the document will not be included in the response body.

Endpoint description

Returns a list of documents with all metadata available in the return manager for a specific year of the TF product.

Note: Requesting the list of documents for the latest taxation period displayed in the return manager will return the list of documents for all years supported by this version. For example, if the last year currently displayed in the return manager supports 2023 and later, this means that getting the list of documents for 2024 will return the list of documents present in the return manager for the 2023 and later period.

Model

{

"cursor": "string",

"search": "string",

"perPage": 0,

"sortColumn": "string",

"sortOrder": "string",

"filters": {},

"excludePlanner": true,

"customReturnManagerFilterIds": [

0

]

}

Properties

cursor: Optional parameter used to navigate between the pages of the resulting response. The "nextCursor" and "prevCursor" parameters, returned in the response of this endpoint, provide the value to use for the cursor parameter.

When this parameter is included in a request, the other parameters will be ignored.

search: Optional parameter used for filtering out results based on a string search.

perPage: Optional parameter that controls the number of results per page (1-500). If you do not include the per page parameter, the application will default to 500.

sortColumn: Optional parameter to sort on a specific columnID. The list of columnIDs can be viewed here. If you do not include the sortColumn parameter, the application will sort using the date modified column.

sortOrder: Optional parameter used to sort in ascending or descending order. If you do not include the sortOrder parameter, the application will default to ascending order.

filters: Optional parameter used for filtering out results based on column(s) value(s). One or more columnIDs must be provided with values to use. The list of columnIDs is available here

excludePlanner: Optional parameter used to include or exclude planner files. If you do not include the excludePlanner parameter, the application will include the planner documents by default.

customReturnManagerFilterIds: Optional parameter used for filtering out results based on a custom filter. The ID of the custom filter must be provided, it can be found in the URL of each custom filter under “Settings/Tax/Custom Diagnostics & Custom Filters”.

Examples

Example of getting a list of returns where the reviewer ID is 1:

Request URL

Example of getting a list of returns where the reviewer is the ID 1 user:https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/getList?returnManagerYear=2023

Request body

{

"perPage": 500,

"sortColumn": "date_modified",

"sortOrder": "Desc",

"filters": {

"reviewer_id": [

1

]

}

}

Response body

{

"result": [

{

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Waters Group",

"firstName": "",

"lastName": "",

"contactType": "Non-profit Organization",

"taxReferenceNumber": "#########RR####",

"returnId": 0,

"clientCode": "JS-179901814",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": {

"userId": 1,

"firstName": "Marc",

"lastName": "Lacasse"

},

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}],

"documentId": "1ae28e5f-45d0-4b35-9a8b-a91f24f21283",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "",

"labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6",

"lastModificationTimestamp": "2024-04-23T15:01:20Z"

}],

"prevCursor": null,

"nextCursor": null,

"errors": []

}

Example of getting a list of returns where the date modified is between two timestamps:

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/getList?returnManagerYear=2023

Request body

{

"perPage": 500,

"sortColumn": "date_modified",

"sortOrder": "Desc",

"filters": {

"date_modified": [

"2024-04-23T01:11:45Z",

"2024-04-24T01:11:45Z"

]

}

}

Response body

{

"result": [

{

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Waters Group",

"firstName": "",

"lastName": "",

"contactType": "Non-profit Organization",

"taxReferenceNumber": "#########RR####",

"returnId": 0,

"clientCode": "JS-179901814",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": {

"userId": 1,

"firstName": "Marc",

"lastName": "Lacasse"

},

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}],

"documentId": "1ae28e5f-45d0-4b35-9a8b-a91f24f21283",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "",

"labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6",

"lastModificationTimestamp": "2024-04-23T15:01:20Z"

}],

"prevCursor": null,

"nextCursor": null,

"errors": []

}

Example of getting a list of returns where the date modified starts from a specific date until this precise moment:

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/getList?returnManagerYear=2023

Request body

{

"perPage": 500,

"sortColumn": "date_modified",

"sortOrder": "Desc",

"filters": {

"date_modified": [

"2024-04-23T01:11:45Z"

]

}

}

Response body

{

"result": [

{

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Waters Group",

"firstName": "",

"lastName": "",

"contactType": "Non-profit Organization",

"taxReferenceNumber": "#########RR####",

"returnId": 0,

"clientCode": "JS-179901814",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": {

"userId": 1,

"firstName": "Marc",

"lastName": "Lacasse"

},

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}],

"documentId": "1ae28e5f-45d0-4b35-9a8b-a91f24f21283",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "",

"labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6",

"lastModificationTimestamp": "2024-04-23T15:01:20Z"

}],

"prevCursor": null,

"nextCursor": null,

"errors": []

}

Example of getting a list of returns where the T4 slips EFILE status is Generated – Original:

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/getList?returnManagerYear=2023

Request body

{

"perPage": 50,

"sortColumn": "date_modified",

"sortOrder": "Desc",

"filters": {

"t4_efile_status": [

"Generated - Original"

]

}

}

Response body

{

"result": [

{

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Waters Group",

"firstName": "",

"lastName": "",

"contactType": "Non-profit Organization",

"taxReferenceNumber": "#########RR####",

"returnId": 0,

"clientCode": "JS-179901814",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Generated - Original",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": {

"userId": 1,

"firstName": "Marc",

"lastName": "Lacasse"

},

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}],

"documentId": "1ae28e5f-45d0-4b35-9a8b-a91f24f21283",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "",

"labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6",

"lastModificationTimestamp": "2024-04-23T15:01:20Z"

}],

"prevCursor": null,

"nextCursor": null,

"errors": []

}

Example of getting a list of returns where the contact type is Corporation:

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/getList?returnManagerYear=2023

Request body

{

"perPage": 500,

"sortColumn": "date_modified",

"sortOrder": "Desc",

"filters": {

"contact_type": [

"Corporation"

]

}

}

Response body

{

"result": [

{

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Johnson Group",

"firstName": "",

"lastName": "",

"contactType": "Corporation",

"taxReferenceNumber": "#########RC####",

"returnId": 0,

"clientCode": "JS-179901814",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": {

"userId": 1,

"firstName": "Marc",

"lastName": "Lacasse"

},

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}],

"documentId": "1ae28e5f-45d0-4b35-9a8b-a91f24f21283",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "",

"labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6",

"lastModificationTimestamp": "2024-04-23T15:01:20Z"

}],

"prevCursor": null,

"nextCursor": null,

"errors": []

}

Example of getting a list of returns that is filtered based on a Custom Filter:

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/getList?returnManagerYear=2023

Request body

{

"perPage": 500,

"sortColumn": "date_modified",

"sortOrder": "Desc",

"customReturnManagerFilterIds": [

338

]

}

Response body

{

"result": [

{

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Harvey Brayan",

"firstName": "Brayan",

"lastName": "Harvey",

"contactType": "Individual",

"taxReferenceNumber": "#########",

"returnId": 0,

"clientCode": "TW-176573492",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Eligible",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Eligible"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": {

"userId": 1,

"firstName": "Marc",

"lastName": "Lacasse"

},

"partner": null,

"returnStatusId": " 3ff2c111-dc7d-471d-bbbe-8f02a86c8ac1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3",

"columnValues": {

"338": {

"REERSUM.R4": "3000",

"T4Sum.R8": "55000"

}

}

}],

"documentId": "1ae28e5f-45d0-4b35-9a8b-a91f24f21283",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "",

"labelId": "10ae1db5-1736-44c0-b8ea-7f18aea380a1",

"lastModificationTimestamp": "2024-04-23T15:01:20Z"

}],

"prevCursor": null,

"nextCursor": null,

"errors": []

}

/api/partner/1.0/tf/documents (POST)

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 the following security roles:

      • Tax – Access Forms Product

      • Tax – Returns - Add

    • The user cannot create a document for a new contact if he does not have access to the below security role:

      • Contacts - View, Add and Edit Contacts

  • This endpoint validates against the user’s contact security. If the user does not have access to the contact associated to the document he is requesting to create, an error 404: Resource not found in the system is returned.

Endpoint description

Creates a new TF document and, once it is created, returns the metadata of the new document including the ID. This endpoint can create a document from an existing contact or for a new contact.

Creating a TF document from an existing contact.

Model

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"details": "string",

"labelId": "00000000-0000-0000-0000-000000000000",

"existingClientCode": "string"

}

Properties

taxYearStartDate: Taxation year-start date of the document.

taxYearEndDate: Taxation year-end date of the document.

details: Details to add to the document (optional).

labelId: The value of the label to be associated to the document (optional).

existingClientCode: Client Code of the existing contact for which you want to create a document.

Creating a TF document from a new contact of Individual or Sole proprietor type.

Model

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "string",

"newClient": {

"firstName": "string",

"lastName": "string",

"birthDate": "1978-08-15",

"title": "Ms",

"taxReferenceNumber": "#########",

"code": "string",

"group1Id": -1,

"group2Id": -1

},

"details": "String",

"labelId": "00000000-0000-0000-0000-000000000000"

}

Properties

taxYearStartDate: Taxation year-start date of the document.

taxYearEndDate: Taxation year-end date of the document.

contactType: Type of contact of the new contact to create.

firstName: First name of the taxpayer.

lastName: Last name of the taxpayer.

birthDate: Date of birth of the taxpayer.

title: Title of the taxpayer (Mr., Mrs., or Ms.).

taxReferenceNumber: Social insurance number of the taxpayer.

code: Client code of the new contact.

details: Details to add to the document (optional).

labelId: The value of the label to be associated to the document (optional).

group1Id: ID of the group1 option (optional: default to -1)

group2Id: ID of the group2 option (optional: default to -1)

Creating a TF document from a new contact of Corporation type.

Model

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "string",

"newClient": {

"name": "string",

"taxReferenceNumber": "#########RC####",

"code": "string",

"group1Id": -1,

"group2Id": -1

},

"details": "String",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1"

}

Properties

taxYearStartDate: Taxation year-start date of the document.

taxYearEndDate: Taxation year-end date of the document.

contactType: Type of contact of the new contact to create.

name: Name of the corporation.

taxReferenceNumber: Business number of the corporation.

code: Client code of the new contact.

details: Details to add to the document (optional).

labelId: The value of the label to be associated to the document (optional).

group1Id: ID of the group1 option (optional: default to -1)

group2Id: ID of the group2 option (optional: default to -1)

 

Creating a TF document from a new contact of Non-profit Organization type.

Model

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "string",

"newClient": {

"name": "string",

"taxReferenceNumber": "#########RR####",

"code": "string",

"group1Id": -1,

"group2Id": -1

},

"details": "String",

"labelId": "00000000-0000-0000-0000-000000000000"

}

Properties

taxYearStartDate: Taxation year-start date of the document.

taxYearEndDate: Taxation year-end date of the document.

contactType: Type of contact of the new contact to create.

name: Name of the non-profit organization.

taxReferenceNumber: Account number of the non-profit organization.

code: Client code of the new contact.

details: Details to add to the document (optional).

labelId: The value of the label to be associated to the document (optional).

group1Id: ID of the group1 option (optional: default to -1)

group2Id: ID of the group2 option (optional: default to -1)

Creating a TF document from a new contact of Partnership type.

Model

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "string",

"newClient": {

"name": "string",

"taxReferenceNumber": "#########RZ####",

"code": "string",

"group1Id": -1,

"group2Id": -1

},

"details": "String",

"labelId": "00000000-0000-0000-0000-000000000000"

}

Properties

taxYearStartDate: Taxation year-start date of the document.

taxYearEndDate: Taxation year-end date of the document.

contactType: Type of contact of the new contact to create.

name: Name of the partnership.

taxReferenceNumber: Account number of the partnership.

code: Client code of the new contact.

details: Details to add to the document (optional).

labelId: The value of the label to be associated to the document (optional).

group1Id: ID of the group1 option (optional: default to -1)

group2Id: ID of the group2 option (optional: default to -1)

Creating a TF document from a new contact of Trust & Estate – Testamentary or Trust - Inter-Vivos type.

Model

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "string",

"newClient": {

"name": "string",

"taxReferenceNumber": "T########",

"code": "string",

"group1Id": -1,

"group2Id": -1

},

"details": "String",

"labelId": "00000000-0000-0000-0000-000000000000"

}

Properties

taxYearStartDate: Taxation year-start date of the document.

taxYearEndDate: Taxation year-end date of the document.

contactType: Type of contact of the new contact to create.

name: Name of the trust.

taxReferenceNumber: Account number of the trust.

code: Client code of the new contact.

details: Details to add to the document (optional).

labelId: The value of the label to be associated to the document (optional).

group1Id: ID of the group1 option (optional: default to -1)

group2Id: ID of the group2 option (optional: default to -1)

Creating a TF document from a new contact of Other type.

Model

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "string",

"newClient": {

"name": "string",

"taxReferenceNumber": "#########AA####",

"code": "string",

"group1Id": -1,

"group2Id": -1

},

"details": "String",

"labelId": "00000000-0000-0000-0000-000000000000"

}

Properties

taxYearStartDate: Taxation year-start date of the document.

taxYearEndDate: Taxation year-end date of the document.

contactType: Type of contact of the new contact to create.

name: Name of the entity.

taxReferenceNumber: Account number of the entity.

code: Client code of the new contact.

details: Details to add to the document (optional).

labelId: The value of the label to be associated to the document (optional).

group1Id: ID of the group1 option (optional: default to -1)

group2Id: ID of the group2 option (optional: default to -1)

Note: The “code” parameter is optional if the option Auto assign numeric client codes for new contacts has been enabled for your site.

Examples

Type: Corporation

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents

Request body

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "Corporation",

"newClient": {

"name": "Corporation Inc",

"taxReferenceNumber": "#########RC####",

"code": "Abc123",

"group1Id": -1,

"group2Id": -1

},

"details": "Copy-1",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1"

}

Response body

{

"result": {

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Corporation Inc",

"firstName": "",

"lastName": "",

"contactType": "Corporation",

"taxReferenceNumber": "#########RC####",

"returnId": 0,

"clientCode": "Abc123",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": null,

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}

],

"documentId": "a6bec801-06bf-4548-abb3-763d222450b2",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "Copy-1",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1",

"lastModificationTimestamp": "2024-09-23T16:22:20Z"

},

"errors": []

}

 

Type: Individual or Sole proprietor

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents

Request body

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "Individual",

"newClient": {

"firstName": "John",

"lastName": "Smith",

"birthDate": "1968-05-30",

"title": "Mr",

"taxReferenceNumber": "#########",

"code": "Abc123",

"group1Id": -1,

"group2Id": -1

},

"details": "Copy-2",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1"

}

Response body

{

"result": {

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Smith John",

"firstName": "John",

"lastName": "Smith",

"contactType": "Individual",

"taxReferenceNumber": "#########",

"returnId": 0,

"clientCode": "Abc123",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": null,

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}

],

"documentId": "9e0230cf-63da-40e5-b73f-8ccd60281a65",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "Copy-2",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1",

"lastModificationTimestamp": "2024-09-23T16:37:20Z"

},

"errors": []

}

 

Type: Trust & Estate - Testamentary or Trust - Inter-Vivos

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents

Request body

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "Trust & Estate - Testamentary",

"newClient": {

"name": "Trust-1",

"taxReferenceNumber": "T########",

"code": "Abc123",

"group1Id": -1,

"group2Id": -1

},

"details": "Copy-3",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1"

}

Response body

{

"result": {

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Trust-1",

"firstName": "",

"lastName": "",

"contactType": "Trust & Estate - Testamentary",

"taxReferenceNumber": "T########",

"returnId": 0,

"clientCode": "Abc123",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": null,

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}

],

"documentId": "677ed313-c47c-4d51-9d1a-8cf606f17ccf",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "Copy-3",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1",

"lastModificationTimestamp": "2024-09-24T12:47:59Z"

},

"errors": []

}

 

Type: Partnership

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents

Request body

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "Partnership",

"newClient": {

"name": "Partnership",

"taxReferenceNumber": "#########RZ####",

"code": "Abc123",

"group1Id": -1,

"group2Id": -1

},

"details": "Copy-4",

"labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6"

}

Response body

{

"result": {

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Gutkowski - McDermott",

"firstName": "",

"lastName": "",

"contactType": "Partnership",

"taxReferenceNumber": "#########RZ####",

"returnId": 0,

"clientCode": "Abc123",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": null,

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}

],

"documentId": "9df9cf49-b33d-446f-87d9-d05f80a120d1",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "Copy-4",

"labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6",

"lastModificationTimestamp": "2024-09-24T12:55:02Z"

},

"errors": []

}

 

Type: Non-profit Organization

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents

Request body

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "Non-profit Organization",

"newClient": {

"name": "Non-Profit Organization",

"taxReferenceNumber": "#########RR####",

"code": "Abc123",

"group1Id": -1,

"group2Id": -1

},

"details": "Copy-5",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1"

}

Response body

{

"result": {

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Non-Profit Organization",

"firstName": "",

"lastName": "",

"contactType": "Non-profit Organization",

"taxReferenceNumber": "#########RR####",

"returnId": 0,

"clientCode": "Abc123",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": null,

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}

],

"documentId": "ffaf22af-1205-4582-a2c3-27639a467ba2",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "Copy-5",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1",

"lastModificationTimestamp": "2024-09-24T13:35:43Z"

},

"errors": []

}

 

Type: Other

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents

Request body

{

"taxYearStartDate": "2023-01-01",

"taxYearEndDate": "2023-12-31",

"contactType": "Other",

"newClient": {

"name": "Other return",

"taxReferenceNumber": "#########RT####",

"code": "Abc123",

"group1Id": -1,

"group2Id": -1

},

"details": "Copy-6",

"labelId": "48637ae7-69ae-57ae-7b1d-c47529e16ba7",

}

Response body

{

"result": {

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Other return",

"firstName": "",

"lastName": "",

"contactType": "Other",

"taxReferenceNumber": "#########RT####",

"returnId": 0,

"clientCode": "Abc123",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Not Applicable",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Not Applicable",

"t5013ret": "Not Applicable",

"rl1_t4": "Not Applicable",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Not Applicable",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": null,

"reviewer": null,

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}

],

"documentId": "b2ae537e-0863-45ab-a148-fd88afbd2754",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "Copy-6",

"labelId": "48637ae7-69ae-57ae-7b1d-c47529e16ba7",

"lastModificationTimestamp": "2024-09-24T13:38:44Z"

},

"errors": []

}

Note: The "group1Id" and "group2Id" properties are always returned in the response of the documents endpoint even if the groups are not activated for your site. The ID -1 represents the “None” group option.

/api/partner/1.0/tf/documents/recycleBin (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 the following security roles:

      • Tax – Access Forms Product

      • Tax – Recycle Bin – Access

    • Whenever the user has access to the below optional security role, he is able to get the value of the taxReferenceNumber property for TF documents. In case the user does not have access to the said security role, the taxReferenceNumber property will be returned as empty in all the retrieved documents:

      • Tax – TF - Return Manager – View Account Number Column

  • This endpoint validates against the user’s contact security and document visibility. If the user does not have access to a given document or to the contact associated to this document, the document will not be included in the response body.

Endpoint description

Returns a list of all TF documents, with their associated metadata, that have been deleted and are in the recycle bin. This endpoint will also return all private documents that may not be visible to all users when accessing the recycle bin modal through the user interface.

The “label” value returned in the response body corresponds to the value displayed in the Details column of the return manager.

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/recycleBin

Request body

N/A

Response body

{

"result": [{

"deletedBy": "UserName",

"deletedOn": "2024-04-07T14:50:26Z",

"taxationStartDate”: “2023-03-16”,

"taxationEndDate”: “2024-03-15”,

"taxpayers": [{

"name”: “Charly Soap",

"firstName”: “Charly",

"lastName”: “Soap",

"contactType": "Individual",

"taxReferenceNumber": "#########",

"returnId": 0,

"clientCode": "10819",

"efileStatuses": {

"nr4": "Not Eligible",

"t4": "Not Applicable",

"t4a": "Not Eligible",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Eligible",

"t4fhsa": "Eligible",

"t5": "Eligible",

"t5008": "Eligible",

"t5018": "Eligible",

"t5013": "Eligible",

"t5013ret": "Eligible",

"rl1_t4": "Eligible",

"rl1_t4a": "Eligible",

"rl1_t4anr": "Eligible",

"rl2_t4a": "Eligible",

"rl2_rif": "Eligible",

"rl2_rsp": "Eligible",

"rl3": "Eligible",

"rl7": "Eligible",

"rl8": "Eligible",

"rl11": "Eligible",

"rl15": "Eligible",

"rl16": "Eligible",

"rl18": "Eligible",

"rl22": "Eligible",

"rl24": "Eligible",

"rl25": "Eligible",

"rl27": "Eligible",

"rl30": "Eligible",

"rl31": "Eligible",

"rl32": "Eligible",

"t2202": "Eligible",

"rrsp": "Eligible"

},

"eSignatureStatuses": {},

"Preparer": {

"userId": 39,

"firstname": "Marc",

"lastname": "Lacasse"

},

"Reviewer": {

"userId": 54,

"firstname": "Alex",

"lastname": "Tremblay"

},

"Partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}],

"documentId": "4e3f9358-9e0c-4488-a617-bd62f44b1a65",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "Details",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1",

"lastModificationTimestamp": "2024-04-07T14:50:26Z"

}],

"errors": []

}

/api/partner/1.0/tf/documents/{documentId} (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 the following security role:

      • Tax – Access Forms Product

  • 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

Returns a specific TF document with all metadata available in the return manager. .

The document GUID must be inserted in the URL of the request.

Model

N/A

Properties

N/A

Examples

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/1014c371-7dae-4c7d-a8ea-bdbe2af6f202

Request body

N/A

Response body

{

"result": {

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Kohler LLC",

"firstName": "",

"lastName": "",

"contactType": "Trust & Estate - Testamentary",

"taxReferenceNumber": "T########",

"returnId": 0,

"clientCode": "Abc12345",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Generated - Original",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Not Applicable",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Eligible",

"t5013ret": "Not Eligible",

"rl1_t4": "Eligible",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Eligible",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Eligible",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": {

"userId": 19,

"firstName": "John",

"lastName": "Smith"

},

"reviewer": null,

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}],

"documentId": "1014c371-7dae-4c7d-a8ea-bdbe2af6f202",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1",

"lastModificationTimestamp": "2024-04-23T16:50:43Z"

},

"errors": []

}

/api/partner/1.0/tf/documents/{documentId}/copy (POST)

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 the following security roles:

      • Tax – Access Forms Product

      • Tax – Returns – Copy

  • 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

Copies a specific document in the TF product. The GUID of the document needs to be inserted in the URL of the request.

Model

{

"details": "string",

"labelId": "00000000-0000-0000-0000-000000000000"

}

Properties

details: Optional parameter to add details to the copied document.

labelId: Optional parameter to add a label to the copied document.

Examples

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/7584665b-7a55-4606-9176-473d7b769eda/copy

Request body

{

"details": "Scenario 1",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1"

}

Response body

{

"result": {

"taxationStartDate": "2023-01-01",

"taxationEndDate": "2023-12-31",

"taxpayers": [

{

"name": "Kohler LLC",

"firstName": "",

"lastName": "",

"contactType": "Trust & Estate - Testamentary",

"taxReferenceNumber": "T########",

"returnId": 0,

"clientCode": "Abc12345",

"efileStatuses": {

"nr4": "Not Applicable",

"t4": "Generated - Original",

"t4a": "Not Applicable",

"t4anr": "Not Applicable",

"t4rif": "Not Applicable",

"t4rsp": "Not Applicable",

"t4fhsa": "Generated - Original",

"t5": "Not Applicable",

"t5008": "Not Applicable",

"t5018": "Not Applicable",

"t5013": "Eligible",

"t5013ret": "Not Eligible",

"rl1_t4": "Eligible",

"rl1_t4a": "Not Applicable",

"rl1_t4anr": "Not Applicable",

"rl2_t4a": "Not Applicable",

"rl2_rif": "Not Applicable",

"rl2_rsp": "Not Applicable",

"rl3": "Not Applicable",

"rl7": "Not Applicable",

"rl8": "Not Applicable",

"rl11": "Not Applicable",

"rl15": "Eligible",

"rl16": "Not Applicable",

"rl18": "Not Applicable",

"rl22": "Not Applicable",

"rl24": "Not Applicable",

"rl25": "Not Applicable",

"rl27": "Not Applicable",

"rl30": "Not Applicable",

"rl31": "Not Applicable",

"rl32": "Not Applicable",

"t2202": "Not Applicable",

"rrsp": "Not Applicable"

},

"eSignatureStatuses": {},

"preparer": {

"userId": 19,

"firstName": "John",

"lastName": "Smith"

},

"reviewer": null,

"partner": null,

"returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1",

"group1Id": -1,

"group2Id": -1,

"environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3"

}],

"documentId": "1014c371-7dae-4c7d-a8ea-bdbe2af6f202",

"isLocked": false,

"isPrivate": false,

"wasRolledForward": false,

"details": "Scenario 1",

"labelId": "415c4238-9117-d545-75k5-a6o5785bdba1",

"lastModificationTimestamp": "2024-04-23T16:50:43Z"

},

"errors": []

}

wasRolledForward parameter limitation

The parameter "wasRolledForward" is returned for every year and period. However, the parameter will display the “false” default value for all TF documents prior to 2020.

/api/partner/1.0/tf/documents/delete (POST)

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 the following security roles:

      • Tax – Access Forms Product

      • Tax – Returns – Delete

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

Endpoint description

Deletes one document or a batch of documents and moves them to the Recycle Bin. The GUID of the document(s) must be provided in the request body.

Model

{

"documentIds": [

"string"

]

}

Properties

documentIds: The GUID(s) array of documents can be retrieved by creating a get request using the Documents endpoint.

Examples

Request URL

https://mysite.cchifirm.ca/taxcan/api/partner/1.0/tf/documents/delete

Request body

{

"documentIds": [

" fedf6b5d-3d01-4276-899e-19fe2d222388"

]

}

Response body

{

"errors": []

}