OnOffice Relation

Manage relationships between estates and addresses

Actions4

Overview

This node manages relationships between estates and addresses in the OnOffice system. It supports operations to find, create, and delete relations that link estates with addresses, specifying the type of relationship (e.g., owner, tenant, contact). This is useful for real estate professionals who need to automate or integrate their property management workflows, such as syncing contacts related to properties or cleaning up outdated relations.

Practical examples:

  • Finding a specific relation by its ID to retrieve details.
  • Creating a new relation to associate an address as the owner of an estate.
  • Deleting a relation when it is no longer valid or needed.

Properties

Name Meaning
Operation The action to perform: Find, Find Many, Create, or Delete a relation
Relation ID The unique identifier of the relation to find or delete
Fields to Return Select which fields to include in the output when finding relations: ID, Type, Estate ID, Address ID
Estate ID The ID of the estate involved in the relation (required when creating a relation)
Address ID The ID of the address involved in the relation (required when creating a relation)
Relation Type The type of relation between estate and address; options are Owner, Tenant, Interested Party, Contact
Filter by Type Filter relations by type when finding many; options include Any, Owner, Tenant, Interested, Contact
Filter by Estate ID Filter relations by estate ID when finding many
Filter by Address ID Filter relations by address ID when finding many
Limit Maximum number of results to return when finding many
Offset Number of results to skip when finding many

Output

The node outputs JSON data structured according to the operation performed:

  • For Find and Find Many operations, the output includes:

    • success: boolean indicating if the operation succeeded.
    • operation: the operation name.
    • data: an array of relation records, each containing requested fields like id, type, estateid, and addressid.
    • total (only for Find Many): total count of matching relations.

  • For Create operation, the output includes:

    • success: true if creation succeeded.
    • operation: "create".
    • data: the created relation data.
    • message: confirmation message from the API.

  • For Delete operation, the output includes:

    • success: true if deletion succeeded.
    • operation: "delete".
    • message: confirmation message from the API.

If an error occurs, the output contains:

  • success: false
  • error: error message
  • operation: the attempted operation

The node does not output binary data.

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.
  • Requires n8n HTTP Request helper for making authenticated POST requests.
  • Uses HMAC signature generation for request authentication.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Providing an incorrect or non-existent Relation ID for find or delete operations will result in errors.
    • Filtering with invalid parameters may return empty results.
    • Network connectivity issues can cause request failures.

  • Error messages:

    • "OnOffice API action error: <message>" indicates the API returned an error for the requested action. Check the provided IDs and parameters.
    • "OnOffice API error: <message>" indicates a general API failure, possibly due to authentication or server issues.
    • If the node throws errors about missing required parameters, ensure all mandatory fields (like Relation ID for delete) are set.

  • To resolve errors, verify credentials, input parameters, and network access. Use the "Continue on Fail" option to handle errors gracefully in workflows.

Links and References

Discussion