Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Contract Header → List Of Contract Header

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve a list of contract headers. It is designed to fetch contract header data based on various filtering, sorting, and pagination parameters. This operation is useful in scenarios where you need to programmatically access contract metadata for clients, devices, or sites within the Halo PSA system.

Practical examples include:

  • Listing all active contracts for a specific client.
  • Retrieving paginated contract headers filtered by device or site.
  • Sorting contract headers by different fields such as creation date or status.
  • Filtering contracts based on billing plan setup or renewal status.

Properties

Name Meaning
Client Id Filter contract headers by a specific client identifier.
Count Limit the number of contract headers returned.
Device Id Filter contract headers associated with a particular device.
Excluderenewed Option to exclude renewed contracts from the results.
Includeinactive Include inactive contracts in the listing.
Includelastrenewed Include only the last renewed contracts.
Isbillingplansetup Filter contracts based on whether a billing plan is set up.
Isoracle Filter contracts related to Oracle (likely a specific integration or type).
Order Primary field to order the results by (string).
Order 2 Secondary ordering field.
Order 3 Tertiary ordering field.
Order 4 Fourth level ordering field.
Order 5 Fifth level ordering field.
Orderdesc Boolean or flag indicating descending order for primary order field.
Orderdesc 2 Descending order flag for secondary order field.
Orderdesc 3 Descending order flag for tertiary order field.
Orderdesc 4 Descending order flag for fourth order field.
Orderdesc 5 Descending order flag for fifth order field.
Page No Page number for paginated results.
Page Size Number of items per page in paginated results.
Pageinate Flag to enable or disable pagination.
Pending Recurring Invoice Filter contracts that have pending recurring invoices.
Search Text search filter applied to contract headers.
Site Id Filter contract headers by a specific site identifier.

Output

The output is an array of JSON objects, each representing a contract header retrieved from the Halo PSA API. Each item contains the full details of a contract header as returned by the API, including metadata such as client info, device association, billing setup, renewal status, and other contract-specific fields.

No binary data output is indicated for this operation.

Dependencies

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

Troubleshooting

  • No credentials returned!: Ensure that the API authentication credentials are properly configured in n8n.
  • Resource or Operation not found: Verify that the selected resource is "Contract Header" and the operation is "List Of Contract Header".
  • API request errors: Could be due to invalid query parameters, network issues, or insufficient permissions. Check the error message returned in the node output for details.
  • Pagination issues: If no results appear, verify that page_no, page_size, and pageinate parameters are correctly set.
  • Invalid JSON in parameters: If using JSON input for query or body parameters, ensure the JSON syntax is correct.

Links and References

Discussion