Halo PSA icon

Halo PSA

Consume Halo PSA API

Actions795

Invoice Header → Get One Invoice Header

AI-generated

Overview

This node integrates with the Halo PSA API to retrieve detailed information about a single invoice header. It is designed to fetch one specific invoice header by its unique identifier, optionally including additional related details in the response.

Common scenarios where this node is beneficial include:

  • Retrieving invoice metadata for billing or accounting workflows.
  • Fetching invoice header data to display or process in downstream automation.
  • Integrating invoice information into custom dashboards or reports.

For example, you might use this node to get the invoice header for invoice ID 12345 and include extra details such as line items or payment status to automate financial reconciliation.

Properties

Name Meaning
Id The unique numeric identifier of the invoice header to retrieve.
Includedetails Boolean flag indicating whether to include extra related objects/details in the response.

Output

The node outputs JSON data representing the requested invoice header. This includes all standard fields of the invoice header object as returned by the Halo PSA API. If Includedetails is set to true, the output will also contain nested objects with additional related information (e.g., line items, payments).

The output structure corresponds directly to the API response for a single invoice header resource. No binary data is produced by this node.

Example output snippet (simplified):

{
  "id": 12345,
  "invoiceNumber": "INV-2024-001",
  "date": "2024-06-01",
  "customer": {
    "id": 6789,
    "name": "Acme Corporation"
  },
  "totalAmount": 1500.00,
  "status": "Paid",
  "details": { ... } // present if Includedetails=true
}

Dependencies

  • Requires an API key credential for authenticating with the Halo PSA API.
  • The node expects configuration of base URL, tenant ID, client ID, and client secret via credentials.
  • Network access to the Halo PSA API endpoint is necessary.

Troubleshooting

  • No credentials returned!
    This error indicates missing or misconfigured API authentication 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 any known API endpoints. Verify that the Resource is set to "Invoice Header" and Operation to "Get One Invoice Header".

  • Invalid or missing Id parameter
    Since the Id property is required, omitting it or providing a non-numeric value will cause errors. Make sure to provide a valid invoice header ID.

  • API request failures
    Network issues, invalid credentials, or insufficient permissions can cause the API call to fail. Check connectivity, credential validity, and user permissions on the Halo PSA side.

  • JSON parsing errors
    If additional query parameters or request bodies are used (not typical for this operation), ensure they are valid JSON.

Links and References

Discussion