Predict payment application

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
required

This is the date the payment will apply.

float
required

This is the amount of the payment.

int32
required

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

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

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

float
required

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

float
required

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

Responses

Language
Credentials