Actions12
- Custom API Call Actions
- Assignments Actions
- Invoices Actions
Invoices → Get All (Index)
AI-generatedOverview
This node interacts with the Flex Platform API to retrieve a list of invoice-related objects. Specifically, for the 'Invoices' resource and 'Get All (Index)' operation, it fetches multiple invoice records based on user-defined filters and pagination options. This is useful for scenarios where users need to bulk retrieve invoice data, such as generating reports, syncing invoices with other systems, or performing batch processing.
Use Case Examples
- Retrieve all collection invoices with a limit of 100 per page and on page 2.
- Fetch invoices filtered by status or other custom criteria using JSON filters or individual filter fields.
Properties
| Name | Meaning |
|---|---|
| Model | Select the type of invoice-related object to retrieve, such as collection invoices, invoices, invoice lines, or invoice contacts. |
| Options | Additional parameters to control the query, including pagination and custom JSON filters. |
| Custom Filters | Individual filter fields to apply to the query, each with a name and value, allowing fine-grained filtering of results. |
Output
JSON
json- The JSON response from the Flex Platform API containing the list of invoice-related objects retrieved based on the specified filters and pagination.
Dependencies
- Requires an API key credential for Flex Platform API authentication.
Troubleshooting
- Common issues include errors in the 'Custom Filter JSON' field, such as invalid JSON syntax. The node throws an error indicating a problem parsing this JSON, which can be resolved by ensuring the JSON is valid and uses double quotes.
- API authentication errors may occur if the API key credential is missing or invalid, resulting in failure to obtain an access token.
- Pagination parameters (limit and page) should be set correctly to avoid empty or incomplete results.