Sapphire Functions - Unveil Sapphire Functions for Unique Operations

Sapphire Functions Overview

Sapphire Functions are for running non-standard activities within SapphireOne. The functions listed under the General Tab are common to all modes within SapphireOne. Other functions for each of the other three modes Financials, Assets and Payroll/HR have been grouped under the appropriate Tabs as seen below. None of the functions in these tables should be used without explicit directions from Sapphire Support Team.

General Tab

API Gateway SapphireOne original API Gateway which is no longer used.
API Gateway II SapphireOne updated API Gateway to API Gateway version II. This function enables the bulk importing or exporting of large amounts of data in or out of SapphireOne.
API Gateway III This is an updated version of API Gateway version II. This function enables the bulk importing of data in to the data file and is mainly used when setting up new data files. The imported file must be in text or CSV format and the user may map the data fields as required when importing data.
Email Orders When this function is select a pop up will ask for permission to connect to your email server and down load any orders that have been sent by email 
Execute Not normally used as an authorisation is required for this screen as this allows access to all data. 
ExecuteText  Not Normally used as an authorisation is required for this screen as this allows access to all data. 
ExportControllerLog  This function allows the user to export the controller log file. 
FixPicture  Not normally used. Ask SapphireOne support staff for details. 
Gateway Log SapphireOne keeps a log of all Gateway imports and exports and this log is not user modifiable. When this function is accessed SapphireOne will display the details of the log onscreen. Once on screen there is an option to export it as a tab delineated text file for further analysis. 
Master Default Log 
Master Quick Report When this function is chosen, an alert will appear, prompting the user to select one of the available tables in the data file. Once the user makes their selection, the Quick Report form is displayed, allowing them to create a quick report based on the chosen table.
NameUpdate This function will reset all of the custom names back to the SapphireOne defaults.
Periods This function is used when combining data files and does a check on the accuracy of Periods. 
SetDefaultpicture
SwapCurrencyDisplayFr
UpdateVersion Allows you to import a list of versions in a tab delimited format which requires two columns which are ‘sequence’ and ‘version’.
UserAccessKeywords This function is only used for file conversion. 

Dictation and Speech to Text Overview

SapphireOne’s implementation of both Dictation (MacOS) and Speech to Text (Windows) is a game changer for data entry. Any data entry field you can type into using a keyboard can use this feature.

You can also use this functionality on all inquiry screens within SapphireOne. For example, the user is in a Contact within a Client. They may have made a phone call to that particular client using the Softphone technology. Consequently, this will automatically date and time stamp both the contact and the phone number you called.

As soon as the call is completed, the user has the ability to use Speech to Text (Windows) or Dictation (MacOS). They can dictate into the memo field of the CRM contact, adding as much description as they require.

Dictation and Speech to Text Procedure

This functionality applies across every single Data Entry screen. For example, the SapphireOne user is entering a Vendor Invoice (VI). Additionally, you may want to add a memo within the Vendor Invoice (VI). The user can utilise the tool and simply dictate the memo.

Another example is if the user wants to add additional lines to the General Ledger account, within each General Ledger account. When the user is completing data entry using a General Ledger, there’s always a unique memo field for each GL account line.

The user can then utilise this feature to quickly add the information they need to add. Alternatively, you may have an interview with an employee. After the interview process is completed, the user can then make notes about the employee.

Speech to Text or Dictation is an extremely powerful tool. It is something that we at SapphireOne, as well as our clients, utilise daily. It is a massive time saver.

Financials Tab

