Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Contract → List Of Contract

AI-generated

Overview

This node integrates with the Halo PSA API to list contracts based on various filtering, ordering, and pagination options. It is useful for retrieving contract data from a Halo PSA system, enabling automation workflows that need to process or analyze contract information.

Common scenarios include:

  • Fetching a list of active or inactive contracts for reporting.
  • Retrieving contracts filtered by supplier or search terms.
  • Ordering contracts by multiple fields in ascending or descending order.
  • Paginating through large sets of contracts to process them in batches.

For example, you could use this node to get the first 50 active contracts ordered by start date descending, or to search contracts containing a specific keyword and paginate through results page by page.

Properties

Name Meaning
Count Number of contracts to return in the response (integer).
Includeinactive Whether to include inactive contracts in the response (boolean).
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).
Search Filters response based on the search string (string).
Supplier Id Filters contracts by the specified supplier ID (integer).

Output

The node outputs an array of items where each item contains a json object representing a contract or a set of contracts returned by the API call. The structure of the JSON depends on the Halo PSA API response for listing contracts, typically including contract details such as IDs, names, statuses, dates, suppliers, and other relevant metadata.

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API authentication credentials. Ensure the API key and related credentials are properly set up in n8n.

  • Resource or Operation not found
    If the node parameters specify a resource or operation that does not exist, verify that the correct resource ("Contract") and operation ("List Of Contract") are selected.

  • API request errors
    Errors from the API (e.g., invalid parameters, rate limits) will be returned in the node output if "Continue On Fail" is enabled; otherwise, they will stop execution. Check parameter values like pagination and ordering fields for correctness.

  • Pagination issues
    When using pagination, ensure that page numbers and sizes are valid integers and that the API supports the requested pagination parameters.

Links and References

Discussion