ParcelPilot
Help

Pricing Metrics

Pricing Metrics define the standard billing codes used for charging things like pick and pack, storage, and shipping.

Each metric is identified by a stable code used by the billing system.

Who can access this page

Pricing Metrics are restricted to users with the right billing configuration access.

Key fields

  • Code: the stable identifier used in calculations and tariffs.
    • The code cannot be changed after creation.
  • Label: human-friendly name shown in UIs/reports.
  • Unit: optional billing unit, such as per order, per item, per pallet week, or per consignment.
  • Category: optional grouping label (used for sorting/grouping).
  • Active: whether the metric is available for use.
  • System / Requires admin: flags used to protect core metrics and prevent accidental semantic changes.
  • Aliases: deprecated codes that should be treated as this metric.

Why aliases matter:

  • Aliases let you rename/standardise codes without breaking old tariffs or historical data. Other parts of the system can resolve “stored code → canonical code”.

Common workflows

Add a new metric

  1. Go to Billing → Pricing Metrics.
  2. Click Create.
  3. Enter a Code, Label, and (optionally) Unit/Category.
  4. Save.

Example:

  • To bill scrapped returns automatically in Monthly Operations, add a metric such as:
  • Code: return_disposal
  • Label: Return disposal / recycle
  • Unit: per item
  • Category: Returns

Deprecate/rename a code

To preserve historical compatibility:

  1. Keep the existing metric as the canonical destination.
  2. Add the old code into Aliases.

Result:

  • Existing records using the old code can be recognised and migrated/normalised to the canonical code.

Actions

  • Create: add a new metric code.
  • Edit: update label/unit/category and flags.
  • Deactivate: set Active = off to prevent future use without breaking history.

Note: metric codes are treated as stable identifiers; prefer deactivating instead of deleting when you need to retire a code.