Skip to main content
GET
Invoices
When to use it: To find an invoice by patient, status or issue date, or to see which invoices are still unpaid. Amounts are in cents.

Authorizations

Authorization
string
header
required

Brelio API key (organization or user) or a WorkOS access token.

Query Parameters

cursor
string

next_cursor of the previous page. Omit it for the first page.

Maximum string length: 200
limit
integer
default:25

Page size, 1 to 100.

Required range: 1 <= x <= 100
patientId
string<uuid>

Only this patient’s invoices.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
status
enum<string>

Only invoices in this status.

Available options:
draft,
issued,
paid,
partial,
void,
overdue,
credit_note_issued,
refunded
issuedFrom
string<date-time>

Only invoices issued at or after, ISO 8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
issuedTo
string<date-time>

Only invoices issued at or before, ISO 8601.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
includeVoided
boolean

Also list voided invoices. Default false.

Response

Success

data
object[]
required
next_cursor
string | null
required

Pass it as cursor to read the next page; null on the last page.

has_more
boolean
required