Billecta¶

Billecta Application Setup¶

Accessing Billecta¶

Billecta account setup is customer-specific and coordinated with your Lime consultant.

Environments: - Test: https://apptest.billecta.com - Production: https://app.billecta.com

Support: For account setup, access issues, or any Billecta-specific questions, contact your Billecta administrator or support@billecta.com.

Prerequisites for Integration¶

Before starting the Billecta integration: 1. ✅ Active Billecta account with admin access 2. ✅ Creditor(s) configured in Billecta 3. ✅ API credentials for authentication 4. ✅ Webhook configuration capabilities in Billecta portal

Billecta API¶

API Documentation¶

Billecta provides comprehensive API documentation covering all available endpoints and operations.

Read the complete API documentation: Billecta API Documentation

Authentication¶

Read the complete Authentication documentation: Billecta Authentication Documentation

Webhook Integration¶

Overview¶

Billecta sends webhook notifications to Lime when events occur in Billecta. This enables real-time synchronization of data between the two systems.

What happens: 1. An event occurs in Billecta (e.g., invoice paid, payment received) 2. Billecta sends a POST request to the Lime webhook receiver endpoint 3. Lime processes the event via the webhook handler 4. Related Lime objects are created or updated 5. Integration monitor logs the transaction

See more about webhooks and how they work in Billecta in their Webhook Documentation

Webhook Configuration in Billecta¶

To receive webhook events in Lime:

Access Billecta Portal:
Login to your Billecta environment
Navigate to: Settings > Addons > Webhooks
For each Creditor:

Add the webhook receiver URL:

https://{customer}.lime-crm.com/{database}/limepkg-billecta-integration/billecta-webhook-receiver

Provide the API key for the Lime API user billectawebhook@api
Select which events to enable (see supported events below)
Webhook Receiver Endpoint (in Lime):
URL: /billecta-webhook-receiver
Method: POST
Authentication: API key validation

Supported Webhook Events¶

The integration currently processes the following Billecta webhook events:

Event	Description
`DebtorUpdated`	Debtor information was updated in Billecta
`InvoiceActionAttested`	Invoice was attested
`InvoiceActionStateChanged`	Invoice state/status changed (e.g., attested to sent)
`InvoicePaymentReceived`	Payment received for an invoice
`ReminderInvoiceActionCreated`	Reminder invoice was created
`Overpayment`	Payment received that exceeds the invoice amount
`OverpaymentMatchedToInvoice`	Overpayment was matched to another invoice
`UnmatchedPayment`	Payment received that couldn't be matched to an invoice
`AmountWrittenOffOnInvoice`	Amount written off on an invoice
`AmountCreditedOnInvoice`	Amount credited on an invoice (fires twice per credit invoicing — once for the debit invoice and once for the credit invoice)
`AutogiroApprovalFailed`	Autogiro approval failed
`AutogiroApprovalChanged`	Autogiro approval status changed
`AutogiroWithdrawalFailedOnInvoice`	Autogiro withdrawal attempt failed
`AutogiroWithdrawalRenewedOnInvoice`	Autogiro withdrawal was renewed

Invoice Management Operations¶

Overview¶

The Billecta integration provides several invoice management operations that allow you to control the collection workflow directly from Lime CRM. These operations include disputing invoices, pausing collections, and resuming paused invoices.

Dispute & Cancel Dispute¶

Use Case: When a debtor contests an invoice or disputes a charge, you can mark the invoice as disputed in Billecta to temporarily halt collection activities while the matter is resolved.

Dispute Invoice: - Marks an invoice as disputed in Billecta - Prevents additional reminders and escalation attempts - Preserves the invoice for later resolution

Cancel Dispute: - Removes the disputed status from an invoice - Resumes normal collection workflow - Use when the dispute has been resolved with the debtor

Requirements: - Invoice must be synced to Billecta (must have actionpublicid)

Pause & Resume¶

Use Case: When a debtor is in active negotiation, on a payment plan, or temporarily unable to pay, you can pause the invoice to halt reminders without removing it from Billecta.

Pause Invoice: - Places an invoice on hold in Billecta - Stops all collection activities (reminders, escalation, etc.) - Useful during payment negotiations or payment plans

Resume Paused Invoice: - Resumes normal collection workflow - Restarts reminder sequence based on Billecta configuration - Use when the pause period ends or payment plan concludes

Requirements: - Invoice must be synced to Billecta (must have actionpublicid)

Access & Availability¶

These operations are available as: - Web Commands: In Lime CRM, use the invoice action menu to access these commands - API Endpoints: For custom integrations or automation scripts - Backend Tasks: Can be triggered programmatically from other components

See Technical - Backend for endpoint details and API specifications.