About CCH iFirm Taxprep Web API

The Web API module allows you to interact with the CCH iFirm Taxprep module externally from the application using HTTP requests. With this module, you can trigger different actions in CCH iFirm Taxprep such as extracting data, setting data, creating returns and more without the need to be in a browser. This way, you can enhance your firm’s workflow by creating your own home made solutions integrated with CCH iFirm Taxprep or simply integrate your existing tools with CCH iFirm Taxprep.

Authentication

There are 2 types of authentication methods to validate the access to the API: The Web API Keys authentication and the OAuth 2.0 authentication.

By default, all firms use the Web API Keys method which provides an unlimited access to all the API endpoints when using the read/write key. Only one of the methods can be used at a time.

Web API Keys Authentication

In order to use the Web API, a Web API key is required to authenticate yourself on the site. The key must be included as part of the HTTP request in an x-api-key header.

To manage the Web API keys, click Settings from the left-hand menu, then click Taxprep, then the Tax API Administration option.

Note: The Tax – Settings - Tax API Administration - Access security role is required to display the option in the Taxprep settings.

Manage Web API keys

Web API keys must be generated on first access. To do so, click the Click here to create keys link.

After clicking the link, two types of keys will be available for use by your firm:

a read-write type key, which allows you to get data and metadata, in addition to setting data or metadata in the different tax elements;
a read-only type key that allows you to get data and metadata from the different elements on your site.

You can manage the keys using the different interface buttons:

Copy the Web API key to the clipboard;
Regenerate the Web API key;
Revoke the Web API key.

A link that points to the API specifications is available in this page so that you can review our different endpoints. For more details, consult the API Specifications and discovery tool section.

OAuth 2.0 Authentication

OAuth adds several security layers by validating against all the different levels of CCH iFirm security: API access, Security Roles, Contact Security and Document Visibility. This authentication method checks the security requirements of each endpoint against the given access of a user.

When accessing the endpoints using OAuth, the system will read the access and refresh tokens which are generated automatically every 20 minutes and 24 hours respectively. The access token provides access to the Web API; it can be used several times. The refresh token is valid for one time only; it is used to obtain new access and refresh tokens. If the tokens are expired, or the user has an invalid username, password or session, an error 401: Unauthorized is displayed.
In order to trigger any endpoint, the system validates whether the user has access to the API Administration security role which is inherited from the global iFirm Web API. In case the user fails to obtain access, an error 401: Unauthorized is displayed.
When attempting to trigger a certain endpoint, OAuth 2.0 validates all the below levels where applicable:
- Security roles
- Contact security
- Document visibility

NB: The list of security layers above will differ from one endpoint to another; for more details, please refer to each endpoint’s specifications.

In case OAuth is activated, it does not work unless the user configures an application in the Application Integration screen under the Firm Settings. The Scope must be set as Taxprep and the Grant Type is Authorization Code. For more details on the Application Integration configuration, please refer to the page How do I implement Oauth2 token authentication for CCH iFirm API?

Web API identity

Some of the actions performed with the Web API create an entry in the document’s audit trail. For example, where the value of a cell is modified using the Web API, the audit trail displays this modification and the user associated with the action performed displays as API in case the user is adopting the API Keys authentication method:

In case the user is adopting the OAuth 2.0 authentication method, any action made via the API is captured in the Audit Trail with the user’s information:

CCH iFirm Taxprep Web API endpoints

Errors and messages (response body)

The Web API endpoints can return different errors in the response body depending on the context of the request. For more information about our different error messages, consult the List of errors and messages.

HTTP errors and messages

With the Web API, you might receive an HTTP error, for example, a 404 Not found error. In many scenarios, different messages were included to help you troubleshoot your requests. For more information, consult the list of HTTP error messages.

Rate Limiting

Different types of Web API requests of CCH iFirm Taxprep module are subject to different rate limits. The endpoints are separated in two categories which are Group A and Group B. You can consult the list of available endpoints to validate in which category they belong in this section : https://support.cchifirm.ca/en/content/cch_ifirm/web_api/api_about_cch_ifirm_tax_web_api.htm?Highlight=tax%20api#Endpoints

The maximum number of requests is dependent on the subscription package. The Group A of requests vary from a maximum of 30 requests per minute and 3000 requests per day to a maximum of 100 requests per minute and 144 000 requests per day. The Group B of requests vary from a maximum of 6 requests per minute and 125 requests per day to a maximum of 20 requests per minute and 6000 requests per day. Other plans are also available. Contact your solution consultant for more information.

