Cancel a customer credit | Distru Documentation

Cancels what's left on a customer credit so it can't be spent. Reaches QuickBooks when your settings sync credits and the customer is linked there, unless the credit came from an overpayment.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-credits. Not a QB_PAYMENT credit: it follows its payment's unapplied amount in QuickBooks.
alsoReverseApplications	boolean	No	Also remove its uses: each invoice they paid owes that amount again, and a payment left at zero is voided and deleted (distru-search-invoice-payments no longer returns it), releasing any other credit it used.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
credit	object	Always
credit.id	string	Always
credit.creditNumber	string	Always
credit.status	enum `ACTIVECANCELEDREDEEMED`	Always
credit.source	enum `INVOICE_PAYMENTQB_CREDIT_MEMOQB_PAYMENTRETURNUSER`	Always
credit.amount	string	Always
credit.originalAmount	string	Always
credit.remainingBalance	string	Always
credit.customer	object	Can be null
credit.customer.id	string	Always
credit.customer.name	string	Null or absent
credit.owner	object	Can be null
credit.owner.id	string	Always
credit.owner.profile	object	Always
credit.owner.profile.fullName	string	Always
credit.externalNote	string	Can be null
credit.internalNote	string	Can be null
credit.qbCreditMemoId	string	Can be null
credit.qbPaymentId	string	Can be null
credit.qbSyncStatus	enum `DELETED_IN_QBOERRORNOT_SYNCEDPARTIALLY_SYNCEDPENDINGSYNCED`	Can be null
credit.insertedAt	string	Always
credit.updatedAt	string	Always
credit.canceledAt	string	Can be null
credit.sourcePayment	object	Can be null
credit.sourcePayment.id	string	Always
credit.sourcePayment.paymentNumber	string	Always
credit.sourcePayment.invoice	object	Can be null
credit.sourcePayment.invoice.id	string	Always
credit.sourcePayment.invoice.invoiceNumber	string	Always
credit.sourceReturn	object	Can be null
credit.sourceReturn.id	string	Always
credit.sourceReturn.returnNumber	string	Always
credit.creditUses	object[]	Always
credit.creditUses[].amount	string	Always
credit.creditUses[].appliedAt	string	Always
credit.creditUses[].payment	object	Can be null
credit.creditUses[].payment.id	string	Always
credit.creditUses[].payment.paymentNumber	string	Always
credit.creditUses[].invoice	object	Can be null
credit.creditUses[].invoice.id	string	Always
credit.creditUses[].invoice.invoiceNumber	string	Always

What the AI reads

Cancels a customer credit's remaining balance, so it can no longer be spent; what it already paid stays applied unless alsoReverseApplications is set. An INVOICE_PAYMENT credit can't be canceled: it goes away only by voiding the payment that created it (sourcePayment.id) with distru-void-invoice-payment, which also takes that payment off its invoice and reverses the credit's uses. Rejected when the credit is already canceled, unless reversing its uses. Returns the credit as distru-get-credit does, without line items or history.