T3 - Documents Endpoints
Cette page est en cours de traduction. Elle sera mise à jour dès que son contenu sera disponible en français.
/api/partner/1.0/t3/documents/getList (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 role:
-
Tax – Access T3 Product
-
-
-
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 of the T3 product for a specific year.
Note: Requesting the list of documents for a taxation period supported by the latest T3 version will return the list of documents for all of the years supported by this version. For example, if the latest version supports 2021 and later, this means that getting the list of documents for 2022 will return the list of documents present in the return manager for the version 2021 and later:
|
Model |
{ "cursor": "string", "search": "string", "perPage": 0, "sortColumn": "string", "sortOrder": "string", "filters": {}, "excludePlanner": true, "customReturnManagerFilterIds": [ 0 ] } |
|
Properties |
cursor: Optional parameter used to navigate between pages of the resulting response. The "nextCursor" and "prevCursor" parameters, returned in the response of this endpoint, provides 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 |
https://mysite.cchifirm.ca/taxcan/api/partner/1.0/t3/documents/getList?returnManagerYear=2021 |
|
Request body |
{ "perPage": 500, "sortColumn": "date_modified", "sortOrder": "Desc", "filters": { "reviewer_id": [ 1 ] } } |
|
Response body |
{ "result": [ { "taxationStartDate": "2021-01-01", "taxationEndDate": "2021-12-31", "taxpayers": [ { "name": "Yundt Inc", "accountNumber": "T########", "returnId": 0, "clientCode": "JS-76320290", "efileStatuses": { "nR4": "Not Applicable", "rL16": "Not Applicable", "t3RET": "Not Applicable", "t3": "Not Applicable", "t1061": "Not Applicable", "t2000": "Not Applicable", "t3D": "Not Applicable", "t3GR": "Not Applicable", "t3M": "Not Applicable", "t3P": "Not Applicable", "t3RI": "Not Applicable", "t3S": "Not Applicable", "t3s_efile": "Not Applicable" “t3ret_efile”:”Not Eligible”, "t3m_efile": "Not Applicable", “t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": 0 }, "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": "747ba372-e759-438d-b7eb-6c2f739ebef5", "isLocked": false, "isPrivate": false, "wasRolledForward": false, "details": "Copy 1", "labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6", "lastModificationTimestamp": "2022-01-23T12:51:07Z" }], "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/t3/documents/getList?returnManagerYear=2021 |
|
Request body |
{ "perPage": 500, "sortColumn": "date_modified", "sortOrder": "Desc", "filters": { "date_modified": [ "2021-04-21T01:11:45Z", "2021-04-24T01:11:45Z" ] } } |
|
Response body |
{ "result": [ { "taxationStartDate": "2021-01-01", "taxationEndDate": "2021-12-31", "taxpayers": [ { "name": "Yundt Inc", "accountNumber": "T########", "returnId": 0, "clientCode": "JS-76320290", "efileStatuses": { "nR4": "Not Applicable", "rL16": "Not Applicable", "t3RET": "Not Applicable", "t3": "Not Applicable", "t1061": "Not Applicable", "t2000": "Not Applicable", "t3D": "Not Applicable", "t3GR": "Not Applicable", "t3M": "Not Applicable", "t3P": "Not Applicable", "t3RI": "Not Applicable", "t3S": "Not Applicable", "t3s_efile": "Not Applicable" “t3ret_efile”:”Not Applicable”, "t3m_efile": "Eligible", "t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": 1 }, "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": "747ba372-e759-438d-b7eb-6c2f739ebef5", "isLocked": false, "isPrivate": false, "wasRolledForward": false, "details": "Copy 1", "labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6", "lastModificationTimestamp": "2021-04-23T12:51:07Z" }], "prevCursor": null, "nextCursor": null, "errors": [] } |
Example of getting a list of returns where the date from a particular timestamp is modified to the current date:
|
Request URL |
https://mysite.cchifirm.ca/taxcan/api/partner/1.0/t3/documents/getList?returnManagerYear=2021 |
|
Request body |
{ "perPage": 500, "sortColumn": "date_modified", "sortOrder": "Desc", "filters": { "date_modified": [ "2021-04-22T05:10:45Z" ] } } |
|
Response body |
{ "result": [ { "taxationStartDate": "2021-01-01", "taxationEndDate": "2021-12-31", "taxpayers": [ { "name": "Yundt Inc", "accountNumber": "T########", "returnId": 0, "clientCode": "JS-76320290", "efileStatuses": { "nR4": "Not Applicable", "rL16": "Not Applicable", "t3RET": "Not Applicable", "t3": "Not Applicable", "t1061": "Not Applicable", "t2000": "Not Applicable", "t3D": "Not Applicable", "t3GR": "Not Applicable", "t3M": "Not Applicable", "t3P": "Not Applicable", "t3RI": "Not Applicable", "t3S": "Not Applicable", "t3s_efile": "Not Applicable" “t3ret_efile”:”Not Eligible”, "t3m_efile": "Not Applicable", "t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": 0 }, "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": "747ba372-e759-438d-b7eb-6c2f739ebef5", "isLocked": false, "isPrivate": false, "wasRolledForward": false, "details": "Copy 1", "labelId": "46918af7-78dc-49bc-9a9d-c82218c18ba6", "lastModificationTimestamp": "2022-01-23T12:51:07Z" }], "prevCursor": null, "nextCursor": null, "errors": [] } |
Example of getting a list of returns where the T3 slips EFILE status is Generated – Original:
|
Request URL |
https://mysite.cchifirm.ca/taxcan/api/partner/1.0/t3/documents/getList?returnManagerYear=2021 |
|
Request body |
{ "perPage": 50, "sortColumn": "date_modified", "sortOrder": "Desc", "filters": { "t3_efile_status": [ "Generated - Original" ] } } |
|
Response body |
{ "result": [ { "taxationStartDate": "2021-01-01", "taxationEndDate": "2021-12-31", "taxpayers": [ { "name": "Yundt Inc", "accountNumber": "T########", "returnId": 0, "clientCode": "JS-76320290", "efileStatuses": { "nR4": "Not Eligible", "rL16": "Eligible", "t3RET": "Generated - Original", "t3": "Generated - Original", "t1061": "Eligible", "t2000": "Eligible", "t3D": "Eligible", "t3GR": "Eligible", "t3M": "Eligible", "t3P": "Eligible", "t3RI": "Eligible", "t3S": "Eligible", "t3s_efile": "Not Applicable", "t3ret_efile": "Not Applicable", "t3m_efile": "Not Applicable", "t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": 0 }, "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": "747ba372-e759-438d-b7eb-6c2f739ebef5", "isLocked": false, "isPrivate": false, "wasRolledForward": false, "details": "Copy WebAPI", "labelId": "10ae1db5-1736-44c0-b8ea-7f18aea380a1", "lastModificationTimestamp": "2022-01-23T13:09:44Z" }], "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/t3/documents/getList?returnManagerYear=2021 |
|
Request body |
{ "perPage": 500, "sortColumn": "date_modified", "sortOrder": "Desc", "customReturnManagerFilterIds": [ 185 ] } |
|
Response body |
{ "result": [ { "taxationStartDate": "2021-01-01", "taxationEndDate": "2021-12-31", "taxpayers": [ { "name": "Yundt Inc", "accountNumber": "T########", "returnId": 0, "clientCode": "JS-76320290", "efileStatuses": { "nR4": "Not Eligible", "rL16": "Eligible", "t3RET": "Generated - Original", "t3": "Generated - Original", "t1061": "Eligible", "t2000": "Eligible", "t3D": "Eligible", "t3GR": "Eligible", "t3M": "Eligible", "t3P": "Eligible", "t3RI": "Eligible", "t3S": "Eligible", "t3s_efile": "Not Applicable", "t3ret_efile": "Not Applicable", "t3m_efile": "Not applicable", "t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": 0 }, "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", "columnValues": { "185": { "DESIGN.B100": "0", "DESIGN.B102": "1", “T3.BalDiff”: “468.43” } } }], "documentId": "747ba372-e759-438d-b7eb-6c2f739ebef5", "isLocked": false, "isPrivate": false, "wasRolledForward": false, "details": "Copy WebAPI", "labelId": "10ae1db5-1736-44c0-b8ea-7f18aea380a1", "lastModificationTimestamp": "2022-01-23T13:09:44Z" }], "prevCursor": null, "nextCursor": null, "errors": [] } |
/api/partner/1.0/t3/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 T3 Product
-
Tax – Returns – Add and copy
-
-
-
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 T3 document and, once it is created, returns the metadata of the new including its ID. This endpoint can manage to create a document from both an existing contact and a new contact.
Creating a T3 document for an existing contact.
|
Model |
{ "taxYearStartDate": "2021-01-01", "taxYearEndDate": "2021-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 T3 document from a new contact
|
Model |
{ "taxYearStartDate": "2021-01-01", "taxYearEndDate": "2021-12-31", "newClient": { "name": "string", "accountNumber": "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. |
|
|
name: Name of the trust. |
|
|
accountNumber: 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) |
Note: The “code” parameter is optional if the option Auto assign numeric client codes for new contacts has been enabled for your site.
Examples
|
Existing contact |
New contact |
|
|
Request URL |
https://mysite.cchifirm.ca/taxcan/ |
https://mysite.cchifirm.ca/taxcan/ |
|
Request body |
{ "taxYearStartDate": "2021-01-01", "taxYearEndDate": "2021-12-31", "details": "Copy-1", "labelId": "415c4238-9117-d545-75k5-a6o5785bdba1", "existingClientCode": "Abc123" } |
{ "taxYearStartDate": "2021-01-01", "taxYearEndDate": "2021-12-31", "newClient": { "name": "Trust Inc.", "accountNumber": "T########", "code": "Abc1234" "group1Id": -1, "group2Id": -1 }, "details": "Copy-2", "labelId": "415c4238-9117-d545-75k5-a6o5785bdba1" } |
|
Response body |
{ "result": { "taxationStartDate": "2021-01-01", "taxationEndDate": "2021-12-31", "taxpayers": [ { "name": "My trust", "accountNumber": "T########", "returnId": 0, "clientCode": "Abc123", "efileStatuses": { "nR4": "Not Applicable", "rL16": "Not Applicable", "t3RET": "Not Applicable ", "t3": "Not Applicable", "t1061": " Not Applicable", "t2000": " Not Applicable", "t3D": " Not Applicable", "t3GR": " Not Applicable", "t3M": " Not Applicable", "t3P": " Not Applicable", "t3RI": " Not Applicable", "t3S": " Not Applicable", "t3s_efile": " Not Applicable", "t3ret_efile": "Not Eligible", "t3m_efile": " Not Applicable", "t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": 0 }, "preparer": null, "reviewer": null, "partner": null, "returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1", "group1Id": -1, "group2Id": -1, "environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3" } ], "documentId": "c36ce4e9-e8f9-4d86-b254-6f5060446504", "isLocked": false, "isPrivate": false, "wasRolledForward": false, "details": "Copy-1", "labelId": "415c4238-9117-d545-75k5-a6o5785bdba1", "lastModificationTimestamp": "2020-09-23T14:54:28Z" }, "errors": [] } |
{ "result": { "taxationStartDate": "2021-01-01", "taxationEndDate": "2021-12-31", "taxpayers": [ { "name": "Trust Inc.", "accountNumber": "T########", "returnId": 0, "clientCode": "Abc1234", "efileStatuses": { "nR4": "Not Applicable", "rL16": "Not Applicable", "t3RET": "Not Applicable", "t3": "Not Applicable", "t1061": " Not Applicable", "t2000": " Not Applicable", "t3D": " Not Applicable", "t3GR": " Not Applicable", "t3M": " Not Applicable", "t3P": " Not Applicable", "t3RI": " Not Applicable", "t3S": " Not Applicable", "t3s_efile": " Not Applicable", "t3ret_efile": "Not Eligible", "t3m_efile": " Not Applicable", "t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": 0 }, "preparer": null, "reviewer": null, "partner": null, "returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1", "group1Id": -1, "group2Id": -1, "environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3" } ], "documentId": "750c588d-fc0f-4219-a0ff-76b3487db0aa", "isLocked": false, "isPrivate": false, "wasRolledForward": false, "details": "Copy-2", "labelId": "415c4238-9117-d545-75k5-a6o5785bdba1", "lastModificationTimestamp": "2020-09-23T14:57:39Z" }, "errors": [] } |
/api/partner/1.0/t3/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 T3 Product
-
Tax – Recycle Bin – Access
-
-
-
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 T3 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.
|
Request URL |
https://mysite.cchifirm.ca/taxcan/api/partner/1.0/t3/documents/recycleBin |
|
Request body |
N/A |
|
Response body |
{ "result": [{ "deletedBy": "UserName", "deletedOn": "2023-04-07T14:50:26Z", "taxationStartDate”: “2022-03-16”, "taxationEndDate”: “2023-03-15”, "taxpayers": [{ "name”: “Grant Trust", "accountNumber": " T########", "returnId": 0, "clientCode": "108197775666", "efileStatuses": { "nR4": "Not Eligible", "rL16": "Not Applicable", "t3RET": "Not Eligible", "t3": "Not Applicable", "t1061": "Not Applicable", "t2000": "Eligible", "t3D": "Eligible", "t3GR": "Eligible", "t3M": "Eligible", "t3P": "Eligible", "t3RI": "Eligible", "t3S": "Eligible", "t3s_efile": "Not Applicable", "t3ret_efile": "Not Applicable", "t3m_efile": "Not Applicable", "t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": "0" }, "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": "2022-04-22T14:50:26Z" }], "errors": [] } |
/api/partner/1.0/t3/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 T3 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 T3 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/T3/documents/d2c33879-b45b-4f89-aefa-4e87f9f97e92 |
|
Request body |
N/A |
|
Response body |
{ "result": { "taxationStartDate": "2021-01-01", "taxationEndDate": "2021-12-31", "taxpayers": [ { "name": "Trust Inc.", "accountNumber": "T########", "returnId": 0, "clientCode": "Abc123", "efileStatuses": { "nR4": "Not Applicable", "rL16": "Not Applicable", "t3RET": "Not Applicable", "t3": "Not Applicable", "t1061": "Not Applicable", "t2000": "Not Applicable", "t3D": "Not Applicable", "t3GR": "Not Applicable", "t3M": "Not Applicable", "t3P": "Not Applicable", "t3RI": "Not Applicable", "t3S": "Not Applicable", "t3s_efile": "Not Applicable", "t3ret_efile": "Accepted", "t3m_efile": "Not Applicable", "t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": 2 }, "preparer": null, "reviewer": null, "partner": null, "returnStatusId": "415c4238-9117-d545-85b5-a6c5717bdba1", "group1Id": -1, "group2Id": -1, "environmentId": "d6d50e87-7189-4ac9-b136-cc849412f4c3" } ], "documentId": "d2c33879-b45b-4f89-aefa-4e87f9f97e92", "isLocked": false, "isPrivate": false, "wasRolledForward": false, "details": "test", "labelId": "415c4238-9117-d545-75k5-a6o5785bdba1", "lastModificationTimestamp": "2020-09-30T21:30:01Z" }, "errors": [] } |
Note: The “group1Id” and “group2Id” properties are always returned in the document’s endpoint response even if the groups are not activated for your site. The ID -1 represents the “None” group option.
/api/partner/1.0/t3/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 T3 Product
-
Tax – Returns – Add and 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 T3 product. The GUID of the document must 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/t3/documents/747ba372-e759-438d-b7eb-6c2f739ebef5/copy |
|
Request body |
{ "details": "Scenario 1", "labelId": "415c4238-9117-d545-75k5-a6o5785bdba1" } |
|
Response body |
{ "result": { "taxationStartDate": "2021-01-01", "taxationEndDate": "2021-12-31", "taxpayers": [ { "name": "Yundt Inc", "accountNumber": "T########", "returnId": 0, "clientCode": "JS-76320290", "efileStatuses": { "nR4": "Not Eligible", "rL16": "Eligible", "t3RET": "Generated - Original", "t3": "Generated - Original", "t1061": "Eligible", "t2000": "Eligible", "t3D": "Eligible", "t3GR": "Eligible", "t3M": "Eligible", "t3P": "Eligible", "t3RI": "Eligible", "t3S": "Eligible", "t3s_efile": "Not Applicable", "t3ret_efile": "Not Applicable", "t3m_efile": "Not Applicable", "t3rca_efile": "Not Applicable" “t3p_efile": "Not Applicable", “t3gr_efile": "Not Applicable", “t3ri_efile": "Not Applicable", “t3d_efile": "Not Applicable", “t1061_efile": "Not Applicable" }, "eSignatureStatuses": { "t183": 0 }, "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": "97409624-cebd-4c83-91fc-106498cb4806", "isLocked": false, "isPrivate": false, "wasRolledForward": false, "details": "Scenario 1", "labelId": "415c4238-9117-d545-75k5-a6o5785bdba1", "lastModificationTimestamp": "2022-01-23T14:25:16Z" }, "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 T3 documents prior to 2020.