Void a purchase payment | Distru Documentation

Voids a payment made to a supplier. Reaches QuickBooks when your settings sync purchases and purchase payments.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-purchase-payments or distru-get-purchase-order (includePayments).

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence	Description
purchasePayment	object	Always
purchasePayment.id	string	Always
purchasePayment.paymentNumber	string	Always
purchasePayment.paymentDate	string	Always
purchasePayment.status	enum `POSTEDVOIDED`	Always	VOIDED payments no longer count toward paid.
purchasePayment.voidedAt	string	Can be null
purchasePayment.amount	string	Always	Dollars, as recorded; a void leaves it unchanged.
purchasePayment.paymentMethod	object	Can be null	Null once the method is deleted.
purchasePayment.paymentMethod.id	string	Always
purchasePayment.paymentMethod.name	string	Always
purchasePayment.note	string	Can be null
purchasePayment.qbPaymentAccount	string	Can be null	Full name of the QuickBooks Bank or Credit Card account the payment was made from. Null when it has none or the account is not in the QuickBooks cache.
purchasePayment.qbBillPaymentId	string	Can be null	Its QuickBooks bill payment ID.
purchasePayment.qbSyncStatus	enum `DELETED_IN_QBOERRORNOT_SYNCEDPARTIALLY_SYNCEDPENDINGSYNCED`	Can be null	Null unless the company's QuickBooks module is on and connected. PENDING and ERROR are its latest sync's outcome and win over the rest. A payment syncs only once its purchase has a QuickBooks bill and purchase payment sync is on, so NOT_SYNCED is normal before that.
purchasePayment.insertedAt	string	Always
purchasePayment.updatedAt	string	Always	Also moves on a void.
purchasePayment.purchase	object	Can be null	Null when the caller's team can't see the purchase.
purchasePayment.purchase.id	string	Always
purchasePayment.purchase.purchaseNumber	string	Always
purchasePayment.purchase.paymentStatus	enum `NOT_PAIDOVER_PAIDPAIDPARTIALLY_PAID`	Always
purchasePayment.purchase.paid	string	Always	Sum of its non-voided payments.
purchasePayment.purchase.total	string	Always
purchasePayment.supplier	object	Can be null	Null when the caller's team can't see it.
purchasePayment.supplier.id	string	Always
purchasePayment.supplier.name	string	Null or absent

What the AI reads

Voids a payment made to a supplier: its amount comes off the purchase order's paid and the purchase's payment status is recomputed. Rejected when the payment is already voided, and as not existing when the ID is an invoice payment's: void that with distru-void-invoice-payment. Returns the voided payment as distru-get-purchase-payment does. qbBillPaymentId is its QuickBooks bill payment ID; qbPaymentAccount is the full name of the QuickBooks account it was paid from. qbSyncStatus is null unless the company's QuickBooks module is on and connected; PENDING and ERROR are its latest sync's outcome and win over the rest; DELETED_IN_QBO = the bill payment was deleted in QuickBooks; NOT_SYNCED = it isn't in QuickBooks, which is normal until its purchase has a QuickBooks bill and purchase payment sync is on. For why a sync failed, use distru-search-quickbooks-activities with purchaseOrderIds (its purchase.id).