Invoice

Invoices can be used to collect payments from patients. Invoices can be directly sent to the patient's email for a patient to complete or can be automatically collected if the patient's billing information is on file.

The invoice model

Name
id
Type
string
Description
Unique identifier for the invoice.
Name
object
Type
string
Description
Always 'invoice'.
Name
name
Type
string
Description
Name of the invoice
Name
patient
Type
string
Description
Patient invoice is associated with.
Name
product
Type
string
Description
Product this invoice is for.
Name
collection_method
Type
string
Description
Possible values:
chargeAutomatically
sendInvoice
Name
comments
Type
array of strings
Description
Comments on this invoice.
Name
reviews
Type
array of objects
Description
Review history of the invoice.
Name
status_history
Type
array of objects
Description
Status history of the invoice.
Name
change_log
Type
string
Description
Change log containing a record of all the changes to the invoice.
Name
created_by
Type
string
Description
Creator of the invoice.
Name
created_at
Type
number
Description
Timestamp (in Unix epoch time in milliseconds) of when the invoice was created.
Name
last_updated_at
Type
number
Description
Timestamp (in Unix epoch time in milliseconds) of when this invoice was last updated.

Response

{
    "id": "invc_LNIRgmClsk0Oq6yMz6nQ",
    "object": "invoice",
    "name": "Physical Health Checkup — May 30, 2023",
    "patient": "user_Z1zXZKvqrpwxbznuW6lJ",
    "product": "prdt_5SR7xXuPb45mtLZUKHtf",

    "collectionMethod": "sendInvoice",

    "comments": [
        "cmmt_18Efdm5UBJduDbioH1kp"
    ],
    "reviews": [
        {
            "status": "needs_review",
            "requested_by": "user_idjkvxZTqfJD734feQHa",
            "reviewer": "user_QtD0YaeDw4VyS9UPBpX4",
            "requested_at": 1684220332000,
            "review_deadline": 1686220332000,
            "reviewed_at": 1684220992000
        }
    ],
    "status_history": [
        {
            "status": "in_progress",
            "changed_by": "user_idjkvxZTqfJD734feQHa",
            "changed_at": 1653798303000
        },
        {
            "status": "sent",
            "changed_by": "user_idjkvxZTqfJD734feQHa",
            "changed_at": 1684220992000
        }
    ],
    "change_log": "clog_24B8OMJAIR2SiWqGQDrc",
    "created_by": "user_Z1zXZKvqrpwxbznuW6lJ",
    "created_at": 1653798303000,
    "last_updated_at": 1653798303000
}