Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Contract → Get One Contract

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a single contract. It is designed to fetch one specific contract by its unique identifier, optionally including additional related details in the response.

Common scenarios where this node is beneficial include:

  • Automating contract management workflows by retrieving contract data for review or processing.
  • Integrating contract information into other systems or dashboards.
  • Triggering actions based on contract details, such as renewals or compliance checks.

For example, you might use this node to get the full details of a contract before sending it for approval or to synchronize contract data with a CRM system.

Properties

Name Meaning
Id The unique numeric identifier of the contract to retrieve.
Includedetails Boolean flag indicating whether to include extra related objects/details in the response.

Output

The node outputs JSON data representing the contract retrieved from the Halo PSA API. The structure includes all standard contract fields and, if requested, additional related objects or details.

If the Includedetails property is set to true, the output JSON will contain extended information beyond the basic contract data.

No binary data output is produced by this node.

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node configuration must include the base URL of the Halo PSA instance and authentication credentials (tenant, client ID, client secret).
  • 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 stating "No credentials returned!". Ensure that valid API authentication details are configured.
  • Resource or Operation Not Found: Errors like "Resource Contract not found" or "Operation Get One Contract not found for resource Contract" indicate misconfiguration of the resource or operation parameters.
  • Invalid Contract Id: Providing an invalid or non-existent contract ID may result in API errors or empty responses.
  • API Request Failures: Network issues or incorrect API credentials can cause request failures. Check connectivity and credential validity.
  • JSON Parsing Errors: If additional query parameters or request bodies are malformed JSON, parsing errors may occur.

To resolve these issues, verify all input parameters, ensure correct credentials, and confirm network connectivity to the Halo PSA API.

Links and References

Discussion