API Reference

Retrieve all credit notes

get
https://api.oysterhr.com/v1/credit_notes

Returns company's credit notes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
reference_codes[]
array of strings

Filter by reference codes

reference_codes[]
string

Filter by payroll period start date (YYYY-MM format)

string

Filter by payroll period end date (YYYY-MM format)

string

Filter by issue date start (YYYY-MM-DD format)

string

Filter by issue date end (YYYY-MM-DD format)

types[]
array

Filter by credit note types

types[]
statuses[]
array

Filter by credit note statuses

statuses[]
Response

Updated 6 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 months ago