Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Contract Exclusion Billing Code records from the Autotask system using an advanced JSON filter. It is useful for users who need to query and extract specific billing code exclusions based on complex criteria, such as filtering by multiple fields or conditions. For example, a user can fetch all exclusion billing codes that match certain contract parameters or statuses by providing a custom JSON filter.

Properties

Name Meaning
Get All Determines whether to return all matching records or limit the number of results.
Max Records Specifies the maximum number of records to return when 'Get All' is false. The value must be between 1 and 500.
Advanced Filter A required JSON string containing a 'filter' array that defines the query criteria according to the Autotask API's advanced query syntax. This allows complex filtering of records based on multiple conditions.
Add Picklist Labels Whether to add human-readable label fields for picklist fields in the output, enhancing readability.
Add Reference Labels Whether to add human-readable label fields for reference fields in the output.
Select Columns Names or IDs. Allows selection of specific 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 if user-defined fields (UDFs) should be moved to the top level of each returned object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the Contract Exclusion Billing Code record.
  • fieldName - Various fields of the Contract Exclusion Billing Code as returned by the Autotask API, depending on selected columns and filters.
    _label - Human-readable labels for picklist or reference fields if enabled.userDefinedFields - User-defined fields either nested or flattened to top-level depending on the flattenUdfs option.

Dependencies

  • Requires an Autotask API credential for authentication to access the Autotask REST API.

Troubleshooting

  • Ensure the 'Advanced Filter' JSON string is correctly formatted and follows the Autotask API query syntax; invalid JSON or incorrect filter structure will cause errors.
  • If no records are returned, verify that the filter criteria match existing data and that the 'Get All' and 'Max Records' settings are appropriate.
  • If picklist or reference labels are not appearing, check that the corresponding options 'Add Picklist Labels' and 'Add Reference Labels' are enabled.
  • API rate limits or authentication errors may occur if the Autotask API credentials are invalid or expired; verify and update credentials as needed.

Links

Discussion