Skip to main content

PlanSo Connector

The PlanSo Connector (codename: “reit”) provides a REST API for the PlanSo workshop management system, enabling order synchronization and queries.

Features

  • Order Sync: Automatic background synchronization from PlanSo to local SQLite database
  • Rich Queries: Search orders by plate, person, phone, email, status, damage type, and date ranges
  • Parts Tracking: View parts lists with order/delivery status
  • CRUD Operations: Create, update, and delete orders in PlanSo

Base URL

https://reit.connectors.aicoflow.com

Architecture

The connector maintains a local SQLite database that mirrors PlanSo data for fast queries:

Sync Behavior

  • Background Sync: Runs automatically during business hours (7:00-19:00 Berlin time by default)
  • Manual Sync: Trigger anytime via the sync endpoint
  • Configurable: Parts sync, extended data sync, and sync intervals are all configurable
Queries hit the local SQLite database, making them fast even for large datasets. Data freshness depends on sync frequency.

API Reference

See the PlanSo API tab above for the full interactive API reference with all endpoints:
  • Authentication: Login to PlanSo
  • Sync: Trigger manual sync and check status
  • Orders: Query, create, update, and delete orders
  • Parts: View parts list and delivery status for orders

Data Model

Order

An order represents a repair project with:
FieldDescription
idUnique order ID
plateVehicle license plate
personCustomer/driver name
phone, emailContact information
damageDamage classification
project_statusCurrent status
shop_date, repair_date, finish_dateKey dates
parts_status, missing_partsParts tracking
est_hours_*Estimated hours by department

Part

Parts are linked to orders:
FieldDescription
order_idParent order
part_no, descriptionPart identification
qty, price_each, price_totalQuantity and pricing
status, status_codeCurrent status
order_date, delivery_date, eta_dateTracking dates
is_missing, is_ordered, is_deliveredStatus flags

Configuration

The connector behavior is controlled by environment variables:
VariableDefaultDescription
AUTO_SYNC_ENABLEDtrueEnable background sync
SYNC_INTERVAL_SECONDS3600Sync interval (1 hour)
SYNC_WITH_PARTStrueSync parts data
SYNC_WITH_EXTENDED_DATAfalseSync extended sections
SYNC_BUSINESS_HOURS_ENABLEDtrueOnly sync during business hours