Autotask icon

Autotask

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

Actions524

Contract Rate → Get

AI-generated

Overview

This node operation retrieves details of a specific Contract Rate from the Autotask PSA system using the provided Rate ID. It is useful for scenarios where you need to fetch contract rate information for billing, reporting, or contract management purposes within an automated workflow.

Use Case Examples

  1. Fetch a contract rate by its ID to display or process billing information.
  2. Retrieve contract rate details to validate or update contract terms in an integration workflow.

Properties

Name Meaning
Rate ID The ID of the contract rate to operate on, used to specify which contract rate 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 rate.
  • name - The name or description of the contract rate.
  • rate - The monetary value or rate defined in the contract rate.
  • contractId - The ID of the contract associated with this rate.
  • effectiveDate - The date from which the contract rate is effective.
  • expirationDate - The date when the contract rate expires.
  • userDefinedFields - Custom fields defined by the user, optionally flattened to top-level properties.
  • _label fields - Optional human-readable labels for picklist and reference fields if enabled.

Dependencies

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

Troubleshooting

  • Ensure the Rate ID provided is valid and exists in the Autotask system to avoid 'not found' errors.
  • If labels for picklist or reference fields are not appearing, verify that the corresponding boolean options are enabled.
  • Check API credentials and permissions if the node fails to authenticate or retrieve data.

Links

Discussion