Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Contract Schedule Plan → Delete Undefined

AI-generated

Overview

This node integrates with the Halo PSA API to perform various operations on different resources. Specifically, for the Contract Schedule Plan resource with the Delete Undefined operation, it deletes a contract schedule plan identified by its unique ID. This is useful in scenarios where you need to programmatically remove obsolete or incorrect contract schedule plans from your system.

Practical examples include:

  • Automating cleanup of outdated contract schedules.
  • Removing erroneous entries during data synchronization processes.
  • Managing contract lifecycle by deleting plans that are no longer valid.

Properties

Name Meaning
Id The unique identifier (number) of the Contract Schedule Plan to delete. This property is required.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output object contains the response from the Halo PSA API after attempting to delete the specified Contract Schedule Plan. If the deletion is successful, the JSON will typically contain confirmation details from the API. In case of failure, the JSON will include an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Halo PSA API.
  • Needs credentials including base URL, tenant identifier, client ID, and client secret for authentication.
  • The node uses HTTP requests to communicate with the Halo PSA REST endpoints.
  • Proper configuration of these credentials within n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Missing or invalid credentials will cause authentication failures.
    • Providing an invalid or non-existent Contract Schedule Plan ID will result in API errors.
    • Network connectivity problems can prevent communication with the Halo PSA API.

  • Error messages:

    • "No credentials returned!": Indicates that the node could not retrieve the required API credentials. Ensure credentials are set up correctly.
    • "Resource Contract Schedule Plan not found" or "Operation Delete Undefined not found for resource Contract Schedule Plan": Suggests misconfiguration or unsupported resource/operation combination.
    • API error messages returned in the error field usually indicate issues like invalid IDs or permission problems. Review the error message and verify the input parameters and user permissions.

  • To handle errors gracefully, enable the "Continue On Fail" option in the node settings to process subsequent items even if some fail.

Links and References

Discussion