Autotask icon

Autotask

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

Actions524

Contract → Get Many (Advanced)

AI-generated

Overview

This node operation allows users to retrieve multiple contract records from the Autotask PSA system using advanced filtering criteria. It supports fetching all records or limiting the number of records returned, applying complex JSON-based filters, and customizing the output fields. This is useful for scenarios where detailed contract data needs to be queried based on specific conditions, such as contract type, status, or other attributes, enabling efficient data retrieval for reporting, analysis, or integration purposes.

Use Case Examples

  1. Retrieve all contracts with a specific contract type using an advanced JSON filter.
  2. Fetch up to 100 contracts that meet certain criteria defined in the advanced filter JSON.
  3. Get contract records with selected fields only, including human-readable labels for picklist and reference fields.

Properties

Name Meaning
Get All Whether to return all contract records or limit the results to a specified maximum number.
Max Records Maximum number of contract records to return when 'Get All' is false. Range is 1 to 500.
Advanced Filter A JSON string containing a 'filter' array with Autotask API query criteria to filter the contract records retrieved.
Add Picklist Labels Whether to automatically add '_label' fields for picklist fields with human-readable values in the output.
Add Reference Labels Whether to automatically add '_label' fields for reference fields with human-readable values in the output.
Select Columns Names or IDs Choose specific contract fields to include in the response. If none are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields Whether to bring user-defined fields (UDFs) up to the top level of each contract object instead of nesting them in the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contract record.
  • contractNumber - Contract number or identifier.
  • contractType - Type of the contract.
  • status - Current status of the contract.
  • startDate - Start date of the contract.
  • endDate - End date of the contract.
  • billingFrequency - Billing frequency associated with the contract.
  • userDefinedFields - Array of user-defined fields related to the contract, unless flattened to top-level.
  • _label - Additional human-readable labels for picklist and reference fields if enabled.

Dependencies

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

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 fields to ensure they exist and are accessible.
  • Errors related to authentication indicate issues with the provided API key or credentials; verify and update as needed.
  • Large data requests may hit API rate limits; consider using the 'Get All' option carefully or implement pagination if supported.

Links

Discussion