Autotask icon

Autotask

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

Actions524

Contract Role Costs → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple Contract Role Costs records from the Autotask PSA system using advanced filtering criteria. It is useful for scenarios where users need to query contract role cost data with specific conditions, such as filtering by date ranges, contract IDs, or other custom criteria defined in the Autotask API. For example, a user might want to extract all contract role costs related to a particular contract or within a certain time period for reporting or integration purposes.

Use Case Examples

  1. Retrieve all contract role costs for a specific contract using an advanced JSON filter.
  2. Fetch a limited number of contract role cost records with specific field selections and labels for reporting.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit.
Max Records Maximum number of records to return when not returning all (range 1-500).
Advanced Filter A JSON string containing a "filter" array with Autotask API query criteria to specify which records to retrieve.
Add Picklist Labels Whether to automatically add "_label" fields for picklist fields with human-readable values (no labels added for empty values).
Add Reference Labels Whether to automatically add "_label" fields for reference fields with human-readable values (no labels added for empty 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 regardless of selection.
Flatten User-Defined Fields Whether to bring user-defined fields up to the top level of each object instead of being nested in the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contract role cost record.
  • contractID - Identifier of the associated contract.
  • roleID - Identifier of the role associated with the cost.
  • cost - Cost value associated with the contract role.
  • effectiveDate - Date from which the cost is effective.
  • expirationDate - Date until which the cost is valid.
  • userDefinedFields - Array of user-defined fields related to the contract role cost, if not flattened.
    _label - Human-readable label for picklist or reference fields if label addition is enabled.

Dependencies

  • An API key credential for Autotask PSA REST API authentication.

Troubleshooting

  • Ensure the advanced filter JSON string is correctly formatted and valid according to Autotask API query criteria to avoid query errors.
  • If the node returns no data, verify that the filter criteria match existing contract role cost records in the Autotask system.
  • Check API credentials and permissions to ensure access to contract role cost data is granted.
  • If the maximum records limit is set too low, increase it or enable 'Get All' to retrieve more records.

Links

Discussion