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 should match the expected schema of the OnOffice API for an address resource.

Output

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

  • success: Boolean indicating if the operation was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "create".
  • data: The response data returned from the OnOffice API after creation, typically including the created address record details.
  • message: A status message from the API confirming the action.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "address",
  "operation": "create",
  "data": {
    /* Created address record details */
  },
  "message": "Record created successfully"
}

If the operation fails and "Continue On Fail" is enabled, the output will include:

  • success: false
  • error: Error message describing the failure
  • resourceType and operation as above

The node does not output binary data.

Dependencies

  • Requires valid credentials for the OnOffice API, specifically an API token and secret.
  • The node makes HTTP POST requests to the OnOffice API endpoint: https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials in n8n is necessary before using this node.

Troubleshooting

  • Invalid JSON in Data property: If the JSON provided in the "Data" field is malformed, the node throws an error stating "Data must be a valid JSON". Ensure the JSON syntax is correct.
  • Filter JSON errors: When using filters in other operations, invalid JSON in filter fields causes errors.
  • API errors: If the OnOffice API returns an error, the node surfaces the message, e.g., "OnOffice API error: ". Check the API credentials and request parameters.
  • Network issues: Network connectivity problems result in "Network error" messages. Verify internet access and API endpoint availability.
  • Unsupported resource or operation: Errors occur if an unsupported resource or operation is selected.
  • Enable "Continue On Fail" to allow processing of subsequent items even if some fail.

Links and References

Discussion