Documentation Index

Fetch the complete documentation index at: https://docs.nyumbazetu.com/llms.txt

Use this file to discover all available pages before exploring further.

​

Security deposits

Security deposits are amounts held against a lease (e.g. for damages or unpaid rent). Nyumba Zetu lets you record, track, and release them from the Security deposits area.

​

Where to find security deposits

1. Sign in to the app.
2. In the sidebar, click Security Deposits.
3. Open a deposit record to view its detailed balance and activity.
4. Depending on your permissions, you can also work from related views such as Deposit Deductions and Deposit Refunds.

​

Recording a deposit

When you set up a lease or receive a deposit from a tenant, record it in Security deposits (or in the lease flow if your app links it automatically). Enter the amount, date received, and the related lease or tenant. If your app supports it, you can also record the bank or account where the deposit is held.

​

During the tenancy

• Deposits are usually held until the lease ends. Use the list or filters to see which deposits are active.
• If you need to adjust the amount (e.g. partial refund or top-up), use the edit or adjustment option for that deposit record, if available.

​

Deposit detail workflow

Inside a security deposit record, the details view includes:

• Balance breakdown (paid, deducted, refunded, and withheld amounts).
• Deductions section to add, edit, and delete deduction entries.
• Refunds section to add, edit, and delete refund entries.
• Download PDF report for sharing or audit documentation.

​

How deposit balances are calculated

Security-deposit balances in the details screen are calculated from the linked invoice and child transactions:

• Paid amount: the amount already paid on the deposit invoice.
• Refunded amount: sum of all refund entries linked to that deposit invoice.
• Deducted amount: sum of deduction entries with status applied.
• Withheld amount: remaining held balance after deductions and refunds.

Formula used in the app’s deposit view: withheld amount = paid amount - refunded amount - deducted amount

​

Validation rules during edits

• You can only add new deduction/refund rows when withheld amount > 0.
• For create actions, amount must be greater than 0 and cannot exceed current withheld amount.
• For edit actions, the app allows the existing row amount plus current withheld amount so unchanged values remain valid.

​

Refund progress states

The deposit view also classifies refund progress:

• none: no amount refunded yet.
• partial: refunded amount is less than paid amount.
• full: refunded amount equals paid amount.

​

Security-deposit reporting (PDF)

From the deposit detail page, use Download PDF Report to generate a security-deposit report for that specific deposit invoice. The report is intended for audit/share workflows and is generated from current deposit data, including:

• deposit/invoice identifiers and lease or unit context
• current balance breakdown (paid, deducted, refunded, withheld)
• recorded deduction and refund activity at report time

​

Releasing a deposit at move-out

When the tenant moves out, release the deposit (full or partial) from the Security Deposits area. Record any deductions first, then process any eligible refund amount. The balance updates automatically in the deposit detail summary.

​

Next steps

• Managing leases – Set up the lease that the deposit is linked to.
• Invoices and payments – Record refunds or deductions if they flow through receivables.