Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves detailed information about a specific Contract Charge from the Autotask system using its unique Charge ID. It is useful for scenarios where users need to fetch and utilize contract charge data within their workflows, such as billing automation, contract management, or financial reporting. For example, a user can get the details of a contract charge to verify billing amounts or to integrate charge data into an invoicing system.

Properties

Name Meaning
Charge ID The unique identifier of the contract charge to retrieve. This is a required field to specify which charge record to fetch.
Add Picklist Labels Determines whether to automatically add human-readable label fields (with suffix '_label') for picklist fields in the response. Labels are only added if the picklist value is not empty.
Add Reference Labels Determines whether to automatically add human-readable label fields (with suffix '_label') for reference fields in the response. Labels are only added if the reference value is not empty.
Select Columns Names or IDs. Allows selection of specific fields to include in the response. If no fields 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 brought up to the top level of each object instead of being nested inside a userDefinedFields array, simplifying access to these fields.

Output

JSON

  • id - The unique identifier of the contract charge.
  • chargeName - The name or description of the contract charge.
  • amount - The monetary amount associated with the contract charge.
  • startDate - The start date of the contract charge period.
  • endDate - The end date of the contract charge period.
  • userDefinedFields - An array of user-defined fields related to the contract charge, unless flattened to top-level properties.
    _label - Human-readable labels for picklist or reference fields, added automatically if enabled.

Dependencies

  • Requires an API key credential for authenticating with the Autotask REST API.

Troubleshooting

  • If the Charge ID is missing or invalid, the node will throw an error indicating that the charge could not be found. Ensure the Charge ID is correct and exists in Autotask.
  • If API authentication fails, verify that the API key credential is correctly configured and has sufficient permissions.
  • Selecting invalid or non-existent fields in 'Select Columns' may result in incomplete or error responses. Use the provided dropdown or valid field IDs.
  • Enabling 'Add Picklist Labels' or 'Add Reference Labels' when the fields have empty values will not add label fields, which is expected behavior.
  • Flattening user-defined fields may cause naming conflicts if UDF names overlap with standard fields; disable flattening if this occurs.

Discussion