voidRetainer

Mutation

Cancels a retainer agreement and returns the unused funded balance, reversing it out of the retainer liability into the bank the money arrived in. Refuses when nothing is left funded — a fully drawn retainer is closed, not voided. Access: signed-in members of the retainer's workspace with the accountingUnpost permission, in a workspace where finance is enabled. Errors: retainer not found; retainer already voided; nothing left funded to return; funded liability does not match the unapplied balance (reconcile first); funded through more than one cash account; no retainer liability account configured for a retainer that has no funding journal; posting date inside closed books; and a refusal to post at all when the deployment cannot run the write in a transaction, which keeps the cancellation and its reversal together.

Returns Retainer !.