Autotask icon

Autotask

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

Actions524

Contract Note → Get

AI-generated

Overview

This node operation retrieves a specific Contract Note from the Autotask PSA system using the provided Note ID. It is useful for scenarios where detailed information about a particular contract note is needed, such as reviewing contract communications or audit trails within a contract management workflow.

Use Case Examples

  1. Retrieve a contract note by its unique ID to display its details in a dashboard.
  2. Fetch a contract note to verify contract-related comments or updates before processing further actions.

Properties

Name Meaning
Note ID The unique identifier of the contract note to retrieve, required for the get operation.
Add Picklist Labels Whether to automatically add human-readable '_label' fields for picklist fields in the response, enhancing readability.
Add Reference Labels Whether to automatically add human-readable '_label' fields for reference fields in the response, improving clarity.
Select Columns Names or IDs. Specify which fields to include in the response. If none are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields Whether to bring user-defined fields (UDFs) up to the top level of the returned object instead of nesting them inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contract note.
  • content - The main content or text of the contract note.
  • createdDate - The date and time when the contract note was created.
  • createdBy - Information about the user who created the contract note.
  • picklistLabels - Optional human-readable labels for picklist fields if enabled.
  • referenceLabels - Optional human-readable labels for reference fields if enabled.
  • userDefinedFields - User-defined fields related to the contract note, either nested or flattened based on configuration.

Dependencies

  • An API key credential for Autotask PSA REST API

Troubleshooting

  • Ensure the Note ID is valid 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 include the necessary fields or leave the selection empty to retrieve all fields.
  • Enable 'Add Picklist Labels' and 'Add Reference Labels' only if the API supports these labels to avoid unexpected empty fields.

Links

  • Autotask PSA REST API Documentation - Official documentation for the Autotask PSA REST API, useful for understanding available endpoints and data structures related to contract notes.

Discussion