Lexware Office icon

Lexware Office

Interact with Lexware Office API

Actions61

Overview

This node integrates with the Lexware Office API to manage various business resources. Specifically, for the Profile resource with the Get All operation, it retrieves a list of profile data entries from the Lexware system.

Common scenarios where this node is beneficial include:

  • Fetching all company profiles or user profiles managed in Lexware.
  • Synchronizing profile data between Lexware and other systems.
  • Reporting or auditing organizational information stored in Lexware.

Practical example:

  • A user wants to retrieve all company profiles to update their CRM system with the latest company details.
  • Another use case is fetching profiles to verify organization settings or tax configurations before generating invoices.

Properties

Name Meaning
Return All Whether to return all results or only up to a given limit (true/false).
Limit Maximum number of results to return (1 to 250). Only used if Return All is false.
Page Page number for pagination (0-based). Used when Return All is false.
Sort Sort order for results. Options:
- Created At (Ascending)
- Created At (Descending)
- Updated At (Ascending)
- Updated At (Descending)
- Voucher Date (Ascending)
- Voucher Date (Descending)
- Name (Ascending)
- Name (Descending)
- ID (Ascending)
- ID (Descending)
Cursor Cursor string for cursor-based pagination.
Offset Offset number for offset-based pagination.

These properties control how many profile records are fetched and how they are sorted or paginated.

Output

The node outputs an array of JSON objects representing profile data retrieved from Lexware. Each object corresponds to a profile entry with fields as defined by the Lexware API for profiles.

The output does not include binary data; it is purely JSON structured data.

Dependencies

  • Requires an API key credential for authenticating with the Lexware Office API.
  • The node uses the base URL and API key from the configured credentials.
  • No additional external dependencies are required beyond the Lexware API access.

Troubleshooting

  • Missing Required Fields Error: If required parameters for an operation are missing, the node throws an error listing the missing fields. Ensure all mandatory inputs are provided.
  • API Authentication Errors: If the API key or resource URL is incorrect or missing, authentication will fail. Verify the credential configuration.
  • Pagination Limits: When Return All is false, the node limits results to the specified Limit. To fetch more data, either increase the limit or set Return All to true.
  • Rate Limiting: The Lexware API may enforce rate limits. If requests fail due to rate limiting, consider adjusting the API rate limit setting or adding delays between calls.

Links and References


If you need further details about other operations or resources, feel free to ask!

Discussion