Get a purchase order | Distru Documentation

Gets one purchase order (a purchase from a supplier) by ID: header detail with supplier, owner, intake, billing and supplier locations, amount paid and the matched compliance manifest number.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Resolve via distru-search-purchase-orders.
includeOrderItems	boolean	No	Line quantity, receivedQuantity and price (cost per unit) are in product.unitType; receivedQuantity is 0 before PARTIALLY_RECEIVED and equals quantity once COMPLETED; a line has a package only once the purchase is matched to a compliance transfer.
includeOrderCharges	boolean	No	Charges, discounts and taxes.
includePayments	boolean	No	Non-voided payments, oldest paymentDate first; they sum to paid. Their ids work with distru-get-purchase-payment and distru-void-purchase-payment. paymentMethod null when the method was deleted. Their QuickBooks fields read as on distru-get-purchase-payment.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence	Description
purchaseOrder	object	Null or absent
purchaseOrder.id	string	Always
purchaseOrder.customFields	object[]	Always
purchaseOrder.customFields[].customField	object	Always
purchaseOrder.customFields[].customField.id	string	Always
purchaseOrder.customFields[].customField.name	string	Always
purchaseOrder.customFields[].customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
purchaseOrder.customFields[].value	string	Can be null
purchaseOrder.purchaseNumber	string	Always
purchaseOrder.status	enum `COMPLETEDDELIVERINGDRAFTPARTIALLY_RECEIVEDPENDINGPROCESSING`	Always
purchaseOrder.paymentStatus	enum `NOT_PAIDOVER_PAIDPAIDPARTIALLY_PAID`	Always
purchaseOrder.total	string	Always
purchaseOrder.totalCharges	string	Always
purchaseOrder.paid	string	Always
purchaseOrder.orderDate	string	Can be null
purchaseOrder.dueDate	string	Can be null
purchaseOrder.createdDate	string	Always
purchaseOrder.updatedDate	string	Always
purchaseOrder.description	string	Can be null
purchaseOrder.url	string	Always
purchaseOrder.supplier	object	Null or absent
purchaseOrder.supplier.id	string	Always
purchaseOrder.supplier.name	string	Null or absent
purchaseOrder.owner	object	Can be null
purchaseOrder.owner.id	string	Always
purchaseOrder.owner.profile	object	Always
purchaseOrder.owner.profile.fullName	string	Always
purchaseOrder.intakeLocation	object	Can be null
purchaseOrder.intakeLocation.id	string	Always
purchaseOrder.intakeLocation.name	string	Always
purchaseOrder.intakeLocation.address	string	Always
purchaseOrder.billingLocation	object	Can be null
purchaseOrder.billingLocation.id	string	Always
purchaseOrder.billingLocation.name	string	Always
purchaseOrder.billingLocation.address	string	Always
purchaseOrder.supplierLocation	object	Can be null
purchaseOrder.supplierLocation.id	string	Always
purchaseOrder.supplierLocation.name	string	Always
purchaseOrder.supplierLocation.address	string	Always
purchaseOrder.qbBillId	string	Can be null
purchaseOrder.qbSyncStatus	enum `DELETED_IN_QBOERRORNOT_SYNCEDPARTIALLY_SYNCEDPENDINGSYNCED`	Can be null
purchaseOrder.orderItems	object[]	Can be absent
purchaseOrder.orderItems[].id	string	Always
purchaseOrder.orderItems[].quantity	string	Always
purchaseOrder.orderItems[].receivedQuantity	string	Can be null
purchaseOrder.orderItems[].price	string	Always
purchaseOrder.orderItems[].product	object	Always
purchaseOrder.orderItems[].product.id	string	Always
purchaseOrder.orderItems[].product.name	string	Always
purchaseOrder.orderItems[].product.unitType	object	Always
purchaseOrder.orderItems[].product.unitType.id	string	Always
purchaseOrder.orderItems[].product.unitType.name	string	Always
purchaseOrder.orderItems[].batch	object	Can be null
purchaseOrder.orderItems[].batch.id	string	Always
purchaseOrder.orderItems[].batch.name	string	Always
purchaseOrder.orderItems[].location	object	Can be null
purchaseOrder.orderItems[].location.id	string	Always
purchaseOrder.orderItems[].location.name	string	Always
purchaseOrder.orderItems[].package	object	Can be null
purchaseOrder.orderItems[].package.id	string	Always
purchaseOrder.orderItems[].package.metrcLabel	string	Always
purchaseOrder.orderCharges	object[]	Can be absent
purchaseOrder.orderCharges[].id	string	Always
purchaseOrder.orderCharges[].name	string	Always
purchaseOrder.orderCharges[].type	string	Always
purchaseOrder.orderCharges[].unitType	string	Always
purchaseOrder.orderCharges[].percent	string	Can be null
purchaseOrder.orderCharges[].price	string	Always
purchaseOrder.orderCharges[].isTax	boolean	Always
purchaseOrder.payments	object[]	Can be absent
purchaseOrder.payments[].id	string	Always
purchaseOrder.payments[].paymentNumber	string	Always
purchaseOrder.payments[].paymentDate	string	Always
purchaseOrder.payments[].status	enum `POSTEDVOIDED`	Always	VOIDED payments no longer count toward paid.
purchaseOrder.payments[].voidedAt	string	Can be null
purchaseOrder.payments[].amount	string	Always	Dollars, as recorded; a void leaves it unchanged.
purchaseOrder.payments[].paymentMethod	object	Can be null	Null once the method is deleted.
purchaseOrder.payments[].paymentMethod.id	string	Always
purchaseOrder.payments[].paymentMethod.name	string	Always
purchaseOrder.payments[].note	string	Can be null
purchaseOrder.payments[].qbPaymentAccount	string	Can be null	Full name of the QuickBooks Bank or Credit Card account the payment was made from. Null when it has none or the account is not in the QuickBooks cache.
purchaseOrder.payments[].qbBillPaymentId	string	Can be null	Its QuickBooks bill payment ID.
purchaseOrder.payments[].qbSyncStatus	enum `DELETED_IN_QBOERRORNOT_SYNCEDPARTIALLY_SYNCEDPENDINGSYNCED`	Can be null	Null unless the company's QuickBooks module is on and connected. PENDING and ERROR are its latest sync's outcome and win over the rest. A payment syncs only once its purchase has a QuickBooks bill and purchase payment sync is on, so NOT_SYNCED is normal before that.
purchaseOrder.payments[].insertedAt	string	Always
purchaseOrder.payments[].updatedAt	string	Always	Also moves on a void.
purchaseOrder.complianceManifestNumber	string	Can be null	Manifest number of the matched compliance transfer; null when unmatched.

