Autotask icon

Autotask

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

Actions524

Configuration Item Billing Product Association → Get Many (Advanced)

AI-generated

Overview

This node operation retrieves multiple Configuration Item Billing Product Association records from the Autotask PSA system using an advanced filter. It allows users to specify complex query criteria in JSON format to filter the results. Users can choose to return all matching records or limit the number of records returned. This operation is useful for scenarios where detailed and specific data retrieval is needed for billing product associations linked to configuration items, such as generating reports or integrating billing data with other systems.

Use Case Examples

  1. Retrieve all billing product associations for configuration items that meet specific criteria defined in an advanced JSON filter.
  2. Limit the number of returned billing product association records to a maximum number for performance optimization.
  3. Use the advanced filter to query billing product associations based on custom fields or complex conditions.

Properties

Name Meaning
Get All Whether to return all results or only up to a given limit (returnAll boolean). If false, maxRecords limits the number of records.
Max Records Maximum number of records to return when Get All is false. Range is 1 to 500.
Advanced Filter A JSON string containing a "filter" array with Autotask API query criteria to filter the results. This allows complex queries to be constructed.
Add Picklist Labels Whether to automatically add "_label" fields for picklist fields with human-readable values. No labels are added for empty values.
Add Reference Labels Whether to automatically add "_label" fields for reference fields with human-readable values. No labels are 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, making them accessible as top-level properties instead of nested in the userDefinedFields array.

Output

JSON

  • id - Unique identifier of the billing product association record.
  • configurationItemId - Identifier of the associated configuration item.
  • billingProductId - Identifier of the billing product associated with the configuration item.
  • startDate - Start date of the billing product association.
  • endDate - End date of the billing product association.
  • isActive - Indicates if the billing product association is currently active.
  • userDefinedFields - Array of user-defined fields related to the billing product association, if not flattened.

Dependencies

  • An API key credential for Autotask PSA REST API authentication

Troubleshooting

  • Ensure the advanced filter JSON is correctly formatted and valid according to Autotask API specifications to avoid query errors.
  • If no records are returned, verify that the filter criteria match existing data in the Autotask system.
  • When limiting records with Max Records, ensure the value is between 1 and 500 to prevent errors.
  • If picklist or reference labels are not appearing as expected, check that the corresponding options are enabled and that the fields contain values.
  • Authentication errors may occur if the API key credential is missing or invalid; verify credentials in node settings.

Links

Discussion