Is there a list of APIs by category in CCH Axcess™ Workflow? 

  • Article Type:
  • QA
  • Last Modified:
  • 05/25/2022

Question

Is there a list of APIs by category? 

Environment

  • API
  • XCM
  • CCH Axcess Workflow
  • CCH Axcess Workflow API

Answer

List of APIs by Category

CountAPI FunctionAPI DescriptionMethod
Category: Auth
1UserAPI that provides the authentication token that will be used by all the other APIs to authenticate the API callPOST
Category: Client
2CreateAPI to create ClientPost
3UpdateAPI to update Client DetailsPOST
4Bulk UpdateAPI to update a large number of Client records at oncePOST
5SearchAPI to search for Client with Basic Parameters (First Name, Last Name, Account Number, Type, Email)POST
6AdvanceAPI to do an Advanced Search for Client with option to create combination search filtersPOST
7ClientAPI to get Client Details using Client Internal IDGET
Category: Firm
8FirmPI to get firm details—firm identity is determined from API keyGET
9BranchAPI to get firm branch details—firm identity is determined from API keyGET
10CategoryAPI to get firm CategoryGET
11Generation TypesAPI to get firm Client Generation TypesGET
12Task TypeAPI to get firm specific Task TypesGET
13RolesAPI to fetch firm RolesGET
14Client TypeAPI to get firm Client TypesGET
Category: Task
15CreateAPI to Create TaskPOST
16UpdateAPI to Update TaskPOST
17Deliverable/CreateAPI to Add Deliverable for existing TaskPOST
18Document/LinkAPI to link document for existing TaskPOST
19Budget Time/ UpdateAPI to update the budgeted time for an existing TaskPOST
20Actual Time/UpdateAPI to do update the actual time for an existing TaskPOST
21SearchAPI to search for a Task with basic Client and Task informationPOST
22Search/AdvancedAPI to perform and advanced search on a Task with multiple filters and combinationsPOST
23TaskAPI to fetch Task details using the Internal Task IDGET
24Task/Status ListAPI to fetch status details on Task movementGET
25Task/ChecklistAPI to fetch checklist details for a particular Task using the Internal Task ID from Task checklistGET
26Task/ Issue PointsAPI to fetch issues and points for a particular Task using the Internal Task IDGET
27Task/DeliverablesAPI to fetch Task deliverables for a particular Task using the Internal Task IDGET
28Task/AssemblyAPI to fetch Task assembly details for a particular Task using the Internal Task IDGET
29Task/ShippingAPI to fetch Task shipping details for a particular Task using the Internal Task IDGET
30Task/Document LinkAPI to fetch a list of linked documentsGET
Category: User
31CreateAPI to create userPOST
32UpdateAPI to update user detailsPOST
33User/ User Internal IDAPI to get user details using internal user idGET
34SearchAPI to search for users using basic search parametersPOST
35AdvancedAPI to perform advanced search for users using filters and combinations of filtersPOST
36User By EmailAPI to get user details using email id of userGET

Additional Information

N/A

  Solution Tools
  Attachments
 Solution Id 000132752/Is-there-a-list-of-APIs-by-category-in-CCH-Axcess-Workflow
 Direct Link
To provide feedback on this solution, please login.

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