onoffice-api

OnOffice integration for n8n - Real Estate API node

Package Information

Released: 5/2/2025
Downloads: 16 weekly / 38 monthly
Latest Version: 0.2.9
Author: makeautomation.at

Available Nodes

OnOffice icon
OnOffice
Consume OnOffice API

Documentation

n8n-nodes-onoffice

This is an n8n community node for the OnOffice API. It allows you to use OnOffice in your n8n workflows.

OnOffice is a CRM system specifically designed for real estate businesses. This node allows you to interact with the OnOffice API to manage estates, addresses, and their relationships.

⚠️ Important API Notes

This integration has been tested and works with the OnOffice API, but there are some important considerations:

  1. Resource Availability: Not all OnOffice accounts have access to all resources. For example:

    • The estate resource is usually available for all accounts
    • The address resource might require specific field names that vary by account
    • The idsfromrelation resource might show as "missing configuration" if not enabled for your account

  2. Field Names: OnOffice uses specific field names for different resources. We've included documentation of common field names in the docs directory:

    • docs/onoffice-estate-fields.md - Common fields for properties/estates
    • docs/onoffice-address-fields.md - Common fields for addresses

Installation

Automated Installation (Recommended)

  1. Open your n8n instance
  2. Go to Settings > Community Nodes
  3. Select "Install" and enter n8n-nodes-onoffice-api
  4. Restart n8n

Manual Installation

  1. Clone the repository: 
    git clone https://github.com/yourusername/onoffice-n8n-node.git
  2. Navigate to the directory: 
    cd onoffice-n8n-node
  3. Install dependencies: 
    npm install
  4. Build the node: 
    npm run build
  5. Link to your n8n installation: 
    npm link
  6. In your n8n installation directory: 
    npm link n8n-nodes-onoffice-api

Docker Installation

  1. Clone the repository
  2. Navigate to the directory
  3. Run ./start-docker.sh to build and start the Docker container
  4. Access n8n at http://localhost:5678

Authentication

You need to obtain API credentials from your OnOffice account:

  1. Contact OnOffice support to have the API enabled for your account
  2. Once enabled, you'll receive an API Token and API Secret
  3. Add these credentials to n8n in the "Credentials" section

Features

This node currently supports the following resources and operations:

Estate Resource (Stable)

  • Get: Retrieve a single estate by ID
  • Get Many: Retrieve multiple estates with filtering options
  • Create: Create a new estate
  • Update: Update an existing estate

Address Resource (May require account-specific configuration)

  • Get: Retrieve a single address by ID
  • Get Many: Retrieve multiple addresses with filtering options
  • Create: Create a new address
  • Update: Update an existing address

Relation Resource (May require account-specific configuration)

  • Get: Retrieve a single relation by ID
  • Get Many: Retrieve multiple relations with filtering options
  • Create: Create a new relation between an estate and an address
  • Delete: Delete an existing relation

IDs From Relation Resource (Alternative to Relation)

  • Get: Retrieve estate IDs connected to an address or address IDs connected to an estate

Estate Resource Fields

Here are some of the most commonly used fields for the estate resource:

Basic Information

  • Id - Unique record ID
  • objektnr_extern - External property number
  • objekttitel - Property title
  • objektbeschreibung - Property description
  • vermarktungsart - Marketing type (e.g. 'kauf', 'miete')
  • objektart - Property type (e.g. 'haus', 'wohnung')
  • objekttyp - Object type

Price and Financial Fields

  • kaufpreis - Purchase price
  • kaltmiete - Cold rent
  • warmmiete - Warm rent
  • nebenkosten - Additional costs
  • heizkosten - Heating costs

Property Features

  • wohnflaeche - Living space
  • anzahl_zimmer - Number of rooms
  • balkon - Balcony
  • terrasse - Terrace
  • baujahr - Year of construction

For a complete list of estate fields, see docs/onoffice-estate-fields.md.

Address Resource Fields

Common fields for the address resource include:

  • Vorname - First name
  • Name - Last name
  • Email - Email address
  • Strasse - Street
  • Ort - City

For a complete list of address fields, see docs/onoffice-address-fields.md.

Troubleshooting

Unknown Field Errors

If you encounter "Unknown field" errors, it's because OnOffice has different field names for different accounts. Try these steps:

  1. Contact OnOffice support to get the correct field names for your account
  2. Use the Debug node after the OnOffice node to see the full error message
  3. Try the discover-fields.js script in the scripts directory to find valid field names

Missing Configuration Errors

If you see "missing configuration for resourceType X" errors, it means your OnOffice account does not have that feature enabled. Contact OnOffice support to enable it.

Authentication Errors

If you encounter authentication errors:

  1. Verify your API Token and Secret are correct
  2. Check that your OnOffice account has API access enabled
  3. Use the test scripts in the scripts directory to test API connectivity directly

Development and Testing

This package includes several test scripts to help with development:

  1. test-api.js: Basic OnOffice API testing

    npm run test-api

  2. test-n8n-api.js: Tests API using the same authentication method as the n8n node

    npm run test-n8n-api

  3. discover-fields.js: Helps discover valid field names for your OnOffice account

    node scripts/discover-fields.js

Resources

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Discussion