Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves detailed information about a specific Contract Rate from the Autotask system using its unique Rate ID. It is useful for scenarios where you need to fetch contract rate details for billing, reporting, or integration purposes. For example, you might use it to get the current rate applied to a contract service or to verify rate details before processing invoices.

Properties

Name Meaning
Rate ID The unique identifier of the contract rate to retrieve. This is required to specify which contract rate record to fetch.
Add Picklist Labels Determines whether to include human-readable labels for picklist fields in the output, enhancing readability by adding "_label" fields for such properties.
Add Reference Labels Determines whether to include human-readable labels for reference fields in the output, adding "_label" fields for referenced entities.
Select Columns Names or IDs. Allows selection of specific fields to include in the response. If none are selected, all fields are returned. The ID field is always included regardless of selection.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are promoted to top-level properties in the output object instead of being nested inside a 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 amount defined in the contract rate.
  • userDefinedFields - An array of user-defined fields associated with the contract rate, unless flattened.
  • *_label - Human-readable labels for picklist or reference fields, added if enabled in input properties.

Dependencies

  • Requires an API key credential for Autotask REST API authentication.

Troubleshooting

  • Ensure the provided Rate ID is valid and exists in the Autotask system; invalid IDs will cause errors.
  • If no data is returned, verify that the API credentials have sufficient permissions to access contract rate data.
  • When selecting specific columns, ensure the field names or IDs are correct; otherwise, the response may omit expected data.
  • If picklist or reference labels are not appearing, check that the corresponding boolean properties are enabled.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields; disable flattening if this occurs.

Discussion