Get an invoice payment | Distru Documentation

Gets one payment received against an invoice by ID, with the credits it used (creditUses) and the credits its overpayment created (overpaymentCredits).

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	Can be null
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

Gets one payment received against an invoice by ID, with the credits it used (creditUses) and the credits its overpayment created (overpaymentCredits). To browse or filter payments use distru-search-invoice-payments. appliedAmount is what counts toward the invoice's paid amount: received.amount + creditAmount = appliedAmount + overpaidAmount, and overpaidAmount became customer credit. received is null when the payment was made entirely with credit. A VOIDED payment keeps its amounts as recorded, so leave it out of totals. customer and invoice are null when the caller's team can't see them. qbSyncStatus ERROR: distru-search-quickbooks-activities with paymentIds gives the error. ERROR or NOT_SYNCED: distru-sync-to-quickbooks pushes it, or says why it can't. creditUses is empty once the payment is voided, and overpaymentCredits are then CANCELED. overpaymentCredits lists only credits the caller's team can see, none without permission to view credits, while overpaidAmount counts them all. Null if no invoice payment matches the ID; a permission error if the caller can't view it. A purchase payment's ID is null here too: read it with distru-get-purchase-payment.