Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Pdf Template Repository → Get One Pdf Template

AI-generated

Overview

This node interacts with the "Pdf Template Repository" resource of the Halo PSA API to retrieve a single PDF template by its identifier. It is designed to fetch detailed information about a specific PDF template stored in the repository, optionally including additional details or filtering by license name and system use.

Common scenarios where this node is beneficial include:

  • Automating retrieval of PDF templates for generating reports or documents.
  • Integrating PDF template data into workflows that require dynamic document generation.
  • Managing and auditing PDF templates by fetching their metadata programmatically.

For example, a user might use this node to get a particular invoice template by its ID, optionally including extended details about the template, to then populate it with customer data in subsequent workflow steps.

Properties

Name Meaning
Id The unique numeric identifier of the PDF template to retrieve. (Required)
Includedetails Optional flag or parameter to specify whether to include additional details in the response.
Licencename Optional string to filter or specify the license name associated with the PDF template.
System Use Optional string to specify the system use context or category for the PDF template.

Output

The node outputs JSON data representing the retrieved PDF template. The structure typically includes all fields returned by the Halo PSA API for a single PDF template, such as template metadata, content references, and possibly extended details if requested.

If an error occurs during the request, the output JSON will contain an error field with the error message.

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the Halo PSA API, including base URL, tenant identifier, client ID, and client secret.
  • The node depends on network access to the Halo PSA API endpoint.
  • No additional external services are required beyond the Halo PSA API.

Troubleshooting

  • No credentials returned!
    This error indicates missing or invalid API authentication credentials. Ensure that the API key credential is properly configured in n8n.

  • Resource or Operation not found
    If the specified resource or operation does not exist, verify that the resource name is exactly "Pdf Template Repository" and the operation is "Get One Pdf Template".

  • Request errors from API
    Errors returned by the API (e.g., 404 Not Found if the template ID does not exist) will be included in the output's error field if "Continue On Fail" is enabled. Otherwise, they will cause the node to fail. Check the template ID and query parameters for correctness.

  • Invalid JSON in parameters
    If using advanced JSON parameters (not typical for this operation), ensure JSON strings are well-formed.

Links and References

Note: The above summary is based solely on static analysis of the provided source code and property definitions.

Discussion