Package Items

Package item configuration, types, and defaults

Package Items

Package Items Fields

Field	Type	Description
packageitemid (Auto)	System allocated	Unique identifier.
postingmapid	int(10)	Link the Package Item to a Contract Type. All of your Salary Packaged items can be linked to the same Contract Type.
package_name	varchar(60)	Give the Package Item a descriptive name.
benefit_type	enum('type-1','type-2','exempt')
cap_type	enum('primary','meal')	Populate with 'primary' if the Package Item will be used in concessional cap calculations. Populate with 'meal' if the Package Item will be used in meal cap calculations. This should be blank if the Package Item is an exempt item.
gst_flag	enum('yes','no')	Set as 'yes' if the item should be treated as GST inclusive. Set as 'no' if the item is GST free. Where gst_flag = 'yes' AND addgstflag = 'yes', IGNORE. Where gst_flag = 'yes' AND addgstflag = 'no', the following business logic will be applied: Contract Budgets will be recalculated as per calculations attached in the spreadsheet - Contract budget amounts calculation.
spprofiletablename	enum('sppackageitemprofilecars', 'spremoteareabenefits')
employeecontributionflag	enum('yes','no')	Set as 'yes' if the item may contain an employee contribution. Set as 'no' if adding an employee contribution is not appropriate. In the Item tab, users can only enter "Employee Contribution" if this is 'yes'. In all other cases, this field is disabled.

Create a separate page where set-up is complicated.

If known, note any that are required to run functions on this screen.

Item Details

Review the main types of package items that can be configured below to inform your package item set-up.

Go to the Package Item Fields page for a full description of the set-up fields.

Benefits

Benefits paid for by the employer

Car Items

Novated Lease
Associate Lease
Associate Lease Managed

Direct Link Car Items

Direct Link Novated Lease
Direct Link Associate Lease Managed

Employee

Access Type: External

Restriction: A package employee can view selected screens under the menu item "Packaging". These are the same as those shown to drivers, with the addition of Current Packages and Transactions tabs.

Set Up: An internal user would check on the Employees / Contact "Access" check box.

Your system can be organised to present package employee information in two ways:

A limited set of system screens as described under 'Restriction' below.
The Employee Portal

Screen access and permissions

Tab	Permissions
Packaging
Contact	View and edit. "Last Login" details and "Access" check box are hidden from the employee's view.
Current Packages
Transactions
Contracts	View only
Vehicle Events	View, create, delete, and attach to selected Event Types. The list of events can be printed to PDF and CSV.
Vehicle FBT	Can view the screen and print the Driver Report to PDF and CSV.
Vehicle Maintenance	Can view a summary of the contract's cost transactions. The employee can print Maintenance and Fuel Reports. The employee can add an Odometer reading. See also Contract Types / Details "Disclose Running Costs" to review the screen view permissions for the linked Contract Type.
Vehicle Claim	Create a new claim.
Password	Employees can change their own passwords.

Advisor

Access Type: External

Restriction Type: User

Restriction: Access to Packaging/Employees screens and a selection of reports within those screens, where the logged in user is the stored Employees / Contact "Package Advisor".

The Package Advisor login does not work when the temporarypasswordflag is set to 'yes'.

Screen access and permissions

Tab	Permissions
Packaging / Employees
Contact	Read access
Current Packages	Read access including report
Transactions	Read access including report
Contracts	Read access
Vehicle Events	Read access including report
Vehicle FBT	Read access including FBT report
Vehicle Maintenance	Read access including Fuel Performance and Maintenance reports

Create a Package Item record for each benefit you are offering

Page not in use, return to Salary Packaging Set-Up.

Create Package Item defaults

Qualifiers

Perform this set-up if you are providing Salary Packaging services.
You have decided which benefits to offer in the table.

Download current details

Go to Setup / Export Table Data
Module - select 'sp | Salary Packaging'
Table - select 'sppackageitems'
Output Options:
- Include Field Headers - leave checked
- 5 Sample Rows Only - leave unchecked
- Remove Null Values - leave unchecked
Click Export

Update details

Save the downloaded file
Review and add any missing items
Save the revised file

Upload revised details

Go to Setup / Import Table Data
Module - select 'sp | Salary Packaging'
Table - select 'sppackageitems'
Data File: Click Upload
Click Import

Next Steps

Start testing your processes and fine tuning them.

Create Package Item records

Qualifiers

Perform this set-up if you are providing Salary Packaging services.
You have decided which benefits to offer in the table.

Download current details

Go to Setup / Export Table Data
Module - select 'sp | Salary Packaging'
Table - select 'sppackageitems'
Output Options:
- Include Field Headers - leave checked
- 5 Sample Rows Only - leave unchecked
- Remove Null Values - leave unchecked
Click Export

Update details

Save the downloaded file
Review and add any missing items
Save the revised file

Upload revised details

Go to Setup / Import Table Data
Module - select 'sp | Salary Packaging'
Table - select 'sppackageitems'
Data File: Click Upload
Click Import

Next Steps

Create Package Item defaults.

Item Fields

Go to the Package Item Details page and review the main types of package items that can be configured.

Below are descriptions of the configuration fields that are set when your package items are created.

These are normally configured by your Account Manager during the setup process.

sppackageitems

