Autotask icon

Autotask

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

Actions524

Contract Billing Rule → Get

AI-generated

Overview

This node operation retrieves a specific Contract Billing Rule from the Autotask PSA system using its unique ID. It is useful for scenarios where detailed information about a particular billing rule within a contract is needed, such as for auditing, reporting, or integration with other systems.

Use Case Examples

  1. Retrieve a contract billing rule by its ID to display billing details in a custom dashboard.
  2. Fetch contract billing rule data to synchronize with an external accounting system.

Properties

Name Meaning
Billing Rule ID The unique identifier of the contract billing rule 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.
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) to the top level of the returned object instead of nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the contract billing rule.
  • name - The name of the contract billing rule.
  • description - Description or details of the contract billing rule.
  • billingType - Type of billing associated with the rule.
  • amount - The monetary amount or rate defined by the billing rule.
  • userDefinedFields - Array of user-defined fields related to the contract billing rule, if not flattened.
  • _label - Additional human-readable labels for picklist or reference fields, if enabled.

Dependencies

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

Troubleshooting

  • Ensure the Billing Rule ID is correct and exists in the Autotask system to avoid 'not found' errors.
  • If labels are not appearing as expected, verify that 'Add Picklist Labels' and 'Add Reference Labels' options are enabled.
  • Check API credentials and permissions if the node fails to authenticate or retrieve data.

Links

Discussion