Source
Payroll handoff — found from sitemap — Oyster HR
Checked for Oyster HR on 10 Nov 2026
- Page
- https://docs.oysterhr.com/docs/payroll-changes-api-guide
- Checked
- 10 Nov 2026, 23:22 UTC
- How we may use it
- Public page, crawling permitted
Technical details
- type
- page
- http status
- 200
- content hash
- sha256:ae3e08d447f79cb9068c12418f8967d68b46c9e50249cbdc2d8203e8fc24c9ff
- permission
- robots_ok
- screenshot
- Screenshot on file (internal exhibit, not published)
Cited by
Facts read from this source
-
Payroll changes purpose Report an error
“The Payroll Changes API lets you manage one-time payroll adjustments for team members. Use it for additions to regular payroll, such as bonuses, commissions, allowances, and insurance contributions.”
-
Expenses separate API Report an error
“Expense reimbursements are not payroll changes. Use the Expenses API for those.”
-
Payroll change states Report an error
“State Current status: PLANNED, APPLIED, or CANCELED”
-
Payroll change deprecated states Report an error
“Deprecated states may appear in legacy data: PAID, PENDING, and COMMITTED.”
-
Payroll changes endpoints Report an error
“List payroll changes GET /v1/payroll_changes Supports filtering by engagement and payroll period”
-
Payroll change types Report an error
“API type Description BONUS One-time bonus payment COMMISSION Sales commission or performance payment EMPLOYER_PENSION_RETIREMENT_CONTRIBUTION Employer pension or retirement contribution HEALTH_INSURANCE Health insurance supplement RISK_INSURANCE Risk or life insurance supplement TRAVEL_ALLOWANCE Travel allowance WORK_FROM_HOME_ALLOWANCE Work from home allowance WELLBEING Health and wellbeing allowance MEALS Meals or sustenance allowance”
-
Payroll change types endpoint Report an error
“The list of supported types can also be retrieved at runtime from GET /v1/payroll_changes/sources/types.”
-
Payroll changes filtering Report an error
“engagementId string No Filter by engagement ID from string No Start payroll period in YYYY-MM format, inclusive to string No End payroll period in YYYY-MM format, inclusive perPage integer No Results per page. Default and maximum are both 100 page integer No Page number, starting at 1”
-
Payroll change update restriction Report an error
“Only the amount can be updated. To change the type, month, year, or engagement, delete the payroll change and create a new one.”
-
Payroll change currency rule Report an error
“The currency code must match the engagement’s currency.”
-
Payroll change year range Report an error
“Year as a string, such as "2026". Must be between "2020" and "2040"”
-
Payroll change notes limit Report an error
“notes string No Optional description, max 2,000 characters”
-
Payroll change contractor restriction Report an error
“The engagement is not a pay-as-you-go contractor.”
-
Payroll change duplicate rule Report an error
“A create is rejected as a duplicate when the engagement, type, year, month, amount, currency, and notes all match a payroll change created within the previous 30 seconds. Canceled payroll changes are included in this check.”
-
Payroll change cancellation Report an error
“Only payroll changes in PLANNED or APPLIED state can be canceled.”
-
Payroll change cancellation permanent Report an error
“Cancellation is permanent and cannot be undone.”
-
Payroll change cancel version Report an error
“It currently exists only on /v0.1, which is a live, supported API version. There is no /v1 equivalent, so calling /v0.1 for this operation alongside /v1 for everything else is expected.”
-
Payroll change delete default reason Report an error
“This is equivalent to canceling with: JSON { "reason": "Cancelled via API" }”
-
Engagement types Report an error
“The engagement.type field in responses is either EMPLOYMENT or CONTRACT.”
Scores citing this record
- The Data Protection Officer Digital personnel file & data model
- The Data Protection Officer Payroll handoff
- The IT Integrator Digital personnel file & data model
- The IT Integrator Payroll handoff
- The Payroll Officer Payroll handoff
- The People Lead Payroll handoff
- The Skeptic Payroll handoff
- The Works Council Advocate Digital personnel file & data model
- The Works Council Advocate Payroll handoff