List payroll entries
/v1/payroll-entriesReturns a page of payroll entries. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Only return entries for this caregiver.
Only return entries with this status.
PendingApprovedProcessedPaidCancelledFailedHoursSubmittedCheckCreatedPaidConfirmedPaidExternallyVoidedOnly return entries for the pay period starting on this date.
Only return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The payroll entries on this page.
Show item attributesHide item attributes(24)
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.
Pass as cursor to fetch the next page. null on the last page.
Whether another page exists.
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 |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 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). |
| 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.