Get an invoice | Distru Documentation

Gets one invoice by ID: header detail with totals, paid and remaining amounts, dates, customer, owner, billing location and sales order.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-invoices.
includeInvoiceItems	boolean	No
includeInvoiceCharges	boolean	No	Charges, discounts and taxes.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
invoice	object	Null or absent
invoice.id	string	Always
invoice.customFields	object[]	Always
invoice.customFields[].customField	object	Always
invoice.customFields[].customField.id	string	Always
invoice.customFields[].customField.name	string	Always
invoice.customFields[].customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
invoice.customFields[].value	string	Can be null
invoice.invoiceNumber	string	Always
invoice.paymentStatus	enum `NOT_PAIDOVER_PAIDPAIDPARTIALLY_PAID`	Always
invoice.total	string	Always
invoice.subtotal	string	Always
invoice.paid	string	Always
invoice.remainingAmount	string	Always
invoice.creditsApplied	string	Can be null
invoice.paymentsCollected	string	Always
invoice.invoiceDate	string	Always
invoice.dueDate	string	Always
invoice.externalNotes	string	Can be null
invoice.paymentTermName	string	Can be null
invoice.qbInvoiceId	string	Can be null
invoice.qbSyncStatus	enum `DELETED_IN_QBOERRORNOT_SYNCEDPARTIALLY_SYNCEDPENDINGSYNCED`	Can be null
invoice.voidedAt	string	Can be null
invoice.createdDate	string	Always
invoice.updatedDate	string	Always
invoice.customer	object	Null or absent
invoice.customer.id	string	Always
invoice.customer.name	string	Null or absent
invoice.owner	object	Can be null
invoice.owner.id	string	Always
invoice.owner.profile	object	Always
invoice.owner.profile.fullName	string	Always
invoice.salesOrder	object	Can be null
invoice.salesOrder.id	string	Always
invoice.salesOrder.orderNumber	string	Always
invoice.billingLocation	object	Can be null
invoice.billingLocation.id	string	Always
invoice.billingLocation.name	string	Always
invoice.billingLocation.address	string	Always
invoice.invoiceItems	object[]	Can be absent
invoice.invoiceItems[].id	string	Always
invoice.invoiceItems[].quantity	string	Always
invoice.invoiceItems[].orderItem	object	Always
invoice.invoiceItems[].orderItem.id	string	Always
invoice.invoiceItems[].orderItem.price	string	Always
invoice.invoiceItems[].orderItem.priceBase	string	Always
invoice.invoiceItems[].orderItem.isSample	boolean	Always
invoice.invoiceItems[].orderItem.note	string	Can be null
invoice.invoiceItems[].orderItem.product	object	Always
invoice.invoiceItems[].orderItem.product.id	string	Always
invoice.invoiceItems[].orderItem.product.name	string	Always
invoice.invoiceItems[].orderItem.batch	object	Can be null
invoice.invoiceItems[].orderItem.batch.id	string	Always
invoice.invoiceItems[].orderItem.batch.name	string	Always
invoice.invoiceItems[].orderItem.location	object	Can be null
invoice.invoiceItems[].orderItem.location.id	string	Always
invoice.invoiceItems[].orderItem.location.name	string	Always
invoice.invoiceCharges	object[]	Can be absent
invoice.invoiceCharges[].id	string	Always
invoice.invoiceCharges[].name	string	Always
invoice.invoiceCharges[].type	string	Always
invoice.invoiceCharges[].unitType	string	Always
invoice.invoiceCharges[].percent	string	Can be null
invoice.invoiceCharges[].price	string	Always
invoice.invoiceCharges[].isTax	boolean	Always

What the AI reads

Gets one invoice by ID: header detail with totals, paid and remaining amounts, dates, customer, owner, billing location and sales order. Line items and charges are left out unless you pass includeInvoiceItems or includeInvoiceCharges. Use for a specific invoice after resolving its ID via distru-search-invoices (search takes an invoice number, e.g. one from distru-report-invoice-history); to browse invoices use distru-search-invoices. For its payments, use distru-search-invoice-payments with invoiceIds. salesOrder is null if the caller lacks access to the underlying order or none exists. qbSyncStatus ERROR: distru-search-quickbooks-activities with invoiceIds gives the error. ERROR or NOT_SYNCED: distru-sync-to-quickbooks pushes it, or says why it can't. Null if no invoice matches the ID; a permission error if the caller can't view it.