Autotask icon

Autotask

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

Actions524

Contract Billing Rule → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple Contract Billing Rule records from the Autotask PSA system using advanced filtering criteria. It is useful for scenarios where users need to query contract billing rules with specific conditions, such as filtering by date ranges, statuses, or other custom fields. For example, a user might want to fetch all active billing rules for contracts within a certain project or client.

Use Case Examples

  1. Retrieve all contract billing rules that match a complex filter criteria defined in JSON format.
  2. Fetch a limited number of contract billing rules with specific fields selected for reporting or integration purposes.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit.
Max Records Maximum number of records to return when not returning all (range 1-500).
Advanced Filter A JSON string containing a "filter" array with Autotask API query criteria to specify complex filtering conditions.
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 instead of nested in the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the contract billing rule record.
  • name - Name or title of the contract billing rule.
  • description - Description or details about the contract billing rule.
  • status - Status of the billing rule (e.g., active, inactive).
  • createdDate - Date when the billing rule was created.
  • modifiedDate - Date when the billing rule was last modified.
  • userDefinedFields - Array of user-defined fields associated with the billing rule, if not flattened.
  • _label - Additional human-readable labels for picklist or reference fields if enabled.

Dependencies

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

Troubleshooting

  • Ensure the advanced filter JSON is correctly formatted and matches Autotask API query criteria syntax to avoid query errors.
  • If the node returns no data, verify that the filter criteria actually match existing contract billing rules in the Autotask system.
  • Check API credentials and permissions to ensure the node can access contract billing rule data.
  • If the maximum records limit is set too low, increase it or enable 'Get All' to retrieve more records.

Links

Discussion