Payroll Entries
One caregiver's hours and pay for one pay period. Read-only.
Endpoints
The PayrollEntry object
object
stringread-only
String representing the object's type. Always payroll_entry.
id
stringread-only
Unique identifier of the payroll entry.
caregiverId
string | nullread-onlymax length 64
The caregiver paid.
payPeriodStart
string · date | nullread-only
First day of the pay period.
payPeriodEnd
string · date | nullread-only
Last day of the pay period.
status
string | nullread-only
Where the entry is in your payroll process.
One of
PendingApprovedProcessedPaidCancelledFailedHoursSubmittedCheckCreatedPaidConfirmedPaidExternallyVoidednullregularHours
number | nullread-only
Regular hours.
overtimeHours
number | nullread-only
Overtime hours.
holidayHours
number | nullread-only
Holiday hours.
ptoHours
number | nullread-only
Paid time off hours.
sickLeaveHours
number | nullread-only
Sick leave hours.
grossPayCents
integer | nullread-only
Gross pay. In cents.
deductionsCents
integer | nullread-only
Total deductions. In cents.
netPayCents
integer | nullread-only
Net pay. In cents.
mileageCents
integer | nullread-only
Mileage reimbursement. In cents.
visitCount
integer | nullread-only
Visits in the pay period.
visitIds
array of strings | nullread-only
Visits paid on this entry.
paymentMethod
string | nullread-only
How the caregiver is paid.
One of
DirectDepositCheckManualACHnullapprovedByName
string | nullread-onlymax length 2000
Who approved the entry.
approvedAt
string · date-time | nullread-only
When it was approved.
paidAt
string · date-time | nullread-only
When it was paid.
notes
string | nullread-onlymax length 20000
Notes.
createdAt
string · date-time | nullread-only
When the payroll entry was created.
updatedAt
string · date-time | nullread-only
When the payroll entry was last changed.