Update a customer credit | Distru Documentation

Changes a customer credit's amount, notes or owner. Reaches QuickBooks when your settings sync credits and the customer is linked there, unless only the owner changes or the credit came from a QuickBooks credit memo.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-credits.
amount	string or number	No	Dollars, the new face value. Only on a USER credit, and not below what has been applied (amount minus remainingBalance).
externalNote	string	No	Visible to the customer; "" clears it. Not on a QB_CREDIT_MEMO credit: QuickBooks owns its notes.
internalNote	string	No	Staff only; "" clears it. Not on a QB_CREDIT_MEMO credit: QuickBooks owns its notes.
ownerId	string	No	An active user whose credits the caller's team can see. Resolve via distru-search-users.

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

Sparse update: changes a customer credit's amount, notes or owner; the fields left out stay as they are. Returns the credit as distru-get-credit does, without line items or history.