Debt Collection

Returns a sample payload for the AccountLifeTimeStatusUpdate webhook event. This webhook is triggered when the status of an invoice group changes to Ended or Active. The payload includes the invoice group ID, customer ID, customer number, and the new status.

Use case: Debt collection partners can use this payload to update their records and related processes when an invoice group status changes.

Returns a sample payload for the InvoiceDunnedPaid webhook event. This webhook is triggered when a payment is registered on an invoice that was previously marked as dunned. The payload includes the paid amount, payment date, invoice number, and bank account information.

Use case: Debt collection partners can use this webhook to update their records and stop or adjust collection activities as soon as a payment is registered.

Returns a sample payload for the InvoiceDunnedCredited webhook event. This webhook is triggered when a dunned invoice is credited. The payload includes the invoice number, credit note number, credited date, and invoice total amount.

Use case: Debt collection partners can use this webhook to stop or adjust collection activities when a dunned invoice is credited.

Returns open invoices that are eligible for debt collection for the specified tenant. Only invoices with overdue status Debt, no active stop reminders, and an unpaid balance are included.

Note: Only available for tenants using UtilityCloud Ledger. Use case: Debt collection partners can use this endpoint to fetch invoices that are currently open for collection, enabling them to initiate or continue collection processes.

Adds one or more fee items to the specified invoice and creates corresponding ledger accounting lines. The total fee amount is added to the invoice total. Each fee item must reference a valid product and have a unique identifier within the request. The new total amount including VAT must equal the original invoice total plus the sum of all fee amounts.

Note: Only available for tenants using UtilityCloud Ledger. Use case: Debt collection partners can use this endpoint to register additional costs, such as collection fees, on an overdue invoice.

Adds one or more invoice lines to be included on the customer's next invoice. Lines are imported as open journal entries and linked to the referenced invoice. Each line must include a unique identifier, amount, and description.

Note: Only available for tenants using UtilityCloud Ledger. Use case: Debt collection partners can use this endpoint to register additional charges or information to be billed on the customer's next invoice.

Marks an invoice as taken over for debt collection. The invoice must be eligible for collection. When assigned, the invoice status is updated to dunned, reminders are stopped, and the debt case ID and details are recorded. Invoices already assigned to a debt case are excluded from the list returned by GET /debtcollection.

Note: Only available for tenants using UtilityCloud Ledger. Use case: Debt collection partners can use this endpoint to confirm that a collection case has been initiated and update the invoice status in UtilityCloud.

Updates debt case details for an invoice already assigned to debt collection. The invoice number and existing debt case ID are required for verification. The debt case ID, date, URL, and comment can be updated independently; only provided fields are changed.

Note: Only available for tenants using UtilityCloud Ledger. Use case: Debt collection partners can use this endpoint to update debt case details after a collection case has already been created.

Closes a debt collection case and returns the invoice to the tenant's standard collection process. The invoice number and matching debt case ID are required. The invoice must have an active debt case with the provided ID.

Note: Only available for tenants using UtilityCloud Ledger. Use case: Debt collection partners can use this endpoint when a debt case was created by mistake or when an agreement has been made to close the case