Void an invoice payment | Distru Documentation

Voids a payment received against an invoice. Reaches QuickBooks when your QuickBooks settings sync payments, and LeafLink when your LeafLink settings sync payments and the order is linked to LeafLink.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-invoice-payments.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
invoicePayment	object	Always
invoicePayment.id	string	Always
invoicePayment.paymentNumber	string	Always
invoicePayment.paymentDate	string	Always
invoicePayment.status	enum `POSTEDVOIDED`	Always
invoicePayment.voidedAt	string	Can be null
invoicePayment.received	object	Can be null
invoicePayment.received.amount	string	Always
invoicePayment.received.paymentMethod	object	Can be null
invoicePayment.received.paymentMethod.id	string	Always
invoicePayment.received.paymentMethod.name	string	Always
invoicePayment.creditAmount	string	Always
invoicePayment.appliedAmount	string	Always
invoicePayment.overpaidAmount	string	Always
invoicePayment.note	string	Can be null
invoicePayment.customer	object	Can be null
invoicePayment.customer.id	string	Always
invoicePayment.customer.name	string	Null or absent
invoicePayment.invoice	object	Can be null
invoicePayment.invoice.id	string	Always
invoicePayment.invoice.invoiceNumber	string	Always
invoicePayment.invoice.paymentStatus	enum `NOT_PAIDOVER_PAIDPAIDPARTIALLY_PAID`	Always
invoicePayment.qbDepositAccount	string	Can be null
invoicePayment.qbPaymentId	string	Can be null
invoicePayment.qbSyncStatus	enum `DELETED_IN_QBOERRORNOT_SYNCEDPARTIALLY_SYNCEDPENDINGSYNCED`	Can be null
invoicePayment.insertedAt	string	Always
invoicePayment.updatedAt	string	Always
invoicePayment.creditUses	object[]	Always
invoicePayment.creditUses[].amount	string	Always
invoicePayment.creditUses[].appliedAt	string	Always
invoicePayment.creditUses[].credit	object	Can be null
invoicePayment.creditUses[].credit.id	string	Always
invoicePayment.creditUses[].credit.creditNumber	string	Always
invoicePayment.overpaymentCredits	object[]	Always
invoicePayment.overpaymentCredits[].id	string	Always
invoicePayment.overpaymentCredits[].creditNumber	string	Always
invoicePayment.overpaymentCredits[].amount	string	Always
invoicePayment.overpaymentCredits[].status	enum `ACTIVECANCELEDREDEEMED`	Always

What the AI reads

Voids a payment received against an invoice: its applied amount comes off the invoice and the credit it used is released. The credits its overpayment created are canceled and their uses removed, so any other invoice they paid owes that amount again. Rejected when the payment is already voided, and as not existing when the ID is a purchase payment's: void that with distru-void-purchase-payment. Returns the voided payment as distru-get-invoice-payment does.