Vendus icon

Vendus

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

Document → Update Document

AI-generated

Overview

This node integrates with the Vendus API, a platform for invoicing and business management. Specifically, the "Update Document" operation under the "Document" resource allows users to update existing documents such as invoices or receipts in their Vendus account.

Typical use cases include:

  • Modifying the status of an invoice after payment or cancellation.
  • Updating document details programmatically as part of an automated workflow.
  • Synchronizing document states between Vendus and other systems.

For example, you might use this node to mark an invoice as "Invoiced" once payment is confirmed in your accounting system, or to cancel a document if an order is voided.

Properties

Name Meaning
Document Name or ID The unique identifier or name of the document to update. Can be selected from a list or set via expression.
Document Status The new status to assign to the document. Options are:
- Canceled
- Invoiced
- Normal
Options Additional settings:
- Enable Debug Logging: Toggle detailed logging for troubleshooting API calls

Output

The node outputs JSON data representing the updated document as returned by the Vendus API. This typically includes all fields of the document after the update, such as its ID, status, dates, client info, totals, and any other relevant metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Vendus API.
  • The node expects the base URL of the Vendus API to be configured in the credentials.
  • Network access to the Vendus API endpoint is necessary.

Troubleshooting

  • Missing or invalid Document ID: If the document identifier is not provided or incorrect, the API call will fail. Ensure the "Document Name or ID" property is correctly set.
  • Invalid Document Status value: Only the predefined statuses ("Canceled", "Invoiced", "Normal") are accepted. Using unsupported values will cause errors.
  • API authentication errors: Verify that the API key credential is valid and has sufficient permissions.
  • Network issues: Connectivity problems or incorrect base URL configuration can prevent successful API calls.
  • Debug logging: Enabling debug logging helps trace request URLs, parameters, and responses, which aids in diagnosing issues.

Common error messages may include:

  • "Parameter 'documentId' is required but not provided": Indicates missing document identifier.
  • HTTP 401 Unauthorized: Authentication failure; check API key.
  • HTTP 404 Not Found: Document does not exist or wrong ID used.
  • HTTP 400 Bad Request: Invalid input data or status value.

Links and References

Discussion