Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Contract Schedule → Get One Contract Schedule

AI-generated

Overview

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

Common scenarios for this node include:

  • Automating contract management workflows by retrieving contract schedules for review or processing.
  • Integrating contract schedule data into other systems such as CRM or ERP platforms.
  • Generating reports or notifications based on contract schedule information.

For example, a user might use this node to get the details of a contract schedule by providing its ID and decide whether to include extended details in the response.

Properties

Name Meaning
Id The unique numeric identifier of the contract schedule to retrieve.
Includedetails Optional flag to specify whether to include additional detailed information in the query.

Output

The node outputs a JSON object representing the retrieved contract schedule. This includes all standard fields returned by the Halo PSA API for a contract schedule, and if requested, additional detailed information.

The output structure is:

{
  "json": {
    // Contract schedule fields as returned by the API,
    // e.g., id, name, startDate, endDate, status, etc.
    // plus any included detailed data if 'Includedetails' was set.
  },
  "pairedItem": {
    "item": <index_of_input_item>
  }
}

No binary data output is produced by this operation.

Dependencies

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

Troubleshooting

  • No credentials returned!
    This error indicates missing or invalid API credentials. Ensure that the required API authentication token or keys are properly configured in n8n credentials.

  • Resource or Operation not found
    If the specified resource ("Contract Schedule") or operation ("Get One Contract Schedule") is not recognized, verify that the node parameters are correctly set and that the node version supports these options.

  • HTTP request errors
    Errors during the API call (e.g., network issues, authorization failures) will be thrown. Check your API credentials, network connectivity, and permissions.

  • JSON parsing errors
    If additional query parameters or request bodies are provided as JSON strings, ensure they are well-formed JSON.

Using the "Continue On Fail" option can help handle errors gracefully by returning error messages in the output instead of stopping execution.

Links and References

Discussion