OnOffice Address

Work with OnOffice address records

Actions4

Overview

The OnOffice Address node allows users to interact with address records in the OnOffice system. It supports operations such as finding a single address by its ID, finding multiple addresses using filters, creating new addresses, and updating existing ones.

This node is beneficial in scenarios where you need to integrate OnOffice address data into workflows, for example:

  • Retrieving detailed contact information for a specific customer.
  • Searching for multiple addresses based on criteria like city or name.
  • Adding new address records from form submissions or other sources.
  • Updating existing address details automatically when changes occur elsewhere.

Practical examples include syncing address data between OnOffice and CRM systems, automating contact updates, or generating mailing lists filtered by location.

Properties

Name Meaning
Operation The action to perform: Find (single), Find Many (multiple), Create, or Update an address record.
Address ID The unique identifier of the address to find or update (required for Find and Update operations).
Fields to Return Select which fields to retrieve in the output for Find and Find Many operations. 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 includes ID, First Name, Last Name, Email, Phone 1.
Filters For Find Many operation: add one or more filters specifying field, operator (Equals, Contains, Greater Than, Less Than), and value to narrow down results. Filterable fields include First Name, Last Name, Email, Phone, City.
Limit For Find Many: maximum number of results to return (default 50).
Offset For Find Many: offset for pagination of results (default 0).
Fields to Include For Create and Update: select which fields to include in the operation. Options include Form of Address, First Name, Last Name, Email, Phone 1, Street, Postal Code, City, Country. This property is required for these operations.
Load Values from Previous Node For Update: whether to load field values from a previous Find operation before applying updates (boolean).
Form of Address For Create and Update: select form of address (Mr, Mrs, Company).
First Name For Create and Update: first name of the contact.
Last Name For Create and Update: last name of the contact.
Email For Create and Update: email address.
Phone 1 For Create and Update: primary phone number.
Street For Create and Update: street address.
Postal Code For Create and Update: postal code.
City For Create and Update: city name.
Country For Create and Update: country name (default "Deutschland").

Output

The node outputs JSON data containing the results of the requested operation:

  • For Find and Find Many, the output includes an array of address records with the selected fields. Each record corresponds to an address matching the query.
  • For Create and Update, the output indicates success status, operation type, and the data of the created or updated address. It may also include messages returned by the API.
  • In case of errors, the output contains success set to false and an error message describing the issue.

No binary data is produced by this node.

Example output structure for a successful Find operation:

{
  "success": true,
  "operation": "find",
  "data": [
    {
      "id": "123",
      "Vorname": "John",
      "Name": "Doe",
      "Email": "john.doe@example.com",
      "Telefon1": "+49123456789"
    }
  ],
  "total": 1
}

Dependencies

  • Requires an API token credential for authenticating with the OnOffice API.
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.
  • The node internally generates HMAC signatures for request authentication.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect Address ID for Find or Update operations will result in no data found or API errors.
    • Using unsupported filter fields or invalid operators may cause the API to reject requests.
    • Omitting required fields in Create or Update operations will lead to validation errors.

  • Error messages:

    • "OnOffice API action error: <message>" indicates the API returned an error for the requested action. Check the message for details.
    • "OnOffice API error: <message>" indicates a general API error response.
    • Network or HTTP errors during the request will be surfaced as node execution errors.

  • Resolution tips:

    • Verify API credentials are correctly configured.
    • Double-check Address IDs and filter parameters.
    • Ensure all required fields are provided for create/update.
    • Use the "Continue On Fail" option to handle errors gracefully in workflows.

Links and References

Discussion