Delete repayment

DELETE /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments/{RepaymentGUID}
Bearer auth

This endpoint allows users to delete a household liability repayment.

Path parameters

  • HouseholdGUID string(uuid) Required

    The HouseholdGUID of the client.

  • LiabilityGUID string(uuid) Required

    The LiabilityGUID for the repayment you want to delete.

  • RepaymentGUID string(uuid) Required

    The RepaymentGUID you want to delete.

Responses

  • 200 application/json

    Success

    Hide response attributes Show response attributes object
  • 403 application/json

    Permission error.

    Hide response attributes Show response attributes object
  • 404 application/json

    Repayment not found

    Hide response attributes Show response attributes object
DELETE /api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments/{RepaymentGUID} 
curl \
 -X DELETE https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/liabilities/{LiabilityGUID}/repayments/{RepaymentGUID} \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "success": true,
  "message": "Repayment deleted successfully"
}
Response examples (403) 
{
  "success": false,
  "message": "You do not have permission to edit the household."
}
Response examples (404) 
{
  "success": false,
  "message": "Repayment not found."
}