CCH Axcess™ Workflow API: Frequently Asked Questions

  • Article Type:
  • Documentation
  • Last Modified:
  • 05/18/2022

Objectives

Read some frequently asked questions about CCH Axcess Workflow API.

Environment

  • CCH Axcess Workflow
  • CCH Axcess Workflow API

Details

CCH Axcess™ Workflow APIi - FAQ

Authentication

How do I authenticate to CCH Axcess™ Workflow API?

CCH Axcess Workflow will provide a unique API Key for the XCM environment for your firm. This API Key should be provided in the header of every API request that you make.
Initially in a new session, you will need to call the authenticate/user endpoint, with the above API Key in the header, and a valid XCM username and password in the json body. This will return a unique token in response. This unique token needs to be provided in the request header for all subsequent API requests for your session.
Please see our Swagger page for more details.

How long is a token valid?

A token is valid for 24 hours.


General

Is paging supported? If so, how does it work?

Certain endpoints support paging, this can be determined by the presence of PageCount and PageIndex (defined below) optional values in the header. This is explained in the Swagger documentation.
PageCount: Specify a value that is the number of desired records in a single page.
PageIndex: Specify the page (starting with 1) that you desire to view.

Is there a limit to the number of records in a page?

Currently, there is no hard limit on the PageCount request parameter. This is an area where you may want to experiment with different values to see what works best for your specific automation. For example, you may find that a PageCount of 2000 works best for you.

How can I determine which request fields are required?

In the Swagger documentation, click the endpoint in question to expand it. Above the request fields, click Model and then click the label that appears beneath it. Any required field will have a red asterisk next to the field name.

Error “Invalid Login Attempt” when trying to log in.

Password is invalid.  Please verify and try again.

When trying to log in or select a header page on the API site I get prompted for my login again without any indicated error.

Log into the https://workflow.cchaxcess.com/xcmv2 page first to establish the needed backend information for the user.
 


Client

The client/search works, but it only returns limited info on each client – how do I get more details?

You may use the ClientInternalID values in the search results to further drill down into each client by calling client/{clientInternalID} which returns more details.

How do I use client/search/advanced?

Regarding advanced client search, we do expect to build out the advanced searches with more capabilities in the future. Currently it supports the same fields as the regular search. The 3 request items key/value/condition are described as follows:

  • KEY: In client advanced search, for example, key can be FirstName, MiddleName, Last_Corporate_Name, EmailID, AccountNumber.
  • VALUE: The value you are searching for.
  • CONDITION: for searches with multiple key/value pairs, you may specify AND or OR.


Task

The task/search works, but it only returns limited info on each task – how do I get more details?

You may use the TaskInternalID values in the search results to further drill down into each client by calling task/{taskInternalID} which will return more details.
Additionally, the above taskInternalID can be used on various other categories of tasks by selecting the following endpoints. For example:
Task/{taskInternalID}/statuslist
Task/{taskInternalID}/checklist
Task/{taskInternalID}/issuepoints
Task/{taskInternalID}/deliverables
Task/{taskInternalID}/assembly
Task/{taskInternalID}/shipping
Task/{taskInternalID}/documentlink
Task/{taskInternalID}/signoff
Task/{taskInternalID}/engagement

How do I use task/search/advanced?

Regarding the advanced task search, we do expect to build out the advanced searches with more capabilities in the future. Currently it supports the same fields as the regular search. The 3 request items key/value/condition are described as follows:

  • KEY: In task advanced search, for example, key can be ClientName, AccountNumber, BranchName, TaskType, TaskDescription, and Status.
  • VALUE: The value you are searching for.
  • CONDITION: For searches with multiple key/value pairs, you may specify AND or OR.

What does task/GetTaskByStatus do?

This endpoint allows you to specify a status value and date range. It will return any task that was moved out of that status value during the date range.

When performing a task/update, do I need to specify ALL fields?

No, only specify the fields that you wish to be update and the remaining fields will stay as-is. But note that the fields ClientName, TaskType and CPAResponsible are required.

Additional Information

Migrated from API FAQ.docx
  Solution Tools
  Attachments
 Solution Id 000128294/CCH-Axcess-Workflow-XCMapi-Frequently-Asked-Questions
 Direct Link
To provide feedback on this solution, please login.

Your feedback about this article will help us make it better. Thank you!