onOffice

Interact with onOffice API

Overview

This node interacts with the onOffice API to manage address data. Specifically, the Address - Create operation allows users to add a new address record, either for a private person or a company, into the onOffice system.

Common scenarios where this node is beneficial include:

  • Automating the creation of contact records in a real estate CRM.
  • Integrating form submissions from websites to automatically add leads or clients.
  • Synchronizing external databases or applications with onOffice address data.

For example, when a new client fills out a contact form on a website, this node can create a corresponding address entry in onOffice, distinguishing between individual persons and companies, and including relevant contact details.

Properties

Name Meaning
Address Type Type of address to create: "Private Person" or "Company".
First Name First name of the person (required if Address Type is "Private Person").
Last Name Last name of the person (required if Address Type is "Private Person").
Company Name Name of the company (required if Address Type is "Company").
Email Email address of the contact.
Phone Primary phone number.
Street Street address.
Postal Code Postal code of the address.
City City of the address.
Country Code ISO 3166 country code (default is "DEU" for Germany).
Additional Fields Optional extra fields including:
• Birthday (date)
• Mobile Phone
• Fax
• Website URL
• Notes
• Newsletter subscription (boolean)

Output

The node outputs the JSON response returned by the onOffice API after creating the address. This typically includes confirmation details about the newly created address record, such as its unique identifier and any metadata provided by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the onOffice API.
  • Needs an API authentication credential configured in n8n (an API key or token).
  • The node sends POST requests to the /api.php endpoint of the onOffice API.

Troubleshooting

  • Missing Required Fields: If required fields like Last Name (for persons) or Company Name (for companies) are not provided, the API may reject the request. Ensure all mandatory fields are filled.
  • Invalid Country Code: The country code must be a valid ISO 3166 code; otherwise, the API might return an error.
  • API Authentication Errors: If the API key or token is invalid or missing, the node will fail to authenticate. Verify credentials in n8n settings.
  • Malformed Additional Fields: Additional fields should conform to expected formats (e.g., date for Birthday). Incorrect formats may cause errors.
  • Network Issues: Connectivity problems with the onOffice API endpoint will result in request failures.

If the node throws an error message containing API response details, review the message for hints on missing or invalid parameters.

Links and References


This summary is based solely on static analysis of the provided source code and property definitions.

Discussion