Magidoc

createVendorPaymentRun
Mutation

Builds a draft worksheet of vendor bills to record as paid: every bill ready for payment, grouped into one payment record per vendor, priced at each bill's outstanding balance. Writes nothing to the ledger and does not move money — the draft is the selection surface, stored so what an operator reviews is exactly what postVendorPaymentRun records. Bills that are ready but cannot be grouped — no vendor on the order, a currency this rail cannot settle — are reported in skipped rather than dropped. Access: 'accountingPost' in a workspace where finance is enabled — the same permission the sweep needs, because a draft run lists every vendor balance in the workspace. Errors: refuses a workspace with nothing ready to pay, and a selection larger than one run sweeps (narrow it with vendorAccountIds).

Arguments

#

workspaceId

ID !
Non-null

Response

#

Returns FinanceVendorPaymentRun !.

Example

#