Bet_Import Not normally used. 
Settlement Import Not normally used. 
Aging This function allows the aging of Clients and Vendor Balances to be redone if there has been any problems with allocations. 
AnalysisClient  Balance When there are problems with Client balances, running this function will create a tab delineated text file displaying additional details including historical information. (May be opened with any spreadsheet program e.g. Excel). 
AnalysisVendor Balance When there are problems with Vendor balances, running this function will create a tab delineated text file displaying additional details including historical information. (May be opened with any spreadsheet program). 
AuditbyDate Enter in a G/L account then pop ups will ask for a start and end dates for this tab delineated text file for the auditing of G/L accounts. 
BAS GST Audit When this is selected SapphireOne will ask for a Start Date and a Finish Date. The user will also be asked where to save the tab delineated text file. This text file contains a list of all transactions that would be in the BAS, as determined by the entered starting and ending dates. 
BatchAudit This function when executed will generate a CSV file with batch or serial numbers and their locations 
Bet_Enquiry Not normally used. 
Bet_Print Not normally used. 
BigCommerceOrderGet
Budget_Import This function will re-write G/L budgets by a direct import of a file. Please check with SapphireOne staff before using 
BuildAnalysis When this function is run SapphireOne will create a tab delineated text file displaying additional information about any built item in the inventory. (May be opened with any spreadsheet program e.g. Excel). 
CGL_Audit When this function is run, SapphireOne will initially ask for a file name for the error file. SapphireOne will then save a tab delineated text type file into the newly created file. This displays additional information about any errors found in the G/L accounts.  (It may then be opened with any spreadsheet program e.g. Excel). 
Check Vendor ABN This function will run an algorithm to check all Vendor ABN’s for validity. If the Vendor has no ABN or an invalid ABN then the ID and Name will be exported to a tab delimited text file. 
CheckImportID
CleanDupBuild Not normally used. Check with SapphireOne staff before using. 
CleanWebInvoiceUser
ClearDeleted
Timesheet
Not normally used.  Check with SapphireOne staff before using. 
ClearPeriod263
ClientAllocationAudit This function checks Client Allocations against Client Balances Total Due. It then produces a tab delineated text file of any errors in allocations. 
Client Audit This function checks the History Journal Lines against Client Balances. The results are then exported to an ASCII text file. 
ClientRating When executed this function checks sales and payments made. It then calculates a Client rating and enters the rating into the client record. 
CompareClientTotal This function checks the Client total GL balance with the Client Transaction total. Results are then exported to an ASCII text file. 
CompareVendorTotal This function checks the Vendor total GL balance with the Vendor Transaction total. Results are then exported to an ASCII text file. 
CopyTaskBudget This function copies a Task Budget from one project to another. 
Createcustominfo
CreateEndYear
Journal
CreatePeriod
Analysis
eCommerce
StockSync
ExcludeOldAudit
LineForBAS
FindDuplicate  MatrixLines This function searches for any duplicated matrix lines in invoices.  If errors are found SapphireOne will generate a csv file with the errors and open it with the default spreadsheet program on the work station. 
Fix30to100
Fix4u
FixCommonID Not normally used. Check with SapphireOne staff before using. 
FixContactFont
FixDepositsScreen
Fixduplicate25006
Fixdupilcate
Changenames
FixHJPeriod This function matches all of the History Journal line periods to the period of the corresponding transaction. 
FixINFtimesheets
FixLinktoCustomer
FixPeriod
Balancedates
FixPVI_Merge PGJ Special tool to fix PVI’s in SapphireOne and to merge any PGJ’s for the same Vendor. Do not use unless you check with SapphireOne support staff first. 
FixRounding
FixTableID Cross checks table ID’s x against y for errors and attempts to fix them. 
Fixtimb
FixTraninvType This function will fix transactions linked to projects that have the correct type entered. Only to be used under the guidance of SapphireOne support staff. 
FixVI
FreightFix
Full History Copies posted or entered status transactions and invoices from current to history, if they have not been created in history already. 
GL Audit This function performs a GL Audit. GL Audit is a function that compares the GL Balances by period to the Journal Lines that make up that GL Balances per period. If any errors are found it will create a file and then automatically execute the default spreadsheet program in the local computer and display the results pf the GL Audit function. The user may then save or delete this file as normal from the spreadsheet program. 
GLFix_LastYear_0
GLFix0
GSTAudit
HInv Audit This function checks that transactions exist for all invoices. The results are then exported to an ASCII text file. 
ImportClientVendor
Opening
ImportGJfromText
ImportInfo
ImportMatrixPacks Please check with SapphireOne staff before using!  This function allows the direct importation of matrix packs from a file. 
ImportPeriod0
Import Postcodes This function imports a text file listing Australian Postcodes Suburbs and Cities. 
ImportTollDepot
Inventoryanalysis
InventoryValue  Audit When this function is run SapphireOne calculates the Average Cost times the Inventory Quantities and compares the result with the dollar value in the appropriate General Ledger account. 
InvoiceAudit This function is the same as a Transaction Audit. An Invoice Audit is a function that compares the Invoice totals to the total of  the account lines making up that transaction. If any errors are found SapphireOne will create a tab delineated text file and automatically open the default spreadsheet program on your computer for immediate examination of the error or errors. 
LocationAudit This function is used when running in multi location mode. This function queries all locations and makes sure that the Base ID is correctly totalled. 
No ABN This function can be used to generate the No ABN magnetic media file for the Australian Taxation Office. (Details later in this article) 
NRLinventPurch Not normally used. 
NRLVenBal Not normally used. 
Orphan AuditLines This function allows audit lines that are not linked to transactions to be located and removed if necessary. 
PostedDeleted  Audit This function looks for records that have been posted and deleted as a result of index damage. The results are then exported to an ASCII text file. 
PRGLBudgetYTD
PrGiRecal Checks that transactions linked to Projects have the correct values entered into the appropriate General Ledger account when it does a recalculation. 
RecalInvoiceMargin
RecalLocal
LandingCost
ReduceVersions Revise all references of a particular version number to another version number.
RemarkBankRec  Sometimes your current Bank rec is not correct in current transactions. When this function is run, SapphireOne checks the bank rec state of each current transaction, against the same transaction that has been stored in history. If it finds a difference it alters the current transactions bank rec state, to be the same as the one in history. 
RemoveRebatezero
ResetPlugins This function Clears the Plug-in keys and allows the user to re-enter the plug in keys. 
Retrieve Inv This function copies an Invoice from History back to the current file. SapphireOne will ask for the sequence number of the invoice to be retrieved. 
Retrieve Tran This function copies a transaction from History back to the current file. SapphireOne will ask for the sequence number of the Transaction to be retrieved. 
Rev_Budget_  Import This function will reverse the Budget Import function that is also in this list of custom functions for Financials. (Last one Only). 
RevalueInvent This function re-values Batch and Serial inventory items based on the cost of the items, to obtain the average cost. 
ReverseAllPGJ This will reverse all PGJ’s in SapphireOne.  The reversing will occur in Accounts mode 
ReverseBankRec
SequenceNumb This function resets the sequence numbers in SapphireOne if they have changed ensuring that there is no overlapping. 
SerialFix This is a specialised function allowing management of serial numbers for damaged logs. Please contact Sapphire Support for Instructions on using this function. 
StockAdjAudit This function checks the stock adjustments against the History Invoice lines. Extended documentation on this function is to be found further on in this section of the manual after these tables. 
StockAnalysis  BacktoDayZero Should not normally used but it will revert analysis stock back to the beginning of the data file. Do not use unless checking with SapphireOne support staff. 
SyncInvLines This function provides the ability to update Invoice lines.  E.g. if an Inventory Class has been changed. 
SystemAudit This function searches for (potentially) illegitimate transactions against control accounts System Audit goes through all historical transactions and reports: a) Non vendor transactions to Vendor Control Accounts, b) Non client transactions to Client Control Accounts & c) Non Bank Transactions to Bank Accounts.  The results are then exported to an ASCII text file. 
TestToll This function tests the printing of Toll generated dockets. 
Tran Audit A Transaction Audit is a function that compares the Transactions total to the total of the journal lines making up that transaction. If an error is found it will log the error in the error log file that the user has created prior to starting the Audit.  N.B. by initiating this function you are required to create a new file and save it, this is your log. 
Tran Company Audit This function will allow SapphireOne to cross check inter company transactions. 
TranAllocAudit This function will allow SapphireOne to check allocations made against transactions. Any errors found are then exported to an ASCII text file. 
UpdateClientYTD  Selecting this function will tell SapphireOne to update all internal reference numbers. 
UpdateContact
Class
UpdateContact
Company
UpdateFXFrom
Keywords
UpdateInternalRef Selecting this function will tell SapphireOne to update all internal reference numbers. 
UpdateInventory  NextDeliver Not normally used but it zeros out all inventory, re scans the OVI’s and then updates the delivery quantities. 
UpdateOrg_Tsum
Update Projects This function re-calculates the projects’ actual costs and billing information from source data into the Quote Details Screen. 
Vendor Allocation  Audit This function checks the History Transactions against Vendor Balances. The results are then exported to an ASCII text file. 
Vendor Audit This function checks the History Journal Lines against Vendor Balances. The results are then exported to an ASCII text file. 
Vendor Allocation Analysis This function will check the as entered vendor for allocation errors.  If there are any errors they the results will be exported to a tab delineated text file. 
Write TableFieldNum  This function writes a complete list of all field files and their properties to an ASCII text file. 

