Delete contribution

DELETE /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions/{ContributionGUID}

Bearer auth

This endpoint allows users to delete a household saving contribution.

Path parameters

HouseholdGUID string(uuid) Required

The HouseholdGUID of the client.
SavingsGUID string(uuid) Required

The SavingsGUID for the contribution you want to delete.
ContributionGUID string(uuid) Required

The ContributionGUID you want to delete.

Responses

200 application/json

Success
Hide response attributes Show response attributes object
- success boolean
  
  Default value is true.
- message string
403 application/json

Permission error.
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string
404 application/json

Contribution not found
Hide response attributes Show response attributes object
- success boolean
  
  Default value is false.
- message string

DELETE /api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions/{ContributionGUID}

curl \
 --request DELETE 'https://api.fincalc.co.uk/api/v2/household/{HouseholdGUID}/savings/{SavingsGUID}/contributions/{ContributionGUID}' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "success": true,
  "message": "Contribution deleted successfully"
}

Response examples (403)

{
  "success": false,
  "message": "You do not have permission to edit the household."
}

Response examples (404)

{
  "success": false,
  "message": "Contribution not found."
}