Actions40
- Customer Actions
- Customer Group Actions
- Discount Actions
- Document Actions
- Document Payment Actions
- SEPA Payment Actions
Document → Get Document List
AI-generatedOverview
This node operation retrieves a list of documents from the EasyBill API. It supports fetching all documents or a limited number of documents with pagination. Users can apply various filters such as cancel ID, customer ID, document date, fulfillment country, archive status, draft status, document number, payment date, project ID, reference ID, shipping country, status, title, type, and VAT country to narrow down the results. This operation is useful for scenarios where users need to query and manage document records, such as invoices or orders, from EasyBill for reporting, auditing, or integration purposes.
Use Case Examples
- Fetch all documents without limit to get a complete list for reporting.
- Retrieve a limited number of documents with specific filters like customer ID and document date for targeted data processing.
- Paginate through documents by specifying page number and limit to handle large datasets efficiently.
Properties
| Name | Meaning |
|---|---|
| Return All | Whether to return all results or only up to a given limit. |
| Limit | Maximum number of results to return when Return All is false. |
| Page | Page number to retrieve when Return All is false. |
| Additional Fields | Additional parameters to filter documents, such as cancel ID, customer ID, document date, fulfillment country, archive flag, draft flag, number, paid date, project ID, reference ID, shipping country, status, title, type, and VAT country. |
Output
JSON
- ``
id- Unique identifier of the document.customer_id- Identifier of the customer associated with the document.document_date- Date of the document.status- Status of the document, if applicable.type- Type of the document, e.g., INVOICE, CREDIT.title- Title of the document.number- Document number.paid_at- Date when the document was paid, if applicable.is_archive- Flag indicating if the document is archived.is_draft- Flag indicating if the document is a draft.
Dependencies
- EasyBill API key credential
Troubleshooting
- Ensure the EasyBill API key credential is correctly configured and has the necessary permissions to access document data.
- If the node returns no documents, verify the filter parameters to ensure they match existing documents.
- Pagination parameters (limit and page) must be positive integers; invalid values may cause errors or empty results.
- Network issues or API downtime can cause request failures; check connectivity and EasyBill API status.
Links
- EasyBill API Documentation - Official API documentation for EasyBill, detailing endpoints and parameters for document management.