Skip to main content
POST
List Invoices V2

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
organization
string
required

Filter by organization ID

Example:

"1700000000000x444444444444444444"

limit
integer<int32>
default:100
required
Required range: 1 <= x <= 200
Example:

100

offset
integer<int32>
default:0
required
Required range: x >= 0
Example:

0

id
string

Filter by invoice ID

Example:

"1700000000000x000000000000000000"

clinic
string

Filter by clinic ID

Example:

"1700000000000x111111111111111111"

user
string

Filter by user ID

Example:

"1700000000000x222222222222222222"

subscription
string

Filter by subscription ID

Example:

"1700000000000x333333333333333333"

status
string

Filter by invoice status

Example:

"Paid"

invoice_pims_id
string

Filter by PIMS invoice ID

Example:

"INV-12345"

spanner_invoice_id
string

Filter by Spanner invoice ID

Example:

"spn_inv_abc123"

modified_since
string<date-time>

Filter: internal modified_date >= value

Example:

"2025-01-01T00:00:00Z"

created_at_since
string<date-time>

Filter: bubble created date >= value

Example:

"2025-01-01T00:00:00Z"

updated_at_since
string<date-time>

Filter: bubble modified date >= value

Example:

"2025-01-01T00:00:00Z"

include_deleted
boolean
default:false

Include soft-deleted rows

Example:

false

Response

200 - application/json

A list of invoices

id
string
organization
string
clinic
string
date
string<date-time>
invoice_lines
string[]
invoice_pims_id
string
pets
string[]
status
string
subscriptions
string[]
subtotal
number<double>
tax
number<double>
total
number<double>