HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions68

Overview

This node integrates with the HaloPSA API to create new invoices. It allows users to specify a client and various optional invoice details, then sends this data to HaloPSA to generate an invoice record. This is useful in automating billing workflows, such as generating invoices after service completion or syncing invoice data from other systems.

Practical examples:

  • Automatically creating an invoice for a client after a support ticket is resolved.
  • Generating scheduled invoices based on contract milestones.
  • Adding custom notes or references to invoices programmatically.

Properties

Name Meaning
Client ID The unique identifier of the client for whom the invoice is created (required).
Additional Fields Optional extra invoice details that can be set:
- Contract ID Identifier for the related contract.
- Currency Symbol representing the currency (e.g., "$").
- Currency Code Numeric code representing the currency.
- Customer Order Number Customer's order number associated with the invoice.
- Due Date Date by which payment should be made.
- Hide Invoice Boolean flag indicating whether the invoice should be hidden.
- Invoice Date Date when the invoice was issued.
- Invoice Type Numeric ID specifying the type of invoice.
- Notes 1, 2, 3 Additional textual notes to include on the invoice.
- Order Number Purchase order number related to the invoice.
- Payment Terms Number of days allowed for payment.
- Reference Reference text for the invoice.
- Schedule Date Scheduled date for the invoice to be processed or sent.
- Site Number Identifier for the site related to the invoice.
- Third Party Invoice Number External invoice number from a third party.
- Ticket ID Associated ticket identifier, linking the invoice to a support or service ticket.

Output

The node outputs JSON data representing the newly created invoice as returned by the HaloPSA API. This typically includes invoice identifiers, status, dates, amounts, and any other relevant metadata provided by the API response.

If binary data were involved (e.g., PDF invoice files), it would be summarized here, but this node focuses on JSON invoice data only.

Dependencies

  • Requires an active connection to the HaloPSA API via an API key credential configured in n8n.
  • The node uses the HaloPSA API endpoints to perform invoice creation.
  • Proper permissions on the API key are necessary to create invoices.

Troubleshooting

  • Common issues:

    • Missing or invalid Client ID will cause the API request to fail.
    • Incorrect date formats in date fields may lead to errors.
    • Insufficient API permissions can result in authorization errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • "Unauthorized" or "Authentication failed": Check API key validity and permissions.
    • "Invalid input" or "Bad Request": Verify all required fields are correctly filled and formatted.
    • "Not Found" when referencing IDs (e.g., client, ticket): Confirm referenced entities exist in HaloPSA.

Resolving these usually involves verifying credentials, ensuring correct property values, and confirming entity existence in the HaloPSA system.

Links and References

Discussion