n8n-nodes-onoffice-api

n8n-nodes-onoffice

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

Latest Update (v0.4.0)

This version features a completely redesigned UI approach with:

• Resource-specific nodes: Dedicated nodes for Address, Estate, and Relation resources
• Building block approach: Visual field selection instead of manual JSON editing
• Dynamic UI: Only see fields relevant to your selected operation
• Improved data mapping: Makes it easier to load data from previous nodes

These improvements make the node much more user-friendly and align with n8n's visual workflow philosophy.

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:

• 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

• 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)

• Open your n8n instance
• Go to Settings > Community Nodes
• Select "Install" and enter n8n-nodes-onoffice-api
• Restart n8n

Manual Installation

• Clone the repository:

  git clone https://github.com/yourusername/onoffice-n8n-node.git
  

• Navigate to the directory:

  cd onoffice-n8n-node
  

• Install dependencies:

  npm install
  

• Build the node:

  npm run build
  

• Link to your n8n installation:

  npm link
  

• In your n8n installation directory:

  npm link n8n-nodes-onoffice-api
  

Docker Installation

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

Authentication

You need to obtain API credentials from your OnOffice account:

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

Features

This integration now provides specialized nodes for different OnOffice resources:

OnOffice Address Node

• Find: Retrieve a single address by ID
• Find Many: Retrieve multiple addresses with visual filtering options
• Create: Create a new address using a form-based approach
• Update: Update an existing address with the option to load values from a previous node

OnOffice Estate Node

• Find: Retrieve a single estate by ID
• Find Many: Find multiple estates with visual filters for property and marketing types
• Create: Create a new estate using a form-based approach
• Update: Update an existing estate with the option to load values from a previous node

OnOffice Relation Node

• Find: Retrieve a single relation by ID
• Find Many: Find multiple relations between estates and addresses
• Create: Create a new relation with proper URN formatting
• Delete: Delete an existing relation

Legacy OnOffice Node

The original, more generic node is still available for backward compatibility.

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:

• Contact OnOffice support to get the correct field names for your account
• Use the Debug node after the OnOffice node to see the full error message
• 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:

• Verify your API Token and Secret are correct
• Check that your OnOffice account has API access enabled
• 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:

• test-api.js: Basic OnOffice API testing

  npm run test-api
  

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

  npm run test-n8n-api
  

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

  node scripts/discover-fields.js
  

Resources

• OnOffice API Documentation
• n8n Community Nodes Documentation

Contributing

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