Screen flows

• Submit—Validate and save the changes.
• Refresh—Reloads the original data. Any changes made since the last submit are lost.
• Save As—Create a new price book from an existing price book.
• Delete—Confirm and delete the current item.
• New Search—Return to the Search screen and clear the search results and the search criteria.

Header

• Organisation Scope

  Indicates whether this entity is available organisation-wide or laboratory-wide.

  • Checked—The entity is available to users who are logged into any laboratory within the organisation.
  • Unchecked—The entity is only available to users who are logged into the current laboratory.

  Setting the price book's scope upon successful creation depends upon the user's security level for the CCPRICEBOOK:CREATE resource. The possible security levels for the resource, from greater scope to lower scope, are:

  • full—full
  • 3—LAB AND ORG
  • 2—ORG ONLY
  • 1—LAB ONLY

  A user can have multiple roles, and each role can contain different rights. Any of these role-right combinations may contain the resource.

  If the resource does not exist across all role-right combinations for the user, then the user has no access to the resource. Otherwise the user's security level for the resource is determined as the greatest scope across all role-right combinations for the user. For example, if a user has Role1 that contains RightA, and Right A contains security level 2 for the resource, and the same user has Role2 that contains RightB, and RightB contains security level 1 for the resource, then the user has a security level of 2 for the resource.

  The selection in this field can determine the visibility for other fields in this form, and the content of various drop-down selection lists.

• Price Catalogue Code

  The code of the associated price catalogue. Display only.

• Is Active

  Indicates whether the price book is available in drop-down lists. An inactive entity cannot be selected for use.

• Price Catalogue Name

  The name of the price catalogue. Display only.

• Price Catalogue Description

  The description of the price catalogue.

• Price Book Currency

  The currency associated with the price book. Display only.

• Price Book Sequence

  The identifier of the price book within the price catalogue. Although the Identifier is applied in a numerical sequence, incremented by one, if price books are re-sequenced, the identifier remains unchanged. The field name is a bit misleading as it contains the Price Book Identifier which is the sequence in which the price book was created within the price catalogue, but is not updated when price books are re-sequenced within the price catalogue, that is, it remains unchanged. Display only.

• Name

  The name of the price book.

• Description

  The description of the price book.

• Start Date

  The date-time from which the price book is active.

• End Date

  The date-time up to which the price book is active.

Search Price Codes Criteria

The search criteria used to return price schedules to the Price Schedule Grid.

• Price Type

  Search price schedules by the price type of an associated price code.

• Scheme Code

  Search price schedules by an associated scheme.

• Return Only Unpriced Schedules

  Search price schedules only where no pricing details exist within price books.

• Price Code

  Search price schedules by an associated price code.

  Where the price schedule is opened in context of a price book within a price catalogue, then this defaults to the scheme or analyte's Price Code.

  Where the price schedule is opened in context of a quote, then this defaults to a concatenation of the Quote Code and a numerical running sequence for price schedules within the quote.

  A price code links a costed or priced entity to a price schedule, that is, they are the master codes for invoiced or costed entities.

  Note that a price book can only contain one occurrence of any price code.

• Price Code Name

  Search price schedules by the name of an associated price code.

• Price Type

  Search price schedules by the price type of an associated price code. A scheme's Price Type can be:

  • Not Priced—The scheme and its analytes are not costed nor invoiced.

  • Sample-Based—The scheme is charged on a ’per sample’ basis with underlying granularity to allow for sliding scale charging based on sample numbers associated with the invoice, regardless of the scheme type or the number of invoiceable analytes in the scheme associated with the invoice. The scheme must be linked to a Price Code where the price code's Price Type is Sample-Based.

  • Scheme-Based—The scheme is charged on a ’per scheme’ basis with underlying granularity to allow for sliding scale charging based on the number of costed or invoiceable analytes in the scheme associated with the invoice. The scheme must be linked to a Price Code where the price code's Price Type is Scheme-Based.

  • Unit-Based—The scheme is charged on a ’per unit’ basis, where a unit is typically a measure of duration (for example, based on the number of hours taken to perform a job scheme, or the number of kilometres travelled for preparation), with underlying granularity to allow for sliding scale charging based on the number of invoiceable units in the scheme associated with the invoice. The scheme must be linked to a Price Code where the price code's Price Type is Unit-Based.

  • Analyte-Based—The scheme is charged based on the presence of a result on a ’per analyte’ basis with underlying granularity to allow for sliding scale charging based on the magnitude of the analytical result. The invoiceable analytes within the scheme must be linked to a Price Code where the price code's Price Type is Analyte-Based.

• Base Price

  A base price that applies to the invoiceable item as a set up fee. The base price is applied separately to the block price, that is, one line item is raised for the base price and one line item is raised for the block price for an invoiced item.

• Base Price Note

  The note on an invoice line item accompanying the base price. Defaults to the price code's Price Code Default Base Price Note. Multi-language support. When the price schedule is used to raise an invoice line item, then the base price note on the invoice line item is flattened to contain content only in the language in which the invoice is raised.

• Fixed Block Price

  A fixed price that applies to the entire invoiceable item amount, instead of applying a sliding-scale of pricing based on the magnitude of the invoiceable item. Must be a real number, and greater than zero. If a Fixed Block Price is not entered, then the price schedule items grid displays and is used in the pricing of line items.

• Block Price Note

  The note on an invoice line item accompanying the block price. Defaults to the price code's Defaults to Price Code Default Block Price Note. Multi-language support. When the price schedule is used to raise an invoice line item, then the bloc price note on the invoice line item is flattened to contain content only in the language in which the invoice is raised.

• Aggregate Items

  Indicates whether invoice line items are aggregated across all the defined ranges to determine sliding-scale pricing based on the magnitude of the invoiceable item.

  • Unchecked—The pricing engine goes directly at the row where the invoiceable item amount <= Up To and applies the pricing from that row for the entire invoiceable item amount, and if such a row is not found, then to apply no pricing for that invoiceable item amount.

  • Checked—The pricing engine starts at the first row of the price schedule items grid and applies pricing to that proportion of invoiceable amount up to the Up To defined for the row, such that, the block price is a total charge for samples falling into that range. Then the pricing engine moves to the next row and applies pricing to the proportion of invoiceable amount from the previous range up to the Up To defined for the row, such that, the block price is a total charge for samples falling into that range. The pricing engine repeats this across all ranges until all of the invoiceable amounts are priced, and then aggregates these amounts s to determine the pricing for the entire invoiceable amount. Note that if the number of invoiceable items exceeds the uppermost Up To value in the price schedule items collection, then the pricing is set based only upon the cumulation of lower level line items. Note that if Aggregate Items is checked, then negative numbers cannot be entered in Up To.