CCH Axcess™ Workflow API Overview
- Article Type:
- Last Modified:
Learn about API in CCH Axcess Workflow.
- CCH Axcess Workflow
- CCH Axcess Workflow API
API OverviewCCH Axcess Workflow provides a diverse set of REST APIs for organizations that use Workflow. This set of APIs is termed XCMAPI. The APIs help to import information into, and export information out of, Workflow.
How APIs are UsedAPIs can be used to add or update Client, Firm, Task, and User information in the workflow. Currently available APIs are grouped into five categories. The APIs under each category and a brief description are detailed in the table at the end of this article.
Organizations that Would Benefit from APIAPI helps organizations connect Workflow with other programs that leverage client, entity, task, employee, scheduling, or time information. This helps users better scale their businesses by providing more detailed data to better assess company and individual performance, bottlenecks, and inefficiencies. This allows users to easily compare data across management systems for a more holistic view of project statuses and business progress.
Organizations that (1) have their own development teams and (2) have a sophisticated set of applications are ideal candidates for API.
Prerequisites/SecurityA valid login and API key are required to authenticate an API user. These credentials will be provided by the Workflow Integration team. Subsequent calls would use the API key and the token that are returned from the authentication call.
API Typeshere are two primary types of APIs: POST and GET.
- POST APIs enable information to be updated (or searched) within Workflow.
- GET APIs enable information to be retrieved from Workflow
API Export and ImportAPI can only retrieve and update information within Workflow. It cannot pull (retrieve) or update (push) information to other applications. Such pull and push operations require the APIs of the respective applications.
For more information on APIContact your Account Manager or your Customer Service Representative/Consultant for more information.
List of APIs by Category
|Count||API Function||API Description||Method|
|1||User||API that provides the authentication token that will be used by all the other APIs to authenticate the API call||POST|
|2||Create||API to create Client||Post|
|3||Update||API to update Client Details||POST|
|4||Bulk Update||API to update a large number of Client records at once||POST|
|5||Search||API to search for Client with Basic Parameters (First Name, Last Name, Account Number, Type, Email)||POST|
|6||Advance||API to do an Advanced Search for Client with option to create combination search filters||POST|
|7||Client||API to get Client Details using Client Internal ID||GET|
|8||Firm||PI to get firm details—firm identity is determined from API key||GET|
|9||Branch||API to get firm branch details—firm identity is determined from API key||GET|
|10||Category||API to get firm Category||GET|
|11||Generation Types||API to get firm Client Generation Types||GET|
|12||Task Type||API to get firm specific Task Types||GET|
|13||Roles||API to fetch firm Roles||GET|
|14||Client Type||API to get firm Client Types||GET|
|15||Create||API to Create Task||POST|
|16||Update||API to Update Task||POST|
|17||Deliverable/Create||API to Add Deliverable for existing Task||POST|
|18||Document/Link||API to link document for existing Task||POST|
|19||Budget Time/ Update||API to update the budgeted time for an existing Task||POST|
|20||Actual Time/Update||API to do update the actual time for an existing Task||POST|
|21||Search||API to search for a Task with basic Client and Task information||POST|
|22||Search/Advanced||API to perform and advanced search on a Task with multiple filters and combinations||POST|
|23||Task||API to fetch Task details using the Internal Task ID||GET|
|24||Task/Status List||API to fetch status details on Task movement||GET|
|25||Task/Checklist||API to fetch checklist details for a particular Task using the Internal Task ID from Task checklist||GET|
|26||Task/ Issue Points||API to fetch issues and points for a particular Task using the Internal Task ID||GET|
|27||Task/Deliverables||API to fetch Task deliverables for a particular Task using the Internal Task ID||GET|
|28||Task/Assembly||API to fetch Task assembly details for a particular Task using the Internal Task ID||GET|
|29||Task/Shipping||API to fetch Task shipping details for a particular Task using the Internal Task ID||GET|
|30||Task/Document Link||API to fetch a list of linked documents||GET|
|31||Create||API to create user||POST|
|32||Update||API to update user details||POST|
|33||User/ User Internal ID||API to get user details using internal user id||GET|
|34||Search||API to search for users using basic search parameters||POST|
|35||Advanced||API to perform advanced search for users using filters and combinations of filters||POST|
|36||User By Email||API to get user details using email id of user||GET|