Invoices

Invoices billed to patients and their families for private-pay care. Read-only.

Endpoints

The Invoice object

object
stringread-only

String representing the object's type. Always invoice.

id
stringread-only

Unique identifier of the invoice.

invoiceNumber
string | nullread-onlymax length 2000

Invoice number shown to the patient.

patientId
string | nullread-onlymax length 64

The patient billed.

status
string | nullread-only

Payment status.

One ofDraftPendingProcessingPaidPartiallyPaidOverdueCancelledRefundedFailednull
invoiceDate
string · date | nullread-only

Date of the invoice.

dueDate
string · date | nullread-only

Date payment is due.

periodStart
string · date | nullread-only

First day of service billed.

periodEnd
string · date | nullread-only

Last day of service billed.

description
string | nullread-onlymax length 20000

Description shown on the invoice.

currency
string | nullread-onlymax length 2000

Three-letter currency code.

subtotalCents
integer | nullread-only

Total before tax, discounts and credits. In cents.

taxCents
integer | nullread-only

Tax. In cents.

discountCents
integer | nullread-only

Discounts applied. In cents.

creditAppliedCents
integer | nullread-only

Account credit applied. In cents.

totalCents
integer | nullread-only

Invoice total. In cents.

amountPaidCents
integer | nullread-only

Amount paid so far. In cents.

amountDueCents
integer | nullread-only

Amount still owed. In cents.

visitIds
array of strings | nullread-only

Visits billed on this invoice.

isAutoBilled
boolean | nullread-only

Whether AveeCare created the invoice automatically when a visit was completed.

sentAt
string · date-time | nullread-only

When the invoice was sent.

paidDate
string · date-time | nullread-only

When the invoice was paid in full.

createdAt
string · date-time | nullread-only

When the invoice was created.

updatedAt
string · date-time | nullread-only

When the invoice was last changed.