Actions40
- Customer Actions
- Customer Group Actions
- Discount Actions
- Document Actions
- Document Payment Actions
- SEPA Payment Actions
Document Payment → Get Document Payment List
AI-generatedOverview
This node interacts with the EasyBill API to retrieve a list of document payments. It supports fetching either all document payments or a limited subset based on pagination parameters. Users can filter the results using additional query parameters such as document ID, payment date, and reference. This node is useful for scenarios where users need to manage or analyze payment data related to documents in EasyBill, such as generating reports or syncing payment data with other systems.
Use Case Examples
- Retrieve all document payments without limit to process or analyze the complete payment history.
- Fetch a limited number of document payments with pagination to display in a user interface or for batch processing.
- Filter document payments by specific document IDs or payment dates to focus on relevant transactions.
Properties
| Name | Meaning |
|---|---|
| Return All | Determines whether to return all document payment results or only up to a specified limit. |
| Limit | Specifies the maximum number of document payment results to return when 'Return All' is false. |
| Page | Specifies the page number to retrieve when 'Return All' is false, enabling pagination. |
| Additional Fields | Additional query parameters to filter the document payments, including document ID(s), payment date(s), and reference(s). |
Output
JSON
- `` - An array of document payment objects returned from the EasyBill API, each representing a payment record with details such as amount, document ID, payment date, and reference.
Dependencies
- Requires an API key credential for EasyBill API authentication.
Troubleshooting
- If no results are returned, verify that the filter parameters (document_id, payment_at, reference) are correctly specified and match existing payments.
- Ensure the API key credential is valid and has the necessary permissions to access document payment data.
- If pagination parameters are used, confirm that the page number and limit are within valid ranges to avoid empty responses.
- Network or API errors may occur; check connectivity and EasyBill API status.
Links
- EasyBill API Documentation - Official documentation for the EasyBill API, including endpoints for document payments.
