For AI agents: the docs index is at https://docs.oysterhr.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Guides
API Reference
Changelog
Public Beta
v1
Log In
API Reference
Log In
v1
Guides
API Reference
Changelog
Calculators
Authentication
Authentication
Create or refresh an access token
post
Endpoints
Team Member Management
Benefits
Request benefits
post
Retrieve an employment's available benefits offerings
get
Retrieve an enrollment
get
Team Member Information
Retrieve all engagements
get
Retrieve an individual engagement
get
Retrieve bonuses for engagement
get
Retrieve allowances for engagement
get
Update personal details
patch
Documents
Retrieve payslips for engagement
get
Retrieve documents for engagement
get
Contract Changes
Retrieve all contract changes
get
Create request
post
Retrieve an individual contract change request
get
Cancel request
post
Expenses
Retrieve all expenses
get
Create expense
post
Deletes an individual expense
del
Retrieve an individual expense
get
Approve expense
post
Decline expense
post
Time Off
Retrieve public holidays
get
Retrieve entitlements
get
Retrieve entitlements for individual engagement
get
Retrieve all requests
get
Create time off request
post
Retrieve an individual request
get
Approve request
post
Upload Time Off Request Attachment
post
Cancel request
post
Reject request
post
Time Tracking
Retrieve all time sheets
get
Retrieve an individual time sheet
get
Create a time sheet
post
Submit time sheet
post
Confirm a time sheet
post
Delete an individual time sheet
del
Create time sheet entry
post
Update time sheet entry
patch
Delete time sheet entry
del
Rulesets
Retrieve expenses rulesets
get
Retrieve expense categories
get
Retrieve default expenses ruleset
get
Retrieve time tracking rulesets for engagement
get
Retrieve time tracking sources by source type for engagement
get
Retrieve rulesets for creating a contract change
get
Retrieve benefits ruleset
get
Finance
Bank Accounts
Retrieve bank accounts
get
Create bank account
post
Delete bank account
del
Retrieve Bank Account details
get
Update bank account
patch
Credit notes
Retrieve all credit notes
get
Retrieve credit notes rulesets for source statuses
get
Retrieve credit notes rulesets for source types
get
Retrieve a credit note
get
Rulesets
Retrieve invoices rulesets for source types
get
Retrieve invoices rulesets for source statuses
get
Retrieve bank account rulesets
get
Invoices
Retrieve all invoices
get
Retrieve an invoice
get
Approve invoice
post
Retrieve invoice breakdown
get
Dispute invoice
post
Calculators
Company
Reseller
Retrieve all customers
get
Create customer
post
Update customer
patch
Departments
Retrieve all departments
get
Retrieve company details
get
Consent
Revoke consent grant
del
Create consent grant
post
Hiring & Onboarding
Get hiring process tasks for an employment
get
Retrieve an individual employment
get
Invite team member
post
Create employment
post
Submit employment
post
Update employment
patch
Delete employment
del
Identity Verification
Retrieve the latest identity verification for an engagement
get
Submit an approved partner identity verification
post
Submit a declined partner identity verification
post
Create or resume a verification session
post
Cost Estimate
Retrieve annual cost estimates for an employment
get
Retrieve monthly cost estimates for an employment
get
Onboarding Forms
Get a document from the onboarding form
get
Fetch the onboarding form for a country
get
Fetch the onboarding form for an employment
get
Mark onboarding form as complete
post
Update the onboarding form
patch
Upload a document to the onboarding form
put
Agreements
Retrieve all agreements for an employment
get
Retrieve an individual agreement
get
Verify agreement
post
Documents
Upload Employment Commission Plan
post
Upload Employment Document
post
Upload Employment Work Permit
post
Delete The Uploaded Employment Work Permit
del
Delete The Uploaded Employment Document
del
Delete The Uploaded Employment Commission Plan
del
Rulesets
Rulesets for updating employment of particular country and subdivision
get
Role types for updating employment
get
API Operations
Retrieve an operation
get
Offboarding
Returns list of offboardings
get
Returns list of agreements for an offboarding
get
Returns an offboarding
get
Attach documents to a draft offboarding
post
Initiate offboarding
post
Request cancellation for an initiated offboarding
post
Resignation
Create a draft resignation for an employment
post
Create a draft resignation for a contractor
post
Termination
Create a draft termination for a payroll team member
post
Create a draft termination for an employment
post
Create a draft termination for a contractor
post
Rulesets
Returns list of offboarding pay types
get
Returns list of offboarding categories
get
Retrieve rulesets for drafting an offboarding for a payroll team member
get
Payments
Retrieve all charge groups
get
Retrieve a charge group
get
Retrieve charge group charges
get
Revoke wire sent confirmation
del
Confirm wire sent
post
Retrieve a charge
get
Retrieve a payout
get
Payroll
Retrieve all payroll
get
Retrieve an individual payroll
get
Retrieve payroll records for individual payroll
get
Payroll Changes
Retrieve all payroll changes
get
Create payroll change
post
Cancel payroll change
del
Retrieve a payroll change
get
Update a payroll change
patch
Rulesets
Retrieve payroll changes rulesets for source types
get
Retrieve default payroll changes rulesets for source types
get
Retrieve payroll changes ruleset
get
Retrieve default payroll changes ruleset
get
Webhooks
Retrieve all webhook endpoints
get
Create a webhook endpoint
post
Retrieve all webhook dispatches
get
Delete a webhook endpoint
del
Update a webhook endpoint
patch
Send a test payload to a webhook endpoint
post
Webhook Events
Benefits
benefits.provisioning_updated
webhook
benefits.enrollment_applied
webhook
benefits.enrollment_canceled
webhook
benefits.enrollment_enrolled
webhook
benefits.enrollment_finished
webhook
benefits.enrollment_opted_out
webhook
benefits.enrollment_processing_initiated
webhook
benefits.enrollment_requested
webhook
Contract Changes
contract.change_requested
webhook
contract.change_updated
webhook
contract.change_amendment_process_started
webhook
contract.change_applied
webhook
contract.change_approved
webhook
contract.change_cancelled
webhook
contract.change_pending_cancellation
webhook
contract.change_submitted
webhook
Engagements
engagements.document_deleted
webhook
engagements.document_request_ready
webhook
engagements.document_updated
webhook
engagements.document_uploaded
webhook
engagements.payslip_deleted
webhook
engagements.payslip_updated
webhook
engagements.payslip_uploaded
webhook
Expenses
expenses.expense_approved
webhook
expenses.expense_declined
webhook
expenses.expense_review_reverted
webhook
expenses.expense_created
webhook
Hiring
hiring.agreement_drafted
webhook
hiring.agreement_signed
webhook
hiring.agreement_updated
webhook
hiring.agreement_verified
webhook
hiring.employment_engaged
webhook
hiring.employment_onboarding_completed
webhook
hiring.employment_submitted
webhook
hiring.oyster_invitation_accepted
webhook
hiring.task_updated
webhook
hiring.agreement_accepted
webhook
hiring.contractor_engaged
webhook
hiring.payroll_team_member_engaged
webhook
hiring.contractor_submitted
webhook
hiring.payroll_team_member_submitted
webhook
hiring.employment_onboarding_form_clarification_request_canceled
webhook
hiring.employment_onboarding_form_clarification_request_updated
webhook
hiring.employment_onboarding_form_clarification_requested
webhook
Identity Verification
identity_verification.approved
webhook
identity_verification.declined
webhook
identity_verification.in_progress
webhook
identity_verification.resubmission_required
webhook
Invoicing
invoicing.credit_note_applied
webhook
invoicing.credit_note_issued
webhook
invoicing.credit_note_refund_initiated
webhook
invoicing.credit_note_refunded
webhook
invoicing.credit_note_voided
webhook
invoicing.credit_note_unapplied
webhook
invoicing.invoice_approved
webhook
invoicing.invoice_disputed
webhook
invoicing.invoice_issued
webhook
invoicing.invoice_modified
webhook
invoicing.invoice_reinstated
webhook
invoicing.invoice_voided
webhook
Offboarding
offboarding.agreement_generated
webhook
offboarding.agreement_sent_for_signature
webhook
offboarding.agreement_signed
webhook
offboarding.approved
webhook
offboarding.cancellation_requested
webhook
offboarding.cancelled
webhook
offboarding.engagement_terminated
webhook
offboarding.initiated
webhook
offboarding.request_updated
webhook
Operations
async_operation_completed
webhook
Payments
payments.charge_direct_debit_initiated
webhook
payments.charge_failed
webhook
payments.charge_marked_as_overdue
webhook
payments.charge_paid
webhook
payments.charge_unpaid
webhook
payments.charge_wire_transfer_requested
webhook
payments.charge_group_paid
webhook
payments.charge_group_unpaid
webhook
payments.charge_group_wire_transfer_requested
webhook
Payroll
payroll.contractor_fees_invoice_generated
webhook
payroll.contractor_fees_invoicing_initialized
webhook
payroll.pre_funding_invoice_created
webhook
payroll.settlement_invoice_created
webhook
Time Off
time_off.request_attachment_modified
webhook
time_off.request_created
webhook
time_off.request_modified
webhook
time_off.request_status_changed
webhook
Time Tracking
time_tracking.time_sheet_amendment_added
webhook
time_tracking.time_sheet_amendment_removed
webhook
time_tracking.time_sheet_approved
webhook
time_tracking.time_sheet_pending_approval
webhook
time_tracking.time_sheet_pending_submission
webhook
time_tracking.time_sheet_submitted
webhook
time_tracking.time_sheet_created
webhook
time_tracking.time_sheet_deleted
webhook
time_tracking.time_sheet_entries_modified
webhook
time_tracking.time_sheet_reviewed
webhook
Powered by
Copy Page
Calculators
Updated 11 months ago
Dispute invoice
Company
Did this page help you?
Yes
No
Updated 11 months ago
Dispute invoice
Company
Did this page help you?
Yes
No
