BUSINESS SOFTWARE, INC. (BSI) CONFIDENTIAL AND PROPRIETARY INFORMATION
|
|
Note: API calls are encrypted using one of the following protocols: SSLv2, SSLv3, TLSv1, TLSv1.1 and TLSv1.2
Your application must call this function prior to processing a payroll run.
This function allows TaxFactory to connect to your database based on:
the passed database connection string
the database connection string contained in the DATABASE environment variable.
This function requires that the database connection string be valid for the given database. This ConnectToDataSource API call requires two parameters:
database connection string
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
Your application must call this function prior to processing a payroll run.
This function allows TaxFactory to connect to your user-defined data set based on:
the passed dataset connection string
the dataset contained in the DATASET environment variable.
This function requires that the dataset variable is valid and contained in the dataset table BTXDSET.
Dataset is BSI’s implementation of the logical database concept. A TaxFactory database may have many sets of user-defined data as distinguished by dataset. This API call requires five parameters:
dataset name
username
password
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This function will disconnect from the database. It will also perform a DisconnectDataset. This function clears the cache of all data. This function must be called at the end of a processing cycle, which may consist of multiple payroll runs. This API call requires a single parameter:
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This function writes all updates to the database. It should be called for employees where the status > 0, and after the last employee of the payroll run. This API call requires a single parameter:
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This function is called by your payroll system for each employee. It accepts employee, tax, earnings and benefit plan information to derive the correct taxes and taxable wages based on your inputs. It is capable of calculating taxes and taxable wages for the following scenarios:
regular, supplemental, cumulative and vacation tax calculations
benefit plan (wage) assessment
gross-up
earning assessment
reciprocal calculations
This API call requires six parameters:
structures for employee data
structures for tax data
structures for garnishment data
run name
session identification structure
a return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This function is called by your payroll system for each employee. It accepts employee, tax, earnings and benefit plan information to derive the correct taxes and taxable wages based on your inputs. It is capable of calculating taxes and taxable wages for the following scenarios:
regular, supplemental, cumulative and vacation tax calculations
benefit plan (wage) assessment
gross-up
earning assessment
reciprocal calculations
Note: It is also capable of backing out negative taxes.
This API call requires five parameters:
structures for employee data
structures for tax data
run name
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This function is called by your payroll system for each employee. It allows you to import employee, tax, earning and benefit plan information into the TaxFactory "What-If" tool. Once imported, different employee withholding scenarios can be easily explored through the interface.
This API call requires five parameters:
structures for employee data
structures for tax data
structures for garnishment data
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This function is called by your payroll system for each employee receiving deferred pay. It accepts employee and tax taxable wages for the following scenarios:
regular, supplemental, cumulative and irregular tax calculations
gross-up
This API call requires five parameters:
structures for employee data
structures for tax data
run name
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This function is called by your payroll system for each employee. It accepts employee and live and work mailing addresses to derive the tax liability based on your inputs. This function also returns taxes that do not exist in the database, but that must be used in some reciprocal tax calculations as placeholders. The TF1_LOCATOR_TAX structure has an additional output parameter Enacted that indicates whether a particular tax is a real tax or a placeholder tax. It is capable of locating tax liabilities for the following scenarios:
regular pay
deferred pay
Railroad retirement
EIC
This API call requires five parameters:
structures for locator employee data
location data
run name
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This functionality is based on several sources of data. As with any application, its results are provided as a guide only, and accuracy cannot be guaranteed.
This function is called by your payroll system if and when you wish to display BSI TaxFactory-generated location choices through your own application. This function is called per employee when the EmployeeStatus field has a value > 0 subsequent to a call to ProcessLocations.
This API call requires four parameters:
locator index number
place structure
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This function is called by your payroll system if and when you wish to display BSI TaxFactory-generated tax calculation messages through your own application. This function is called per employee when the EmployeeStatus field has a value > 0 subsequent to a call to ProcessLocations, ProcessTaxes, ProcessNegativeTaxes or ProcessPensionTaxes.
This API call requires three parameters:
character string to hold the message
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
GetEngineRelease (TF1014)
This function returns an identifying string that contains the TaxFactory release and cyclic information and, if a connection to the database has been established, the current support bulletin number.
This API call requires two parameters:
character string to hold the release information
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
RollbackDataSource (TF1006)
This function removes all updates to the database, on databases where commit control is recognized. It should be called for employees where the status >0, and after the last employee of the payroll run, assuming that changes to the database do not need to be preserved.
This API call requires a single parameter:
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
ControlMessages (TF1016)
This function controls the writing of messages to the database. This function can only be called after the ConnectToDatabase API. Call this API with a 0 (zero) to turn the writing of messages Off. Call this API with a 1 (one) to turn the writing of messages On. Note that the messages are still available through the GetTaxMessages and GetLocatorMessges API.
This API requires four parameters:
message number
on/off API value
session identification
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
ImportPensionTaxes (TF1012)
This function is called by your payroll system for each pension employee. It allows you to import employee, tax, earning and benefit plan information into the TaxFactory "Pension What-If" tool. Once imported, different pension employee withholding scenarios can be easily explored through the interface.
This API requires four parameters:
session identification structure
structures for employee data
structures for tax data
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
GetPkgFiles (TF1021)
This function returns information on the data files contained within a package file. These data files contain backup tax data or custom data.
This API requires four parameters:
a package file
a count of the number of entries
package information structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
RunTests (TF1024)
This function performs tests against the appropriate TaxFactory engine. The test are written in the same format used by the "Batch Test" tool. If desired, the tests can also be imported to the database for further exploration through the interface.
This API requires six parameters:
a test file
a result file
an error file
a flag to import the test to the database (flag uses values of 0=No and 1=Yes)
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
ImportLocations (TF1025)
This function is called by your payroll system for each locator employee. It allows you to import locator employee and location information into the TaxFactory "TaxLocator" tool. Once imported, different locator scenarios can be easily explored through the interface.
This API requires four parameters:
structures for locator Employee data
structures for Location data
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
CrtCheckPoint (TF1017)
This function saves the entire database to a package file. This allows for a complete backup of the TaxFactory table data which includes tax data and custom data.
This API requires four parameters:
a package file
a report file
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
RstCheckPoint (TF1018)
This function restores a prior database backup from a package file. All tax and custom data within TaxFactory tables will be deleted prior to restoration.
This API requires four parameters:
a package file
a report file
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
SaveCustomData (TF1011)
This function saves the custom TaxFactory data to a backup file. A single call to this function can be used to backup a single dataset or all datasets for this datasource. This is determined by the parameter passed for the dataset:
Named - The named dataset will be backed up
Blank or "*CURRENT"- the dataset to which you are currently connected
"*ALL" - All datasets are backed up
This API call requires five parameters:
a backup file
a report file
a dataset
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
LoadCustomData (TF1020)
This function restores the custom TaxFactory data from a backup file. A single call to this function can be used to restore a single dataset or all datasets. This is determined by the parameter passed for the dataset:
Named - The restore will take place to the named dataset
Blank - The restore will take place to the dataset (or datasets) as originally backed up
"*ALL" - All datasets from the backup file will be restored
This API call requires eight parameters:
a backup file
a report file
a dataset
a flag to create a new dataset
a flag to clear the existing dataset
a flag to include security records for the dataset (All flags use values of 0=No and 1=Yes)
session identification structure
a return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
ExportCustomData (TF1023)
This function saves the custom TaxFactory data to a backup file. This data is also used by the BSI ComplianceFactory products. Only customers who use both products should utilize this function. A single call to this function can be used to backup a single dataset or all datasets for this datasource. This is determined by the parameter passed for the dataset:
Named - The named dataset will be backed up
Blank or "*CURRENT"- the dataset to which you are currently connected
"*ALL" - All datasets are backed up
This API call requires five parameters:
a backup file
a report file
a dataset
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
ImportCustomData (TF1022)
This function restores the custom TaxFactory data from a backup file. This data is also used by the BSI ComplianceFactory products. Only customers who use both products should utilize this function. A single call to this function can be used to restore a single dataset or all datasets. This is determined by the parameter passed for the dataset:
Named - The restore will take place to the named dataset
Blank - The restore will take place to the dataset (or datasets) as originally backed up
"*ALL" - All datasets from the backup file will be restored
This API call requires seven parameters (All flags use values of 0=No and 1=Yes):
a backup file
a report file
a dataset
a flag to create a new dataset
a flag to clear the existing dataset
session identification structure
a return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
This function will disconnect from the user-defined dataset. It also clears the cache of all data. This function is called when you want to clear the cache without dropping the database connection.
This API call requires two parameters:
session identification structure
return code
This API call returns a value of 1 for SUCCESS or 0 for FAILURE.
©Copyright 2021 Business Software, Inc
Unpublished - Rights Reserved Under the Copyright Laws of the United States