Autotask icon

Autotask

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

Actions524

Contract Retainer → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple Contract Retainer records from the Autotask PSA system using advanced filtering criteria. It is useful for scenarios where users need to query and fetch a customized list of contract retainers based on specific conditions, such as filtering by date ranges, statuses, or other contract retainer attributes. For example, a user might want to get all contract retainers that are active within a certain period or match particular business rules.

Use Case Examples

  1. Fetch all contract retainers with a specific status using an advanced JSON filter.
  2. Retrieve a limited number of contract retainers matching complex criteria for reporting or integration purposes.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit (maxRecords).
Max Records Maximum number of contract retainer 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 contract retainer records. This allows complex querying based on Autotask's REST API filtering capabilities.
Add Picklist Labels Whether to automatically add '_label' fields for picklist fields with human-readable values in the output. No labels are added for empty values.
Add Reference Labels Whether to automatically add '_label' fields for reference fields with human-readable values in the output. No labels are 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 (UDFs) up to the top level of each object instead of being nested in the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contract retainer record.
  • contractId - Identifier of the associated contract.
  • retainerAmount - The amount of the retainer.
  • retainerBalance - Current balance of the retainer.
  • retainerStatus - Status of the contract retainer.
  • startDate - Start date of the retainer period.
  • endDate - End date of the retainer period.
  • userDefinedFields - Array of user-defined fields related to the contract retainer, if not flattened.
  • _label - Additional human-readable labels for picklist or 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 results are returned, verify the filter criteria and the selected fields to ensure they exist and are accessible.
  • Check API credentials and permissions to confirm access to contract retainer data.
  • If the node fails, review error messages for rate limiting or authentication issues and adjust credentials or usage accordingly.

Links

Discussion