Predict payment application

post https://loanpro.simnang.com/api/public/api/1/Loans({id})/Autopal.PredictPaymentApplication()

This request previews a payment's breakdown before it's logged and processed.

Click here to learn more about this request

This request allows you to predict how a payment will apply to different pieces of a loan. Note the following when using this request:

This request does not log a payment. It simply displays how the payment affects the loan.

This request is useful for testing if your payment will affect other payments. If this is the case, the response will include an affectedPayments object.

Depending on the loan's extra towards settings, a payment amount that is larger than the scheduled payment will apply to future payments.

👆
Pay special attention to the endpoint of this request.
This request does not use OData, so it's not included in the endpoint like most other LMS requests.

Database

For information on payment database tables, see the following articles:

Database – Payments (payment_entity)

Database – Payment Defaults (defaults_payments)

{
     "Date": "2022-03-19",
     "Amount": 250,
     "PaymentTypeId": 1,
     "Extra": "payment.extra.tx.principal",
     "chargeFeeType": "loan.cardfee.types.1",
     "chargeFeeAmount": 5,
     "chargeFeePercentage": 5
}

Path Params

int32

required

This is the ID of the loan.

Body Params

Date

date

required

This is the date the payment will apply.

Amount

float

required

This is the amount of the payment.

PaymentTypeId

int32

required

This is the ID of the type of payment waterfall.
> Your payment type IDs can be found under Settings > Loan > Payments > Types.

Extra

string

required

Defaults to payment.extra.tx.principal

This determines how extra is applied.
> The selection here must match the extra towards selection (either between periods or between transactions) set in Loan Setup.
> For more information on these values, click here

chargeFeeType

string

required

Defaults to loan.cardfee.types.1

This determines the type of the card fee that will apply to the payment.
> For more information on these values, click here

chargeFeeAmount

float

required

This is the card fee amount to apply to the payment.

chargeFeePercentage

float

required

This is the percentage fee amount to apply to the payment.

Responses

Language

Credentials


xxxxxxxxxx
10
1
curl --request POST \
2
     --url 'https://loanpro.simnang.com/api/public/api/1/Loans(id)/Autopal.PredictPaymentApplication()' \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "Extra": "payment.extra.tx.principal",
8
  "chargeFeeType": "loan.cardfee.types.1"
9
}
10
'


xxxxxxxxxx
21
 
1
{
2
  "d": {
3
    "date": "2022-04-27",
4
    "period": 20,
5
    "amount": 225.26,
6
    "interest": 150.44,
7
    "principal": 44.82,
8
    "discount": 0,
9
    "escrow": 0,
10
    "fees": 30,
11
    "escrow_breakdown": [],
12
    "fees_breakdown": {
13
      "2486": 30
14
    },
15
    "extra_payments": [],
16
    "principal_balance": 8642.22,
17
    "affectedPayments": [],
18
    "affectedCredits": [],
19
    "loan_display_id": "current"
20
  }
21
}

Predict payment application

👆
Pay special attention to the endpoint of this request.

Database

Customers

Loans

Loan Servicing

Lines of Credit/Cards

Line of Credit Servicing

Custom Fields

👆Pay special attention to the endpoint of this request.

Database

200200

401401

409409

👆
Pay special attention to the endpoint of this request.