Skip to main content

Delete Amortization Schedule

DELETE 

/api/amortization-schedules/:amortizationSchedule

Delete an amortization schedule together with all of its periods.

Required scope: purchase-orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

There is no guard against deleting a schedule that has already-processed periods: any cost allocations that were created by processing this schedule's periods are also deleted, effectively reversing those allocations. The whole operation runs in a single transaction, and the parent cost entry's allocation status is recalculated afterwards (for example back to pending_allocation if nothing else is allocated against it).

The cost entry itself is not deleted - a new schedule can be created for it afterwards with POST /api/cost-entries/:costEntry/amortization-schedule.

Returns 200 with a confirmation message (not 204).

Authentication: Requires Bearer token. Scope: purchase-orders (read/write).

Request

Responses

OK

Response Headers
    Content-Type