ecl-logo Documentation

PriceStocking

PriceStocking[protocol]table

provides a table listing the pricing information for the restocking of public samples generated during protocol.

PriceStocking[notebook]table

provides a table listing the pricing information for the restocking of public samples affiliated with notebook within the last month.

PriceStocking[notebook, dateRange]table

provides a table listing the pricing information for the restocking of public samples affiliated with notebook in the time period defined by the dateRange.

PriceStocking[team]table

provides a table listing the pricing information for the restocking of public samples affiliated with notebooks financed by team in the last month.

PriceStocking[team, dateRange]table

provides a table listing the pricing information for the restocking of public samples affiliated with notebooks financed by team in the time period defined by the dateRange.

Details

  • By default, if Teams or Notebooks are specified and no date range is provided, the function defaults to include restockable objects used by protocols which completed in the past 30 days.
  • Note that the prices displayed in this documentation are only for the sake of example and do not represent actual prices.
  • In order to find the up to date price for stocking a particular model, please download the StockingPricing field of the relevant Object[Bill].
  • Input
    Output
    General Options
    Messages
  • ParentProtocolRequiredThe following provided protocol(s) are subprotocols: `1`. These protocols' prices are already included in the restocking pricing of their parent protocols. Please provide only completed parent protocols to the inputs of PriceMaterials.
    ProtocolNotCompletedThe following provided protocol(s) are not yet completed and thus restocking pricing for materials used cannot be calculated: `1`. Please wait until these protocols are completed and then call this function again.

Examples

Basic Examples  (5)

Displays the pricing information for restocking of public samples used in a protocol as a table:

Displays the pricing information for a list of protocols as one large table:

Displays the pricing information for all protocols tied to a given notebook:

Displays the pricing information for all protocols tied to a given financing team:

Specifying a date span excludes protocols that fall outside that range:

Additional Examples  (2)

If a protocol has been refunded, include it in the pricing to reflect the refunded price:

Date span can go in either order:

Options  (8)

Consolidation  (6)

Specifying Consolidation -> Notebook groups all items by Notebook and sums their prices in the output table:

Specifying Consolidation -> Protocol groups all items by Protocol and sums their prices in the output table:

Specifying Consolidation -> Container groups all items by Model object and sums their prices in the output table:

Specifying Consolidation -> CleaningMethod groups all items by their storage condition and sums their prices in the output table:

If OutputFormat -> TotalPrice is specified, this overrides the Consolidation option and returns the total summed price:

If OutputFormat -> Association is specified, this overrides the Consolidation option and returns a list of associations matching StockingPriceTableP:

OutputFormat  (2)

If OutputFormat -> Association, returns a list of associations matching StockingPriceTableP:

If OutputFormat -> TotalPrice, returns a single price summing the restocking cost for all objects:

Messages  (2)

ParentProtocolRequired  (1)

Throws an error if PriceStocking is called on a subprotocol:

ProtocolNotCompleted  (1)

Throws an error if PriceStocking is called on a protocol that is not Completed: