Actions389
- Contract Actions
- Ticket History Actions
- Ticket Note Webhook Actions
- Ticket Note Actions
- Ticket Webhook Actions
- Time Entry Actions
- Resource Actions
- Role Actions
- Resource Role Actions
- Search Filter Actions
- Service Actions
- Skill Actions
- Service Call Actions
- Survey Results Actions
- Survey Actions
- Ticket Actions
- Opportunity Actions
- Notification History Actions
- Invoice Actions
- Product Actions
- Product Vendor Actions
- Project Actions
- Project Charge Actions
- Project Phase Actions
- Project Task Actions
- Project Note Actions
- Contract Retainer Actions
- Contract Service Actions
- Contract Service Adjustment Actions
- Contract Service Bundle Actions
- Contract Service Bundle Unit Actions
- Contract Service Bundle Adjustment Actions
- Contract Ticket Purchase Actions
- Contract Service Unit Actions
- Domain Registrar Actions
- Holiday Actions
- Holiday Set Actions
- Contract Exclusion Billing Code Actions
- Contract Rate Actions
- Contract Exclusion Role Actions
- Contract Exclusion Sets Actions
- Contract Exclusion Set Excluded Role Actions
- Contract Exclusion Set Excluded Work Type Actions
- Contract Milestone Actions
- Contract Note Actions
- Contract Role Costs Actions
- Contact Groups Actions
- Contact Actions
- Contact Webhook Actions
- Contact Group Contacts Actions
- Contract Block Hour Factor Actions
- Contract Block Actions
- Contract Billing Rule Actions
- Contract Charge Actions
- Configuration Item Category Actions
- Configuration Item Category UDF Association Actions
- Configuration Item DNS Record Actions
- Configuration Item Note Actions
- Configuration Item Related Item Actions
- Configuration Item SSL Subject Alternative Name Actions
- Configuration Item Type Actions
- Configuration Item Webhook Actions
- Company Alert Actions
- Company Actions
- Billing Code Actions
- Company Location Actions
- Company Note Actions
- Company Webhook Actions
- Configuration Item Actions
- Configuration Item Billing Product Association Actions
Overview
The 'Contract Charge - Get Many (Advanced)' operation allows users to retrieve multiple contract charge records from the Autotask system using advanced filtering criteria. This operation is beneficial when you need to query contract charges with complex conditions beyond simple retrieval, such as filtering by specific fields, ranges, or logical combinations. For example, you can fetch all contract charges exceeding a certain amount within a date range or those linked to specific contracts. It supports pagination control by allowing users to specify whether to return all matching records or limit the number of results.
Properties
| Name | Meaning |
|---|---|
| Get All | Determines whether to return all matching contract charge records or limit the results to a specified maximum number. |
| Max Records | Specifies the maximum number of contract charge records to return when 'Get All' is false. The value must be between 1 and 500. |
| Advanced Filter | A JSON string containing a 'filter' array that defines the Autotask API query criteria for filtering contract charges. This allows complex queries using Autotask's REST API filtering syntax. |
| Add Picklist Labels | If enabled, adds additional fields with '_label' suffix for picklist fields to provide human-readable values instead of raw codes. |
| Add Reference Labels | If enabled, adds additional fields with '_label' suffix for reference fields to provide human-readable values. |
| Select Columns Names or IDs. | Allows selection of specific fields to include in the response. If no fields are selected, all fields are returned. The ID field is always included. |
| Flatten User-Defined Fields | If enabled, user-defined fields (UDFs) are brought to the top level of each returned object instead of being nested inside a 'userDefinedFields' array. |
Output
JSON
id- Unique identifier of the contract charge record.fieldName- Various fields of the contract charge as specified by the selected columns or all fields if none selected.fieldName_label- Human-readable labels for picklist or reference fields if 'Add Picklist Labels' or 'Add Reference Labels' is enabled.userDefinedFields- Array of user-defined fields associated with the contract charge, unless 'Flatten User-Defined Fields' is enabled.userDefinedFieldName- User-defined fields promoted to top-level properties if 'Flatten User-Defined Fields' is enabled.
Dependencies
- Requires an Autotask API key credential for authentication to access the Autotask REST API.
Troubleshooting
- Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is well-formed and follows Autotask API filter syntax.
- Requesting too many records without pagination or 'Get All' enabled may lead to timeouts or API limits being hit.
- Selecting invalid or unsupported fields in 'Select Columns' may result in errors or missing data.
- If picklist or reference labels are not appearing, verify that the corresponding options are enabled and that the fields support labels.
- API authentication errors may occur if the Autotask API key credential is missing, expired, or incorrect.
Links
- Autotask API Basic Query Calls - Official Autotask documentation describing how to construct advanced filter queries for API calls.