Vendus icon

Vendus

Interact with Vendus API for invoicing and business management. Developed by Pixel Infinito (https://pixel.ao)

Document → Get All Documents

AI-generated

Overview

This node integrates with the Vendus API, a platform for invoicing and business management. Specifically, the "Get All Documents" operation under the "Document" resource allows users to retrieve multiple documents from their Vendus account, such as invoices, receipts, or other document types managed in Vendus.

Common scenarios where this node is beneficial include:

  • Automating retrieval of all sales invoices or receipts for reporting or accounting purposes.
  • Filtering documents by store or register to analyze sales per location.
  • Integrating Vendus document data into other workflows, such as CRM updates or inventory management.

For example, a user might configure this node to fetch all documents from a specific store within a date range to generate a sales report automatically.

Properties

Name Meaning
Search & Filter Options Collection of filters to narrow down the documents retrieved. Includes:
- Register ID String to specify a particular register identifier to filter documents.
- Store Name or ID Dropdown or expression to select a store by name or ID to filter documents belonging to that store.
Options Additional options for the operation.
- Enable Debug Logging Boolean flag to enable detailed debug logging for troubleshooting API calls.

Output

The node outputs an array of JSON objects, each representing a document retrieved from Vendus. The structure of each JSON object corresponds directly to the response from the Vendus API's documents endpoint and typically includes fields such as document ID, type, date, client info, totals, and status.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for Vendus API authentication.
  • The node uses the base URL configured in the credentials to make HTTP requests.
  • Optionally, enabling debug logging requires access to the node's logger.

Troubleshooting

  • Common Issues:

    • Missing or invalid API credentials will cause authentication failures.
    • Incorrect or missing filter parameters (e.g., invalid store ID) may result in empty responses or errors.
    • Network connectivity issues can prevent successful API calls.
  • Error Messages:

    • "No routing configuration found for document.getDocuments" indicates a misconfiguration or unsupported operation.
    • Parameter substitution errors occur if required parameters are not provided; ensure all necessary inputs are set.
    • HTTP request failures will be logged if debug logging is enabled, showing error messages and response details.
  • Resolutions:

    • Verify API credentials and permissions.
    • Double-check input parameters, especially store and register IDs.
    • Enable debug logging to get detailed information about request and response for troubleshooting.

Links and References

Discussion