The record of one installment that one payroll calculation took from one loan or advance. Payroll writes these rows; users do not need to create them. Each row holds the amount recovered and the loan balance straight after it, with the run and period that took it. When a run is recalculated, its earlier rows are retired and their amounts are given back to the loan before the run recovers again, so the live rows always match the current calculation. A row created by hand changes nothing: it does not lower the loan's balance or its open item.
Fields
| Field | Label | Type | Required | What it does |
|---|
Amount | Amount | Currency | | The amount deducted in this run: the loan's installment, or the remaining balance when that is smaller. |
CreatedById | Created By | Lookup → UserAccount | Yes | |
CreatedDateTime | Created Date | DateAndTime | Yes | |
Id | Id | Guid | Yes | |
Label | Label | Text | | |
LoanAdvanceId | Loan Advance | Lookup → LoanAdvance | | The loan or advance the installment was taken from. |
ModifiedById | Modified By | Lookup → UserAccount | Yes | |
Name | Name | Text, unique | Yes | |
OutstandingAfter | Outstanding After | Currency | | The loan's balance straight after this installment. Zero means this installment closed the loan. |
OwnerId | Owner | Lookup → UserAccount | Yes | |
PartnerAccountId | Partner Account | Lookup → Account | | The company of the payroll run that took the installment. |
PayrollPeriodId | Payroll Period | Lookup → PayrollPeriod | | The run's payroll period. The year-end Loan Schedule places the installment in the fiscal year that contains this period's end date. |
PayrollRunId | Payroll Run | Lookup → PayrollRun | | The payroll run whose calculation took the installment. Recalculating this run retires the row and gives the amount back to the loan. |
RecordTypeId | Record Type | Guid, hidden | | |
ResourceId | Resource | Lookup → Resource | | The employee the installment was deducted from. |
UIProps | UI Props | Text | | |
UpdatedDateTime | Modified Date | DateAndTime | Yes | |
Actions
| Action | Label | Type | What it does |
|---|
Clone | Clone | ServerAction (Clone) | Create a copy of this record |
Delete | Delete | Delete | Delete this LoanAdvanceRecovery. |
DeleteEntity | Delete | Delete | DeleteEntity |
DeleteHeader | Delete | Delete | DeleteHeader |
Edit | Edit | Edit | Edit this LoanAdvanceRecovery. |
EditEntity | Edit | Edit | EditEntity |
EditInLine | Edit | EditInline | EditInLine |
New | New | NewInline | Create a LoanAdvanceRecovery. |
View | View | View | View this LoanAdvanceRecovery. |
