Magidoc

voidVendorPayment
Mutation

Reverses, in the Hive ledger only, a vendor payment record by writing the offsetting payment that cancels it, and returns that offsetting document. Does not recall, cancel or refund any real payment. The void is a document, not a status: it carries the negative of the original's amount and allocations under the original's number suffixed '-VOID', and posts a reversing journal through the shared reversal builder, so every AP read that sums payments over a window — 1099 detail, cash-basis P&L, AP aging — nets it out without being taught about voids. The bills the original settled are reopened to what they owed before it, which is what makes them payable again; the original payment stays posted and is stamped with the void. Access: 'accountingPost' in a workspace where finance is enabled — the void posts a document rather than unposting one, and is the same authority that recorded the payment. Errors: refuses a payment with no journal of ours (a synced payment), one already voided, the offsetting document itself, an empty reason, and a void into a closed period.

Arguments

#

vendorPaymentId

ID !
Non-null

reason

Non-null

Response

#

Returns FinanceVendorPayment !.

Example

#