package PayrollDeduction\CA
inherited_from \PayrollDeduction_Base

 Methods

__construct()

__construct() 

calcNonPeriodicDeduction()

calcNonPeriodicDeduction($annual_tax_payable, $ytd_deduction) 
Inherited

Parameters

$annual_tax_payable

$ytd_deduction

calcNonPeriodicIncome()

calcNonPeriodicIncome($ytd_gross_income, $gross_pp_income) 
Inherited

Parameters

$ytd_gross_income

$gross_pp_income

convertToCountryCurrency()

convertToCountryCurrency($amount) 
Inherited

Parameters

$amount

convertToUserCurrency()

convertToUserCurrency($amount) 
Inherited

Parameters

$amount

getAnnualPayPeriods()

getAnnualPayPeriods() 
Inherited

getAnnualizingFactor()

getAnnualizingFactor($reverse = FALSE
Inherited

Parameters

$reverse

getBasicClaimCodeData()

getBasicClaimCodeData($date) 

Parameters

$date

getBasicFederalClaimCodeAmount()

getBasicFederalClaimCodeAmount($date = FALSE

Parameters

$date

getBasicProvinceClaimCodeAmount()

getBasicProvinceClaimCodeAmount($date = FALSE

Parameters

$date

getCPPBasicExemption()

getCPPBasicExemption() 

getCPPData()

getCPPData($date) 

Parameters

$date

getCPPEmployeeMaximumContribution()

getCPPEmployeeMaximumContribution() 

getCPPEmployeeRate()

getCPPEmployeeRate() 

getCPPMaximumEarnings()

getCPPMaximumEarnings() 

getCompany()

getCompany() 
Inherited

getCountry()

getCountry() 
Inherited

getCountryPrimaryCurrency()

getCountryPrimaryCurrency() 
Inherited

getCountryPrimaryCurrencyID()

getCountryPrimaryCurrencyID() 
Inherited

getCurrentPayPeriod()

getCurrentPayPeriod() 
Inherited

getCurrentPayrollRunID()

getCurrentPayrollRunID() 
Inherited

getData()

getData() 

getDataFromRateArray()

getDataFromRateArray($epoch, $arr) 
Inherited

Parameters

$epoch

$arr

getDate()

getDate() 
Inherited

getDateEpoch()

getDateEpoch() 
Inherited

getDistrict()

getDistrict() 
Inherited

getEIData()

getEIData($date) 

Parameters

$date

getEIEmployeeMaximumContribution()

getEIEmployeeMaximumContribution() 

getEIEmployeeRate()

getEIEmployeeRate() 

getEIEmployerRate()

getEIEmployerRate() 

getEIMaximumEarnings()

getEIMaximumEarnings() 

getFederalConstant()

getFederalConstant($income) 

Parameters

$income

getFederalEmploymentCreditAmount()

getFederalEmploymentCreditAmount() 

getFederalEmploymentCreditData()

getFederalEmploymentCreditData($date) 

Parameters

$date

getFederalLowestRate()

getFederalLowestRate() 

getFederalRate()

getFederalRate($income) 

Parameters

$income

getFormulaType()

getFormulaType() 
Inherited

getGrossPayPeriodIncome()

getGrossPayPeriodIncome() 
Inherited

getISODate()

getISODate($epoch) 
Inherited

Parameters

$epoch

getProvince()

getProvince() 
Inherited

getProvincialConstant()

getProvincialConstant($income) 

Parameters

$income

getProvincialLowestRate()

getProvincialLowestRate() 

getProvincialRate()

getProvincialRate($income) 

Parameters

$income

getProvincialSurTaxData()

getProvincialSurTaxData($date) 

Parameters

$date

getProvincialTaxReductionData()

getProvincialTaxReductionData($date) 

Parameters

$date

getRemainingPayPeriods()

getRemainingPayPeriods() 
Inherited

getUser()

getUser() 
Inherited

getUserCurrency()

getUserCurrency() 
Inherited

getUserValue1()

getUserValue1() 
Inherited

getUserValue2()

getUserValue2() 
Inherited

getUserValue3()

getUserValue3() 
Inherited

getUserValue4()

getUserValue4() 
Inherited

getYearToDateDeduction()

getYearToDateDeduction() 
Inherited

getYearToDateGrossIncome()

getYearToDateGrossIncome() 
Inherited

setAnnualPayPeriods()

setAnnualPayPeriods($value) 
Inherited

Parameters

$value

setCompany()

setCompany($company_id) 
Inherited

Parameters

$company_id

setCountry()

setCountry($country) 
Inherited

Parameters

$country

setCurrentPayPeriod()

setCurrentPayPeriod($value) 
Inherited

Parameters

$value

setCurrentPayrollRunID()

setCurrentPayrollRunID($value) 
Inherited

Parameters

$value

setDate()

setDate($epoch) 
Inherited

Parameters

$epoch

setDistrict()

setDistrict($district) 
Inherited

Parameters

$district

setFormulaType()

setFormulaType($type_id) 
Inherited

Parameters

$type_id

setGrossPayPeriodIncome()

setGrossPayPeriodIncome($income) 
Inherited

Parameters

$income

setProvince()

setProvince($province) 
Inherited

Parameters

$province

setUser()

setUser($user_id) 
Inherited

Parameters

$user_id

setUserCurrency()

setUserCurrency($currency_id) 
Inherited

Parameters

$currency_id

setUserValue1()

setUserValue1($value) 
Inherited

Parameters

$value

setUserValue2()

setUserValue2($value) 
Inherited

Parameters

$value

setUserValue3()

setUserValue3($value) 
Inherited

Parameters

$value

setUserValue4()

setUserValue4($value) 
Inherited

Parameters

$value

setYearToDateDeduction()

setYearToDateDeduction($amount) 
Inherited

Parameters

$amount

setYearToDateGrossIncome()

setYearToDateGrossIncome($income) 
Inherited

Parameters

$income

getRateArray()

getRateArray($income, $type) 

Parameters

$income

$type

 Properties

 

$basic_claim_code_options

$basic_claim_code_options 

Default

array(20170701 => array('CA' => 11635, 'BC' => 10208, 'AB' => 18690, 'SK' => 16065, 'MB' => 9271, 'QC' => 0, 'ON' => 10171, 'NL' => 8978, 'NB' => 9895, 'NS' => 8481, 'PE' => 8320, 'NT' => 14278, 'YT' => 11635, 'NU' => 13128), 20170101 => array('CA' => 11635, 'BC' => 10208, 'AB' => 18690, 'SK' => 16065, 'MB' => 9271, 'QC' => 0, 'ON' => 10171, 'NL' => 8978, 'NB' => 9895, 'NS' => 8481, 'PE' => 8000, 'NT' => 14278, 'YT' => 11635, 'NU' => 13128), 20160701 => array('CA' => 11474, 'BC' => 10027, 'AB' => 18451, 'SK' => 15843, 'MB' => 9134, 'QC' => 0, 'ON' => 10011, 'NL' => 8802, 'NB' => 9758, 'NS' => 8481, 'PE' => 8292, 'NT' => 14081, 'YT' => 11474, 'NU' => 12947), 20160101 => array('CA' => 11474, 'BC' => 10027, 'AB' => 18451, 'SK' => 15843, 'MB' => 9134, 'QC' => 0, 'ON' => 10011, 'NL' => 8802, 'NB' => 9758, 'NS' => 8481, 'PE' => 7708, 'NT' => 14081, 'YT' => 11474, 'NU' => 12947), 20150101 => array('CA' => 11327, 'BC' => 9938, 'AB' => 18214, 'SK' => 15639, 'MB' => 9134, 'QC' => 0, 'ON' => 9863, 'NL' => 8767, 'NB' => 9633, 'NS' => 8481, 'PE' => 7708, 'NT' => 13900, 'YT' => 11327, 'NU' => 12781), 20140101 => array('CA' => 11138, 'BC' => 9869, 'AB' => 17787, 'SK' => 15378, 'MB' => 9134, 'QC' => 0, 'ON' => 9670, 'NL' => 8578, 'NB' => 9472, 'NS' => 8481, 'PE' => 7708, 'NT' => 13668, 'YT' => 11138, 'NU' => 12567), 20130101 => array('CA' => 11038, 'BC' => 10276, 'AB' => 17593, 'SK' => 15241, 'MB' => 8884, 'QC' => 0, 'ON' => 9574, 'NL' => 8451, 'NB' => 9388, 'NS' => 8481, 'PE' => 7708, 'NT' => 13546, 'YT' => 11038, 'NU' => 12455), 20120101 => array('CA' => 10822, 'BC' => 11354, 'AB' => 17282, 'SK' => 14942, 'MB' => 8634, 'QC' => 0, 'ON' => 9405, 'NL' => 8237, 'NB' => 9203, 'NS' => 8481, 'PE' => 7708, 'NT' => 13280, 'YT' => 10822, 'NU' => 12211), 20110701 => array('CA' => 10527, 'BC' => 11088, 'AB' => 16977, 'SK' => 14535, 'MB' => 8634, 'QC' => 0, 'ON' => 9104, 'NL' => 7989, 'NB' => 8953, 'NS' => 8731, 'PE' => 7708, 'NT' => 12919, 'YT' => 10527, 'NU' => 11878), 20110101 => array('CA' => 10527, 'BC' => 11088, 'AB' => 16977, 'SK' => 13535, 'MB' => 8134, 'QC' => 0, 'ON' => 9104, 'NL' => 7989, 'NB' => 8953, 'NS' => 8231, 'PE' => 7708, 'NT' => 12919, 'YT' => 10527, 'NU' => 11878), 20100101 => array('CA' => 10382, 'BC' => 11000, 'AB' => 16825, 'SK' => 13348, 'MB' => 8134, 'QC' => 0, 'ON' => 8943, 'NL' => 7833, 'NB' => 8777, 'NS' => 8231, 'PE' => 7708, 'NT' => 12740, 'YT' => 10382, 'NU' => 11714), 20090401 => array('CA' => 10375, 'BC' => 9373, 'AB' => 16775, 'SK' => 13269, 'MB' => 8134, 'QC' => 0, 'ON' => 8881, 'NL' => 7778, 'NB' => 8134, 'NS' => 7981, 'PE' => 7708, 'NT' => 12664, 'YT' => 10375, 'NU' => 11644), 20090101 => array('CA' => 10100, 'BC' => 9373, 'AB' => 16775, 'SK' => 13269, 'MB' => 8134, 'QC' => 0, 'ON' => 8881, 'NL' => 7778, 'NB' => 8134, 'NS' => 7981, 'PE' => 7708, 'NT' => 12664, 'YT' => 10100, 'NU' => 11644), 20080101 => array('CA' => 9600, 'BC' => 9189, 'AB' => 16161, 'SK' => 8945, 'MB' => 8034, 'QC' => 0, 'ON' => 8681, 'NL' => 7566, 'NB' => 8395, 'NS' => 7731, 'PE' => 7708, 'NT' => 12355, 'YT' => 9600, 'NU' => 11360), 20070701 => array('CA' => 8929, 'BC' => 9027, 'AB' => 15435, 'SK' => 8778, 'MB' => 7834, 'QC' => 0, 'ON' => 8553, 'NL' => 7558, 'NB' => 8239, 'NS' => 7481, 'PE' => 7708, 'NT' => 12125, 'YT' => 8929, 'NU' => 11149), 20070101 => array('CA' => 8929, 'BC' => 9027, 'AB' => 15435, 'SK' => 8778, 'MB' => 7834, 'QC' => 0, 'ON' => 8553, 'NL' => 7410, 'NB' => 8239, 'NS' => 7481, 'PE' => 7412, 'NT' => 12125, 'YT' => 8929, 'NU' => 11149), 20060701 => array('CA' => 8639, 'BC' => 8858, 'AB' => 14999, 'SK' => 8589, 'MB' => 7734, 'QC' => 0, 'ON' => 8377, 'NL' => 7410, 'NB' => 8061, 'NS' => 7231, 'PE' => 7412, 'NT' => 11864, 'YT' => 8328, 'NU' => 10909), 20060101 => array('CA' => 9039, 'BC' => 8858, 'AB' => 14799, 'SK' => 8589, 'MB' => 7734, 'QC' => 0, 'ON' => 8377, 'NL' => 7410, 'NB' => 8061, 'NS' => 7231, 'PE' => 7412, 'NT' => 11864, 'YT' => 8328, 'NU' => 10909))
 

$country_primary_currency

$country_primary_currency 

Default

'CAD'
 

$cpp_options

$cpp_options 

Default

array(20170101 => array('maximum_pensionable_earnings' => 55300, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2564.1), 20160101 => array('maximum_pensionable_earnings' => 54900, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2544.3), 20150101 => array('maximum_pensionable_earnings' => 53600, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2479.95), 20140101 => array('maximum_pensionable_earnings' => 52500, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2425.5), 20130101 => array('maximum_pensionable_earnings' => 51100, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2356.2), 20120101 => array('maximum_pensionable_earnings' => 50100, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2306.7), 20110101 => array('maximum_pensionable_earnings' => 48300, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2217.6), 20100101 => array('maximum_pensionable_earnings' => 47200, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2163.15), 20090101 => array('maximum_pensionable_earnings' => 46300, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2118.6), 20080101 => array('maximum_pensionable_earnings' => 44900, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 2049.3), 20070101 => array('maximum_pensionable_earnings' => 43700, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 1989.9), 20060101 => array('maximum_pensionable_earnings' => 42100, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 1910.7), 20050101 => array('maximum_pensionable_earnings' => 41100, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 1861.2), 20040101 => array('maximum_pensionable_earnings' => 40500, 'basic_exemption' => 3500, 'employee_rate' => 0.0495, 'employee_maximum_contribution' => 1831.5))
 

$data

$data 

Default

array()
 

$db

$db 

Default

NULL
 

$ei_options

$ei_options 

Default

array(20170101 => array('maximum_insurable_earnings' => 51300, 'employee_rate' => 0.0163, 'employee_maximum_contribution' => 836.1900000000001, 'employer_rate' => 1.4), 20160101 => array('maximum_insurable_earnings' => 50800, 'employee_rate' => 0.0188, 'employee_maximum_contribution' => 955.04, 'employer_rate' => 1.4), 20150101 => array('maximum_insurable_earnings' => 49500, 'employee_rate' => 0.0188, 'employee_maximum_contribution' => 930.6, 'employer_rate' => 1.4), 20140101 => array('maximum_insurable_earnings' => 48600, 'employee_rate' => 0.0188, 'employee_maximum_contribution' => 913.6799999999999, 'employer_rate' => 1.4), 20130101 => array('maximum_insurable_earnings' => 47400, 'employee_rate' => 0.0188, 'employee_maximum_contribution' => 891.12, 'employer_rate' => 1.4), 20120101 => array('maximum_insurable_earnings' => 45900, 'employee_rate' => 0.0183, 'employee_maximum_contribution' => 839.97, 'employer_rate' => 1.4), 20110101 => array('maximum_insurable_earnings' => 44200, 'employee_rate' => 0.0178, 'employee_maximum_contribution' => 786.76, 'employer_rate' => 1.4), 20100101 => array('maximum_insurable_earnings' => 43200, 'employee_rate' => 0.0173, 'employee_maximum_contribution' => 747.36, 'employer_rate' => 1.4), 20090101 => array('maximum_insurable_earnings' => 42300, 'employee_rate' => 0.0173, 'employee_maximum_contribution' => 731.79, 'employer_rate' => 1.4), 20080101 => array('maximum_insurable_earnings' => 41100, 'employee_rate' => 0.0173, 'employee_maximum_contribution' => 711.03, 'employer_rate' => 1.4), 20070101 => array('maximum_insurable_earnings' => 40000, 'employee_rate' => 0.018, 'employee_maximum_contribution' => 720.0, 'employer_rate' => 1.4), 20060101 => array('maximum_insurable_earnings' => 39000, 'employee_rate' => 0.0187, 'employee_maximum_contribution' => 729.3, 'employer_rate' => 1.4), 20050101 => array('maximum_insurable_earnings' => 39000, 'employee_rate' => 0.0195, 'employee_maximum_contribution' => 760.5, 'employer_rate' => 1.4), 20040101 => array('maximum_insurable_earnings' => 39900, 'employee_rate' => 0.0198, 'employee_maximum_contribution' => 722.2, 'employer_rate' => 1.4))
 

$federal_employment_credit_options

$federal_employment_credit_options 

Default

array(20170101 => array('credit' => 1178), 20160101 => array('credit' => 1161), 20150101 => array('credit' => 1146), 20140101 => array('credit' => 1127), 20130101 => array('credit' => 1117), 20120101 => array('credit' => 1095), 20110101 => array('credit' => 1065), 20100101 => array('credit' => 1051), 20090101 => array('credit' => 1044), 20080101 => array('credit' => 1019), 20070101 => array('credit' => 1000), 20060101 => array('credit' => 500))
 

$federal_income_tax_rate_options

$federal_income_tax_rate_options 

Default

array(20170101 => array(array('income' => 45916, 'rate' => 15, 'constant' => 0), array('income' => 91831, 'rate' => 20.5, 'constant' => 2525), array('income' => 142353, 'rate' => 26, 'constant' => 7576), array('income' => 202800, 'rate' => 29, 'constant' => 11847), array('income' => 202800, 'rate' => 33, 'constant' => 19959)), 20160101 => array(array('income' => 45282, 'rate' => 15, 'constant' => 0), array('income' => 90563, 'rate' => 20.5, 'constant' => 2491), array('income' => 140388, 'rate' => 26, 'constant' => 7471), array('income' => 200000, 'rate' => 29, 'constant' => 11683), array('income' => 200000, 'rate' => 33, 'constant' => 19683)), 20150101 => array(array('income' => 44701, 'rate' => 15, 'constant' => 0), array('income' => 89401, 'rate' => 22, 'constant' => 3129), array('income' => 138586, 'rate' => 26, 'constant' => 6705), array('income' => 138586, 'rate' => 29, 'constant' => 10863)), 20140101 => array(array('income' => 43953, 'rate' => 15, 'constant' => 0), array('income' => 87907, 'rate' => 22, 'constant' => 3077), array('income' => 136270, 'rate' => 26, 'constant' => 6593), array('income' => 136270, 'rate' => 29, 'constant' => 10681)), 20130101 => array(array('income' => 43561, 'rate' => 15, 'constant' => 0), array('income' => 87123, 'rate' => 22, 'constant' => 3049), array('income' => 135054, 'rate' => 26, 'constant' => 6534), array('income' => 135054, 'rate' => 29, 'constant' => 10586)), 20120101 => array(array('income' => 42707, 'rate' => 15, 'constant' => 0), array('income' => 85414, 'rate' => 22, 'constant' => 2989), array('income' => 132406, 'rate' => 26, 'constant' => 6406), array('income' => 132406, 'rate' => 29, 'constant' => 10378)), 20110101 => array(array('income' => 41544, 'rate' => 15, 'constant' => 0), array('income' => 83088, 'rate' => 22, 'constant' => 2908), array('income' => 128800, 'rate' => 26, 'constant' => 6232), array('income' => 128800, 'rate' => 29, 'constant' => 10096)), 20100101 => array(array('income' => 40970, 'rate' => 15, 'constant' => 0), array('income' => 81941, 'rate' => 22, 'constant' => 2868), array('income' => 127021, 'rate' => 26, 'constant' => 6146), array('income' => 127021, 'rate' => 29, 'constant' => 9956)), 20090401 => array(array('income' => 41200, 'rate' => 15, 'constant' => 0), array('income' => 82399, 'rate' => 22, 'constant' => 2884), array('income' => 126264, 'rate' => 26, 'constant' => 6180), array('income' => 126264, 'rate' => 29, 'constant' => 9968)), 20090101 => array(array('income' => 38832, 'rate' => 15, 'constant' => 0), array('income' => 77664, 'rate' => 22, 'constant' => 2718), array('income' => 126264, 'rate' => 26, 'constant' => 5825), array('income' => 126264, 'rate' => 29, 'constant' => 9613)), 20080101 => array(array('income' => 37885, 'rate' => 15, 'constant' => 0), array('income' => 75769, 'rate' => 22, 'constant' => 2652), array('income' => 123184, 'rate' => 26, 'constant' => 5683), array('income' => 123184, 'rate' => 29, 'constant' => 9378)), 20070101 => array(array('income' => 37178, 'rate' => 15.5, 'constant' => 0), array('income' => 74357, 'rate' => 22, 'constant' => 2417), array('income' => 120887, 'rate' => 26, 'constant' => 5391), array('income' => 120887, 'rate' => 29, 'constant' => 9017)), 20060701 => array(array('income' => 36378, 'rate' => 15.5, 'constant' => 0), array('income' => 72756, 'rate' => 22, 'constant' => 2365), array('income' => 118285, 'rate' => 26, 'constant' => 5275), array('income' => 118285, 'rate' => 29, 'constant' => 8823)), 20060101 => array(array('income' => 36378, 'rate' => 15, 'constant' => 0), array('income' => 72756, 'rate' => 22, 'constant' => 2546), array('income' => 118285, 'rate' => 26, 'constant' => 5457), array('income' => 118285, 'rate' => 29, 'constant' => 9005)), 20050101 => array(array('income' => 35595, 'rate' => 16, 'constant' => 0), array('income' => 71190, 'rate' => 22, 'constant' => 2136), array('income' => 115739, 'rate' => 26, 'constant' => 4983), array('income' => 115739, 'rate' => 29, 'constant' => 8455)), 20040101 => array(array('income' => 35000, 'rate' => 16, 'constant' => 0), array('income' => 70000, 'rate' => 22, 'constant' => 2100), array('income' => 113804, 'rate' => 26, 'constant' => 4900), array('income' => 113804, 'rate' => 29, 'constant' => 8314)), 20030101 => array(array('income' => 35000, 'rate' => 16, 'constant' => 0), array('income' => 70000, 'rate' => 22, 'constant' => 2100), array('income' => 113804, 'rate' => 26, 'constant' => 4900), array('income' => 113804, 'rate' => 29, 'constant' => 8314)), 20020101 => array(array('income' => 35000, 'rate' => 16, 'constant' => 0), array('income' => 70000, 'rate' => 22, 'constant' => 2100), array('income' => 113804, 'rate' => 26, 'constant' => 4900), array('income' => 113804, 'rate' => 29, 'constant' => 8314)), 20010101 => array(array('income' => 35000, 'rate' => 16, 'constant' => 0), array('income' => 70000, 'rate' => 22, 'constant' => 2100), array('income' => 113804, 'rate' => 26, 'constant' => 4900), array('income' => 113804, 'rate' => 29, 'constant' => 8314)))
 

$income_tax_rates

$income_tax_rates 

Default

array()