Request Body

{
  "removal_reason_code": "Incorrect Payment Date",
  "status": "Removed",
  "note": ""
}

Response Structure

The response returns the updated LMS Promise To Pay document after cancellation.

Top-Level Fields

• data: Object
  • Represents the updated Promise To Pay record.

Promise To Pay Details

• name: Promise To Pay identifier
• lending_account_id: Associated lending account number
• balance_id: Related balance identifier
• status: Current status (Removed)
• removal_reason_code: Reason for removal
• note: Optional note
• total_promised_amount: Total promised amount
• start_date: Promise start date
• balance_description: Description of the balance
• collector: User who handled the Promise To Pay
• promised_by: User identifier who created the promise
• promised_by_name: Name of the user
• doctype: Document type (LMS Promise to Pay)

Promises (Child Records)

• promises: Array of promise entries

Each promise includes:

• promised_date
• promised_amount
• paid_amount
• promise_status
• receipt_method
• scheduled_payment_status
• payment_method
• payment_processor_type
• note

Example Response

{
  "data": {
    "name": "PTP-000678",
    "lending_account_id": "LA-004120",
    "balance_id": "BA-009600",
    "status": "Removed",
    "removal_reason_code": "Incorrect Payment Date",
    "total_promised_amount": 3100.0,
    "balance_description": "Primary Loan Balance",
    "promises": [
      {
        "promised_date": "2025-07-23",
        "promised_amount": 3100.0,
        "paid_amount": 0.0,
        "promise_status": "Removed",
        "scheduled_payment_status": "Scheduled"
      }
    ]
  }
}