List All Customer Invoices

get

https://api.sandbox.hint.com/api/provider/customer_invoices

Returns invoices in every status, including draft and cancelled (voided). Invoices are
returned newest first, by when they were created.
To filter by several statuses, repeat the status parameter with brackets, such as
status[]=issued&status[]=sent.

Query Params

limit

int32

Defaults to 10, maximum 100. A larger value returns 100.

offset

int32

Defaults to 0.

sort

string

Sort by date, status, invoice_number, created_at or updated_at, such as sort=date; prefix - for descending, such as sort=-date. Ties break by creation order, newest first.

owner

string

Filter by invoice owner, the patient who pays the invoice. This is not necessarily the patient on each charge: a dependent's charges are billed to their payer. A patient id, such as pat- (or sbx-pat- in sandbox).

location

string

Filter by invoice location. A location id, such as loc- (or sbx-loc- in sandbox).

status

array of strings

Filter by invoice status. cancelled is a voided invoice.

status

updated_at

date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

created_at

date-time

Allows filtering by date or time. Accepts an object with allowed keys of [gte, gt, lte, lt] and a value of the date or time in iso8601 format. See advanced querying for more information.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response