Autotask icon

Autotask

Consume Autotask REST API
Join our community

Actions389

Overview

This node interacts with the Autotask REST API to retrieve detailed information about a specific invoice by its ID. It is useful for workflows that need to fetch invoice data for processing, reporting, or integration with other systems. For example, a user can automate the retrieval of invoice details to generate financial reports or trigger follow-up actions based on invoice status.

Properties

Name Meaning
Invoice ID The unique identifier of the invoice to retrieve. This is a required field to specify which invoice the operation will target.
Add Picklist Labels Determines whether to automatically add human-readable label fields (with a '_label' suffix) for picklist fields in the invoice data. Labels are only added if the picklist fields have non-empty values.
Add Reference Labels Determines whether to automatically add human-readable label fields (with a '_label' suffix) for reference fields in the invoice data. Labels are only added if the reference fields have non-empty 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 invoice ID field is always included regardless of selection.
Flatten User-Defined Fields Determines whether user-defined fields (UDFs) in the invoice data should be promoted to top-level properties instead of being nested inside a userDefinedFields array.

Output

JSON

  • id - The unique identifier of the invoice.
  • invoiceNumber - The invoice number assigned by the system.
  • status - The current status of the invoice.
  • totalAmount - The total amount due on the invoice.
  • dueDate - The date by which the invoice should be paid.
  • userDefinedFields - An array of user-defined fields associated with the invoice, unless flattened to top-level properties.
  • picklistField_label - Human-readable labels for picklist fields, added if 'Add Picklist Labels' is enabled.
  • referenceField_label - Human-readable labels for reference fields, added if 'Add Reference Labels' is enabled.

Dependencies

  • Requires an API key credential for authenticating with the Autotask REST API.

Troubleshooting

  • If the node throws an error indicating the invoice ID is missing or invalid, ensure that the 'Invoice ID' property is correctly set and corresponds to an existing invoice.
  • If the response does not include expected fields, verify that the 'Select Columns Names or IDs.' property is configured correctly or left empty to retrieve all fields.
  • If labels for picklist or reference fields are missing, check that the corresponding 'Add Picklist Labels' and 'Add Reference Labels' options are enabled.
  • Network or authentication errors may occur if the API key credential is invalid or expired; verify and update credentials as needed.

Discussion