Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Contract Schedule Plan → Get One Contract Schedule Plan

AI-generated

Overview

This node interacts with the Halo PSA API to retrieve detailed information about a specific Contract Schedule Plan by its unique identifier. It is designed to fetch one contract schedule plan at a time, optionally including detailed related data.

Common scenarios where this node is beneficial include:

  • Automating contract management workflows by retrieving contract schedule details for review or processing.
  • Integrating contract schedule data into other systems such as CRMs, ERPs, or reporting tools.
  • Triggering downstream actions based on contract schedule attributes or statuses.

For example, a user might use this node to get the schedule plan of a contract before sending renewal reminders or generating invoices.

Properties

Name Meaning
Id The unique numeric identifier of the Contract Schedule Plan to retrieve (required).
Includedetails Optional flag to specify whether to include detailed related information in the response.

Output

The node outputs a JSON object representing the requested Contract Schedule Plan. This includes all standard fields returned by the Halo PSA API for that resource, such as identifiers, dates, status, and any other contract schedule metadata.

If the Includedetails property is set, the output may contain nested objects or arrays with additional detailed information related to the contract schedule plan.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": 123,
  "name": "Sample Contract Schedule Plan",
  "startDate": "2023-01-01",
  "endDate": "2023-12-31",
  "status": "Active",
  "details": { /* included if Includedetails is true */ }
}

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs valid API credentials configured in n8n, including base URL, tenant ID, client ID, and client secret.
  • The node uses HTTP requests with appropriate authentication headers to communicate with the Halo PSA service.

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API credentials. Ensure that the required API key or authentication token is properly set up in n8n credentials.

  • Resource or Operation not found
    Occurs if the specified resource or operation name does not match those supported by the node. Verify that "Contract Schedule Plan" and "Get One Contract Schedule Plan" are correctly selected.

  • HTTP request errors (e.g., 401 Unauthorized, 404 Not Found)
    These errors typically indicate issues with authentication or invalid resource IDs. Confirm that the provided Id exists and credentials have sufficient permissions.

  • JSON parsing errors
    If using advanced parameters like query or body JSON, ensure the JSON syntax is correct.

Links and References

Discussion