Autotask icon

Autotask

Interact with Kaseya's Autotask PSA REST API to manage companies, tickets, contracts, and more.

Actions524

Contract Rate → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple contract rate records from the Autotask PSA system using advanced filtering criteria. It is useful for scenarios where users need to query contract rates with specific conditions, such as filtering by date ranges, rate types, or other custom fields. For example, a user might want to fetch all contract rates that apply to a particular contract or within a certain billing period.

Use Case Examples

  1. Retrieve all contract rates for a specific contract using a JSON filter.
  2. Fetch contract rates with a limit on the number of records returned.
  3. Use advanced JSON filters to get contract rates matching complex criteria.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit.
Max Records Maximum number of contract rate records to return when not returning all.
Advanced Filter A JSON string containing a "filter" array with Autotask API query criteria to filter contract rates.
Add Picklist Labels Whether to automatically add "_label" fields for picklist fields with human-readable values.
Add Reference Labels Whether to automatically add "_label" fields for reference fields with human-readable values.
Select Columns Names or IDs. Choose which fields to include in the response. If no fields are selected, all fields will be returned. The ID field is always included.
Flatten User-Defined Fields Whether to bring user-defined fields up to the top level of each object instead of nested in the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contract rate record.
  • contractId - Identifier of the contract associated with the rate.
  • rate - The rate value defined in the contract rate record.
  • effectiveDate - The date from which the contract rate is effective.
  • expirationDate - The date until which the contract rate is valid.
  • userDefinedFields - Custom user-defined fields associated with the contract rate, if not flattened.
  • _label - Human-readable labels for picklist or reference fields if enabled.

Dependencies

  • An API key credential for Autotask PSA REST API

Troubleshooting

  • Ensure the advanced filter JSON is correctly formatted and matches Autotask API query criteria to avoid errors.
  • If no records are returned, verify the filter criteria and the selected columns to ensure they exist and are accessible.
  • Authentication errors may occur if the API key credential is invalid or expired; verify credentials in node settings.
  • If the node returns partial data or errors, check if the 'returnAll' option is set correctly and the 'maxRecords' limit is appropriate.

Links

Discussion