A 429 http status code (i.e. Too many requests), is returned when the maximum number of requests per minute or day is reached. Note that the rate-limit algorithm that tracks the number of requests for the CCH iFirm Taxprep Web API includes a margin of error that may lead to imperfect count before you get an error for exceeding a threshold.

Web API Endpoints classification

In the API classification table below, you will be able to identify the Group A or Group B endpoints offered:

Group	Type	URL	Category
Audit Trail	GET	/api/partner/1.0/{product}/documents/{documentId}/auditTrail/{dateFilter}	Group A
EFILE	GET	/api/partner/1.0/{product}/documents/{documentId}/efileinfo	Group A
EFILE	GET	/api/partner/1.0/efileIdentificationProfiles	Group A
Return statuses	PUT	/api/partner/1.0/{product}/documents/{documentId}/returnStatus	Group A
Return statuses	GET	/api/partner/1.0/{product}/returnStatuses	Group A
Return statuses	PUT	/api/partner/1.0/{product}/documents/returnStatuses	Group A
Preparer profiles	GET	/api/partner/1.0/{product}/preparerProfiles	Group A
Preparer profiles	PUT	/api/partner/1.0/{product}/documents/preparerProfile	Group A
Print	GET	/api/partner/1.0/{product}/printFormats	Group A
Print	POST	/api/partner/1.0/{product}/print	Group B
Print	POST	/api/partner/1.0/{product}/documents/{documentId}/printslips	Group B
Print	GET	/api/partner/1.0/print/{resultId}	Group A
Return assignees	PUT	/api/partner/1.0/{product}/documents/assignees	Group A
Roll forward	POST	/api/partner/1.0/{product}/rollforward	Group B
Roll forward	GET	/api/partner/1.0/rollforward/{resultId}	Group A
Tasks	GET	/api/partner/1.0/tasks/{taskId}	Group A
Cells	POST	/api/partner/1.0/{product}/documents/{documentId}/cells/getdata	Group A
Cells	POST	/api/partner/1.0/{product}/documents/{documentId}/cells/setdata	Group A
Environments	GET	/api/partner/1.0/environments	Group A
File	GET	/api/partner/1.0/files/{fileId}	Group A
Groups	GET	/api/partner/1.0/groups	Group A
Labels	GET	/api/partner/1.0/{Product}/labels	Group A
Lock	POST	/api/partner/1.0/{product}/documents/{documentId}/lock	Group B
Lock	GET	/api/partner/1.0/lock/{resultId}	Group A
Unlock	POST	/api/partner/1.0/{product}/documents/{documentId}/unlock	Group A
T1 - Documents	POST	/api/partner/1.0/t1/documents	Group A
T1 - Documents	POST	/api/partner/1.0/t1/documents/getList	Group A
T1 - Documents	GET	/api/partner/1.0/t1/documents/recycleBin	Group A
T1 - Documents	GET	/api/partner/1.0/t1/documents/{documentId}	Group A
T1 - Documents	POST	/api/partner/1.0/t1/documents/{documentId}/copy	Group A
T2 - Documents	POST	/api/partner/1.0/t2/documents	Group A
T2 - Documents	POST	/api/partner/1.0/t2/documents/getList	Group A
T2 - Documents	GET	/api/partner/1.0/t2/documents/recycleBin	Group A
T2 - Documents	GET	/api/partner/1.0/t2/documents/{documentId}	Group A
T2 - Documents	POST	/api/partner/1.0/t2/documents/{documentId}/copy	Group A
T3 - Documents	POST	/api/partner/1.0/t3/documents	Group A
T3 - Documents	POST	/api/partner/1.0/t3/documents/getList	Group A
T3 - Documents	GET	/api/partner/1.0/t3/documents/recyclebin	Group A
T3 - Documents	GET	/api/partner/1.0/t3/documents/{documentId}	Group A
T3 - Documents	POST	/api/partner/1.0/t3/documents/{documentId}/copy	Group A
TF - Documents	POST	/api/partner/1.0/tf/documents	Group A
TF - Documents	POST	/api/partner/1.0/tf/documents/getList	Group A
TF - Documents	GET	/api/partner/1.0/tf/documents/recycleBin	Group A
TF - Documents	GET	/api/partner/1.0/tf/documents/{documentId}	Group A
TF - Documents	POST	/api/partner/1.0/tf/documents/{documentId}/copy	Group A

