Skip to main content

Reference Codes

Evan Nelson avatar
Written by Evan Nelson
Updated over a year ago

What we'll review:

Setting up Reference Codes

Displaying Summary on Client Invoices

Reference Codes are a versatile feature used to apply identifiers to reports, which can even be displayed on client invoices. Reference Code settings can be found under the "Applicant Profile Form" section at the client level. These codes can be applied when ordering via the Admin or Client module (including manual or SwiftHire).

Setting up Reference Codes

Reference Codes are optional by default but can be made a required field as shown below. The default Reference Code field is a free-text box where the user can type in the code of their choosing.

1. To make the Reference Code a required field, toggle to 'Required' and click the Update button directly below.

The above setting will leave the Reference Code as a free-text field but will make it a requirement before an order can be placed:

*NOTE* When set to 'Required,' the Reference Code field does not automatically show the red underline; the field will only turn red if the user attempts to place an order without a Reference Code entered in the field.

The next option controls whether or not to display the Reference Code in the Applicant Detail. To display the code, check the box for 'Show reference on applicant detail' and click Update below the list.

Fixed codes can also be created and made available for the client to choose from at the time of ordering (as shown above). The use of fixed codes is often desirable because they prevent any potential for variation in grammar, spelling, etc, which can impact some of the other settings we will review later.

2. To set up a list of fixed codes for the client, enter the value in the box and click Add to List. Once all necessary codes have been added, click the Update button below the list. Similar steps apply when removing one or more codes: click the code and then Remove. Once all necessary codes have been removed, click the Update button.

When using a list of fixed codes, the Reference Code field will turn into a drop-down list:

3. There are two more sections for additional Reference Code fields that can be set up, if necessary:

Additional Client Reference Code fields, when enabled, will appear as shown below and will follow their own settings as discussed for the primary Reference Code (i.e. Required vs Not Required, display in Applicant Detail, etc).

Display Summary on Client Invoices

When Reference Codes are used, they will automatically be displayed in a column on the client's invoice. There is another optional feature under the Additional Settings section at the client level, which controls the 'Invoice Summary Reference View."

When the summary view is enabled, the subtotals for each primary reference code used on their orders for the invoiced time period will be displayed at the top of the invoice:

*NOTE* The subtotal functionality only applies to the primary Reference Codes (not Additional Reference Codes).

Did this answer your question?