PHP Class XeroPHP\Models\PayrollUS\Employee\OpeningBalance

Inheritance: extends XeroPHP\Remote\Object

Public Methods

Method	Description
addBenefitLine ( BenefitLine $value ) : OpeningBalance
addDeductionLine ( DeductionLine $value ) : OpeningBalance
addEarningsLine ( EarningsLine $value ) : OpeningBalance
addReimbursementLine ( ReimbursementLine $value ) : OpeningBalance
getAPIStem ( ) : string \| null	Get the stem of the API (core.xro) etc
getAmount ( ) : float
getBenefitLines ( ) : BenefitLine[] \| Collection
getBenefitTypeID ( ) : string
getDeductionLines ( ) : DeductionLine[] \| Collection
getDeductionTypeID ( ) : string
getEarningsLines ( ) : EarningsLine[] \| Collection
getEarningsTypeID ( ) : string
getEmployeeID ( ) : string
getGUIDProperty ( ) : string	Get the guid property
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
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
isPageable ( )
setAmount ( float $value ) : OpeningBalance
setBenefitTypeID ( string $value ) : OpeningBalance
setDeductionTypeID ( string $value ) : OpeningBalance
setEarningsTypeID ( string $value ) : OpeningBalance
setEmployeeID ( string $value ) : OpeningBalance
setReimbursementTypeID ( string $value ) : OpeningBalance

Method Details

addBenefitLine() public method

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

addDeductionLine() public method

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

addEarningsLine() public method

public addEarningsLine ( EarningsLine $value ) : OpeningBalance
$value	XeroPHP\Models\PayrollUS\Paystub\EarningsLine
return	OpeningBalance

addReimbursementLine() public method

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

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

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

getEarningsLines() public method

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

getEarningsTypeID() public method

public getEarningsTypeID ( ) : string
return	string

getEmployeeID() public method

Deprecation:

public getEmployeeID ( ) : string
return	string

getGUIDProperty() public static method

Get the guid property

public static getGUIDProperty ( ) : 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

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 ( )

isPageable() public static method

public static isPageable ( )

setAmount() public method

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

setBenefitTypeID() public method

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

setDeductionTypeID() public method

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

setEarningsTypeID() public method

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

setEmployeeID() public method

Deprecation:

public setEmployeeID ( string $value ) : OpeningBalance
$value	string
return	OpeningBalance

setReimbursementTypeID() public method

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