Skip to content

Sales Orders

Sales Orders

Sales orders allow to track which stock items are sold to customers, therefore converting stock items / inventory into externally sold items.

To access the sales order page, click on the Sell navigation tab and click on Sales Orders option in the dropdown list.

Sales Order List Sales Order List

Sales Order Reference

Each Sales Order is uniquely identified by a Reference field.

Reference Pattern

New in v0.8.0

Reference patterns were introduced in version 0.8.0. Users upgrading from an older version may find that the reference fields behave slightly differently than previous versions.

The Sales Order reference field must conform to a (configurable) pattern, allowing users to define a standard for identifying individual orders.
In addition to being used ensure the reference fields conform to a standard format, the reference pattern is also used to automatically generate sequential reference values.

The default pattern for the Sales Order reference pattern is SO-{ref:04d}.
This will generate a sequence of reference values like:

  • SO-0001
  • SO-0002
  • SO-0003
The Sales Order reference pattern can be configured to generate a different reference sequence as required.

The Sales Order pattern is implemented as follows:

  • The pattern must specify a single {ref} block - this is the required sequential portion of the pattern.
  • A ? character is treated as a wildcard which will match any character.
  • A # character is treated as a wildcard which will match any number.
  • Any other characters will be matched literally.

Reference Formatting

The reference field pattern uses Python string formatting for value substitution.

Create Sales Order

Once the sales order page is loaded, click on New Sales Order which opens the "Create Sales Order" form.

A sales order is linked to a specific customer, select one in the list of existing customers.


Only companies with the "Customer" attribute enabled will be shown and can be selected

Fill out the rest of the form with the sales order information then click on Submit

Add Line Items

On the sales order detail page, user can link parts to the sales order selecting the Line Items tab then clicking on the Add Line Item button.

Once the "Add Line Item" form opens, select a part in the list.


Only parts that have the "Salable" attribute enabled will be shown and can be selected

Fill out the rest of the form then click on Submit


After all line items were added to the sales order, user needs to create one or more shipments in order to allocate stock for those parts.

In order to create a new shipment:

  1. Click on the Pending Shipments tab
  2. Click on New Shipment button, fill out the form with the shipment number (tracking number can be added but is optional) then click on Submit

Repeat the two steps above to create more shipments.

Allocate Stock Items

After shipments were created, user can either:

  • allocate stock items for that part to the sales order (click on button)
  • or create a build order for that part to cover the quantity of the sales order (click on button)

During the allocation process, user is required to select the desired shipment that will contain the stock items.

Complete Shipment

To complete a shipment, click on the Pending Shipments tab then click on button shown in the shipment table.

Fill out the "Complete Shipment" form then click on Submit.

To view all the completed shipment, click on the Completed Shipments tab. In the completed shipments table, click on the icon next to each shipment reference to see the items and quantities which were shipped.

Complete Order

Once all items in the sales order have been shipped, click on Complete Order to mark the sales order as complete.

Cancel Order

To cancel the order, click on the menu button next to the Complete Order button, then click on the " Cancel Order" menu option. Confirm then click on the Submit to cancel the order.

Last update: July 9, 2022