CalculateTaxesByDateRange

Calculate Taxes by Date Range

Minor Business Rule

Object Name: N0701710

Parent DLL: CHRM

Location: Client/Server

Language: NER

Function:  Calculate Taxes by Date Range

Module:N0701710

Name:CalculateTaxesbyDateRange

Data Structure:D0701710

Related Table(s):F06166


Purpose:

The function will calculate the State Taxes paid by an employee over a specified date range.  The function 

will search the F06166 (Pay Check History Tax Ledger) for records matching the Address Numer (AN8) and 

Home Company (HMCO) of a specific employee and Pay Tax Type (PTAX) = 'F' (State Income Tax).  The function 

will return the Gross Pay, Excludable Pay, Excess Pay, Taxable Pay, and Amount Tax Paid over that date 

range.


Parameters:

ItemType      Required   Input/OutputDescription

mnAddress NumberMath NumericYIThe employee identification 

number

szCompanyHomeStringYIThe company under which taxes paid

mnDateYearMath NumericYIThe 2-digit year taxes were paid

jdBeginDateRangejdeDateYIThe beginning date of 

calculation 

range

jdEndDateRangejdeDateYIThe end date of calculation range

mnTotalPayGrossMath NumericNOThe gross amount paid to employee

over the date range

mnTotalPayExcludableMath NumericNOThe pay excluded from taxes over the 


date range

mnTotalPayExcessMath NumericNOThe excess pay over the date 

range

(also excluded from taxes)

mnTotalAmountTaxMath NumericNOThe amount of taxes paid over 

the 

date range

mnTotalPayTaxableMath NumericN0The amount of pay to tax over 

the 

date range


Data Structure

D0701710 - Calculate Taxes by Date Range

Parameter NameData ItemData TypeReq/OptI/O/Both
mnAddressNumberAN8MATH_NUMERICREQINPUT

A number that identifies an entry in the Address Book system, such as employee, applicant, participant, customer, supplier, tenant, or 
location.

szCompanyHomeHMCOcharREQINPUT

The company number where the employee records generally reside.

mnDateYearDTEYMATH_NUMERICREQINPUT

A two-digit number that specifies the applicable year. If you leave this field blank, the program uses the system date.

jdBeginDateRangePPEDJDEDATEREQINPUT

The last day of a processing period (pay period, month, quarter or year).

jdEndDateRangePPEDJDEDATEREQINPUT

The last day of a processing period (pay period, month, quarter or year).

mnTotalPayGrossBW01MATH_NUMERICOPTOUTPUT

The gross amount of the transaction. The specific meaning, depending on the type of transaction, is as follows:    A  Pay types: The total 
amount of earnings related to the type of pay.    B  DBAs: The total amount of the deduction, benefit, or accrual.    C  Payroll taxes: The total 
amount of gross wages, before exclusions and paid-in-excess amounts. This amount represents the total for the first month of either the payroll 
year or the calendar year, depending on the review form that you are using. Payroll-month totals are stored in the Employee Transaction History 
Summary table (F06146). Calendar-month totals are stored in the Calendar Month DBA Summary History table (F06145).

mnTotalPayExcludableBX01MATH_NUMERICOPTOUTPUT

The amount of monthly gross pay excluded from the tax calculation. This amount includes deductions for retirement savings plans and 
other non-taxable accounts.

mnTotalPayExcessBE01MATH_NUMERICOPTOUTPUT

The amount of wages earned, but in excess of the annual limit, for tax calculation.

mnTotalAmountTaxBY01MATH_NUMERICOPTOUTPUT

The monthly amount of tax calculated.

mnTotalPayTaxableBW02MATH_NUMERICOPTOUTPUT

The gross amount of the transaction. The specific meaning, depending on the type of transaction, is as follows:    A  Pay types - The total 
amount of earnings related to the type of pay.    B  DBAs - The total amount of the deduction, benefit or accrual.    C  Payroll taxes - The total 
amount of gross wages, before exclusions and paid-in-excess amounts. This amount represents the total for the second month of either the 
payroll year or the calendar year, depending on the review form that you are using. Payroll-month totals are stored in the Employee Transaction 
History Summary table (F06146). Calendar-month totals are stored in the Calendar Month DBA Summary History table (F06145).

szTaxAreaWorkTARAcharOPTNONE

A code that identifies a geographical location and the tax authorities for an employee work site, including employee and employer statutory 
requirements. In the Vertex payroll tax calculation software, the tax area code is synonymous with GeoCode. To determine the valid codes 
for your location, refer to the documentation for the tax calculation software that you are using.

Related Functions

None

Related Tables

None