PHP Class XeroPHP\Models\PayrollUS\Employee\PayTemplate

Inheritance: extends XeroPHP\Remote\Object

Public Methods

Method	Description
addBenefitLine ( BenefitLine $value ) : PayTemplate
addDeductionLine ( DeductionLine $value ) : PayTemplate
addEarningsLine ( float $value ) : PayTemplate
addReimbursementLine ( ReimbursementLine $value ) : PayTemplate
getAPIStem ( ) : string \| null	Get the stem of the API (core.xro) etc
getAmount ( ) : float
getBenefitLines ( ) : BenefitLine[] \| Collection
getBenefitTypeID ( ) : string
getCalculationType ( ) : string
getDeductionLines ( ) : DeductionLine[] \| Collection
getDeductionTypeID ( ) : string
getDescription ( ) : string
getEarningsLines ( ) : float[] \| Collection
getEarningsTypeID ( ) : string
getEmployeeMax ( ) : float
getGUIDProperty ( ) : string	Get the guid property
getPercentage ( ) : string
getProperties ( ) : array	Get the properties of the object. Indexed by constants [0] - Mandatory [1] - Type [2] - PHP type [3] - Is an Array [4] - Saves directly
getRatePerUnit ( ) : float
getReimbursementLines ( ) : ReimbursementLine[] \| Collection
getReimbursementTypeID ( ) : string
getResourceURI ( ) : string	Get the resource uri of the class (Contacts) etc
getRootNodeName ( ) : string	Get the root node name. Just the unqualified classname
getSupportedMethods ( )	Get the supported methods
getUnitsOrHours ( ) : string
isPageable ( )
setAmount ( float $value ) : PayTemplate
setBenefitTypeID ( string $value ) : PayTemplate
setCalculationType ( string $value ) : PayTemplate
setDeductionTypeID ( string $value ) : PayTemplate
setDescription ( string $value ) : PayTemplate
setEarningsTypeID ( string $value ) : PayTemplate
setEmployeeMax ( float $value ) : PayTemplate
setPercentage ( string $value ) : PayTemplate
setRatePerUnit ( float $value ) : PayTemplate
setReimbursementTypeID ( string $value ) : PayTemplate
setUnitsOrHour ( string $value ) : PayTemplate

Method Details

addBenefitLine() public method

public addBenefitLine ( BenefitLine $value ) : PayTemplate
$value	XeroPHP\Models\PayrollUS\Paystub\BenefitLine
return	PayTemplate

addDeductionLine() public method

public addDeductionLine ( DeductionLine $value ) : PayTemplate
$value	XeroPHP\Models\PayrollUS\Paystub\DeductionLine
return	PayTemplate

addEarningsLine() public method

public addEarningsLine ( float $value ) : PayTemplate
$value	float
return	PayTemplate

addReimbursementLine() public method

public addReimbursementLine ( ReimbursementLine $value ) : PayTemplate
$value	XeroPHP\Models\PayrollUS\Paystub\ReimbursementLine
return	PayTemplate

getAPIStem() public static method

Get the stem of the API (core.xro) etc

public static getAPIStem ( ) : string \| null
return	string \| null

getAmount() public method

public getAmount ( ) : float
return	float

getBenefitLines() public method

public getBenefitLines ( ) : BenefitLine[] \| Collection
return	XeroPHP\Models\PayrollUS\Paystub\BenefitLine[] \| XeroPHP\Remote\Collection	Always returns a collection, switch is for type hinting

getBenefitTypeID() public method

public getBenefitTypeID ( ) : string
return	string

getCalculationType() public method

public getCalculationType ( ) : string
return	string

getDeductionLines() public method

public getDeductionLines ( ) : DeductionLine[] \| Collection
return	XeroPHP\Models\PayrollUS\Paystub\DeductionLine[] \| XeroPHP\Remote\Collection	Always returns a collection, switch is for type hinting

getDeductionTypeID() public method

public getDeductionTypeID ( ) : string
return	string

getDescription() public method

public getDescription ( ) : string
return	string

getEarningsLines() public method

public getEarningsLines ( ) : float[] \| Collection
return	float[] \| XeroPHP\Remote\Collection	Always returns a collection, switch is for type hinting

getEarningsTypeID() public method

public getEarningsTypeID ( ) : string
return	string

getEmployeeMax() public method

public getEmployeeMax ( ) : float
return	float

getGUIDProperty() public static method

Get the guid property

public static getGUIDProperty ( ) : string
return	string

getPercentage() public method

public getPercentage ( ) : string
return	string

getProperties() public static method

Get the properties of the object. Indexed by constants [0] - Mandatory [1] - Type [2] - PHP type [3] - Is an Array [4] - Saves directly

public static getProperties ( ) : array
return	array

getRatePerUnit() public method

public getRatePerUnit ( ) : float
return	float

getReimbursementLines() public method

public getReimbursementLines ( ) : ReimbursementLine[] \| Collection
return	XeroPHP\Models\PayrollUS\Paystub\ReimbursementLine[] \| XeroPHP\Remote\Collection	Always returns a collection, switch is for type hinting

getReimbursementTypeID() public method

public getReimbursementTypeID ( ) : string
return	string

getResourceURI() public static method

Get the resource uri of the class (Contacts) etc

public static getResourceURI ( ) : string
return	string

getRootNodeName() public static method

Get the root node name. Just the unqualified classname

public static getRootNodeName ( ) : string
return	string

getSupportedMethods() public static method

Get the supported methods

public static getSupportedMethods ( )

getUnitsOrHours() public method

public getUnitsOrHours ( ) : string
return	string

isPageable() public static method

public static isPageable ( )

setAmount() public method

public setAmount ( float $value ) : PayTemplate
$value	float
return	PayTemplate

setBenefitTypeID() public method

public setBenefitTypeID ( string $value ) : PayTemplate
$value	string
return	PayTemplate

setCalculationType() public method

public setCalculationType ( string $value ) : PayTemplate
$value	string
return	PayTemplate

setDeductionTypeID() public method

public setDeductionTypeID ( string $value ) : PayTemplate
$value	string
return	PayTemplate

setDescription() public method

public setDescription ( string $value ) : PayTemplate
$value	string
return	PayTemplate

setEarningsTypeID() public method

public setEarningsTypeID ( string $value ) : PayTemplate
$value	string
return	PayTemplate

setEmployeeMax() public method

public setEmployeeMax ( float $value ) : PayTemplate
$value	float
return	PayTemplate

setPercentage() public method

public setPercentage ( string $value ) : PayTemplate
$value	string
return	PayTemplate

setRatePerUnit() public method

public setRatePerUnit ( float $value ) : PayTemplate
$value	float
return	PayTemplate

setReimbursementTypeID() public method

public setReimbursementTypeID ( string $value ) : PayTemplate
$value	string
return	PayTemplate

setUnitsOrHour() public method

public setUnitsOrHour ( string $value ) : PayTemplate
$value	string
return	PayTemplate