Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Item → List Of Item

AI-generated

Overview

This node integrates with the Halo PSA API to list items based on various filtering and sorting criteria. It is designed to retrieve a collection of "Item" resources from the Halo PSA system, allowing users to specify detailed query parameters such as active status, asset groups, suppliers, pagination, and ordering preferences.

Common scenarios where this node is beneficial include:

  • Fetching inventory or service items filtered by specific attributes like supplier, stock location, or asset group.
  • Retrieving paginated lists of items for reporting or synchronization with other systems.
  • Filtering items by their active/inactive status or inclusion in external accounting platforms like QuickBooks or Xero.
  • Sorting items by multiple fields in ascending or descending order.

Practical example:

  • A user wants to get all active items belonging to a particular supplier, sorted by name ascending and limited to 50 results per page. They can configure the node with appropriate filters (includeactive=true, supplier_id=123), set the ordering (order=name, orderdesc=false), and enable pagination (pageinate=true, page_size=50).

Properties

Name Meaning
Activeinactive Filter on active/inactive items - comma separated, first value true/false for active, second for inactive.
Advanced Search Advanced search string filter.
Assetgroup Id Filter by items belonging to a particular asset group (integer).
Assetgroups Filter items on asset groups, comma separated IDs.
Assettypes Filter items on asset types, comma separated IDs.
Autotask Service Items Include only autotask service items in the response (boolean).
Count Number of items to return in the response (integer).
Dbc Company Id Filter by DBC company ID (string).
Exactdivision Filter by exact division (type not specified).
Excluderecurring Exclude recurring items in the response (boolean).
Includeactive Include active items in the response (boolean).
Includeinactive Include inactive items in the response (boolean).
Itemservice Id Filter by item service ID (type not specified).
Itemservicerequestdetails Id Filter by item service request details ID (type not specified).
Itemsupplierclientid Filter by items belonging to a supplier client (integer).
Kashflowtenantid Filter by items belonging to a particular Kashflow tenant (integer).
Order The name of the field to order by first (string).
Order 2 The name of the field to order by second (string).
Order 3 The name of the field to order by third (string).
Order 4 The name of the field to order by fourth (string).
Order 5 The name of the field to order by fifth (string).
Orderdesc Whether to order ascending or descending on first order (boolean).
Orderdesc 2 Whether to order ascending or descending on second order (boolean).
Orderdesc 3 Whether to order ascending or descending on third order (boolean).
Orderdesc 4 Whether to order ascending or descending on fourth order (boolean).
Orderdesc 5 Whether to order ascending or descending on fifth order (boolean).
Page No When using pagination, the page number to return (integer).
Page Size When using pagination, the size of the page (integer).
Pageinate Whether to use pagination in the response (boolean).
Qbitemsonly Include only QuickBooks items in the response (boolean).
Qbocompanyid Filter by items QuickBooks online company ID (string).
Recurringonly Include only recurring items (type not specified).
Sagebusinesscloudtenantid Filter by Sage Business Cloud tenant ID (type not specified).
Search Filters response based on the search string (string).
Search 1 Additional search filter (string).
Show Not In Stock Include items not in stock in the response (boolean).
Stocklocation Id Filter by items belonging to a particular stock location (integer).
Supplier Id Filter by items belonging to a particular supplier (integer).
Xerotenantid Filter by items Xero tenant ID (string).

Output

The node outputs an array of JSON objects representing the items retrieved from the Halo PSA API according to the specified filters and pagination settings. Each output item corresponds to one item resource returned by the API.

  • The json property contains the full response data for each item.
  • If an error occurs during the API request and the node is configured to continue on failure, the output will contain an object with an error property describing the issue.
  • This node does not output binary data.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node uses credentials that provide base URL, tenant identifier, client ID, and client secret for API access.
  • No additional environment variables are required beyond the configured credentials.

Troubleshooting

  • No credentials returned!: This error indicates missing or misconfigured API credentials. Ensure that valid credentials are set up in n8n before running the node.
  • Resource or Operation not found: Occurs if the selected resource or operation is invalid or not supported. Verify that "Item" resource and "List Of Item" operation are correctly selected.
  • API request errors: Network issues, invalid query parameters, or authentication failures may cause errors. Check the error message returned in the output and verify API credentials and parameter values.
  • JSON parsing errors: If using advanced JSON parameters, ensure that JSON strings are well-formed.
  • To handle errors gracefully, enable "Continue On Fail" in the node settings.

Links and References

Discussion