Technical - Frontend¶
Overview¶
This page documents all available frontend commands and web components in the Billecta Integration. Each command can be added as a promoted/unpromoted action or bulk action in Lime Admin view configurations.
Quick Navigation¶
- Article Commands
- Debtor Commands
- Creditor Commands
- Invoice Commands
- Debt Collection Commands
- Payment Commands
- Order Commands
- Report Commands
Article Commands¶
Upsert Articles in Billecta¶
Command ID: limepkg_billecta_integration.upsert-articles-in-billecta
Type: Bulk action
Limetype: article
Purpose: Synchronize articles to Billecta, creating new items or updating existing ones
Behavior¶
- Extracts article IDs from the selected records
- Prompts user for confirmation
- Creates a background task to upsert articles in Billecta
- Displays notification upon success or failure
Error Handling¶
- Shows error notification if task creation fails
- Logs errors for monitoring dashboard review
Delete Articles in Billecta¶
Command ID: limepkg_billecta_integration.delete-articles-in-billecta
Type: Bulk action
Limetype: article
Purpose: Remove articles from Billecta
Behavior¶
- Extracts article IDs from the selected records
- Prompts user for confirmation
- Creates a background task to delete articles in Billecta
- Displays notification upon success or failure
Error Handling¶
- Shows error notification if task creation fails
- Logs errors for monitoring dashboard review
Debtor Commands¶
Upsert Debtors in Billecta¶
Command ID: limepkg_billecta_integration.upsert-debtors-in-billecta
Type: Bulk action
Limetype: debtor
Purpose: Synchronize debtor (customer) information to Billecta
Behavior¶
- Extracts debtor IDs from the selected records
- Prompts user for confirmation
- Creates a background task to upsert debtors in Billecta
- Displays notification upon success or failure
Error Handling¶
- Shows error notification if task creation fails
- Logs errors for monitoring dashboard review
Anonymize Debtors in Billecta¶
Command ID: limepkg_billecta_integration.anonymize-debtors-in-billecta
Type: Bulk action
Limetype: debtor
Purpose: Remove personally identifiable information from debtor records in Billecta (GDPR compliance)
Behavior¶
- Extracts debtor IDs from the selected records
- Prompts user for confirmation (emphasizes data destruction)
- Creates a background task to anonymize debtors in Billecta
- Displays notification upon success or failure
Error Handling¶
- Shows error notification if task creation fails
- Logs errors for monitoring dashboard review
Creditor Commands¶
Update Creditor in Billecta¶
Command ID: limepkg_billecta_integration.update-creditor-in-billecta
Type: Promoted/unpromoted action
Limetype: creditor
Purpose: Synchronize creditor (supplier) information to Billecta
Behavior¶
- Extracts the ID of the current creditor object
- Prompts user for confirmation
- Creates a background task to update the creditor in Billecta
- Displays notification upon success or failure
Error Handling¶
- Shows error notification if task creation fails
- Logs errors for monitoring dashboard review
Invoice Commands¶
Invoice Status Management¶
Invoices in Billecta can have multiple status states that affect collection workflow:
- Normal: Regular collection activities and reminders proceed
- Paused: Collection activities are halted, useful during payment negotiations
- Disputed: Invoice is contested by debtor, collection is stopped while dispute is resolved
Use the appropriate status commands to control invoice collection behavior without needing to modify Billecta directly. See Pause Invoice, Resume Paused Invoice, Dispute Invoice, and Cancel Disputed Invoice for status management commands.
Credit Invoices in Billecta¶
Command ID: limepkg_billecta_integration.credit-invoices-in-billecta
Type: Bulk action
Limetype: invoice
Purpose: Create credit notes for invoices in Billecta
Behavior¶
- Extracts invoice IDs from the selected records
- Prompts user for confirmation
- Creates a background task to credit invoices in Billecta
- Displays notification upon success or failure
Error Handling¶
- Shows error notification if task creation fails
- Logs errors for monitoring dashboard review
Fetch & Save Invoice PDF¶
Command ID: limepkg_billecta_integration.fetch-and-save-invoice-pdf
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Download invoice PDF from Billecta and store in Lime CRM
Behavior¶
- Checks if
actionpublicidis present on the invoice - Prompts user for confirmation
- Sends request to download and save the PDF document
- Displays notification upon success or failure
Requirements¶
- Invoice must have a
actionpublicid(already synchronized to Billecta)
Error Handling¶
- Alert if
actionpublicidis missing - Aborts if user cancels confirmation
- Shows error notification if download fails
- Logs technical errors for debugging
Use Credit on Invoice¶
Command ID: limepkg_billecta_integration.use-credit-on-invoice
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Apply credit from an open credit invoice to settle balance on another invoice
Features¶
- Dialog interface for selecting target invoice
- Invoice search with autocomplete
- Real-time form validation
- Displays available credit amount
Error Handling¶
- Displays error callout if credit application fails
- Shows validation errors in real-time
- Disables save button until form is valid
Use Credit on Invoice¶
This command makes it possible to use credit from an open credit invoice on another open invoice. The command opens a Use Credit on Invoice Web Component Dialog. Add the command limepkg_billecta_integration.use-credit-on-invoice as a promoted/unpromoted action in the view configuration of the invoice limeobject in Lime Admin to enable the command.
Features¶
- Dialog interface for selecting an invoice to use the credit on
- Invoice search functionality using a custom
Searcherhelper - Form validation and error handling
Error Handling¶
- Displays a callout if the response anything goes wrong when using the credit on an invoice
- Disables the save button until the form is valid
Register Manual Payments¶
Command ID: limepkg_billecta_integration.register-manual-payments
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Record a manual payment that occurred outside Billecta (e.g., cash, bank transfer)
Features¶
- Dialog interface for entering payment details
- Real-time form validation
- Handles multiple payment types
Error Handling¶
- Displays error callout if response contains errors or missing data
- Shows generic error message if HTTP request fails
- Disables save button until form is valid
Register Write-Off Payments¶
Command ID: limepkg_billecta_integration.register-writeoff-payments
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Record write-off amounts (uncollectible/bad debts) on invoices
Features¶
- Dialog interface for entering write-off details
- Real-time form validation
- Optional reason/comment field
Error Handling¶
- Displays error callout if response contains errors or missing data
- Shows generic error message if HTTP request fails
- Disables save button until form is valid
Create Reminder Invoice¶
Command ID: limepkg_billecta_integration.create-reminder-invoice
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Send a reminder invoice in Billecta with customizable fee and payment terms
Features¶
- Dialog interface for configuring reminder invoice settings
- Delivery method selection (manual, email, SMS, etc.)
- Reminder fee field (pre-populated from creditor settings, allows 0)
- Payment terms in days field (configurable)
- Currency display for reminder fee
- Real-time form validation
- Save button disabled until all required fields are completed
Requirements¶
- Invoice must have a
actionpublicid(already synchronized to Billecta) - All fields must have valid values before saving
Effect¶
- Creates and sends a reminder invoice in Billecta
- Reminder fee and payment terms are sent to Billecta
- Collection workflow may be accelerated based on reminder configuration
Error Handling¶
- Displays error callout if request fails
- Shows validation errors if required fields are empty
- Disables save button until form is valid
- Shows generic error message if HTTP request fails
Dispute Invoice¶
Command ID: limepkg_billecta_integration.dispute-invoice
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Mark an invoice as disputed in Billecta when a debtor contests the charge
Behavior¶
- Prompts user for confirmation
- Checks if
actionpublicidis present on the invoice - Sends request to dispute the invoice in Billecta
- Displays notification upon success or failure
Requirements¶
- Invoice must have a
actionpublicid(already synchronized to Billecta)
Effect¶
- Invoice status changes to "disputed" in Billecta
- Collection activities are paused
- Reminders and escalations are stopped
Error Handling¶
- Alert if
actionpublicidis missing - Aborts if user cancels confirmation
- Shows error notification if dispute fails
- Logs technical errors for debugging
Cancel Disputed Invoice¶
Command ID: limepkg_billecta_integration.cancel-disputed-invoice
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Remove disputed status from an invoice in Billecta when dispute is resolved
Behavior¶
- Prompts user for confirmation
- Checks if
actionpublicidis present on the invoice - Sends request to cancel the dispute in Billecta
- Displays notification upon success or failure
Requirements¶
- Invoice must have a
actionpublicid(already synchronized to Billecta) - Invoice must have an active dispute
Effect¶
- Disputed status is removed from invoice
- Normal collection workflow resumes
- Reminders and escalations are reactivated
Error Handling¶
- Alert if
actionpublicidis missing - Aborts if user cancels confirmation
- Shows error notification if cancellation fails
- Logs technical errors for debugging
Pause Invoice¶
Command ID: limepkg_billecta_integration.pause-invoice
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Pause an invoice in Billecta to temporarily halt collection activities
Behavior¶
- Prompts user for confirmation
- Checks if
actionpublicidis present on the invoice - Sends request to pause the invoice in Billecta
- Displays notification upon success or failure
Requirements¶
- Invoice must have a
actionpublicid(already synchronized to Billecta)
Effect¶
- Invoice is placed on hold in Billecta
- All collection activities are stopped (no reminders or escalations)
- Useful during payment negotiations or payment plans
Error Handling¶
- Alert if
actionpublicidis missing - Aborts if user cancels confirmation
- Shows error notification if pause fails
- Logs technical errors for debugging
Resume Paused Invoice¶
Command ID: limepkg_billecta_integration.resume-paused-invoice
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Resume normal collection on a paused invoice in Billecta
Behavior¶
- Prompts user for confirmation
- Checks if
actionpublicidis present on the invoice - Sends request to resume the paused invoice in Billecta
- Displays notification upon success or failure
Requirements¶
- Invoice must have a
actionpublicid(already synchronized to Billecta) - Invoice must be in paused state
Effect¶
- Paused status is removed from invoice
- Normal collection workflow resumes
- Reminders and escalations proceed based on Billecta configuration
Error Handling¶
- Alert if
actionpublicidis missing - Aborts if user cancels confirmation
- Shows error notification if resume fails
- Logs technical errors for debugging
Invoice Postpone Next Event¶
Command ID: limepkg_billecta_integration.invoice-postpone-next-event
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Delay the next collection event for an invoice in Billecta
Behavior¶
- Dialog interface for specifying postponement duration
- User enters number of days to postpone
- Prompts user for confirmation
- Sends request to postpone the next event in Billecta
- Displays notification upon success or failure
Requirements¶
- Invoice must have a
actionpublicid(already synchronized to Billecta)
Features¶
- Input field for number of days to postpone
- Real-time form validation
- Save button disabled until number of days is specified and valid
Effect¶
- The next scheduled collection event is delayed by the specified number of days
- Reminders and escalations are postponed accordingly
- Useful during payment negotiations or when additional time is needed
Error Handling¶
- Alert if
actionpublicidis missing - Shows validation errors if days field is invalid
- Disables save button until form is valid
- Shows error notification if postponement fails
- Logs technical errors for debugging
Swish Request¶
Command ID: limepkg_billecta_integration.swish-request
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Send payment request via Swish (Swedish payment method)
Configuration¶
- Requires field mapping configuration in Lime Admin specifying which field contains the payer's phone number (supports dot notation, e.g.,
contact.phonenumber) - Customize default message text in configuration
Features¶
- Dialog to review and adjust phone number
- Customize payment message before sending
- Real-time validation of phone number format
Error Handling¶
- Displays error callout if request fails
- Shows validation errors for invalid phone numbers
- Shows generic error message if HTTP request fails
- Disables send button until form is valid
Send to Debt Collection¶
Command ID: limepkg_billecta_integration.send-to-debt-collection
Type: Promoted/unpromoted action
Limetype: invoice
Purpose: Escalate an unpaid invoice to debt collection in Billecta
Features¶
- Dialog interface for configuring debt collection settings
- Delivery method selection (for collection notices)
- Custom reference field
- Reason for debt collection
- Optional interest rate configuration
- Real-time form validation
- Save button disabled until required fields are completed
Requirements¶
- Invoice must have a
actionpublicid(already synchronized to Billecta) - Creditor must be configured in Billecta
- Invoice must not already be in debt collection
Effect¶
- Creates a debt collection case in Billecta
- Invoice is transferred to debt collection workflow
- Collection agency may be involved depending on Billecta configuration
- Original invoice remains linked to debt collection case
Error Handling¶
- Alert if
actionpublicidis missing - Shows validation errors if required fields are empty
- Disables save button until form is valid
- Displays error callout if debt collection creation fails
- Shows generic error message if HTTP request fails
Debt Collection Commands¶
Debt Collection Postpone Next Event¶
Command ID: limepkg_billecta_integration.debtcollection-postpone-next-event
Type: Promoted/unpromoted action
Limetype: debtcollection
Purpose: Delay the next collection event for a debt collection case in Billecta
Behavior¶
- Dialog interface for specifying postponement duration
- Fetches the current next event date from Billecta
- User enters number of days to postpone
- Prompts user for confirmation
- Sends request to postpone the next event in Billecta
- Displays notification upon success or failure
Requirements¶
- Debt collection case must have a
actionpublicid(Billecta case ID)
Features¶
- Input field for number of days to postpone
- Displays current next event date for reference
- Real-time form validation
- Save button disabled until number of days is specified and valid
Effect¶
- The next scheduled collection event is delayed by the specified number of days
- Collection activities are postponed accordingly
- Useful during debtor negotiations or when additional time is needed for payment
Error Handling¶
- Shows error message if event date cannot be fetched from Billecta
- Shows validation errors if days field is invalid
- Disables save button until form is valid
- Displays error notification if postponement fails
- Logs technical errors for debugging
Cancel Debt Collection¶
Command ID: limepkg_billecta_integration.cancel-debtcollection
Type: Promoted/unpromoted action
Limetype: debtcollection
Purpose: Cancel a debt collection case in Billecta
Behavior¶
- Prompts user for confirmation before cancelling
- Checks if
actionpublicidis present on the debt collection - Sends request to cancel the debt collection in Billecta
- Displays notification upon success or failure
Requirements¶
- Debt collection case must have a
actionpublicid(Billecta case ID)
Effect¶
- Debt collection case is cancelled in Billecta
- Collection activities are terminated
- Useful when debt collection should no longer proceed
Error Handling¶
- Alert if
actionpublicidis missing - Aborts if user cancels confirmation
- Shows error notification if cancellation fails
- Logs technical errors for debugging
Send to Long-term Surveillance¶
Command ID: limepkg_billecta_integration.send-to-long-term-surveillance
Type: Promoted/unpromoted action
Limetype: debtcollection
Purpose: Send a debt collection case to long-term surveillance in Billecta
Behavior¶
- Prompts user for confirmation before sending to long-term surveillance
- Checks if
actionpublicidis present on the debt collection - Sends request to move the debt collection to long-term surveillance in Billecta
- Displays notification upon success or failure
Requirements¶
- Debt collection case must have a
actionpublicid(Billecta case ID)
Effect¶
- Debt collection case is moved to long-term surveillance in Billecta
- Collection is transitioned to extended monitoring period
- Useful when standard collection procedures have been exhausted
- Debt collection continues under long-term surveillance protocols
Error Handling¶
- Alert if
actionpublicidis missing - Aborts if user cancels confirmation
- Shows error notification if the operation fails
- Logs technical errors for debugging
Send to Bailiff¶
Command ID: limepkg_billecta_integration.send-to-bailiff
Type: Promoted/unpromoted action
Limetype: debtcollection
Purpose: Send a debt collection case to bailiff in Billecta
Behavior¶
- Opens a dialog where user selects bailiff option
- User can choose between two options:
- Send to Bailiff: Standard bailiff process
- Send for Eviction and Bailiff: Combined eviction and bailiff process
- Checks if
actionpublicidis present on the debt collection - Sends request to Billecta with the selected option
- Displays notification upon success or failure
Requirements¶
- Debt collection case must have a
actionpublicid(Billecta case ID)
Dialog Options¶
- Send to Bailiff - Initiates standard bailiff collection procedures
- Send for Eviction and Bailiff - Initiates eviction proceedings together with bailiff collection
Effect¶
- Debt collection case is sent to bailiff in Billecta
- Collection process escalates to court bailiff (Kronofogdemyndigheten)
- Different endpoints are called based on selected option:
- Bailiff:
/debtcollection/SendToBailiff/{actionpublicid} - Assistance with Bailiff:
/debtcollection/SendToAssistanceWithBailiff/{actionpublicid} - Useful when collection requires legal enforcement or eviction proceedings
Error Handling¶
- Alert if
actionpublicidis missing - Validates bailiff option selection
- Shows error notification if the operation fails
- Logs technical errors for debugging
Payment Commands¶
Delete Unhandled Payments¶
Command ID: limepkg_billecta_integration.delete-unhandled-payment
Type: Promoted/unpromoted action
Limetype: payment
Purpose: Remove unhandled or incorrectly recorded payments from Billecta
Features¶
- Dialog interface for confirming deletion
- Form validation
- Displays payment details for verification
Error Handling¶
- Shows generic error message if HTTP request fails
- Disables delete button until form is valid
Match Unhandled Payments¶
Command ID: limepkg_billecta_integration.match-unhandled-payments
Type: Promoted/unpromoted action
Limetype: payment
Purpose: Link unhandled payments to their corresponding invoices
Features¶
- Dialog interface for matching payments to invoices
- Invoice search with autocomplete
- Displays OCR (optical character recognition) information from payment
- Real-time form validation
- Shows match confidence indicators
Error Handling¶
- Displays error callout if match response contains errors or missing data
- Shows generic error message if HTTP request fails
- Disables save button until form is valid
Order Commands¶
Upsert Orders in Billecta¶
Command ID: limepkg_billecta_integration.upsert-orders-in-billecta
Type: Bulk action
Limetype: order
Purpose: Synchronize orders to Billecta, creating new items or updating existing ones
Behavior¶
- Extracts order IDs from the selected records
- Prompts user for confirmation
- Creates a background task to upsert orders in Billecta
- Displays notification upon success or failure
Error Handling¶
- Shows error notification if task creation fails
- Logs errors for monitoring dashboard review
Attest Orders in Billecta¶
Command ID: limepkg_billecta_integration.attest-orders-in-billecta
Type: Bulk action
Limetype: order
Purpose: Officially attest (approve/finalize) orders in Billecta before invoicing
Behavior¶
- Extracts order IDs from the selected records
- Prompts user for confirmation
- Creates a background task to attest orders in Billecta
- Displays notification upon success or failure
Error Handling¶
- Shows error notification if task creation fails
- Logs errors for monitoring dashboard review
Upsert & Attest Orders in Billecta¶
Command ID: limepkg_billecta_integration.upsert-attest-orders-in-billecta
Type: Bulk action
Limetype: order
Purpose: Synchronize and immediately attest orders in Billecta (combined operation)
Behavior¶
- Extracts order IDs from the selected records
- Prompts user for confirmation
- Creates a background task to upsert and attest orders in single operation
- Displays notification upon success or failure
Error Handling¶
- Shows error notification if task creation fails
- Logs errors for monitoring dashboard review
Add Message to Orderrow¶
Command ID: limepkg_billecta_integration.add-message-to-orderrow
Type: Promoted/unpromoted action
Limetype: orderrow
Purpose: Add a note or message row to an existing order row
Features¶
- Dialog interface for entering message text
- Form validation
- Optional fields for message type/category
Error Handling¶
- Displays error notification with backend error message
- Logs detailed error information for debugging
- Disables save button until form is valid
Report Commands¶
Account Receivables Report¶
Command ID: limepkg_billecta_integration.account-receivables-report
Type: Promoted/unpromoted action
Limetype: creditor
Purpose: Generate a detailed accounts receivable report showing outstanding invoices and payment status
Features¶
- Generates report for a specific date or period
- Date selection for report snapshot
- Option to exclude invoices with periods outside the selected date
- Multiple file format options (PDF export)
- Dialog interface for configuring report parameters
- Real-time form validation
Configuration¶
- Report can be run for a specific date or as a period-specific report
- Includes invoices from both Lime and Billecta systems
- Provides comprehensive accounts receivable aging analysis
Error Handling¶
- Displays error callout if report generation fails
- Shows validation errors for invalid dates
- Disables export button until form is valid
- Shows generic error message if HTTP request fails
Account Reconciliation Report¶
Command ID: limepkg_billecta_integration.account-reconciliation-report
Type: Promoted/unpromoted action
Limetype: creditor
Purpose: Compare invoices and transactions between Lime and Billecta for reconciliation
Features¶
- Displays side-by-side comparison of Lime and Billecta data
- Highlights discrepancies and matching records
- Export reconciliation results
- Opening balance calculations
Configuration¶
See Reports Configuration for field mapping details.
Report Creator¶
Command ID: limepkg_billecta_integration.report-creator
Type: Promoted/unpromoted action
Limetype: creditor
Purpose: Build custom reports combining data from Lime and Billecta
Features¶
- Flexible field selection from both systems
- Custom filtering conditions
- Date pickers and configurable parameters
- Number formatting and sum columns
- Data export capabilities
Pre-configured Reports¶
- Accounts Receivable (Kundreskontra)
- Prepaid Payments (Förutbetalda avier)
See Reports Configuration for creating custom reports.
Event Log Commands¶
Show Event Log¶
Command ID: limepkg_billecta_integration.show-event-log
Type: Promoted/unpromoted action
Limetype: Contextual (uses current object type and ID)
Purpose: Display integration event log for monitoring and debugging Billecta synchronization
Features¶
- Dialog interface displaying event history from Billecta
- Shows all events related to the current object
- Event details include timestamp, type, status, and description
- Real-time retrieval from Billecta API
- Search and filter capabilities for events
- Export event log as CSV or JSON
- Last updated timestamp
Supported Limetypes¶
invoice- View all invoice-related eventsorder- View all order-related eventsdebtor- View all debtor-related eventscreditor- View all creditor-related eventsdebtcollection- View all debt collection-related eventspayment- View all payment-related events
Event Information Displayed¶
- Event Type - Action that occurred (InvoiceAttested, PaymentReceived, etc.)
- Event Status - Result of the event (Success, Error, Pending)
- Timestamp - When the event occurred in Billecta
- Description - Human-readable summary of what happened
- Details - Technical details for debugging if available
Error Handling¶
- Shows error message if event log cannot be retrieved
- Displays "No events available" if object has no Billecta history
- Logs technical errors to browser console for debugging
- Shows generic error message if API request fails
Use Cases¶
- Troubleshooting: Identify why an object wasn't synchronized
- Auditing: Verify all actions taken on an object in Billecta
- Debugging: Review technical details when integration fails
- Monitoring: Track the status of invoices, orders, and other objects
Common Patterns¶
User Confirmation¶
Most bulk and action commands prompt users for confirmation before executing to prevent accidental operations.
Notifications¶
All commands display results to users via notification service with either success or error messages.
Background Tasks¶
Heavy/asynchronous operations (article sync, debtor sync, order sync) are processed as background tasks and can be monitored via the Integration Monitoring dashboard.
Form Validation¶
Dialog-based commands validate input in real-time and disable save/submit buttons until the form is valid.
Error Logging¶
All errors are logged and can be reviewed in: - Integration Monitoring dashboard (for background tasks) - Browser console (for frontend errors) - Lime admin logs (for system-level issues)