Billecta Integration Documentation¶
Welcome to the complete documentation for the limepkg-billecta-integration package. This documentation covers everything you need to install, configure, and extend the Billecta integration for Lime CRM.
New to this package? Start with the Installation Guide
Overview¶
The Billecta Integration package bridges Lime CRM and Billecta, enabling seamless billing and invoicing workflows. It allows Lime customers to work with billing operations directly in Lime, creating and sending orders and invoices using Billecta, while receiving real-time status updates for continuous follow-up.
What This Package Does¶
This package provides: - REST API endpoints for Lime UI and external webhook receivers - Event handlers for automated workflows and integrations - Custom decorators for enhanced field UI - Background tasks for batch processing and external syncing - Configuration schema for field mappings and settings - Frontend components for interactive dialogs and commands - Webhook receiver for real-time Billecta updates
What This Package Does NOT Do¶
- It does not automatically push data without configuration
- It does not modify Billecta without explicit user action
- It provides integration points for third parties but requires custom implementation
Key Features¶
✨ Order & Invoice Management - Create and manage orders directly in Lime - Attest and send invoices to Billecta - Automatic synchronization of order status - Support for cancellation and deletion workflows
📊 Real-Time Updates - Webhook integration for instant status updates from Billecta - Event logging and monitoring dashboard - Integration health tracking
💼 Business Object Management - Creditor and debtor management - Article/product catalog synchronization - Custom field mappings and decorators - Related object sync and validation
🔧 Integration Monitoring - Built-in event logging and audit trail - Failed transaction tracking and recovery - Integration health checks and status reporting - Batch processing for bulk operations
Documentation Structure¶
Getting Started¶
- Installation Guide - Step-by-step setup and configuration
- Requirements - System and dependency requirements
- Configuration Guide - Complete configuration reference
Understanding the Integration¶
- How It Works - Architecture and workflow overview
- Billecta Integration - Billecta-specific details and API reference
- For Third Parties - Integration points for external systems
Development & Operations¶
- Technical Backend - API endpoints, handlers, tasks, and webhooks
- Technical Frontend - UI components and web component details
- Upgrading - Migration guides for version updates
Quick Navigation¶
| I want to... | Go to... |
|---|---|
| Install the package | Installation |
| Configure field mappings | Configuration |
| Understand the workflow | How It Works |
| Read about available webhooks | Technical Backend - Webhooks |
| Read about custom endpoints | Technical Backend - Endpoints |
| Read bout available UI components | Technical Frontend |
| Understand technicla workflows | Technical Backend - Handlers |
| Read third-party integration possibilities | For Third Parties |
| Read upgrading requirements | Upgrading |
Common Workflows¶
1. Sending orders to Billecta¶
- Create/update and attest an order in Billecta
- Monitor status in integration dashboard
2. Handle Incoming Webhooks from Billecta¶
- Create invoices in Lime with data from Billecta
- Listen to real-time events related to invoices
- Update invoices and related data in Lime based on webhook information
3. Generate Financial Reports¶
- Access Reports endpoint
- Select report type (Account Reconciliation, Payment Summary, etc.)
- Apply filters (date range, status, creditor)
- Export as PDF or data format
See Upgrading for migration guides between versions.
Getting Help¶
Documentation Issues¶
If you find unclear sections or missing information, please refer to: - Relevant technical guide for your task - Requirements for dependency details - How It Works for architecture overview
Integration Problems¶
When troubleshooting: 1. Check the integration monitor dashboard for error details 2. Verify configuration mappings in Configuration 3. Review event logs using Kibana 4. Check webhook setup in For Third Parties
Support¶
For support and inquiries: - Review the complete technical documentation above - Reach out to the Lime Real Estate vertical team
Last Updated: February 2026
Package: limepkg-billecta-integration
Version: 2.0.0-dev.22