Assets Tab

AssetCompany Checks that all assets have a company ID entered. 
AssetImport
LastYear
AssetImpoert
LastYearDCO
AssetReval Normally only used when a new data file is being set up  Check with SapphireOne staff before using. 
AssetTranAudit Transaction Audit but will only check transactions that relate to Assets. 
AssetValueAudit Normally only used when a new data file is being set up  Check with SapphireOne staff before using. 
Check2018Depr
Check2019Depr
CheckMethodDepr
ClearAssetGST Normally only used when a new data file is being set up  Check with SapphireOne staff before using. 
ClearSoldAssets  Normally only used when a new data file is being set up  Check with SapphireOne staff before using. 
FixSoldAssets Normally only used when a new data file is being set up  Check with SapphireOne staff before using. 
Fix74545R –
FixAddCost
FixAddCostManual
FixNegWdr
FixOldSoldAssets
FixYTDdepr
Import Asset Bar Code This function allows the importation of Bar Codes for Assets
Import Assets This function is for the importing of Assets. 
Import Assets Class This function allows the importation of Bar Codes for Assets
ImportAssetTF
ReCalcDepr Selecting this function will force SapphireOne to re-calculate the depreciation for all assets. 
Update Assets This function is for the changing of Asset details. 
Update Method If the method has not been updated correctly with the current depreciation in the 2004 data file use this function to correct the problem. 
UpdateOWDVsold

