List invoices
/v1/invoicesReturns a page of invoices. Filters combine with AND. Use next_cursor to fetch the next page. Available to keys belonging to office staff.
Query parameters
Number of objects to return, from 1 to 100.
The next_cursor from the previous page. Send the same filters with it.
Only return invoices for this patient.
Only return invoices with this status.
DraftPendingProcessingPaidPartiallyPaidOverdueCancelledRefundedFailedOnly return objects created after this time (exclusive). ISO 8601 with a time zone.
Only return objects created before this time (exclusive). ISO 8601 with a time zone.
Only return objects last changed after this time (exclusive). ISO 8601 with a time zone. Use it for incremental sync: pass the newest updatedAt you already have.
Only return objects last changed before this time (exclusive). ISO 8601 with a time zone.
Response
200A page of results.
Always list.
The invoices on this page.
Show item attributesHide item attributes(24)
String representing the object's type. Always invoice.
Unique identifier of the invoice.
Invoice number shown to the patient.
The patient billed.
Payment status.
DraftPendingProcessingPaidPartiallyPaidOverdueCancelledRefundedFailednullDate of the invoice.
Date payment is due.
First day of service billed.
Last day of service billed.
Description shown on the invoice.
Three-letter currency code.
Total before tax, discounts and credits. In cents.
Tax. In cents.
Discounts applied. In cents.
Account credit applied. In cents.
Invoice total. In cents.
Amount paid so far. In cents.
Amount still owed. In cents.
Visits billed on this invoice.
Whether AveeCare created the invoice automatically when a visit was completed.
When the invoice was sent.
When the invoice was paid in full.
When the invoice was created.
When the invoice was last changed.
Pass as cursor to fetch the next page. null on the last page.
Whether another page exists.
Response headers
Request-IdstringUnique ID of this request. Quote it when contacting support.RateLimit-LimitintegerRequests allowed in the current window.RateLimit-RemainingintegerRequests left in the current window.RateLimit-ResetintegerSeconds until the window resets.Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | n/a | The request was malformed, a value was invalid, or it contained an unknown field (invalid_request, unknown_field). |
| 401 | n/a | The API key is missing, malformed, expired or revoked (unauthorized). |
| 403 | n/a | The key is read-only (insufficient_scope), or its user's role cannot do this (forbidden). |
| 429 | n/a | Too many requests (rate_limited). Wait for Retry-After seconds. |
| 500 | n/a | Something went wrong on our side (internal_error). Retry, and quote the request ID if it persists. |
Every error uses the same body. See Errors for the full list of codes.