Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Supplier Order Header → List Of Supplier Order Header

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of supplier order headers. It allows users to filter and paginate through supplier orders based on various criteria such as approval status, delivery options, client or supplier IDs, order statuses, and more. This is useful in scenarios where you need to automate workflows involving supplier order management, reporting, or synchronization with other systems.

Practical examples:

  • Fetching all supplier orders that are currently awaiting approval.
  • Retrieving paginated lists of open purchase orders filtered by specific suppliers or sites.
  • Sorting supplier orders by multiple fields to generate custom reports or dashboards.

Properties

Name Meaning
Awaiting Approval Filter by suppliers whose orders are awaiting approval (integer).
Awaitingstock Filter by suppliers awaiting stock (boolean).
Client Id Filter orders by the specified client ID (integer).
Closed Filter orders by closed status (boolean).
Count Number of contracts to return in the response (integer).
Deliver To Us Filter orders based on delivery to us option (boolean).
Deliver To User Salesorder Id Filter by a specific user sales order ID (integer).
My Approvals Filter by suppliers awaiting your approval (integer).
Open Filter orders by open status (boolean).
Order The name of the first field to order results by (string).
Order 2 The name of the second field to order results by (string).
Order 3 The name of the third field to order results by (string).
Order 4 The name of the fourth field to order results by (string).
Order 5 The name of the fifth field to order results by (string).
Orderdesc Whether to order ascending or descending on the first order (boolean).
Orderdesc 2 Whether to order ascending or descending on the second order (boolean).
Orderdesc 3 Whether to order ascending or descending on the third order (boolean).
Orderdesc 4 Whether to order ascending or descending on the fourth order (boolean).
Orderdesc 5 Whether to order ascending or descending on the fifth order (boolean).
Page No Page number to return when using pagination (integer).
Page Size Size of the page when using pagination (integer).
Pageinate Whether to use pagination in the response (boolean).
Po Status Filters by specified purchase order statuses, comma separated (string).
Salesorder Id Filter by the specified sales order ID (integer).
Search Filter response based on a search string (string).
Site Id Filter by the specified site ID (integer).
Supplier Id Filter by the specified supplier ID (integer).
Ticket Id Filter by the specified ticket ID (integer).
Unsent Filter by sent status (boolean).
User Id Filter by the specified user ID (integer).

Output

The node outputs an array of JSON objects representing supplier order headers retrieved from the Halo PSA API. Each item corresponds to one supplier order header record, containing all relevant fields returned by the API.

If an error occurs during the request, the output will contain an object with an error property describing the issue.

The node does not output binary data.

Dependencies

  • Requires connection to the Halo PSA API.
  • Needs an API authentication credential configured in n8n with:
    • Base URL of the Halo PSA instance.
    • Tenant identifier.
    • Client ID.
    • Client secret.

These credentials must be set up in n8n before using the node.

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API credentials. Ensure the Halo PSA API credentials are properly set in n8n.

  • Resource or Operation not found
    If the specified resource or operation is invalid or misspelled, the node will throw an error. Verify the resource is "Supplier Order Header" and operation is "List Of Supplier Order Header".

  • API request errors
    Network issues, incorrect filters, or permission problems may cause API request failures. Check the error message returned in the output for details.

  • JSON parsing errors
    If using JSON parameters or request bodies, ensure they are valid JSON strings.

Links and References

Discussion