Autotask icon

Autotask

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

Actions524

Contract Billing Rule → Get Many

AI-generated

Overview

This node operation retrieves multiple Contract Billing Rule records from the Autotask PSA system. It supports fetching all records or limiting the number of records returned, with options to include human-readable labels for picklist and reference fields, select specific columns, and flatten user-defined fields for easier access. This operation is useful for scenarios where users need to list or analyze multiple contract billing rules, such as generating reports, syncing data with other systems, or performing bulk updates.

Use Case Examples

  1. Retrieve all contract billing rules to analyze billing configurations across contracts.
  2. Fetch a limited number of contract billing rules with specific fields for display in a dashboard.
  3. Get contract billing rules with user-friendly labels for picklist and reference fields to improve readability in reports.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit.
Max Records Maximum number of contract billing rule records to return when not returning all. Range is 1 to 500.
Add Picklist Labels Whether to automatically add "_label" fields for picklist fields with human-readable values (no labels added for empty values).
Add Reference Labels Whether to automatically add "_label" fields for reference fields with human-readable values (no labels 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 for easier access instead of being nested in the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contract billing rule.
  • name - Name of the contract billing rule.
  • description - Description of the contract billing rule.
  • billingCodeId - Identifier of the associated billing code.
  • contractId - Identifier of the associated contract.
  • isActive - Indicates if the contract billing rule is active.
  • startDate - Start date of the billing rule.
  • endDate - End date of the billing rule.
  • userDefinedFields - Array of user-defined fields related to the contract billing rule, if not flattened.
  • _label - Human-readable labels for picklist and reference fields if enabled.

Dependencies

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

Troubleshooting

  • Ensure the API credentials are correctly configured and have sufficient permissions to access contract billing rules.
  • If the node returns no data, verify that contract billing rules exist in the Autotask system and that filters (if any) are correctly set.
  • If the node fails with rate limit errors, consider enabling rate limiting or retry mechanisms as per Autotask API guidelines.
  • Errors related to field selection may occur if invalid field names or IDs are specified in the Select Columns property; verify field names against the Autotask API documentation.

Links

Discussion