Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Note records from the Autotask system. It is useful for scenarios where users need to fetch a list of contract notes for reporting, analysis, or integration purposes. For example, a user might want to extract all contract notes related to a specific contract or within a certain date range to synchronize with another system or generate summaries.

Properties

Name Meaning
Fields Defines which fields of the Contract Note resource to map and include in the output. This allows users to specify exactly which data points they want to retrieve.
Get All Determines whether to return all available Contract Note records or limit the number of records returned.
Max Records Specifies the maximum number of Contract Note records to return when 'Get All' is set to false. The value can range from 1 to 500.
Add Picklist Labels Indicates whether to add human-readable labels for picklist fields in the output, enhancing readability by including '_label' fields.
Add Reference Labels Indicates whether to add human-readable labels for reference fields in the output, adding '_label' fields for better clarity.
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) should be promoted to top-level properties in the output objects instead of being nested within an array.

Output

JSON

  • id - Unique identifier of the Contract Note record.
  • fieldName - Various fields of the Contract Note as specified by the selected fields mapping.
  • picklistField
    • _label - Human-readable label for picklist fields if 'Add Picklist Labels' is enabled.
  • referenceField
    • _label - Human-readable label for reference fields if 'Add Reference Labels' is enabled.
  • userDefinedFields - Array of user-defined fields unless 'Flatten User-Defined Fields' is enabled, in which case UDFs appear as top-level properties.

Dependencies

  • Requires an API key credential for authenticating with the Autotask REST API.

Troubleshooting

  • If no records are returned, verify that the query parameters and field mappings are correct and that the user has access to the Contract Note data.
  • If the node fails with authentication errors, ensure that the API key credential is valid and has sufficient permissions.
  • When selecting fields, if unexpected data is missing, check if 'Select Columns' is restricting the output fields.
  • Large data requests may time out or be limited; use 'Max Records' to limit the number of records or enable 'Get All' cautiously.

Discussion