Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node operation retrieves multiple Invoice records from the Autotask REST API using an advanced filtering mechanism. It allows users to specify complex query criteria in JSON format to filter invoices according to their needs. This is useful for scenarios where you need to extract a customized list of invoices based on specific conditions, such as date ranges, status, customer, or other invoice attributes. For example, a user can fetch all unpaid invoices from a particular client or all invoices created within a certain period.

Properties

Name Meaning
Get All Determines whether to return all matching invoice records or limit the number of results.
Max Records Specifies the maximum number of invoice 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 with Autotask API query criteria to filter invoices. This allows complex and precise filtering based on invoice fields.
Add Picklist Labels If enabled, adds additional fields with '_label' suffix for picklist fields to provide human-readable values instead of raw codes.
Add Reference Labels If enabled, adds additional fields with '_label' suffix for reference fields to provide human-readable values.
Select Columns Names or IDs. Allows selection of specific invoice fields to include in the response. If no fields are selected, all fields are returned. The ID field is always included.
Flatten User-Defined Fields If enabled, user-defined fields (UDFs) are moved to the top level of each invoice object instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - Unique identifier of the invoice.
  • invoiceNumber - The invoice number.
  • customerID - Reference ID of the customer associated with the invoice.
  • status - Status code of the invoice.
  • status_label - Human-readable label for the invoice status (if Add Picklist Labels is enabled).
    userDefinedFields - Individual user-defined fields accessible at top level if Flatten User-Defined Fields is enabled. - Other selected invoice fields as specified by the Select Columns property.

Dependencies

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

Troubleshooting

  • Invalid JSON in the Advanced Filter property will cause the node to fail. Ensure the JSON string is well-formed and follows the Autotask API query format.
  • If no invoices are returned, verify that the filter criteria match existing invoices and that the user has permission to access those records.
  • Selecting too many fields or requesting a very large number of records may lead to performance issues or API rate limits.
  • If picklist or reference labels are not appearing, ensure that the corresponding fields have valid values and that the Add Picklist Labels and Add Reference Labels options are enabled.
  • Errors related to authentication usually indicate missing or invalid API credentials; verify the Autotask API key configuration.

Links

Discussion