OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. It supports operations such as creating, retrieving (single or multiple), updating, and deleting records for these resources.

For the Address - Create operation, the node allows users to create a new address record in the OnOffice system by providing the address data in JSON format. This is useful in scenarios where you want to automate adding new contact addresses into your real estate management workflow, for example, when onboarding new tenants or contacts.

Practical examples:

  • Automatically add a new tenant's address when they fill out a form.
  • Sync address data from another CRM or database into OnOffice.
  • Batch-create multiple addresses from an external source.

Properties

Name Meaning
Data JSON object containing the details of the address to create. The structure must conform to OnOffice API's expected address schema.

Note: The "Data" property expects valid JSON representing the address fields and values to be created.

Output

The node outputs a JSON array where each item corresponds to an input item processed. For the create operation on Address resource, the output JSON has the following structure:

{
  "success": true,
  "resourceType": "address",
  "operation": "create",
  "data": { /* response data from OnOffice API about the created address */ },
  "message": "..." // status message from the API
}
  • success: Indicates if the operation was successful.
  • resourceType: The resource involved ("address").
  • operation: The performed operation ("create").
  • data: Contains the newly created address record details returned by the API.
  • message: A human-readable status message from the API.

If the operation fails and "Continue On Fail" is enabled, the output will include an error object with success: false and an error message.

The node does not output binary data.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs the OnOffice API credentials configured in n8n (an API key credential and secret).
  • Uses the OnOffice REST API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Relies on helper functions to generate request IDs, HMAC signatures, and format fields.

Troubleshooting

  • Invalid JSON in Data property: If the "Data" field contains invalid JSON, the node throws an error "Data must be a valid JSON". Ensure the JSON syntax is correct before running.
  • Filter parsing errors: When using filters in other operations, invalid JSON filters cause errors.
  • API authentication errors: If the API token or secret is incorrect or missing, requests will fail.
  • Network errors: Connectivity issues to the OnOffice API endpoint will result in network error messages.
  • Unsupported resource or operation: Errors occur if an unsupported resource or operation is selected.
  • API errors: The node surfaces API error messages returned by OnOffice, which can help diagnose issues like invalid parameters or permission problems.

To resolve errors:

  • Validate all JSON inputs carefully.
  • Verify API credentials are correctly set up.
  • Check network connectivity.
  • Review API documentation for correct parameter usage.

Links and References

Discussion