Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node interacts with the Autotask REST API to retrieve detailed information about a specific Contract Billing Rule by its ID. It is useful for automating workflows that require fetching billing rule data related to contracts, such as billing automation, contract management, or financial reporting. For example, a user can retrieve a contract billing rule's details to validate billing conditions or integrate billing data into other systems.

Properties

Name Meaning
Billing Rule ID The unique identifier of the contract billing rule to retrieve.
Add Picklist Labels Determines whether to add human-readable label fields (with suffix '_label') for picklist fields in the response, enhancing readability.
Add Reference Labels Determines whether to add human-readable label fields (with suffix '_label') for reference fields in the response.
Select Columns Names or IDs. Specifies 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 Determines whether user-defined fields (UDFs) are promoted to top-level properties in the output instead of being nested.

Output

JSON

  • id - The unique identifier of the contract billing rule.
  • name - The name of the contract billing rule.
  • description - Description or details about the contract billing rule.
  • userDefinedFields - Array of user-defined fields related to the billing rule, unless flattened.
    _label - Human-readable label for picklist or reference fields if enabled.

Dependencies

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

Troubleshooting

  • If the Billing Rule ID is invalid or not found, the node will throw an error indicating the resource could not be retrieved. Verify the ID is correct.
  • If API authentication fails, ensure the API key credential is correctly configured and has sufficient permissions.
  • Selecting specific columns that do not exist may result in incomplete data or errors; verify field names or IDs are valid.
  • Enabling flattening of user-defined fields may cause naming conflicts if UDF names overlap with standard fields.

Discussion