OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses (contacts), and relations between them. The "Relation" resource with the "Create" operation allows users to establish a relationship between an estate and an address/contact, such as marking someone as an owner, tenant, interested party, or contact related to a property.

Common scenarios include:

  • Linking a new tenant or owner to a property record.
  • Associating contacts with estates for communication or management purposes.
  • Managing different types of relationships between properties and people in a real estate CRM workflow.

Practical example:

  • When a new tenant signs a lease, this node can create a "tenant" relation linking the tenant's contact information to the specific estate in the OnOffice system.

Properties

Name Meaning
Relation Type Type of relation between estate and address. Options: Owner, Tenant, Interested Party, Contact
Estate ID ID of the estate for which the relation is being created
Address ID ID of the address/contact to be linked to the estate

Output

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

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource involved ("relation").
  • operation: The operation performed ("create").
  • data: The response data from the API about the newly created relation.
  • message: A status message from the API confirming the creation.

No binary data output is produced by this node.

Example output JSON structure:

{
  "success": true,
  "resourceType": "relation",
  "operation": "create",
  "data": {
    // API response details about the created relation
  },
  "message": "Relation created successfully"
}

Dependencies

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

Troubleshooting

  • Invalid JSON in input fields: If the "Data" field or filters are provided as JSON strings, they must be valid JSON; otherwise, the node throws an error.
  • API errors: Errors returned by the OnOffice API will be surfaced with messages like "OnOffice API error: [message]". Check the API credentials and request parameters.
  • Network issues: Network connectivity problems will cause errors labeled "Network error: [message]".
  • Missing required fields: The "Estate ID" and "Address ID" are mandatory for creating a relation; missing these will cause errors.
  • Unsupported operations or resources: Attempting unsupported combinations will throw errors indicating the unsupported resource or operation.

To resolve errors:

  • Verify that all required fields are correctly filled.
  • Ensure JSON inputs are properly formatted.
  • Confirm API credentials are valid and have sufficient permissions.
  • Check network connectivity to the OnOffice API endpoint.

Links and References

Discussion