Autotask icon

Autotask

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

Actions524

Contract → Get

AI-generated

Overview

This node operation retrieves a specific contract from the Autotask PSA system using the contract's ID. It is useful for scenarios where detailed information about a particular contract is needed, such as viewing contract terms, status, or related billing information. For example, a user might use this operation to fetch contract details before generating a report or updating related records.

Use Case Examples

  1. Retrieve contract details by providing the contract ID to view its terms and status.
  2. Fetch a contract to verify billing rules or service agreements associated with it.

Properties

Name Meaning
Contract ID The ID of the contract to operate on, required to specify which contract to retrieve.
Add Picklist Labels Whether to automatically add "_label" fields for picklist fields with human-readable values (no labels will be added for empty values).
Add Reference Labels Whether to automatically add "_label" fields for reference fields with human-readable values (no labels will be 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 up to the top level of each object, making UDFs accessible as top-level properties instead of nested in the userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contract.
  • contractName - The name of the contract.
  • contractType - The type/category of the contract.
  • startDate - The start date of the contract.
  • endDate - The end date of the contract.
  • status - The current status of the contract.
  • billingRules - Billing rules associated with the contract.
  • serviceDetails - Details about services included in the contract.
  • userDefinedFields - Custom fields defined by the user, optionally flattened to top-level properties.

Dependencies

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

Troubleshooting

  • Ensure the Contract ID provided is valid and exists in the Autotask system to avoid 'Resource not supported' or 'Not found' errors.
  • Check API credentials and permissions if authentication errors occur.
  • If no fields are returned, verify the 'Select Columns' property or try without selecting specific fields to get all data.

Links

Discussion