Invoice a sales order | Distru Documentation

Creates the invoice of a sales order that has none. Reaches QuickBooks unless its total is negative, and your POS (Dutchie, Blaze or Treez) when the customer is mapped to one of its retailers.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
salesOrderId	string	Yes	Sales order to invoice. Resolve via distru-search-sales-orders.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
invoice	object	Always
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[]	Always
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[]	Always
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

Creates the invoice of a sales order that has none, the same invoice Distru creates when an order is saved with invoicing on. Bills every line at its ordered minus returned quantity, in the order's line order, with the order's charges; fully returned lines are left out. Dates, due date, payment term, owner, billing location and notes come from the order; the invoice number is assigned per company. Rejected when the order already has an invoice, voided ones included, even one the caller's team can't see (so an empty distru-get-sales-order includeInvoices doesn't prove there is none); when the order is canceled or merged, has no customer or billing location, its billing location was deleted or isn't the customer's, it lacks the due date or the date the invoice date is taken from, or it has nothing left to bill; when the company's invoice numbering (company settings) gives no number, a taken one or one with special characters; when the order's owner can't own invoices in the caller's team; and when the company's custom invoice rules refuse it. Required invoice custom fields are left empty, since this tool can't set them. Queues a QuickBooks and a POS sync when connected; sends no invoice email. To rebuild an invoice, delete it with distru-delete-invoice and create it again; partial invoices and edits are UI-only. Returns the invoice in distru-get-invoice's shape, with its items and charges. Requires authentication via Authorization header.