Fixed Rate Loan Pay Instruction
FixedRateLoanPayInstruction [Schema]
| Name | Type | Required | Description |
|---|---|---|---|
| Code | SystemCode | no | [Optional] The payment code override. If omitted; the LOAN payment code is used. |
| Identifier | xsd:string ( max: 35) | yes | The alpah-numeric loan identifier; used to link and group pay instructions and their pay lines. |
| RepaymentRate | Money | yes | The per period repayment rate as monetary value. |
| LoanAmount | Money | no | Optional total loan amount; the loan deductions will automatically cease when the loan amount is reached. |
| ProtectedEarnings | Money | no | The protected earnings amount. Indicates the amount of earnings that cannot be collected in repayment of the loan. |
Interits from: PayInstruction[Schema]
See Understanding Pay Instructions for more information on how pay instructions can be used.
| Name | Type | Required | Description |
|---|---|---|---|
| StartDate | xsd:date | yes | The date the instruction will come into effect. |
| EndDate | xsd:date | no | The date the instruction will end, open ended instructions will run forever. |
| Description | xsd:string ( max: 200) | no | The pay line descripton override; this description will override the default description from the pay code. See Customising the Payslip for more information on customising the payslip output and using runtime variables. |
| PayLineTag | xsd:string ( max: 100) | no | If specified, the PayLineTag value is used to decorate all child pay lines generated by the instruction. |