OnOffice Address

Work with OnOffice address records

Actions4

Overview

The node "OnOffice Address" allows users to interact with address records in the OnOffice system. Specifically, the Find Many operation enables retrieving multiple address records based on user-defined filters, limits, and offsets. This is useful for scenarios where you want to query a list of contacts or addresses matching certain criteria, such as all customers in a specific city or those whose names contain a particular substring.

Practical examples include:

  • Fetching a paginated list of addresses filtered by city or name.
  • Retrieving only selected fields (e.g., first name, last name, email) to reduce data volume.
  • Applying multiple filters combined with operators like equals or contains to refine search results.

Properties

Name Meaning
Fields to Return Select which fields to include in the output. Options include: ID, Customer Number, Form of Address, First Name, Last Name, Email, Phone 1, Phone 2, Mobile, Street, Postal Code, City, Country, User, Creation Date, Last Change Date. Default selection includes ID, First Name, Last Name, Email, and Phone 1.
Filters Add one or more filters to narrow down the search results. Each filter consists of:
- Field: Choose from First Name, Last Name, Email, Phone, City.
- Operator: Equals (=), Contains (like), Greater Than (>), Less Than (<).
- Value: The string value to compare against.
Limit Maximum number of results to return. Defaults to 50.
Offset Number of results to skip before starting to collect the result set. Defaults to 0.

Output

The output JSON array contains objects representing address records matching the query. Each object includes the fields specified in the "Fields to Return" property.

Example output structure (simplified):

[
  {
    "success": true,
    "operation": "findMany",
    "data": [
      {
        "id": "123",
        "Vorname": "John",
        "Name": "Doe",
        "Email": "john.doe@example.com",
        "Telefon1": "+123456789"
      },
      {
        "id": "124",
        "Vorname": "Jane",
        "Name": "Smith",
        "Email": "jane.smith@example.com",
        "Telefon1": "+987654321"
      }
    ],
    "total": 200
  }
]
  • success: Indicates if the API call was successful.
  • operation: The operation performed ("findMany").
  • data: An array of address records with requested fields.
  • total: (Optional) Total number of matching records available in the system.

The node does not output binary data.

Dependencies

  • Requires an API token credential and secret for authenticating with the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials within n8n is necessary for successful execution.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect field names or unsupported filter values may lead to API errors.
    • Exceeding API rate limits or network connectivity problems can cause request failures.

  • Error messages:

    • "OnOffice API action error: <message>" indicates the API returned an error related to the requested action. Check the message for details.
    • "OnOffice API error: <message>" indicates a general API error response.
    • If the node is configured to continue on failure, it will output an object with success: false and an error message instead of stopping execution.

  • Resolution tips:

    • Verify API credentials are correctly set up.
    • Double-check filter fields and operators for correctness.
    • Ensure network connectivity and API availability.
    • Use smaller limits or adjust offset to paginate through large datasets.

Links and References

  • OnOffice API Documentation (general reference for API capabilities)
  • n8n documentation on HTTP Request Node (for understanding underlying HTTP calls)
  • n8n community forums and support channels for troubleshooting custom nodes and API integrations

Discussion