Jump to Content

Guides API Reference Changelog

API Reference

Guides API Reference Changelog

Authentication

Authentication
- Create or refresh an access tokenpost

Endpoints

Expenses
Contract Changes
Reseller
Benefits
Cost Estimate
- Retrieve annual cost estimates for an employmentget
- Retrieve monthly cost estimates for an employmentget
Employments
Credit notes
Invoices
Identity Verification
- Create or resume a verification sessionpost
- Retrieve the latest identity verification for an engagementget
Offboarding
Bank Accounts
Payroll Changes
Company
- Retrieve company detailsget
Departments
- Retrieve all departmentsget
Engagements
Webhooks
Time Off

Webhook Events

Benefits
- benefits.provisioning_updatedpost
Contract Changes
- contract.change_requestedpost
- contract.change_updatedpost
Engagements
Expenses
Hiring
Identity Verification
Invoicing
Offboarding
Operations
- async_operation_completedpost
Payments
Time Off

Powered by

Retrieve an credit note

get https://api.oysterhr.com/v0.1/credit_notes/{identifier}

Returns an credit note

Language

Credentials

Bearer

Click Try It! to start a request and see the response here!