GroupMonthlyPayment

A GroupMonthlyPayment object describes both what has been retrieved from Servicer Aggregation, as well as any other pertinent information we can interpret and calculate from collected data to accurately describe the PaymentGroup a PortfolioLoan object may belong to.

Schema Definition

Property	Type	Format	Description
`current_amount`	`string` or `null`	`decimal`	The outstanding payment amount that is currently due. This value can be greater or less than the `scheduled_amount`, dependent on whether there is any outstanding fees, past-due balance, and other factors. NOTE: Money values are returned as decimal strings with 2-digit precision. Defaults to `null`
`estimated`	`boolean`		Indicates if the `scheduled_amount` shown is a calculated estimate or confirmed as the exact dollar amount expected by the servicer. NOTE: Every servicer calculates and exposes a borrower's monthly payment in different ways. Payitoff uses a variety of intelligent heuristics to provide the most accurate `scheduled_amount`. When we are able to confirm the monthly payment is correct to the cent, `estimated` will be `false`. Otherwise, `estimated` will be `true`.
`next_payment_due`	`string` or `null`	`date`	A `Date` string indicating the next known date on which a payment is due.
`past_due_amount`	`string` or `null`	`decimal`	The outstanding amount that is currently past due. NOTE: Money values are returned as decimal strings with 2-digit precision. Defaults to `null`
`scheduled_amount`	`string`	`decimal`	The scheduled monthly payment a borrower is expected to pay, as reported by their Servicer. NOTE: Money values are returned as decimal strings with 2-digit precision.

Example

{
  "current_amount": "0.00",
  "estimated": true,
  "next_payment_due": "2022-04-01",
  "past_due_amount": "0.00",
  "scheduled_amount": "238.00"
}