PayRoll Tab

ChangeDownload No longer used. 
CheckAccumSuper Not normally used.
CheckAlltot Checks the all of the allowance totals for integrity. 
CheckHistPayroll
CheckPAYG
CompanyConversion
CreateAllowances Used for the creation new 2004 data file. Not normally used! 
CreateWorkingDays
ExpDeduction This allows you to export a breakdown of the deductions for the current Pay Run into a text file suitable for reading in a Spreadsheet. You will be asked to save a file. Give it a suitable name, click on the Save button and the file will be saved. 
ExportTranHol Allows the export of the current Pay, to another data file. 
FixcurrentyearPeriod
Dates
Batch repair when incorrect Payroll Year end has been set.
How to run the FixcurrentyearPerioddates Function
FixHistoryPayrundate
FixHistorySuperYTD Not normally used.
FixHpayperiod Not normally used.
FixPaidToDate
Employee
FixSafe
FixSuperHistory
Amount
FixSuperYTD Not normally used.
FixTrial Balance
GenerateJournal This function is designed to correct errors in financial records for a specific pay period. It works by reversing previously posted journal entries and then recreating them according to the current settings. This is especially useful when the trial balance is not balanced across companies, often due to transactions being incorrectly linked to the wrong department within a company or a GL Account not existing for a company.
ImportEmployee
Salary
ImportMemberNo Not normally used. Superannuation funds have a standard format for supplying member’s details and this function will comply with the format. For example this allows for the importation of a large number of employees superannuation details when starting a new data file with details provided by the superannuation fund. 
ImportOther This function allows you to import all other details. 
ImportSetHol
ImportTaxRatesTCP
ImportTaxRates Text
LinkRSRateTo
Employee
Payrollupdate2023 This will remove the $450 minimum superannuation exemption and adjust all 10% super to 10.5%.
ReadTimesheet
RecalAllowance Total Not normally used and should only be used on advice from SapphireOne support staff.. When this function is run SapphireOne will do an immediate re-calculation of all allowance totals in SapphireOne. 
Recalc450Min
RecalcLumpD
RecalcOWP
ReversePayRun This allows for the reversal of a complete pay run for all employees or selected employees. (Limited to the last pay that has been executed). (See below). 
SetCountry
Setup PayrollWizard This wizard allows you to set up a checklist and the order in which procedures are to be run when completing a pay run. 
Supercheck Not normally used.
SuperRec Prints a list of employees with Job Title, Class and Department details. 
UpdateEmployeeYTD This function will cause SapphireOne to recalculate update the Employee’s YTD accumulators. 
UpdateHistory  LineSearch This function checks each of 31 Allowances against historical data. 
UpdateHistory  PayrollGross Not normally used.
UpdateHistPayrollPeriod Not normally used.
UpdateHistoryPayslip
UpdateHistsuper
UpdateSuperfromhistory
VerifyUnposted Payroll This function checks and verifies any un-posted records in Payroll. 

