Skip to main content

Interface: ContractorPayEstimate

Defined in: src/server/services/payroll.ts:422

A contractor's own estimated pay for a period (for the contractor dashboard), summed across all of their rate-bearing assignments — matching how the period close would pay them.

Remarks​

Money fields are PHP integer centavos; hour fields are rounded to 2 dp. For a multi-assignment contractor, bimonthlyRateCentavos and weeklyContractedHours are the totals across assignments.

Properties​

bimonthlyRateCentavos​

readonly bimonthlyRateCentavos: number

Defined in: src/server/services/payroll.ts:426

Sum of bi-monthly contract rates (centavos) across assignments.

facilityName​

readonly facilityName: string | null

Defined in: src/server/services/payroll.ts:423

The single facility's name, or the literal 'Multiple facilities' when the contractor has more than one assignment in the period (null if the lone facility is unknown).

holidayHours​

readonly holidayHours: number

Defined in: src/server/services/payroll.ts:428

Total credited holiday hours (in-house admins only), rounded to 2 dp.

hoursWorked​

readonly hoursWorked: number

Defined in: src/server/services/payroll.ts:427

Total payable hours logged so far across assignments, rounded to 2 dp.

ratio​

readonly ratio: number

Defined in: src/server/services/payroll.ts:430

Paid fraction = totalCentavos / bimonthlyRateCentavos (0 when the rate is 0).

serviceType​

readonly serviceType: string | null

Defined in: src/server/services/payroll.ts:424

Always null here; reserved for callers that join service metadata.

totalCentavos​

readonly totalCentavos: number

Defined in: src/server/services/payroll.ts:429

Estimated total payout across assignments, in centavos.

weeklyContractedHours​

readonly weeklyContractedHours: number

Defined in: src/server/services/payroll.ts:425

Sum of weekly contracted hours across the contractor's assignments.

weeks​

readonly weeks: SerializedWeek[]

Defined in: src/server/services/payroll.ts:431

Per-week serialized breakdown, concatenated across all assignments.