/v1/payment-schedules/{id}Read one repayment schedule
One schedule in full: funded amount, total payback, factor and interest rate, fees, the instalment amount and frequency, start and expected end, how much has been collected, what is outstanding, how many payments remain, the next payment date, and whether it is delinquent. All money in exact minor units, in fields named …Minor. Reach for get_payment_schedules_id_reconciliation when the question is how the schedule is performing rather than what its terms are, and get_payment_schedules_id_payments for the instalments themselves. A schedule belonging to another workspace answers not found.
Access class: workspace.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Responses
the action's answer
{
"data": {
"actualEndDate": "string",
"collectionRate": "string",
"completedAt": "string",
"consecutiveMissed": 1,
"contractId": 1,
"createdAt": "string",
"currency": "string",
"daysDelinquent": 1,
"dealRowId": "",
"detail": {},
"expectedEndDate": "string",
"facilityId": 1,
"factorRate": "string",
"fundedAmountMinor": 1,
"fundingRecordId": 1,
"id": 1,
"interestRate": "string",
"internalNotes": "string",
"isDelinquent": true,
"lastModifiedReason": "string",
"modificationsCount": 1,
"nextPaymentDate": "string",
"offerId": 1,
"originationFeeMinor": 1,
"otherFeesMinor": 1,
"pausedAt": "string",
"paymentAmountMinor": 1,
"paymentFrequency": "string",
"paymentMethod": "string",
"paymentsMade": 1,
"paymentsRemaining": 1,
"paymentsWaived": 1,
"scheduleNumber": "string",
"startDate": "string",
"status": "string",
"totalCollectedMinor": 1,
"totalMissedMinor": 1,
"totalOutstandingMinor": 1,
"totalPaybackMinor": 1,
"totalPayments": 1,
"updatedAt": "string"
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}