Lexware Office icon

Lexware Office

Interact with Lexware Office API

Actions61

Overview

This node integrates with the Lexware Office API, allowing users to interact with various Lexware resources such as contacts, articles, invoices, files, and more. Specifically, for the File resource with the Get operation, the node retrieves detailed information about a specific file stored in the Lexware system by its unique File ID.

Typical use cases include:

  • Fetching metadata or details of a particular file (e.g., invoice PDF, receipt image) stored in Lexware.
  • Automating workflows that require accessing file information for further processing or archiving.
  • Integrating Lexware file data into other systems or reports.

Example: You have an automated process where after uploading a document to Lexware, you want to retrieve its details (like name, type, or status) to log or trigger subsequent actions.

Properties

Name Meaning
File ID The unique identifier of the file to retrieve. This is required to specify which file's details to fetch.

Output

The node outputs a JSON array containing the file's data as returned by the Lexware Office API. The structure typically includes all available metadata and attributes of the file resource, such as:

  • File identifiers
  • File type (e.g., invoice, credit note, image)
  • Category and access level
  • MIME content type
  • Processing status
  • Flags like e-invoice indicator
  • Descriptions or tags
  • Date fields (creation, modification)
  • Archived status

If the node supports binary data output for files (not explicitly shown here), it would represent the actual file content (e.g., PDF or image). However, for the Get operation on the File resource, the output is primarily metadata in JSON format.

Dependencies

  • Requires an API key credential for authenticating with the Lexware Office API.
  • The node expects the Lexware Office API base URL and API key to be configured in the credentials.
  • No additional external dependencies are indicated.

Troubleshooting

  • Missing File ID: Since File ID is required, omitting it will cause an error indicating missing required fields.
  • Authentication Errors: If the API key or base URL is incorrect or expired, the node will fail to authenticate with the Lexware API.
  • File Not Found: Providing an invalid or non-existent File ID will result in an error from the API stating the file could not be found.
  • API Rate Limits: Excessive requests may hit rate limits; ensure the API rate limit settings in credentials are respected.
  • Continue On Fail: The node supports continuing execution on failure, returning error messages in the output JSON for failed items.

To resolve errors:

  • Verify the File ID is correct and exists in Lexware.
  • Check API credentials and permissions.
  • Review API usage limits and adjust workflow frequency if needed.

Links and References

Discussion