Add inventory costs | Distru Documentation

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
packageId	string	No	Send exactly one of packageId, batchId or productId. Resolve via distru-search-packages.
batchId	string	No	A batch of a batch-tracked product. Resolve via distru-search-batches.
productId	string	No	A product-tracked product; package- and batch-tracked products take costs per package or batch. Resolve via distru-search-products.
locationIds	string[]	No	batchId or productId only: spread the costs over the stock at these locations only; default all. Resolve via distru-search-locations.
expectedQuantity	string or number	Yes	The record's quantity on hand as you last read it, in its unit type; refused when it has changed since. packageId: quantity from distru-get-package. batchId: quantity from distru-get-batch. productId: quantityActive from distru-get-product. With locationIds: the sum of those locations' activeQuantitiesByLocation.
costs	object[]	Yes
costs[].costTypeId	string	Yes	Resolve via distru-search-lookups (type COST_TYPE).
costs[].quantity	string or number	Yes	Greater than 0, in the cost type's unit type.
costs[].costPerUnit	string or number	No	Dollars per unit of the cost type's unit type. Defaults to the cost type's costPerUnit; refused when the cost type's allowInlineEdits is false.
costs[].description	string	No

Output

This tool returns one of 3 shapes, depending on its inputs.

Presence on a nested field assumes its parent exists.

Result with package

Field	Type	Presence
costs	object[]	Always
costs[].name	string	Always
costs[].description	string	Can be null
costs[].costType	object	Can be null
costs[].costType.id	string	Always
costs[].costType.name	string	Always
costs[].createdBy	object	Can be null
costs[].createdBy.id	string	Always
costs[].createdBy.fullName	string	Always
costs[].insertedAt	string	Always
costs[].origin	object	Always
costs[].origin.type	enum `ASSEMBLYBIOTRACK_ADJUSTMENTBIOTRACK_MANIFEST_RECEIVEDBREAKDOWNCOST_ENTRYMETRC_ADJUSTMENTMETRC_TRANSFER_RECEIVEDOTHERPACKAGE_IMPORTPLANT_BATCH_PACKAGINGPURCHASE_ORDERSTOCK_ADJUSTMENT`	Always
costs[].origin.purchaseOrder	object	Can be null
costs[].origin.purchaseOrder.id	string	Always
costs[].origin.purchaseOrder.purchaseNumber	string	Always
costs[].origin.assembly	object	Can be null
costs[].origin.assembly.id	string	Always
costs[].origin.assembly.number	string	Always
costs[].origin.breakdown	object	Can be null
costs[].origin.breakdown.breakdownNumber	string	Can be null
costs[].recordedOn	object	Always
costs[].recordedOn.type	enum `PACKAGEBATCHPRODUCTHARVESTPLANTPLANT_BATCHMULTIPLE_PLANTSNONE`	Always
costs[].recordedOn.product	object	Can be null
costs[].recordedOn.product.id	string	Always
costs[].recordedOn.product.name	string	Always
costs[].recordedOn.product.sku	string	Always
costs[].recordedOn.package	object	Can be null
costs[].recordedOn.package.id	string	Always
costs[].recordedOn.package.metrcLabel	string	Always
costs[].recordedOn.batch	object	Can be null
costs[].recordedOn.batch.id	string	Always
costs[].recordedOn.batch.name	string	Always
costs[].recordedOn.harvest	object	Can be null
costs[].recordedOn.harvest.name	string	Always
costs[].recordedOn.plant	object	Can be null
costs[].recordedOn.plant.label	string	Can be null
costs[].recordedOn.plant.strainName	string	Can be null
costs[].recordedOn.plantBatch	object	Can be null
costs[].recordedOn.plantBatch.name	string	Always
costs[].recordedOn.plantBatch.strainName	string	Can be null
costs[].recordedOn.multiplePlants	object	Can be null
costs[].recordedOn.multiplePlants.summary	string	Always
costs[].recordedOn.multiplePlants.details	string	Always
costs[].quantity	string	Always
costs[].costQuantity	string	Always
costs[].unitType	object	Always
costs[].unitType.id	string	Always
costs[].unitType.name	string	Always
costs[].costPerUnit	string	Can be null
costs[].totalCost	string	Can be null
package	object	Always
package.id	string	Always
package.metrcLabel	string	Always
package.quantity	string	Always
package.quantityCost	string	Can be null

Result with batch

