v1

latestOpenAPI 3.1.0Proprietary2026-08-06177398877.4 KB
Bill Payments

Delete a bill payment

Delete a bill payment and all its applications.

What happens

  • PaymentGroup record is deleted
  • All Payment applications are deleted
  • Bill open balances are restored
  • Load/service status may revert if payment made them PAID
delete/bill-payments/{id}

Path parameters

idstring required

Resource ID (UUID) or client key

Query parameters

by'id' | 'key'

Specify lookup type for faster retrieval. If omitted, defaults to looking up by ID first, then falls back to client key if not found. Use by=key when you know you're providing a client key for best performance.

Response

Bill payment deleted successfully