Lexoffice Public APIInstall

Overview

This node interacts with the Lexoffice Public API, specifically targeting the "Contacts" category with the "API Contact GET filter" operation. It allows users to retrieve filtered contact data from their Lexoffice account, supporting vendor and customer filtering as well as pagination. This is useful for automating workflows that require up-to-date contact information, such as syncing contacts to a CRM, generating reports, or triggering actions based on contact lists.

Example scenarios:

• Fetching all vendors or customers from Lexoffice for synchronization with another system.
• Paginating through large contact lists to process them in batches.
• Filtering contacts to trigger downstream automation (e.g., send emails to new customers).

Properties

Output

The node outputs a collection of items, each with a json field containing the response from the Lexoffice API. The structure of the json output will match the Lexoffice API's response for the contact list endpoint, typically including fields such as contact IDs, names, types (vendor/customer), and other contact details.

Example output:

{
  "json": {
    "content": [
      {
        "id": "contact-id-1",
        "type": "customer",
        "name": "John Doe",
        // ...other contact fields
      },
      // ...more contacts
    ],
    "page": 1,
    "totalPages": 5,
    // ...other pagination info
  }
}

Note: The actual fields depend on the Lexoffice API schema.

Dependencies

• External Service: Requires access to the Lexoffice Public API.
• Credentials: Needs a valid Lexoffice API token and domain configured in n8n credentials under "lexofficePuplicApi".
• n8n Configuration: No special environment variables required beyond standard credential setup.

Troubleshooting

• Common Issues:

  • Invalid Credentials: If the API token or domain is incorrect, authentication errors will occur.
  • Missing Required Parameters: Not selecting "Contacts" as the category or omitting required filters may result in errors or empty results.
  • Pagination Errors: Providing an invalid page number could lead to out-of-range errors.

• Error Messages:

  • "No API Item found": Indicates that the selected category/operation combination is not supported. Ensure "Contacts" and "API Contact GET filter" are chosen.
  • API Errors: Any error returned by the Lexoffice API will be surfaced as a node error. Check the error message for details (e.g., "Unauthorized", "Not Found").
  • JSON Parsing Error: If a property expects JSON input and receives invalid JSON, an error like Error parsing JSON may appear.

Resolution Steps:

• Double-check credentials and ensure they are active.
• Verify that all required properties are set correctly.
• Consult the Lexoffice API documentation for expected request parameters and response formats.

Links and References

• Lexoffice Public API Documentation
• n8n Documentation: Creating Custom Nodes