OnOffice

Consume OnOffice API

Actions12

Relation → Create

AI-generated

Overview

This node integrates with the OnOffice API to manage relations between estates and addresses (contacts). Specifically, the "Create Relation" operation allows users to establish a connection between an estate and an address with a defined relation type such as Owner, Tenant, Interested Party, or Contact.

Common scenarios include:

  • Linking a property (estate) to its owner or tenant.
  • Associating interested parties or contacts with a specific estate for communication or record-keeping.
  • Automating the creation of these relationships in bulk workflows when importing or syncing data from other systems.

Example: Automatically create a "Tenant" relation between a rental property and a tenant's contact record after a lease agreement is signed.

Properties

Name Meaning
Relation Type Type of relation between estate and address. Options: Owner, Tenant, Interested Party, Contact
Estate ID The unique identifier of the estate involved in the relation (required)
Address ID The unique identifier of the address/contact involved in the relation (required)

Output

The node outputs JSON data representing the result of the create operation. The output structure includes:

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource affected, here always "relation".
  • operation: The operation performed, here "create".
  • data: The created relation data returned by the OnOffice API.
  • message: A status message from the API confirming the creation.

No binary data output is produced by this operation.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs configuration of credentials within n8n to provide these authentication details.
  • Relies on the OnOffice REST API endpoint at https://api.onoffice.de/api/v1.

Troubleshooting

  • Invalid JSON Data: If the input data for creating relations is malformed, the node will throw an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
  • API Authentication Errors: Missing or incorrect API tokens/secrets will cause authentication failures. Verify that the API credentials are correctly set up in n8n.
  • Missing Required Fields: The Estate ID and Address ID fields are mandatory. Omitting them will cause errors.
  • Filter Parsing Errors: When using filters in other operations, invalid JSON filters will cause errors.
  • Network Issues: Network connectivity problems will result in network error messages. Check your internet connection and API availability.
  • API Error Messages: The node surfaces error messages returned by the OnOffice API. Review these messages for clues on issues like permission problems or invalid parameters.

Links and References

Discussion