OnOffice

Consume OnOffice API
Join our community

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 various types of relationships between properties and people within a real estate management workflow.

For example, a real estate agent could use this node to automatically create a "tenant" relation when a new rental agreement is signed, connecting the tenant's contact information with the relevant estate record.

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 includes:

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

If the operation fails and "Continue on Fail" is enabled, the output will contain an error message instead.

No binary data is produced by this node.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs the OnOffice API credentials configured in n8n.
  • Makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.

Troubleshooting

  • Invalid JSON Data: If the input data for other resources is malformed JSON, the node throws an error. Ensure all JSON inputs are valid.
  • API Errors: The node surfaces errors returned by the OnOffice API, including messages like "Unknown error" or specific API error messages. Check API credentials and request parameters.
  • Network Issues: Network connectivity problems will cause the node to throw network error messages.
  • Missing Required Fields: For creating a relation, missing Estate ID or Address ID will cause failure. Make sure these required fields are provided.
  • Filter Parsing Errors: When using filters in other operations, invalid JSON filters will cause errors.

To resolve issues:

  • Verify API credentials are correct and have necessary permissions.
  • Validate all JSON inputs before running the node.
  • Confirm required fields are set.
  • Check network connectivity to the OnOffice API endpoint.

Links and References

Discussion