Get a customer credit | Distru Documentation

Gets one customer credit by ID, with where it came from (sourcePayment or sourceReturn) and where it was applied (creditUses); line items and history are opt-in.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-credits.
includeCreditActivities	boolean	No	History, oldest first. creditUse is set on a CREDIT_USED or CREDIT_USE_DELETED entry: what was applied or released. _IN_QBO types came from QuickBooks.
includeCreditItems	boolean	No	Line items, each product line followed by its tax lines; tax is set only on a tax line. price is per unit.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
credit	object	Can be null
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
credit.creditItems	object[]	Can be absent
credit.creditItems[].quantity	string	Always
credit.creditItems[].price	string	Always
credit.creditItems[].description	string	Can be null
credit.creditItems[].product	object	Always
credit.creditItems[].product.id	string	Always
credit.creditItems[].product.name	string	Always
credit.creditItems[].package	object	Can be null
credit.creditItems[].package.id	string	Always
credit.creditItems[].package.metrcLabel	string	Always
credit.creditItems[].tax	object	Can be null
credit.creditItems[].tax.id	string	Always
credit.creditItems[].tax.name	string	Always
credit.creditActivities	object[]	Can be absent
credit.creditActivities[].type	enum `CREDIT_CANCELEDCREDIT_CANCELED_IN_QBOCREDIT_CREATEDCREDIT_CREATED_IN_QBOCREDIT_DELETEDCREDIT_DELETED_IN_QBOCREDIT_EDITEDCREDIT_EDITED_IN_QBOCREDIT_USE_DELETEDCREDIT_USE_DELETED_IN_QBOCREDIT_USEDCREDIT_USED_IN_QBO`	Always
credit.creditActivities[].insertedAt	string	Always
credit.creditActivities[].user	object	Can be null
credit.creditActivities[].user.id	string	Always
credit.creditActivities[].user.profile	object	Always
credit.creditActivities[].user.profile.fullName	string	Always
credit.creditActivities[].creditUse	object	Can be null
credit.creditActivities[].creditUse.amount	string	Always
credit.creditActivities[].creditUse.payment	object	Can be null
credit.creditActivities[].creditUse.payment.id	string	Always
credit.creditActivities[].creditUse.payment.paymentNumber	string	Always

What the AI reads

Gets one customer credit by ID, with where it came from (sourcePayment or sourceReturn) and where it was applied (creditUses); line items and history are opt-in. To browse or filter credits use distru-search-credits. amount is the current face value, originalAmount the value at issue. remainingBalance is amount minus the credit already applied; a CANCELED credit keeps its balance but can't be spent, so leave CANCELED credits out of what a customer has available. INVOICE_PAYMENT and QB_PAYMENT credits are a payment's overpayment. customer is null when the caller's team can't see it. qbSyncStatus ERROR: distru-search-quickbooks-activities with creditIds gives the error. ERROR or NOT_SYNCED: distru-sync-to-quickbooks pushes it, or says why it can't. creditUses lists live uses only, oldest first: a use released by a void, a reversing cancel or a QuickBooks change is left out, and creditActivities records it. sourcePayment is null once its invoice is deleted or hidden from the caller's team, and sourceReturn once the return is removed or hidden; a credit use's payment and invoice are null when the team can't see that invoice. Null if no credit matches the ID; a permission error if the caller can't view it.