HTTP errors and messages

API specifications and discovery tool

In the API specifications, you will be able to discover the different endpoints offered with the Web API and to experiment with different requests to observe their behaviour.

Here is a quick guide using the GetData endpoint to explain how you can experiment with the different endpoints using the API specifications:

If you are accessing the API with the Keys authentication method, enter one of the Web API keys that were created for your site in the “api_key” field. Please note that for an action such as setting a value in a cell, you will be required to use a read-write key. In case you are using OAuth 2.0 as an authentication method for the Web API, then the validation process is automatically done through the session’s cookies.
Expand the section corresponding to the action you would like to perform with the Web API.
Expand the endpoint in which you are interested to try out.

Complete the product field (e.g., T1, T2, T3 or TF).
Complete the id field, which represents the GUID of the document you would like to modify.
Click the example value of the body (optional), to paste the example into the requests field—this will allow you to start with an already valid structure.
Complete the requests field and make sure that, if you used the body example at point 6, the placeholders such as ‘string’ in the above example are replaced.
To launch the request, click the Try it out! button.

Once the request has been completed, the following information is provided:

A curl example of your request.
The URL of your request, including the parameters that were set at points 4 and 5.
The response body.
The response code.
The different response headers.

Web API Sample

Authentication

There are 2 types of authentication methods available to validate the access to the sample demo which mimics the Web API’s behavior: Web API Keys and OAuth 2.0. In order to switch between the different authentication methods of the Sample Code, the user must modify the configuration in the app.config file inside the PartnerApi.Demo.sln which is included in the downloadable demo sample provided below. Please note that the selected method in the Sample should be correlated with the authentication method selected in the Web API; in other words, when OAuth 2.0 is activated in the Web API, the user should use OAuth 2.0 in the Sample and vice versa. In case the selected method in the Web API is different than that configured in the Sample file, an error Unauthorized is triggered.

In order to activate the Web API Keys method, the user should set the value of ActiveConfiguration to 1 as per the below screenshot. He must also fill the value of BaseUrl, ApiKey and ClientCode.

In order to activate the OAuth 2.0 method, the user should set the value of ActiveConfiguration to 2 as per the below screenshot. He must also fill the value of BaseUrl, ClientId, ClientSecret, AccessToken and RefreshToken.

In case the OAuth 2.0 is active, and the Web API key's special fields are filled, the system will automatically discard these values. Similarly, if the Web API Keys authentication method is active and the fields corresponding to OAuth are configured, the system will automatically discard their values.

Another important step is required on the User Interface’s level in order to activate OAuth 2.0. The user should configure a new Application Integration entry under the Firm Settings. The value of the Application Name and Description fields is optional. The Client Identifier should match the ClientId provided in the configuration above. In addition, the Scope should be set as Taxprep while the Grant Type should be set as Authorization Code. Once saved, the configuration will automatically generate a GUID for this record which will be set as the value of ClientSecret in the configuration file above.

Demo Sample

To download the C# language demo sample click here.

Scenarios and Endpoints

The demo application covers the following scenarios and endpoints:

Creates a new 2019 document.
Retrieves all return statuses.
Changes the return status of a return.
Retrieves the document to display the status change.
Creates two T4 slips by setting the issuer field.
Gets data set in the document to show the change was made.
Rolls forward the document to 2020.
Retrieves the newly rolled forward document.
Retrieves the EFILE information of the newly rolled forward document.
Retrieves all print formats.
Prints the return to PDF using the print formats.
Retrieves all electronic services identification profiles.
Copies the document.
Locks the document.
Unlocks the document.
Retrieves the list of preparer profiles.
Changes the preparer profile of a document.
Retrieves the filtered list of documents from the return manager using the date_modified column
Retrieves a list of documents and navigate through the pages using the next or previous cursors.
Retrieves a list of documents sorted by one specific column.
Handles rate limiting using Retry-After.
Retrieves a list of environments without the list of templates linked to each environment.
Retrieves a list of groups with their group options.
Retrieves user data entered or modified in a document.
Changes the assignees of a return.
Returns the list of deleted documents available in the recycle bin.
Retrieves the list of labels for the selected product.

Note: To get started, read the README file provided with the solution.