GET api/loan/paymentallocation?CustomerID={CustomerID}

Get loan payment schedule information.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/loan/paymentallocation. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

Name	Description	Type	Additional information
CustomerID	Unique identifier of the customer.	integer

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns loan schedule information for the loan accounts that matches the search parameters.

Collection of PaymentAllocationDto

Name	Description	Type
AccountNumber	Account number of the loan account.	string
Product	product description of the loan account.	string
Date	Balance date of the loan account.	string
Balance	Loan account balance..	string
Active	Active status of the loan account.	boolean
LoanSchedule	Loan Schedule information.	Collection of LoanScheduleResultDto
AccountBranch	Branch name of the loan account.	string
CUAccountID	Loan account's Id.	integer
CurrencyID	Product currency ID	integer

Response Formats

application/json, text/json

Sample:

[
  {
    "accountNumber": "sample string 1",
    "product": "sample string 2",
    "date": "sample string 3",
    "balance": "sample string 4",
    "active": true,
    "loanSchedule": [
      {
        "cuAccountID": 1,
        "scheduleID": 1,
        "cuLoanPartID": 1,
        "period": 1,
        "repaymentDate": "sample string 1",
        "totalRepayment": 1.0,
        "totalRepaymentPaid": "sample string 2",
        "feeRepayment": 1.0,
        "feeAmtPaid": 1.0,
        "udsFeeRepayment": 1.0,
        "udsFeePaid": 1.0,
        "interestRepayment": 1.0,
        "interestAmtPaid": "sample string 3",
        "compIntRepayment": "sample string 4",
        "compIntAmtPaid": "sample string 5",
        "loanRepayment": 1.0,
        "loanRepaymentPaid": "sample string 6",
        "penaltyDue": "sample string 7",
        "penaltyDuePaid": "sample string 8",
        "outstandingFeeDue": "sample string 9",
        "outstandingFeeDuePaid": "sample string 10",
        "writtenOffAmount": "sample string 11",
        "balance": 1.0,
        "savingsPayment": 1.0,
        "savingsPaymentPaid": "sample string 12",
        "allPaid": true,
        "status": "sample string 13",
        "repaidDate": "sample string 14",
        "repaymentAmount": 1.0,
        "lateDays": 1,
        "totalRepaymentString": "sample string 15",
        "feeRepaymentString": "sample string 16",
        "interestRepaymentString": "sample string 17",
        "loanRepaymentString": "sample string 18",
        "balanceString": "sample string 19",
        "dateChanged": true
      },
      {
        "cuAccountID": 1,
        "scheduleID": 1,
        "cuLoanPartID": 1,
        "period": 1,
        "repaymentDate": "sample string 1",
        "totalRepayment": 1.0,
        "totalRepaymentPaid": "sample string 2",
        "feeRepayment": 1.0,
        "feeAmtPaid": 1.0,
        "udsFeeRepayment": 1.0,
        "udsFeePaid": 1.0,
        "interestRepayment": 1.0,
        "interestAmtPaid": "sample string 3",
        "compIntRepayment": "sample string 4",
        "compIntAmtPaid": "sample string 5",
        "loanRepayment": 1.0,
        "loanRepaymentPaid": "sample string 6",
        "penaltyDue": "sample string 7",
        "penaltyDuePaid": "sample string 8",
        "outstandingFeeDue": "sample string 9",
        "outstandingFeeDuePaid": "sample string 10",
        "writtenOffAmount": "sample string 11",
        "balance": 1.0,
        "savingsPayment": 1.0,
        "savingsPaymentPaid": "sample string 12",
        "allPaid": true,
        "status": "sample string 13",
        "repaidDate": "sample string 14",
        "repaymentAmount": 1.0,
        "lateDays": 1,
        "totalRepaymentString": "sample string 15",
        "feeRepaymentString": "sample string 16",
        "interestRepaymentString": "sample string 17",
        "loanRepaymentString": "sample string 18",
        "balanceString": "sample string 19",
        "dateChanged": true
      }
    ],
    "accountBranch": "sample string 5",
    "cuAccountID": 1,
    "currencyID": 1
  },
  {
    "accountNumber": "sample string 1",
    "product": "sample string 2",
    "date": "sample string 3",
    "balance": "sample string 4",
    "active": true,
    "loanSchedule": [
      {
        "cuAccountID": 1,
        "scheduleID": 1,
        "cuLoanPartID": 1,
        "period": 1,
        "repaymentDate": "sample string 1",
        "totalRepayment": 1.0,
        "totalRepaymentPaid": "sample string 2",
        "feeRepayment": 1.0,
        "feeAmtPaid": 1.0,
        "udsFeeRepayment": 1.0,
        "udsFeePaid": 1.0,
        "interestRepayment": 1.0,
        "interestAmtPaid": "sample string 3",
        "compIntRepayment": "sample string 4",
        "compIntAmtPaid": "sample string 5",
        "loanRepayment": 1.0,
        "loanRepaymentPaid": "sample string 6",
        "penaltyDue": "sample string 7",
        "penaltyDuePaid": "sample string 8",
        "outstandingFeeDue": "sample string 9",
        "outstandingFeeDuePaid": "sample string 10",
        "writtenOffAmount": "sample string 11",
        "balance": 1.0,
        "savingsPayment": 1.0,
        "savingsPaymentPaid": "sample string 12",
        "allPaid": true,
        "status": "sample string 13",
        "repaidDate": "sample string 14",
        "repaymentAmount": 1.0,
        "lateDays": 1,
        "totalRepaymentString": "sample string 15",
        "feeRepaymentString": "sample string 16",
        "interestRepaymentString": "sample string 17",
        "loanRepaymentString": "sample string 18",
        "balanceString": "sample string 19",
        "dateChanged": true
      },
      {
        "cuAccountID": 1,
        "scheduleID": 1,
        "cuLoanPartID": 1,
        "period": 1,
        "repaymentDate": "sample string 1",
        "totalRepayment": 1.0,
        "totalRepaymentPaid": "sample string 2",
        "feeRepayment": 1.0,
        "feeAmtPaid": 1.0,
        "udsFeeRepayment": 1.0,
        "udsFeePaid": 1.0,
        "interestRepayment": 1.0,
        "interestAmtPaid": "sample string 3",
        "compIntRepayment": "sample string 4",
        "compIntAmtPaid": "sample string 5",
        "loanRepayment": 1.0,
        "loanRepaymentPaid": "sample string 6",
        "penaltyDue": "sample string 7",
        "penaltyDuePaid": "sample string 8",
        "outstandingFeeDue": "sample string 9",
        "outstandingFeeDuePaid": "sample string 10",
        "writtenOffAmount": "sample string 11",
        "balance": 1.0,
        "savingsPayment": 1.0,
        "savingsPaymentPaid": "sample string 12",
        "allPaid": true,
        "status": "sample string 13",
        "repaidDate": "sample string 14",
        "repaymentAmount": 1.0,
        "lateDays": 1,
        "totalRepaymentString": "sample string 15",
        "feeRepaymentString": "sample string 16",
        "interestRepaymentString": "sample string 17",
        "loanRepaymentString": "sample string 18",
        "balanceString": "sample string 19",
        "dateChanged": true
      }
    ],
    "accountBranch": "sample string 5",
    "cuAccountID": 1,
    "currencyID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfPaymentAllocationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto.CU">
  <PaymentAllocationDto>
    <AccountBranch>sample string 5</AccountBranch>
    <AccountNumber>sample string 1</AccountNumber>
    <Active>true</Active>
    <Balance>sample string 4</Balance>
    <CUAccountID>1</CUAccountID>
    <CurrencyID>1</CurrencyID>
    <Date>sample string 3</Date>
    <LoanSchedule>
      <LoanScheduleResultDto>
        <AllPaid>true</AllPaid>
        <Balance>1</Balance>
        <BalanceString>sample string 19</BalanceString>
        <CUAccountID>1</CUAccountID>
        <CULoanPartID>1</CULoanPartID>
        <CompIntAmtPaid>sample string 5</CompIntAmtPaid>
        <CompIntRepayment>sample string 4</CompIntRepayment>
        <DateChanged>true</DateChanged>
        <FeeAmtPaid>1</FeeAmtPaid>
        <FeeRepayment>1</FeeRepayment>
        <FeeRepaymentString>sample string 16</FeeRepaymentString>
        <InterestAmtPaid>sample string 3</InterestAmtPaid>
        <InterestRepayment>1</InterestRepayment>
        <InterestRepaymentString>sample string 17</InterestRepaymentString>
        <LateDays>1</LateDays>
        <LoanRepayment>1</LoanRepayment>
        <LoanRepaymentPaid>sample string 6</LoanRepaymentPaid>
        <LoanRepaymentString>sample string 18</LoanRepaymentString>
        <OutstandingFeeDue>sample string 9</OutstandingFeeDue>
        <OutstandingFeeDuePaid>sample string 10</OutstandingFeeDuePaid>
        <PenaltyDue>sample string 7</PenaltyDue>
        <PenaltyDuePaid>sample string 8</PenaltyDuePaid>
        <Period>1</Period>
        <RepaidDate>sample string 14</RepaidDate>
        <RepaymentAmount>1</RepaymentAmount>
        <RepaymentDate>sample string 1</RepaymentDate>
        <SavingsPayment>1</SavingsPayment>
        <SavingsPaymentPaid>sample string 12</SavingsPaymentPaid>
        <ScheduleID>1</ScheduleID>
        <Status>sample string 13</Status>
        <TotalRepayment>1</TotalRepayment>
        <TotalRepaymentPaid>sample string 2</TotalRepaymentPaid>
        <TotalRepaymentString>sample string 15</TotalRepaymentString>
        <UDSFeePaid>1</UDSFeePaid>
        <UDSFeeRepayment>1</UDSFeeRepayment>
        <WrittenOffAmount>sample string 11</WrittenOffAmount>
      </LoanScheduleResultDto>
      <LoanScheduleResultDto>
        <AllPaid>true</AllPaid>
        <Balance>1</Balance>
        <BalanceString>sample string 19</BalanceString>
        <CUAccountID>1</CUAccountID>
        <CULoanPartID>1</CULoanPartID>
        <CompIntAmtPaid>sample string 5</CompIntAmtPaid>
        <CompIntRepayment>sample string 4</CompIntRepayment>
        <DateChanged>true</DateChanged>
        <FeeAmtPaid>1</FeeAmtPaid>
        <FeeRepayment>1</FeeRepayment>
        <FeeRepaymentString>sample string 16</FeeRepaymentString>
        <InterestAmtPaid>sample string 3</InterestAmtPaid>
        <InterestRepayment>1</InterestRepayment>
        <InterestRepaymentString>sample string 17</InterestRepaymentString>
        <LateDays>1</LateDays>
        <LoanRepayment>1</LoanRepayment>
        <LoanRepaymentPaid>sample string 6</LoanRepaymentPaid>
        <LoanRepaymentString>sample string 18</LoanRepaymentString>
        <OutstandingFeeDue>sample string 9</OutstandingFeeDue>
        <OutstandingFeeDuePaid>sample string 10</OutstandingFeeDuePaid>
        <PenaltyDue>sample string 7</PenaltyDue>
        <PenaltyDuePaid>sample string 8</PenaltyDuePaid>
        <Period>1</Period>
        <RepaidDate>sample string 14</RepaidDate>
        <RepaymentAmount>1</RepaymentAmount>
        <RepaymentDate>sample string 1</RepaymentDate>
        <SavingsPayment>1</SavingsPayment>
        <SavingsPaymentPaid>sample string 12</SavingsPaymentPaid>
        <ScheduleID>1</ScheduleID>
        <Status>sample string 13</Status>
        <TotalRepayment>1</TotalRepayment>
        <TotalRepaymentPaid>sample string 2</TotalRepaymentPaid>
        <TotalRepaymentString>sample string 15</TotalRepaymentString>
        <UDSFeePaid>1</UDSFeePaid>
        <UDSFeeRepayment>1</UDSFeeRepayment>
        <WrittenOffAmount>sample string 11</WrittenOffAmount>
      </LoanScheduleResultDto>
    </LoanSchedule>
    <Product>sample string 2</Product>
  </PaymentAllocationDto>
  <PaymentAllocationDto>
    <AccountBranch>sample string 5</AccountBranch>
    <AccountNumber>sample string 1</AccountNumber>
    <Active>true</Active>
    <Balance>sample string 4</Balance>
    <CUAccountID>1</CUAccountID>
    <CurrencyID>1</CurrencyID>
    <Date>sample string 3</Date>
    <LoanSchedule>
      <LoanScheduleResultDto>
        <AllPaid>true</AllPaid>
        <Balance>1</Balance>
        <BalanceString>sample string 19</BalanceString>
        <CUAccountID>1</CUAccountID>
        <CULoanPartID>1</CULoanPartID>
        <CompIntAmtPaid>sample string 5</CompIntAmtPaid>
        <CompIntRepayment>sample string 4</CompIntRepayment>
        <DateChanged>true</DateChanged>
        <FeeAmtPaid>1</FeeAmtPaid>
        <FeeRepayment>1</FeeRepayment>
        <FeeRepaymentString>sample string 16</FeeRepaymentString>
        <InterestAmtPaid>sample string 3</InterestAmtPaid>
        <InterestRepayment>1</InterestRepayment>
        <InterestRepaymentString>sample string 17</InterestRepaymentString>
        <LateDays>1</LateDays>
        <LoanRepayment>1</LoanRepayment>
        <LoanRepaymentPaid>sample string 6</LoanRepaymentPaid>
        <LoanRepaymentString>sample string 18</LoanRepaymentString>
        <OutstandingFeeDue>sample string 9</OutstandingFeeDue>
        <OutstandingFeeDuePaid>sample string 10</OutstandingFeeDuePaid>
        <PenaltyDue>sample string 7</PenaltyDue>
        <PenaltyDuePaid>sample string 8</PenaltyDuePaid>
        <Period>1</Period>
        <RepaidDate>sample string 14</RepaidDate>
        <RepaymentAmount>1</RepaymentAmount>
        <RepaymentDate>sample string 1</RepaymentDate>
        <SavingsPayment>1</SavingsPayment>
        <SavingsPaymentPaid>sample string 12</SavingsPaymentPaid>
        <ScheduleID>1</ScheduleID>
        <Status>sample string 13</Status>
        <TotalRepayment>1</TotalRepayment>
        <TotalRepaymentPaid>sample string 2</TotalRepaymentPaid>
        <TotalRepaymentString>sample string 15</TotalRepaymentString>
        <UDSFeePaid>1</UDSFeePaid>
        <UDSFeeRepayment>1</UDSFeeRepayment>
        <WrittenOffAmount>sample string 11</WrittenOffAmount>
      </LoanScheduleResultDto>
      <LoanScheduleResultDto>
        <AllPaid>true</AllPaid>
        <Balance>1</Balance>
        <BalanceString>sample string 19</BalanceString>
        <CUAccountID>1</CUAccountID>
        <CULoanPartID>1</CULoanPartID>
        <CompIntAmtPaid>sample string 5</CompIntAmtPaid>
        <CompIntRepayment>sample string 4</CompIntRepayment>
        <DateChanged>true</DateChanged>
        <FeeAmtPaid>1</FeeAmtPaid>
        <FeeRepayment>1</FeeRepayment>
        <FeeRepaymentString>sample string 16</FeeRepaymentString>
        <InterestAmtPaid>sample string 3</InterestAmtPaid>
        <InterestRepayment>1</InterestRepayment>
        <InterestRepaymentString>sample string 17</InterestRepaymentString>
        <LateDays>1</LateDays>
        <LoanRepayment>1</LoanRepayment>
        <LoanRepaymentPaid>sample string 6</LoanRepaymentPaid>
        <LoanRepaymentString>sample string 18</LoanRepaymentString>
        <OutstandingFeeDue>sample string 9</OutstandingFeeDue>
        <OutstandingFeeDuePaid>sample string 10</OutstandingFeeDuePaid>
        <PenaltyDue>sample string 7</PenaltyDue>
        <PenaltyDuePaid>sample string 8</PenaltyDuePaid>
        <Period>1</Period>
        <RepaidDate>sample string 14</RepaidDate>
        <RepaymentAmount>1</RepaymentAmount>
        <RepaymentDate>sample string 1</RepaymentDate>
        <SavingsPayment>1</SavingsPayment>
        <SavingsPaymentPaid>sample string 12</SavingsPaymentPaid>
        <ScheduleID>1</ScheduleID>
        <Status>sample string 13</Status>
        <TotalRepayment>1</TotalRepayment>
        <TotalRepaymentPaid>sample string 2</TotalRepaymentPaid>
        <TotalRepaymentString>sample string 15</TotalRepaymentString>
        <UDSFeePaid>1</UDSFeePaid>
        <UDSFeeRepayment>1</UDSFeeRepayment>
        <WrittenOffAmount>sample string 11</WrittenOffAmount>
      </LoanScheduleResultDto>
    </LoanSchedule>
    <Product>sample string 2</Product>
  </PaymentAllocationDto>
</ArrayOfPaymentAllocationDto>