Item

Get the unit cost Fulcrum's BOM costing assigns to an item consumed as a routing input at a given quantity, and the basis it used.

Changed on
get/api/items/{itemId}/costing/unit-cost

Request

  • Base URL
    https://api.fulcrumpro.com
  • URL
    https://api.fulcrumpro.com/api/items/{itemId}/costing/unit-cost
  • Auth
    none declared

Path parameters

itemIdstring required

Id of the item to cost.

Query parameters

quantitynumber double required

Total quantity of the item consumed, in its inventory unit of measure. Must be greater than zero and at most 2147483647.

Response

The item's unit cost at the given quantity.

unitCostnumber double nullable

Cost per unit of the item's inventory unit of measure, in currencyCode. Null when Fulcrum costs the item at nothing.

basis'none' | 'vendorPriceBreak' | 'vendorPrice' | 'inventoryValue' | 'inventoryAndVendor' | 'materialVendor' required

The source that priced an item's input unit cost.

priceBreakQuantityinteger nullable

The starting quantity, in the item's inventory unit of measure, of the vendor price break that priced the vendor portion. Null unless that portion came from a vendor price break.

currencyCodestring required

The currency unitCost is expressed in: the company's primary currency, or unconvertedVendorCurrencyCode when that is set and basis is vendorPriceBreak, vendorPrice or materialVendor.

unitOfMeasureNamestring nullable

The item's inventory unit of measure, which unitCost is per.

unconvertedVendorCurrencyCodestring nullable

The currency of the vendor pricing that contributed to unitCost when it is not the primary currency and has no exchange rate, so it was used unconverted. Null when the vendor pricing was converted or in the primary currency, or no vendor pricing contributed. With inventoryAndVendor, unitCost mixes this currency with the primary currency.

Changes