Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Pdf Template → Get One Pdf Template

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve data about PDF templates. Specifically, the "Get One Pdf Template" operation fetches detailed information about a single PDF template by its unique identifier. This is useful in scenarios where you need to programmatically access or display specific PDF templates stored in the Halo PSA system, such as generating reports, invoices, or other documents based on predefined templates.

Practical examples include:

  • Automatically retrieving a PDF template's details before populating it with dynamic data.
  • Validating the existence and properties of a PDF template before using it in a workflow.
  • Fetching metadata or configuration of a PDF template for auditing or synchronization purposes.

Properties

Name Meaning
Id The unique numeric identifier of the PDF template to retrieve.
Includedetails Optional query parameter to specify whether to include detailed information in response.
Licencename Optional query parameter to filter or specify license name related to the PDF template.
System Use Optional query parameter to specify system use context or filter for the PDF template.

Output

The node outputs JSON data representing the retrieved PDF template. The structure corresponds to the API response from Halo PSA and typically includes fields such as template ID, name, description, content, and possibly metadata depending on the includedetails parameter.

If the API returns binary data (e.g., the actual PDF file), it would be included in the binary output field; however, this operation appears focused on metadata retrieval, so output is primarily JSON.

Example output JSON structure (simplified):

{
  "id": 123,
  "name": "Invoice Template",
  "description": "Template used for invoicing clients",
  "content": "...",
  "licenseName": "Standard",
  "systemUse": "Billing",
  "details": { ... } // present if includedetails=true
}

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 with appropriate headers to communicate with the Halo PSA service.
  • No additional external dependencies beyond the configured API credentials.

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 ("Pdf Template") or operation ("Get One Pdf Template") is incorrect or unavailable. Verify spelling and availability in the node configuration.

  • API request failures
    Network issues, invalid parameters (e.g., wrong template ID), or insufficient permissions can cause errors. Check the API response message for details and confirm that the provided ID exists and credentials have proper access rights.

  • JSON parsing errors
    If custom query parameters or JSON bodies are malformed, the node may throw parsing errors. Validate all input fields and ensure correct JSON formatting.

Links and References

Discussion