PayslipV3PayDetail
in package
uses
FieldPositionMixin, FieldConfidenceMixin
Detailed information about the pay.
Table of Contents
Properties
- $boundingBox : Polygon|null
- $confidence : float
- $grossSalary : float|null
- $grossSalaryYtd : float|null
- $incomeTaxRate : float|null
- $incomeTaxWithheld : float|null
- $netPaid : float|null
- $netPaidBeforeTax : float|null
- $netTaxable : float|null
- $netTaxableYtd : float|null
- $polygon : Polygon
- $totalCostEmployer : float|null
- $totalTaxesAndDeductions : float|null
Methods
- __construct() : mixed
- __toString() : string
- toFieldList() : string
- Output in a format suitable for inclusion in a field list.
- setConfidence() : void
- Sets the confidence score.
- setPosition() : void
- Sets the position of a field.
- printableValues() : array<string|int, mixed>
- Return values for printing as an array.
- tablePrintableValues() : array<string|int, mixed>
- Return values for printing inside an RST table.
Properties
$boundingBox
public
Polygon|null
$boundingBox
A right rectangle containing the word in the document.
$confidence
public
float
$confidence
The confidence score.
$grossSalary
public
float|null
$grossSalary
The gross salary of the employee.
$grossSalaryYtd
public
float|null
$grossSalaryYtd
The year-to-date gross salary of the employee.
$incomeTaxRate
public
float|null
$incomeTaxRate
The income tax rate of the employee.
$incomeTaxWithheld
public
float|null
$incomeTaxWithheld
The income tax withheld from the employee's pay.
$netPaid
public
float|null
$netPaid
The net paid amount of the employee.
$netPaidBeforeTax
public
float|null
$netPaidBeforeTax
The net paid amount before tax of the employee.
$netTaxable
public
float|null
$netTaxable
The net taxable amount of the employee.
$netTaxableYtd
public
float|null
$netTaxableYtd
The year-to-date net taxable amount of the employee.
$polygon
public
Polygon
$polygon
A polygon containing the word in the document.
$totalCostEmployer
public
float|null
$totalCostEmployer
The total cost to the employer.
$totalTaxesAndDeductions
public
float|null
$totalTaxesAndDeductions
The total taxes and deductions of the employee.
Methods
__construct()
public
__construct(array<string|int, mixed> $rawPrediction, int|null $pageId) : mixed
Parameters
- $rawPrediction : array<string|int, mixed>
-
Array containing the JSON document response.
- $pageId : int|null
-
Page number for multi pages document.
__toString()
public
__toString() : string
Return values
string —String representation.
toFieldList()
Output in a format suitable for inclusion in a field list.
public
toFieldList() : string
Return values
stringsetConfidence()
Sets the confidence score.
protected
setConfidence(array<string|int, mixed> $rawPrediction) : void
Parameters
- $rawPrediction : array<string|int, mixed>
-
Raw prediction array.
setPosition()
Sets the position of a field.
protected
setPosition(array<string|int, mixed> $rawPrediction) : void
Parameters
- $rawPrediction : array<string|int, mixed>
-
Raw prediction array.
printableValues()
Return values for printing as an array.
private
printableValues() : array<string|int, mixed>
Return values
array<string|int, mixed>tablePrintableValues()
Return values for printing inside an RST table.
private
tablePrintableValues() : array<string|int, mixed>