Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Rate records from the Autotask system using an advanced filtering mechanism. It is useful for users who need to query contract rates with complex criteria beyond simple filters, such as specific field values or combinations thereof. For example, a user can fetch all contract rates that match certain billing conditions or date ranges by providing a JSON filter array according to Autotask API query syntax.

Properties

Name Meaning
Get All Determines whether to return all matching contract rate records or limit the number of results.
Max Records Specifies the maximum number of contract rate 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 query criteria for retrieving contract rates. This filter uses Autotask API query syntax to specify complex search conditions.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for picklist fields in the output.
Add Reference Labels If enabled, adds additional fields with '_label' suffix containing human-readable labels for reference fields in the output.
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 regardless of selection.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are moved to the top level of each returned object instead of being nested inside a 'userDefinedFields' array.

Output

JSON

  • id - Unique identifier of the contract rate record.
    - Various contract rate fields as specified by the selected columns or all fields if none selected._label - Human-readable labels for picklist or reference fields if label options are enabled.
  • userDefinedFields - Array of user-defined fields unless flattened to top-level properties.

Dependencies

  • Requires an Autotask API credential for authentication to access the Autotask REST API.

Troubleshooting

  • Ensure the 'Advanced Filter' JSON string is correctly formatted and follows Autotask API query syntax; invalid JSON or incorrect filter structure will cause errors.
  • If 'Max Records' is set outside the allowed range (1-500), the node will throw an error; adjust the value accordingly.
  • If no records are returned, verify that the filter criteria match existing contract rates in Autotask.
  • Authentication errors may occur if the Autotask API credentials are invalid or expired; re-authenticate or update credentials as needed.

Links

Discussion