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.

Example

<?xml version="1.0"?>
<FixedRateLoanPayInstruction xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <StartDate>2020-01-24</StartDate>
  <EndDate>2020-01-24</EndDate>
  <Description>string</Description>
  <PayLineTag>string</PayLineTag>
  <Code>string</Code>
  <Identifier>string</Identifier>
  <RepaymentRate>123.99</RepaymentRate>
  <LoanAmount>123.99</LoanAmount>
  <ProtectedEarnings>123.99</ProtectedEarnings>
</FixedRateLoanPayInstruction>

{
  "FixedRateLoanPayInstruction": {
    "StartDate": "2020-01-24",
    "EndDate": "2020-01-24",
    "Description": "string",
    "PayLineTag": "string",
    "Code": "string",
    "Identifier": "string",
    "RepaymentRate": "123.99",
    "LoanAmount": "123.99",
    "ProtectedEarnings": "123.99"
  }
}