PriceMaterials
PriceMaterials[protocol]⟹table
provides a table listing the pricing information for all materials used by protocol.
PriceMaterials[transaction]⟹table
provides a table listing the pricing information for all materials in transaction.
PriceMaterials[notebook]⟹table
provides a table listing the pricing information for all materials from completed protocols or from received transaction orders in notebook within the last month.
PriceMaterials[notebook, dateRange]⟹table
provides a table listing the pricing information for all materials from completed protocols or from received transaction orders in notebook in the time period defined by the dateRange.
PriceMaterials[team]⟹table
provides a table listing the pricing information for all materials from completed protocols or from received transaction orders in notebooks financed by team within the last month.
PriceMaterials[team, dateRange]⟹table
provides a table listing the pricing information from completed protocols or from received transaction orders in notebooks financed by team in the time period defined by the dateRange.
Details
- The pricing of protocols is based on the list price of each given material and how much of that material was used, plus the applicable sales tax rate depending on the location of the ECL facility where the protocol was performed.
- The pricing of transaction orders (items ordered from a supplier) is based on the list price of each given material and the quantity ordered, plus the applicable sales tax rate depending on the location of the ECL facility where the transaction was shipped to.
- For clarity, the pricing components (product list price and tax price) are displayed as individual entries in the output association or table.
- Pricing information is only calculated for completed parent protocols and non-cancelled transactions.
- For the Team or Notebook overloads, only completed protocols and received transaction orders are priced; non-completed and/or non-parent protocols as-well as pending transactions are filtered out and not displayed in the output.
- By default, if Teams or Notebooks are specified and no date range is provided, the function defaults to showing protocols and transactions completed in the past 30 days.
- Note that the prices displayed in this documentation are only for the sake of presentation and do not represent actual prices.
- In order to find the real list price for a material, please Download the Price field from the corresponding Object[Product].
- In order to find the applicable sale tax rate, please Download the SalesTaxRate field from the Model[Container,Site] object corresponding to the ECL site the user is submitting his protocols.
-
MissingProductInformation The following materials are not associated with a product, or if a stock solution do not have Price populated in the model and thus do not have pricing information available: `1`. These materials have been filtered out of the displayed results. ParentProtocolRequired The following provided protocol(s) are subprotocols: `1`. These protocols' prices are already included in the price of their parent protocols. Please provide only completed parent protocols to the inputs of PriceMaterials. ProtocolNotCompleted The following provided protocol(s) are not yet completed and thus pricing for materials used cannot be calculated: `1`. Please wait until these protocols are completed and then call this function again. SiteNotFound The site at which the protocol `1` was run could not be determined. Please provide only completed protocols that are passing ValidObjectQ.
Input
Output
General Options
Messages
Examples
Basic Examples (5)
Displays the pricing information for each material used in a given protocol as a table:
Displays the pricing information for each material ordered in a given transaction order as a table:
Displays the pricing information for a list of protocols and transactions 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:
Additional Examples (4)
Options (8)
Consolidation (3)
Specifying Consolidation -> Notebook groups all items by Notebook and sums their prices in the output table:
Specifying Consolidation -> Source groups all items by Source and sums their prices in the output table:
Specifying Consolidation -> Material groups all items by Material and sums their prices in the output table:
OutputFormat (5)
If OutputFormat -> Association, returns a list of associations matching MaterialsPriceTableP:
If OutputFormat -> TotalPrice, returns a single price summing the cost of all materials:
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 MaterialsPriceTableP:
If OutputFormat -> Association is specified, this overrides the Consolidation option and returns a list of associations matching MaterialsPriceTableP:
