n8n-nodes-simpro

This is an n8n community node that provides integration with the SimPRO API.

n8n is a fair-code licensed workflow automation platform.

Features

This package provides two nodes:

1. SimPRO Node - User-Friendly API Access

A completely redesigned, user-friendly interface for accessing the SimPRO API:

• ✅ Individual parameter fields instead of manual JSON entry
• ✅ Organized parameter collections for path params and query params
• ✅ Common parameters built-in: Search, Pagination, Display options
• ✅ Clean operation dropdown with method badges [GET], [POST], etc.
• ✅ Helpful error messages that tell you exactly where to set parameters
• ✅ Supports all SimPRO API endpoints via OpenAPI spec

2. SimPRO AI Tool - AI Agent Integration

Designed for use with AI agents (OpenAI, Anthropic, etc.):

• 🤖 Exposes SimPRO operations as tool calls
• 🎯 Smart operation matching (list vs get specific items)
• 📊 Detailed logging for debugging
• 🔍 Automatic resource and operation detection

Installation

Community Nodes (Recommended)

For production use, install via n8n's Community Nodes:

1. Go to Settings → Community Nodes
2. Click Install
3. Enter: n8n-nodes-simpro
4. Click Install

Manual Installation

For development or custom deployment:

npm install n8n-nodes-simpro

Prerequisites

• n8n installed (version 1.0.0 or higher)
• SimPRO account with API access
• SimPRO API Bearer token

Configuration

Setting up Credentials

1. In n8n, go to Credentials → New
2. Search for "SimPRO API"
3. Enter your SimPRO API Bearer token
4. Test and save

Getting Your API Token

1. Log in to your SimPRO instance
2. Go to System → Setup → API (or Security)
3. Generate or copy your API token
4. Use the token (with or without "Bearer " prefix)

Usage

SimPRO Node - Basic Examples

Get a Customer

1. Resource: Customers
2. Operation: [GET] Retrieve details for a specific customer
3. Company ID: 0
4. Additional Parameters → Customer ID: 123

Search Jobs

1. Resource: Jobs
2. Operation: [GET] List all jobs
3. Company ID: 0
4. Query Parameters:
   • Search: urgent
   • Page Size: 10

Create a Customer

1. Resource: Customers
2. Operation: [POST] Create a new customer
3. Company ID: 0
4. Request Body:

{
  "GivenName": "John",
  "FamilyName": "Smith",
  "Phone": "555-1234"
}

SimPRO AI Tool - With AI Agents

Connect to an AI Agent node (OpenAI, Anthropic, etc.):

User: "Get details for job number 12345"

AI Tool Call:

{
  "resource": "Jobs",
  "operation": "get",
  "pathParams": {
    "jobID": "12345"
  }
}

See FILTERING_AND_SPECIFIC_ITEMS.md for detailed AI tool usage.

Recent Improvements (v0.4.10+)

The SimPRO node has been completely redesigned for better user experience:

Before vs After

Before (Manual JSON):

Path Params: {"companyID": "0", "customerID": "123"}
Query: {"search": "test", "pageSize": 10}

After (Structured Fields):

Company ID: 0
Additional Parameters → Customer ID: 123
Query Parameters → Search: test
Query Parameters → Page Size: 10

Key Improvements

• 🎯 Individual fields for common parameters (Customer ID, Job ID, etc.)
• 📋 Parameter collections organize related options
• 🏷️ Better operation names: [GET] List all jobs instead of long paths
• 💡 Helpful errors that show exactly where to set missing parameters
• 🔧 JSON fallback still available for advanced use cases

See SIMPRO_NODE_IMPROVEMENTS.md for complete details.

Documentation

• Improvements Guide - What's new and how to use it
• AI Tool Guide - Using with AI agents
• Query Parameters - Query parameter usage
• Troubleshooting - Common issues and solutions
• Testing Guide - How to test the nodes

Development

Build

npm run build

Lint

npm run lint
npm run lintfix  # Auto-fix issues

Local Testing

npm run build
n8n start

The nodes will be available in your local n8n instance.

Resources

• n8n Documentation
• SimPRO API Documentation
• Community Forum

Version

Current version: 0.4.10

License

MIT

Support

For issues, questions, or contributions:

• 🐛 Report bugs via GitHub Issues
• 💬 Ask questions in n8n Community Forum
• 🤝 Contributions welcome via Pull Requests