Australian Superannuation Guarantee 2021 PayRoll Key Updates

The Australian 2021 Federal Budget stipulated a number of updates to Superannuation in effect from July 1st 2021. Continue reading to learn the three key changes for SapphireOne users to note, as well as how SapphireOne has been updated to seamlessly respond to the new laws.

  1. Rate of Compulsory Super to Rise 0.5% Each Year from July 1st 2021
    The Superannuation Guarantee (SG) rate as currently legislated by the 2021 Federal Budget will increase from 9.5% to 10% with effect from 1 July 2021, with further increases of 0.5% per year to come from 1 July 2022.
  2. Removal of the $450 Minimum Threshold
    Under the current superannuation arrangements, if a person earns less than $450 per month from the one employer, they are not entitled to receive the superannuation guarantee. As of July 1st 2021, regardless of how much money an employee earns, they will be entitled to employer-paid superannuation.
  3. Removal of Age Restrictions for Compulsory Super Contributions
    All employees, including employees under the age of 18, will be entitled to employer-paid superannuation as of July 1st 2021.

SapphireOne PayRoll Super Update 2021 Function

How to Run the PayRoll Super Update 2021 Tool

To run the SapphireOne PayRoll Super Update 2021 function please follow the below steps:

  1. Navigate to Utilities > Utilities > SapphireOne Functions.
  2. In the top dropdown menu, select ‘PayRoll/HR’. 
  3. Within the list, select the ‘PayRollSuperUpdate2021 Tool’, and select ‘OK’.

PayRoll Super Update 2021 function Updates

Superannuation Guarantee Rate Increased to 10%
  • Running the PayRoll Super Update 2021 Function will automatically increase all superannuation contributions from 9.5% to 10% within all Australian employee files in SapphireOne.
  • After running the tool, you can view the updates to the superannuation contributions by navigating to PayRoll/HR > Administration > Employee > Modify Employee > Superannuation Page. As seen in the screenshot below, under the Superannuation Set Up Details area, the Percentage will now be updated to 10% .

$450 Minimum Threshold Removed
  • Running the Super Update 2021 Function will automatically change all Australian Employee Awards to an Exemption Minimum of $0.00 within SapphireOne. All Australian employees with any previously set Award Entitlement Exemption Minimum has now been removed.
  • You are able to view this change by navigating to PayRoll/HR > Administration > Award Entitlements  > Superannuation Page as seen in the screenshot below.
  • Under the Superannuation Area in the lower left corner of the screen, the value of ‘Exemption Minimum’ has been updated to $0.00.

Age Restrictions for Super Contributions Removed
  • Similarly, running the PayRoll Super Update 2021 Function will automatically remove Superannuation age restrictions within all employee files. This means that all employees within SapphireOne will now receive super benefits regardless of age.
  • You are able to view this change by navigating to PayRoll/HR > Administration > Award Entitlements  > Superannuation Page as seen in the screenshot below.
  • Under the Superannuation Area in the lower left corner of the screen, you will see that the ‘Pay Super Regardless of Age’ checkbox has now been selected.

Prior to SapphireOne version 18.0.22, if a user entered an Incorrect Finish Date for Period 1, that date would be recorded against the Annual Leave history. This caused SapphireOne to display incorrect dates on the Payroll/Leave page. The issue is cosmetic only and did not effect the values.

The SapphireOne Fix Current Year Period Dates Tool will repair the cosmetic display issue across all employees.

Fix Current Year Period Dates Function Procedure
  1. Navigate to Utilities > Controls > Company > Select and Modify > Periods and Taxes.
  2. In the following example the Period 1 Finish Date under System Periods > Payroll (drop-down), has been incorrectly set to 2022 in the year ending 2021. The first step before running the tool is to select and modify this date to indicate the correct year.

Reverse Pay Run Restrictions: If you have selected the Single Journal in Master Defaults, the Payrun will create a Single COMBINED journal for all of the employee’s in the Payrun. This will cause a problem if you want to do a Reverse Payrun for anything less than the full Payrun. If for example you want to reverse the Payrun for a single Employee, there will not be a journal record for that single employee. When a combined Payrun is executed the journals for each individual employee are combined into a single journal entry. 


You can review our Blog and YouTube channel for additional information and resources on SapphireOne ERP, CRM and Business Accounting software.

Was this helpful?

Next Article

Sapphire Tools