Field	Type	Description
packageitemid	int(10)	Unique ID.
postingmapid	int(10)	Set the Contract Type this benefit should be linked to. When an item is made 'Active', this Contract Type is linked to the Contract.
packageitemcode	varchar(6)	Create a short code for the benefit.
module	varchar(6)	'sp' - this is a non-functional field.
package_name	varchar	Displays as Employees / Item "Package Item" and is shown in the selection list. This field also defaults into the Employees / Item "Description" field (which can be edited by the user).
benefittype	enum('type-1','type-2','exempt')	Displays as Employees / Item "Benefit Type". Set the required benefittype. This is used in FBT calculations and reports.
captype	enum('primary','meal')	Select the required captype. This is used in FBT calculations and reports. If the benefit is exempt, leave this field as NULL.
gst_flag	enum('yes','no')	Set to 'yes' if the benefit will contain GST and the Employer will hold GST Invoices. When an item is made 'Active', the contract budgets will contain GST.
addgstflag	enum('yes','no')	Set to 'no'. This feature is not currently in use.
taxinvoiceflag	enum('yes','no')
spprofiletablename	enum	Set as 'sppackageitemprofile_cars' if the benefit is for a Novated Lease or an Associate Lease. Leave as NULL in all other cases.
tax_method	enum	This displays as Employees / Item "Tax Method". Set as 'pre-tax'. It is a non-functional field.
employeecontributionflag	enum('yes','no')	Employees / Item "Employee Contribution" is enabled if this is set as 'yes'. Do this if an Employee Contribution or Post Tax amount can be set for the benefit. E.g. Novated Leases or Associate Leases.

sppackageitem_defaults

Field	Type	Description
packageitemdefault_id	bigint(20) unsigned	Unique ID.
packageitemid	int(10)	Set the link to the table above.
paycycletype_default		Use this if the benefit needs to default to the pay cycle variant 'REG12'.
totaldeductiondefault	decimal(10,2)	Defaults into Employees / Item "Total Deduction". Leave as 0 in most cases. Set a value if a known annual amount can be applied. E.g. Packaging Fees.
compressflagdefault	enum('yes','no')	Defaults into Employees / Item "Compress". Checked items are calculated for the remaining pay periods in the current FBT year.
inertiaflagdefault	enum('yes','no')	Defaults into Employees / Item "Inertia". Set as 'yes' if the benefit should persist over time and does not require ongoing substantiation. E.g. Fees, Cards. Checked items are calculated for the remaining pay periods in the current FBT year.
cycles_default	smallint(5)	Defaults into Employees / Item "Cycles". Use this to set a default for specific items. E.g. an Annual Fee that is charged once a year. This is mostly left as 0.
disbursementtypedefault	enum('claim','periodic','recurring')	Defaults into Employees / Item "Disbursement Type". Recurring - most benefits will be set as 'recurring'. Periodic - set as 'periodic' for Novated Lease benefits where a schedule of payments is required. Claim - set as 'claim' if the benefit will be paid after the employee has submitted a claim. Discuss the set-up for this with your Account Manager.
supplieriddefault	int(10)	Defaults into Employees / Item "Supplier". Most benefits will be set with a specific supplier.
supplieridedit_flag	enum('yes','no')	Set this as 'no' if Employees / Item "Supplier" should not be editable.
substantiationflagdefault	enum('yes','no')	Set this as 'yes' if you want to create a Contract Substantiation Event when an item is made 'Active'.

Packages

Filters

Filter	Type	Description
FBT Year Ending	List	The default selection is '--All--'. Choose an FBT Year if you want to review items that are dated within the chosen FBT year.
Status	List	The default selection is '--All--'. Choose a status if you want to review only items in the chosen status.

Columns

Column	Description
# (Check Box)
Package Item (Hyperlink)	Displays the Employees / Item "Description". Click on this to navigate to the Item record.
Supplier
Status (Display field)	Displays the Employees / Item "Status". The statuses are presented in the following order: Pending, Quoting, Accepted, Active, Expired, Inactive, Suspended
$ Per Year
Notes (Text)	When the Employees / Item "Notes" have been entered, the notes icon is displayed. If the "Notes" field is blank, the icon is not shown. Hover over the icon with your mouse to see the notes as a tooltip.

Action Buttons

Button	Description
Print	Print is disabled if your report selection is for 'Package Activity Statement' and the field "FBT Year Ending" is set to '--All--' or when there are no records on screen to print.
Delete	Select the record you want to edit by checking the "#" of its row. Click on Delete to delete the item. Items that are linked to a contract cannot be deleted. The Delete button will be disabled for these items. Deleted items are no longer visible on the Current Packages tab or the Item tab.
Edit	Select the record you want to edit by checking the "#" of its row. Edit will become enabled.
New	Press New to create a new item.

Output Fields

Field	Description
Report Name (List)	Package Activity Statement is the default report. If you have Screen Reports set-up, they can also be chosen here.
Report Month (List)	Displays as 'YYYY Month'. This list displays the months that fall within the chosen "FBT Year Ending" year and is ordered from April to March. This field only applies to the 'Package Activity Statement'. It is not selectable for other reports.
Print Format (Drop List)	Choose the print format you want to use.
Print (Button)	The print button creates the selected report. If the selected "Report Type" is 'Email', the Send Email pop-up will be launched.

Output Options

Package Activity Statement

Displays a summary of the package items you can see on the screen. The output format will default to 'PDF', but you can choose from 'Email', 'PDF' or 'Text(CSV)'. If you select 'Email', the PDF report will be attached to a system email addressed to the driver.

Contract Transactions

This report is a companion to the scheduler report SP - Contract Balance Checks. It contains many of the same fields as SP - Contract Balance Checks but the information here is by transaction. The report selects contract transactions for all the employee's benefit items. The direct link vehicle contracts are not currently shown here.

Impact Statement

This report is designed to illustrate the packaging benefits to the employee. The report can be renamed to suit your business. Ongoing maintenance is required to keep this report updated with the latest ATO PAYG Tax and HECS calculation factors. Visit the Impact Statement page for more details.

Screen Reports

If set up a customised report can be generated from here.

Validations and Alerts

Below are alerts that you may receive if a file cannot be generated.

	Alert
Print - Screen Report	Nothing to report!