Retrieve an invoice
/v1/invoices/{id}Returns one invoice by ID. Available to keys belonging to office staff.
Path parameters
ID of the invoice.
Response
200The invoice.
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.
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 |
|---|---|---|
| 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). |
| 404 | n/a | No such object, or it is not visible to this key (not_found). |
| 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.