This API creates a Promise To Pay (PTP) record for a lending account. It allows collectors or agents to record a customer’s commitment to pay a specific amount on a promised date against a particular balance. The API also supports creating one or more promise entries under a single Promise To Pay record.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Response Explanation
Top-Level Field
- data (object)
▸ Represents the newly created Promise To Pay record.
Promise To Pay Details (data)
data)-
name
▸ System-generated Promise To Pay identifier
▸ Example:PTP-000889 -
lending_account_id
▸ Lending account linked to the Promise To Pay. -
balance_id
▸ Balance against which the promise is recorded. -
start_date
▸ Start date of the Promise To Pay. -
total_promised_amount
▸ Sum of all promised amounts across promise entries. -
balance_description
▸ Description of the associated balance. -
promised_by / promised_by_name
▸ Identifier and name of the user who created the promise. -
collector
▸ Collector assigned to manage the Promise To Pay. -
status
▸ Current status of the Promise To Pay
▸ Example:Open -
doctype
▸ Document type
▸ Value:LMS Promise to Pay
Promises (data.promises[])
data.promises[])Each object represents an individual promised payment:
-
promised_date
▸ Date on which payment is expected. -
promised_amount
▸ Amount committed by the customer. -
paid_amount
▸ Amount already paid against the promise. -
payment_method
▸ Mode of payment
▸ Example:Cash -
promise_status
▸ Status of the individual promise
▸ Example values:Open,Kept,Broken -
scheduled_payment_status
▸ Indicates whether the payment is scheduled.