Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Supplier Order Header → Get One Supplier Order Header

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve detailed information about a single Supplier Order Header. It is designed to fetch one specific supplier order header by its unique identifier, optionally including additional related data such as receivable lines, invoiceable lines, and extra details.

Common scenarios where this node is beneficial include:

  • Integrating supplier order data into workflows for procurement or inventory management.
  • Automating reporting or auditing processes that require up-to-date supplier order information.
  • Enriching other business processes with supplier order details fetched dynamically from Halo PSA.

For example, you might use this node to get a supplier order header by its ID and include all consignable lines and extra details to verify order status before triggering payment or delivery workflows.

Properties

Name Meaning
Id The unique numeric identifier of the Supplier Order Header to retrieve. This is required.
Extrareceivablelines Boolean flag to include "deliver to us" lines for suppliers who have received more quantity than currently held.
Includedetails Boolean flag to include extra related objects/details in the response.
Invoiceablelines Boolean flag to include only invoiceable lines in the response.
Receivablelines Boolean flag to include only consignable (receivable) lines in the response.

Output

The node outputs JSON data representing the requested Supplier Order Header object as returned by the Halo PSA API. The structure includes the main order header fields and, depending on the boolean flags set, may also contain nested arrays or objects for receivable lines, invoiceable lines, extra receivable lines, and additional details.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Halo PSA API via an API key credential.
  • The node expects configuration of credentials including base URL, tenant identifier, client ID, and client secret for authentication.
  • Network access to the Halo PSA API endpoint is necessary.

Troubleshooting

  • Missing Credentials Error: If no credentials are provided or they are invalid, the node will throw an error indicating missing credentials. Ensure the API key credential is configured correctly.
  • Resource or Operation Not Found: Errors occur if the specified resource ("Supplier Order Header") or operation ("Get One Supplier Order Header") is not recognized. Verify the resource and operation names are correct.
  • Invalid or Missing Id: Since the Id property is required, omitting it or providing an invalid value will cause the request to fail. Always provide a valid numeric Id.
  • API Request Failures: Network issues, incorrect base URL, or authentication failures can cause the API request to fail. Check connectivity and credential validity.
  • JSON Parsing Errors: If additional query parameters or request bodies are malformed JSON, parsing errors may occur. Validate any JSON inputs carefully.

Links and References

If you need further details on other operations or resources, feel free to ask!

Discussion