What the AI reads

Gets one purchase order (a purchase from a supplier) by ID: header detail with supplier, owner, intake, billing and supplier locations, amount paid and the matched compliance manifest number. Line items, charges and payments are left out unless you pass includeOrderItems, includeOrderCharges or includePayments. Use for a specific purchase after resolving its ID via distru-search-purchase-orders; to browse purchases use distru-search-purchase-orders; for payments across purchases, distru-search-purchase-payments. intakeLocation is where the inventory is received into; supplierLocation is where the items ship from, null when unset or when the supplier uses Distru itself. A soft-deleted location is null. description is the purchase notes. paid is the sum of the non-voided payments. complianceManifestNumber is null when unmatched. Drafts are returned too (status DRAFT) and may lack supplier, locations, dates and lines. qbBillId is its QuickBooks bill ID. qbSyncStatus is null unless the company's QuickBooks module is on and connected; PENDING and ERROR are its latest sync's outcome and win over the rest; DELETED_IN_QBO = the bill was deleted in QuickBooks; NOT_SYNCED = it has no QuickBooks bill. Bill payment syncs don't count. qbSyncStatus ERROR: distru-search-quickbooks-activities with purchaseOrderIds gives the error. ERROR or NOT_SYNCED: distru-sync-to-quickbooks pushes it, or says why it can't. Null if no purchase matches the ID; a permission error if the caller can't view it.