Invoices

Fetch an invoice

Fetches an invoice by its ID.

An invoice represents a bill for services rendered to a clinic patient during a visit. Each invoice is associated with a clinic, a client (pet parent), and contains line items for the services and products provided. Invoices track totals, discounts, payments, and remaining balance.

get/ext/v2/invoices/{invoice_id}/

Request

  • Base URL
    https://connect.vetcove.com
  • URL
    https://connect.vetcove.com/ext/v2/invoices/{invoice_id}/
  • Auth
    HTTP bearer

Path parameters

invoice_idinteger required

The ID of the invoice to fetch

Response

OK

amount_paidinteger required

The amount paid so far for this invoice

clinic_client_idinteger required

The ID of the client this invoice is for

clinic_idinteger required

The ID of the clinic which issued this invoice

createdstring date-time required

The datetime this object was created.

date_postedstring date-time required

The datetime this invoice was posted

deletedstring date-time nullable required

The datetime this record was soft deleted.

discountinteger required

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

finalized_atstring date-time nullable required

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

idinteger required

The unique identifier for the invoice

is_deletedboolean required

Whether this record is soft deleted or not.

locked_atstring date-time nullable required

The datetime at which this invoice was marked as locked

marked_as_collections_atstring date-time nullable required

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

marked_not_rendered_atstring date-time nullable required

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

modifiedstring date-time required

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

remaining_balanceinteger required

The remaining balance for this invoice

subtotalinteger required

The subtotal due for this invoice

taxinteger required

The amount of tax charged to the client for this invoice

totalinteger required

The total amount billed to the client for this invoice

Changes

No recorded changes to this operation across all 1 revision of this API.