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 Invoice - Get All operation node retrieves a list of invoices from the PortaOne API. It allows users to filter, sort, and paginate invoice records based on various criteria such as customer ID, date ranges, invoice status, and more. This node is useful for automating financial reporting, synchronizing invoice data with other systems, or generating custom invoice lists for analysis.
Practical examples:
- Fetch all invoices issued within a specific date range for a particular customer.
- Retrieve only non-voided invoices and download their archived PDFs.
- List invoices with specific statuses or numbers for reconciliation purposes.
Properties
| Name | Meaning |
|---|---|
| Authentication | The authentication method to use. Options: Token Authentication, Basic Authentication. |
| AdditionalFields | A collection of optional filters and settings to refine the invoice search. Includes: - Complex Ordering (sort by field/direction) - Covers Date - From/To Date - Get Archived PDFs (Yes/No) - Hide Void (Yes/No) - Customer ID - Parent ID - Invoice Number - Invoice Number List - Invoice Status List - Issued After/Before - Limit - Offset - Pdf Generated - Stage |
| 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_list. |
Output
- By default, the node outputs a JSON object containing the full response from the PortaOne API for the invoice list request.
- If Simplify is enabled, only the property specified by SimplifyPath (default:
invoice_list) is returned, which typically contains an array of invoice objects. - Each invoice object may include fields such as invoice number, customer ID, status, issue dates, amounts, etc., depending on the API's response structure.
- If binary data is requested (e.g., archived PDFs), the node may also output binary fields representing the PDF files.
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 set up in n8n under the respective authentication method.
Troubleshooting
Common Issues:
- Authentication Errors: Occur if the wrong authentication method or invalid credentials are provided. Ensure you select the correct authentication type and supply valid credentials.
- Missing Required Fields: Some filters (like offset) require others (like limit). If you specify "Offset", make sure "Limit" is also set.
- Empty Results: If filters are too restrictive, no invoices may be returned. Adjust your filters accordingly.
- API Rate Limits or Connectivity Issues: May result in timeout or connection errors; check network connectivity and API limits.
Error Messages:
- "Invalid credentials" – Check your API key or username/password.
- "Missing required parameter: limit" – Set the "Limit" property if using "Offset".
- "Resource not found" – Verify the resource and operation names.