Autotask icon

Autotask

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

Actions524

Contract Retainer → Get

AI-generated

Overview

This node operation retrieves details of a specific Contract Retainer from the Autotask PSA system using its ID. It is useful for scenarios where you need to fetch detailed information about a particular contract retainer, such as for contract management, auditing, or integration with other business processes.

Use Case Examples

  1. Fetch a contract retainer by its unique ID to display its details in a dashboard.
  2. Retrieve contract retainer information to validate contract terms before processing billing or service delivery.

Properties

Name Meaning
Retainer ID The unique identifier of the contract retainer to retrieve. This is a required field for the 'Get' operation on the Contract Retainer resource.
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 them accessible as top-level properties instead of nested in the userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contract retainer.
  • name - The name or title of the contract retainer.
  • status - The current status of the contract retainer.
  • amount - The monetary value or amount associated with the contract retainer.
  • startDate - The start date of the contract retainer.
  • endDate - The end date or expiration date of the contract retainer.
  • userDefinedFields - Custom fields defined by the user, optionally flattened to top-level properties.
  • picklistLabels - Human-readable labels for picklist fields, if enabled.
  • referenceLabels - Human-readable labels for reference fields, if enabled.

Dependencies

  • An API key credential for Autotask PSA REST API authentication

Troubleshooting

  • Ensure the Retainer ID is correctly specified and exists in the Autotask system to avoid 'not found' errors.
  • Check API credentials and permissions if authentication errors occur.
  • If no data is returned, verify that the selected columns and label options are correctly configured.

Links

Discussion