Field	Type	Presence
costs	object[]	Always
costs[].name	string	Always
costs[].description	string	Can be null
costs[].costType	object	Can be null
costs[].costType.id	string	Always
costs[].costType.name	string	Always
costs[].createdBy	object	Can be null
costs[].createdBy.id	string	Always
costs[].createdBy.fullName	string	Always
costs[].insertedAt	string	Always
costs[].origin	object	Always
costs[].origin.type	enum `ASSEMBLYBIOTRACK_ADJUSTMENTBIOTRACK_MANIFEST_RECEIVEDBREAKDOWNCOST_ENTRYMETRC_ADJUSTMENTMETRC_TRANSFER_RECEIVEDOTHERPACKAGE_IMPORTPLANT_BATCH_PACKAGINGPURCHASE_ORDERSTOCK_ADJUSTMENT`	Always
costs[].origin.purchaseOrder	object	Can be null
costs[].origin.purchaseOrder.id	string	Always
costs[].origin.purchaseOrder.purchaseNumber	string	Always
costs[].origin.assembly	object	Can be null
costs[].origin.assembly.id	string	Always
costs[].origin.assembly.number	string	Always
costs[].origin.breakdown	object	Can be null
costs[].origin.breakdown.breakdownNumber	string	Can be null
costs[].recordedOn	object	Always
costs[].recordedOn.type	enum `PACKAGEBATCHPRODUCTHARVESTPLANTPLANT_BATCHMULTIPLE_PLANTSNONE`	Always
costs[].recordedOn.product	object	Can be null
costs[].recordedOn.product.id	string	Always
costs[].recordedOn.product.name	string	Always
costs[].recordedOn.product.sku	string	Always
costs[].recordedOn.package	object	Can be null
costs[].recordedOn.package.id	string	Always
costs[].recordedOn.package.metrcLabel	string	Always
costs[].recordedOn.batch	object	Can be null
costs[].recordedOn.batch.id	string	Always
costs[].recordedOn.batch.name	string	Always
costs[].recordedOn.harvest	object	Can be null
costs[].recordedOn.harvest.name	string	Always
costs[].recordedOn.plant	object	Can be null
costs[].recordedOn.plant.label	string	Can be null
costs[].recordedOn.plant.strainName	string	Can be null
costs[].recordedOn.plantBatch	object	Can be null
costs[].recordedOn.plantBatch.name	string	Always
costs[].recordedOn.plantBatch.strainName	string	Can be null
costs[].recordedOn.multiplePlants	object	Can be null
costs[].recordedOn.multiplePlants.summary	string	Always
costs[].recordedOn.multiplePlants.details	string	Always
costs[].quantity	string	Always
costs[].costQuantity	string	Always
costs[].unitType	object	Always
costs[].unitType.id	string	Always
costs[].unitType.name	string	Always
costs[].costPerUnit	string	Can be null
costs[].totalCost	string	Can be null
batch	object	Always
batch.id	string	Always
batch.name	string	Always
batch.quantity	string	Always
batch.activeQuantityCost	string	Can be null

Result with product

Field	Type	Presence
costs	object[]	Always
costs[].name	string	Always
costs[].description	string	Can be null
costs[].costType	object	Can be null
costs[].costType.id	string	Always
costs[].costType.name	string	Always
costs[].createdBy	object	Can be null
costs[].createdBy.id	string	Always
costs[].createdBy.fullName	string	Always
costs[].insertedAt	string	Always
costs[].origin	object	Always
costs[].origin.type	enum `ASSEMBLYBIOTRACK_ADJUSTMENTBIOTRACK_MANIFEST_RECEIVEDBREAKDOWNCOST_ENTRYMETRC_ADJUSTMENTMETRC_TRANSFER_RECEIVEDOTHERPACKAGE_IMPORTPLANT_BATCH_PACKAGINGPURCHASE_ORDERSTOCK_ADJUSTMENT`	Always
costs[].origin.purchaseOrder	object	Can be null
costs[].origin.purchaseOrder.id	string	Always
costs[].origin.purchaseOrder.purchaseNumber	string	Always
costs[].origin.assembly	object	Can be null
costs[].origin.assembly.id	string	Always
costs[].origin.assembly.number	string	Always
costs[].origin.breakdown	object	Can be null
costs[].origin.breakdown.breakdownNumber	string	Can be null
costs[].recordedOn	object	Always
costs[].recordedOn.type	enum `PACKAGEBATCHPRODUCTHARVESTPLANTPLANT_BATCHMULTIPLE_PLANTSNONE`	Always
costs[].recordedOn.product	object	Can be null
costs[].recordedOn.product.id	string	Always
costs[].recordedOn.product.name	string	Always
costs[].recordedOn.product.sku	string	Always
costs[].recordedOn.package	object	Can be null
costs[].recordedOn.package.id	string	Always
costs[].recordedOn.package.metrcLabel	string	Always
costs[].recordedOn.batch	object	Can be null
costs[].recordedOn.batch.id	string	Always
costs[].recordedOn.batch.name	string	Always
costs[].recordedOn.harvest	object	Can be null
costs[].recordedOn.harvest.name	string	Always
costs[].recordedOn.plant	object	Can be null
costs[].recordedOn.plant.label	string	Can be null
costs[].recordedOn.plant.strainName	string	Can be null
costs[].recordedOn.plantBatch	object	Can be null
costs[].recordedOn.plantBatch.name	string	Always
costs[].recordedOn.plantBatch.strainName	string	Can be null
costs[].recordedOn.multiplePlants	object	Can be null
costs[].recordedOn.multiplePlants.summary	string	Always
costs[].recordedOn.multiplePlants.details	string	Always
costs[].quantity	string	Always
costs[].costQuantity	string	Always
costs[].unitType	object	Always
costs[].unitType.id	string	Always
costs[].unitType.name	string	Always
costs[].costPerUnit	string	Can be null
costs[].totalCost	string	Can be null
product	object	Always
product.id	string	Always
product.name	string	Always
product.quantityActive	string	Always
product.activeQuantityCost	string	Can be null

What the AI reads

Adds costs to one package, batch or product, spread over its quantity on hand. Each cost adds costPerUnit × quantity to the record's total cost, not to each unit. Not idempotent: calling twice adds the costs twice. Distru cost accounting only; nothing is sent to Metrc. Returns the added costs in the get tools' cost breakdown shape, and the record with its total cost after the change: quantityCost (package) or activeQuantityCost (batch, product), not per unit; null when the caller cannot view costs.