Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Note records from the Autotask REST API using advanced filtering criteria. It is useful for users who need to query contract notes with complex conditions beyond simple filters, allowing precise data extraction for reporting, analysis, or integration purposes. For example, a user can fetch all contract notes related to specific contracts within a date range or matching particular custom fields.

Properties

Name Meaning
Get All Determines whether to return all matching contract note records or limit the number of results.
Max Records Specifies the maximum number of contract note 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 with Autotask API query criteria to perform advanced filtering of contract notes.
Add Picklist Labels Indicates whether to automatically add human-readable '_label' fields for picklist fields in the returned contract note data.
Add Reference Labels Indicates whether to automatically add human-readable '_label' fields for reference fields in the returned contract note data.
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.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) are brought up to the top level of each returned object instead of being nested.

Output

JSON

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

Dependencies

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

Troubleshooting

  • Invalid JSON in the 'Advanced Filter' property will cause errors. Ensure the JSON string is well-formed and follows Autotask API filter syntax.
  • Requesting too many records without pagination or 'Get All' enabled may lead to timeouts or API limits.
  • Selecting invalid or non-existent fields in 'Select Columns' may result in incomplete data or errors.
  • If picklist or reference labels are not appearing, verify that 'Add Picklist Labels' and 'Add Reference Labels' are enabled and that the fields have valid values.
  • API authentication errors may occur if the API key credential is missing, expired, or invalid.

Links

Discussion