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
| Count | API Function | API Description | Method |
| Category: Auth | |||
| 1 | User | API that provides the authentication token that will be used by all the other APIs to authenticate the API call | POST |
| Category: Client | |||
| 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 |
| Category: Firm | |||
| 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 |
| Category: Task | |||
| 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 |
| Category: User | |||
| 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 |
Additional Information
N/A
| Solution Id | 000132752/Is-there-a-list-of-APIs-by-category-in-CCH-Axcess-Workflow |
|---|---|
| Direct Link |
