OnOffice

Consume OnOffice API

Actions12

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 new relationship linking an estate with an address, defining the type of relation such as owner, tenant, interested party, or contact.

Common scenarios include:

  • Associating a property (estate) with its owner or tenant.
  • Linking contacts who are interested parties in a real estate listing.
  • Managing relationships between properties and various stakeholders for CRM or property management workflows.

Practical example:

  • Automatically create a "tenant" relation when a new rental agreement is signed, linking the tenant's contact information to the specific estate in OnOffice.

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 to which the relation applies (required)
Address ID The unique identifier of the address/contact involved in the relation (required)

Output

The node outputs JSON data containing the result of the create operation. The 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 response data from OnOffice API about the created relation.
  • message: A status message returned by the API.

Example output JSON:

{
  "success": true,
  "resourceType": "relation",
  "operation": "create",
  "data": {
    // Relation details returned by OnOffice API
  },
  "message": "Relation created successfully"
}

No binary data output is produced by this node.

Dependencies

  • Requires an active connection to the OnOffice API using valid API credentials (an API token and secret).
  • The node expects these credentials to be configured in n8n prior to execution.
  • Network access to https://api.onoffice.de/api/latest/api.php is necessary.

Troubleshooting

  • Invalid JSON in Data Fields: If the input JSON for fields like data or filters is malformed, the node throws an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
  • API Authentication Errors: If the API token or secret is missing or incorrect, the node will fail with an authentication error. Verify that the API credentials are properly set up.
  • Unsupported Resource or Operation: Attempting to use unsupported resources or operations results in errors specifying the unsupported action. Confirm that "relation" resource and "create" operation are selected.
  • Network Issues: Network connectivity problems cause errors labeled as network errors. Check internet connection and firewall settings.
  • API Error Responses: If the OnOffice API returns an error, the node surfaces the API message. Review the message for details and adjust parameters accordingly.

Links and References

Discussion