Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Billing Rule records from the Autotask REST API using advanced filtering criteria. It is useful for users who need to query contract billing rules with complex conditions, such as filtering by specific fields or combinations of fields, beyond simple list retrieval. For example, a user can fetch all contract billing rules that match certain billing criteria or date ranges by providing a JSON filter. This operation supports returning all matching records or limiting the number of results, and can enhance data readability by adding human-readable labels for picklist and reference fields.

Properties

Name Meaning
Get All Determines whether to return all matching contract billing rule records or limit the results to a specified maximum number.
Max Records Specifies the maximum number of contract billing rule records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array that defines the Autotask API query criteria for filtering contract billing rules. This allows complex queries using Autotask's REST API filtering syntax.
Add Picklist Labels If enabled, adds additional '_label' fields to the output for picklist fields, providing human-readable values instead of raw codes.
Add Reference Labels If enabled, adds additional '_label' fields to the output for reference fields, providing 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 billing rule record.
  • fieldName - Various fields of the contract billing rule as returned by the Autotask API, depending on selected columns.
  • fieldName_label - Human-readable label for picklist or reference fields if 'Add Picklist Labels' or 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields if 'Flatten User-Defined Fields' is disabled.
  • userDefinedFieldName - User-defined fields promoted to top-level properties if 'Flatten User-Defined Fields' is enabled.

Dependencies

  • Requires an Autotask API credential (API key or token) to authenticate requests to the Autotask REST API.

Troubleshooting

  • Invalid JSON in 'Advanced Filter' property can cause query failures. Ensure the JSON string is correctly formatted and follows Autotask API filter syntax.
  • Requesting more than 500 records when 'Get All' is false will be limited to 500 due to API constraints.
  • If no records are returned, verify that the filter criteria match existing contract billing rules.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' may not add labels if the corresponding fields are empty.
  • Selecting invalid or unsupported columns in 'Select Columns' may cause errors or incomplete data.

Links

Discussion