API Reference

Retrieve all invoices

get
https://api.oysterhr.com/v0.1/invoices

Returns company's invoices.

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 invoice types

types[]
statuses[]
array

Filter by invoice statuses

statuses[]
engagement_ids[]
array of strings

Filter by engagement IDs

engagement_ids[]
customer_ids[]
array of strings

Filter by customer IDs

customer_ids[]
charge_statuses[]
array

Filter by charge statuses

charge_statuses[]
payout_statuses[]
array

Filter by payout statuses

payout_statuses[]
Response

Updated 7 months ago

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