Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node interacts with the Autotask REST API to retrieve detailed information about a specific contract by its ID. It is useful for workflows that need to fetch contract data for processing, reporting, or integration with other systems. For example, a user can get contract details to verify contract terms before creating an invoice or to synchronize contract data with a CRM system.

Properties

Name Meaning
Contract ID The unique identifier of the contract to retrieve. This is a required field to specify which contract's details to fetch.
Add Picklist Labels Determines whether to automatically add human-readable label fields (with suffix '_label') for picklist fields in the contract data. Labels are only added if the picklist value is not empty.
Add Reference Labels Determines whether to automatically add human-readable label fields (with suffix '_label') for reference fields in the contract data. Labels are only added if the reference value is not empty.
Select Columns Names or IDs. Allows selection of specific contract fields to include in the response. If no fields are selected, all fields are returned. The contract ID field is always included regardless of selection.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are brought up to the top level of the contract object instead of being nested inside a userDefinedFields array, simplifying access to these fields.

Output

JSON

contract_label - Human-readable labels for picklist or reference fields, added when the corresponding 'Add Picklist Labels' or 'Add Reference Labels' options are enabled.

  • userDefinedFields - An array of user-defined fields associated with the contract, present if 'Flatten User-Defined Fields' is disabled.
    - User-defined fields promoted to top-level properties when 'Flatten User-Defined Fields' is enabled.

Dependencies

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

Troubleshooting

  • If the specified Contract ID does not exist or is invalid, the node will throw an error indicating the contract was not found. Verify the Contract ID is correct.
  • If API authentication fails, ensure the API key credential is correctly configured and has sufficient permissions.
  • Selecting specific columns that do not exist or are misspelled may result in incomplete data or errors. Use the provided dropdown or expressions to select valid fields.
  • Enabling 'Flatten User-Defined Fields' may cause naming conflicts if user-defined fields have the same names as standard fields; use with caution.

Discussion