Actions68
- Client Actions
- Agent Actions
- Asset Actions
- Field Info Actions
- Invoice Actions
- Site Actions
- Ticket Actions
- Ticket Status Actions
- Ticket Type Actions
- Timesheet Actions
- Timesheet Event Actions
- Webhook Actions
- Webhook Event Actions
Overview
This node integrates with the HaloPSA API to retrieve detailed information about invoices. Specifically, the "Get by ID" operation under the "Invoice" resource fetches a single invoice based on its unique identifier. This is useful in scenarios where you need to access or process specific invoice data within an automated workflow, such as generating reports, syncing invoice details with other systems, or triggering follow-up actions based on invoice status.
Practical examples include:
- Retrieving an invoice to verify payment status before proceeding with service delivery.
- Fetching invoice details to populate a custom dashboard or send notifications.
- Including additional related objects (like line items or client info) when needed for comprehensive processing.
Properties
| Name | Meaning |
|---|---|
| Invoice ID | The unique numeric identifier of the invoice to retrieve. |
| Include Details | Boolean flag indicating whether to include extra related objects in the response. |
Output
The node outputs JSON data representing the requested invoice. The structure typically includes standard invoice fields such as invoice number, date, client information, amounts, and status. If "Include Details" is set to true, the output will also contain additional nested objects related to the invoice, such as line items, taxes, or linked client data.
No binary data output is indicated for this operation.
Dependencies
- Requires an active connection to the HaloPSA API via an API key credential configured in n8n.
- The node depends on the HaloPSA API being accessible and the provided invoice ID existing in the system.
Troubleshooting
Common Issues:
- Invalid or missing invoice ID: The node requires a valid numeric invoice ID; providing zero or a non-existent ID will result in errors or empty responses.
- API authentication failure: Ensure that the API key credential is correctly configured and has sufficient permissions.
- Network or API downtime: Connectivity issues can cause request failures.
Error Messages:
- Errors related to "invoice not found" indicate the specified ID does not exist; verify the ID.
- Authentication errors suggest invalid or expired credentials; reconfigure the API key.
- Timeout or network errors require checking internet connectivity or HaloPSA service status.
Links and References
- HaloPSA API Documentation (for detailed API endpoints and data structures)
- n8n documentation on creating and using API credentials