Retrieve a payroll entry
/v1/payroll-entries/{id}Returns one payroll entry by ID. Available to keys belonging to office staff.
Path parameters
ID of the payroll entry.
Response
200The payroll entry.
String representing the object's type. Always payroll_entry.
Unique identifier of the payroll entry.
The caregiver paid.
First day of the pay period.
Last day of the pay period.
Where the entry is in your payroll process.
PendingApprovedProcessedPaidCancelledFailedHoursSubmittedCheckCreatedPaidConfirmedPaidExternallyVoidednullRegular hours.
Overtime hours.
Holiday hours.
Paid time off hours.
Sick leave hours.
Gross pay. In cents.
Total deductions. In cents.
Net pay. In cents.
Mileage reimbursement. In cents.
Visits in the pay period.
Visits paid on this entry.
How the caregiver is paid.
DirectDepositCheckManualACHnullWho approved the entry.
When it was approved.
When it was paid.
Notes.
When the payroll entry was created.
When the payroll entry was last changed.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 404 | n/a | No such object, or it is not visible to this key (not_found). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.