Skip to main content

An invoice represents a bill issued by a clinic to a client (pet parent) for services rendered, products sold, or other charges. Invoices track the total amount, payments made, discounts applied, and remaining balance.

​
amount_paid
integer
required

The amount paid so far for this invoice

Required range: x >= 0
​
clinic_client_id
integer
required

The ID of the client this invoice is for

​
clinic_id
integer
required

The ID of the clinic which issued this invoice

​
created
string<date-time>
required

The datetime this object was created.

​
date_posted
string<date-time>
required

The datetime this invoice was posted

​
deleted
string<date-time> | null
required

The datetime this record was soft deleted.

​
discount
integer
required

The discount given to the client for this invoice, if any

Required range: x >= 0
​
finalized_at
string<date-time> | null
required

The datetime at which this invoice was marked as finalized and became due

​
id
integer
required

The unique identifier for the invoice

​
is_deleted
boolean
required

Whether this record is soft deleted or not.

​
locked_at
string<date-time> | null
required

The datetime at which this invoice was marked as locked

​
marked_as_collections_at
string<date-time> | null
required

The datetime at which this invoice was marked as collections (a.k.a. written off)

​
marked_not_rendered_at
string<date-time> | null
required

The datetime at which this invoice was marked as not-rendered

​
modified
string<date-time>
required

The datetime this object was last modified; changes to related entities will not update this field.

​
remaining_balance
integer
required

The remaining balance for this invoice

​
status
required

The status of the invoice

Available options:
IN_PROGRESS,
READY_FOR_PAYMENT,
FINALIZED,
LOCKED,
IMPORTED
​
subtotal
integer
required

The subtotal due for this invoice

Required range: x >= 0
​
tax
integer
required

The amount of tax charged to the client for this invoice

Required range: x >= 0
​
total
integer
required

The total amount billed to the client for this invoice