Preparer Profiles Endpoints

/api/partner/1.0/{product}/preparerProfiles (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

Endpoint description

Returns a list of preparer profiles for the product and year specified in the URL of the endpoint.

Model	N/A
Properties	N/A

Examples

Request URL	https://mysite.cchifirm.ca/taxcan/api/partner/1.0/T1/preparerProfiles?year=2020
Request body	N/A
Response body	{ "result": [ { "id": 37, "name": "Default Preparer Profile", "description": "This is the default profile", "isDefault": ["d6d50e87-7189-4ac9-b136-cc849412f4c3"], "lastModificationTimestamp": "2021-04-12T14:00:55Z" }, { "id": 22, "name": "Montreal", "description": "This is the Montreal profile", "isDefault": ["d6d50e87-7189-4ac9-b136-cc849412f4c3"], "lastModificationTimestamp": "2021-04-09T19:04:27Z" }, { "id": 30, "name": "Sherbrooke", "description": "This is the Sherbrooke profile", "isDefault": ["d6d50e87-7189-4ac9-b136-cc849412f4c3"], "lastModificationTimestamp": "2021-04-09T18:44:09Z" }], "errors": [] }

/api/partner/1.0/{product}/documents/preparerProfile (PUT)

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 modify the preparer profile of a document if he does not have access to the below security role:

    • Tax – Returns – Change Preparer Profile

• 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 request body or the contact associated to this document, an error 404: Resource not found in the system is returned.

Endpoint description

Updates the preparer profile for the documents specified in the request body with the preparer profile specified. The product (T1, T2, T3, TF) must be included in the URL.

Model	{ "preparerProfileId": 0, "documentIds": [ "string" ] }
Properties	preparerProfileId: The ID of the preparer profile can be retrieved by creating a GET request using the preparerProfiles endpoint.
	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/T1/documents/preparerProfile
Request body	{ "preparerProfileId": 22, "documentIds": [ "fedf6b5d-3d01-4276-899e-19fe2d222388" ] }
Response body	{ "errors": [] }