Actions34
- Customer Actions
- Customer Xdrs Actions
- Customer Extensions Actions
- Account Actions
- Invoice Actions
- DID Numbers Actions
- Billing sessions Actions
- Rate Management Actions
Overview
The PortaOne node for n8n allows you to interact with the PortaOne API, specifically to retrieve invoice information. The "Invoice: Get" operation fetches details about a specific invoice or set of invoices, optionally including the PDF file and filtered by various criteria such as customer ID or invoice number. This node is useful in scenarios where you need to automate billing processes, integrate invoice data into other systems, or trigger workflows based on invoice retrieval.
Practical examples:
- Automatically download invoice PDFs for archiving or emailing.
- Retrieve invoice details for a specific customer to update CRM records.
- Filter and process invoices based on their numbers for reconciliation tasks.
Properties
| Name | Meaning |
|---|---|
| Authentication | The authentication method to use. Options: Token Authentication, Basic Authentication. |
| AdditionalFields | A collection of optional fields: - Get PDF: Whether to include the PDF file in the response (Yes/No). - Customer ID: The unique ID of the customer record. - Invoice ID: The unique ID of the invoice. - Invoice Number: Filters invoices by the invoice number. |
| Simplify | Whether to simplify the output data. If enabled, only the property specified in "SimplifyPath" will be returned. |
| SimplifyPath | Path to the property that should be returned when "Simplify" is enabled. Default: invoice_info. |
Output
- By default, the node outputs a JSON object containing invoice information as returned by the PortaOne API.
- If Simplify is enabled, only the property specified by SimplifyPath (default:
invoice_info) is included in the output. - If Get PDF is set to "Yes", the response may include binary data representing the invoice PDF.
Dependencies
- External Services: Requires access to the PortaOne API.
- API Credentials:
- For Token Authentication: portaOneTokenApi credentials.
- For Basic Authentication: portaOneBasicApi credentials.
- n8n Configuration: Ensure the appropriate credentials are configured in n8n under the node's settings.
Troubleshooting
- Authentication Errors:
- Error message: "Invalid credentials" or "401 Unauthorized".
Resolution: Check that the correct authentication method and valid credentials are provided.
- Error message: "Invalid credentials" or "401 Unauthorized".
- Missing Required Fields:
- Error message: "Missing required parameter" or similar.
Resolution: Ensure that necessary fields like Customer ID or Invoice ID are filled if required by your use case.
- Error message: "Missing required parameter" or similar.
- PDF Not Included:
- Issue: PDF not present in output when expected.
Resolution: Make sure "Get PDF" is set to "Yes" in AdditionalFields.
- Issue: PDF not present in output when expected.
- Empty Output When Simplified:
- Issue: Output is empty or missing expected data.
Resolution: Verify that the path in "SimplifyPath" matches the structure of the API response.
- Issue: Output is empty or missing expected data.