GET api/loan/payments/{id}

Get payment information of a specified loan account on a session date.

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/payments/{id}. 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
id	Identifier of a loan account.	integer	Required

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns payment Information on a session date.

PaymentInformationDto

Name	Description	Type	Additional information
PrincipalDue	Principle has to pay.	decimal number	Read-Only.
InterestDue	Interest has to pay.	decimal number	Read-Only.
OpeningBalance	Opening balance of an account.	decimal number	Read-Only.
ClosingBalance	Closing balance of an account once paid the current dues.	decimal number	Read-Only.
AccountRating	Rating of an account on a particular day.	string	Read-Only.
BalanceDate	Last transaction date which affected the balance of an account.	date	Read-Only.
IssueAmount	Issued amount.	decimal number	Read-Only.
IssueDate	Issue Date of an account.	date	Read-Only.
ArrearsInformation	Arrear Information of an account.	string	Read-Only.
ArrearsAmount	Arrear amount of an account.	decimal number	Read-Only.
ArrearsDays	Arrear days of an account.	integer	Read-Only.
CurrentInstallmentNumber	Actual repayment period of an account.	integer	Read-Only.
NextDueDate	Next due date of an account.	date	Read-Only.
PenaltyDue	Penalty due of an account.	decimal number	Read-Only.
FeesDue	Fees which are still pending.	decimal number	Read-Only.
CustomerName	A person who owns the account.	string	Read-Only.
AccountID	Identifier of an account.	integer	Read-Only.
SessionDate	Date when payment information instantiated.	date

Response Formats

application/json, text/json

Sample:

{
  "principalDue": 1.0,
  "interestDue": 2.0,
  "openingBalance": 3.0,
  "closingBalance": 4.0,
  "accountRating": "sample string 5",
  "balanceDate": "2019-06-04T21:07:46.3412233-04:00",
  "issueAmount": 7.0,
  "issueDate": "2019-06-04T21:07:46.3412233-04:00",
  "arrearsInformation": "sample string 9",
  "arrearsAmount": 1.0,
  "arrearsDays": 10,
  "currentInstallmentNumber": 11,
  "nextDueDate": "2019-06-04T21:07:46.3412233-04:00",
  "penaltyDue": 13.0,
  "feesDue": 14.0,
  "customerName": "sample string 15",
  "accountID": 16,
  "sessionDate": "2019-06-04T21:07:46.342223-04:00"
}

application/xml, text/xml

Sample:

<PaymentInformationDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto" />