Skip to main content
GET
Fetch an invoice item

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

pk
integer
required

Response

200 - application/json

OK

clinic_client_id
integer
required

The ID of the client (pet parent) on the invoice.

clinic_id
integer
required

The ID of the clinic that issued the invoice.

clinic_patient_id
integer
required

The ID of the patient this item is for.

created
string<date-time>
required

The datetime this object was created.

date_posted
string<date-time>
required

The date and time when this item was posted.

deleted
string<date-time> | null
required

The datetime this record was soft deleted.

description
string
required

The display description of the line item.

discount
integer
required

The discount applied to this item, in cents.

id
integer
required

The unique identifier for the invoice item.

invoice_id
integer
required

The ID of the invoice this item belongs to.

is_declined
boolean
required

Whether the client declined this item.

is_deleted
boolean
required

Whether this record is soft deleted or not.

kind
enum<string>
required

Whether the item is an in-clinic service or a take-home product.

Available options:
IN_CLINIC,
TAKE_HOME
modified
string<date-time>
required

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

quantity
required

The quantity of the item.

subtotal
integer
required

The subtotal for the item before discounts and taxes, in cents.

tax
integer
required

The tax applied to this item, in cents.

total
integer
required

The total for the item after discounts and taxes, in cents.

unit_price
integer
required

The unit price of the item, in cents.

group_bundle_code
string | null

The human-visible bundle code for this line item, if it is a bundle.

group_bundle_id
integer | null

The ID of the group bundle for this line item, if it is a bundle.

group_service_code
string | null

The human-visible service code for this line item, if it is a service.

group_service_id
integer | null

The ID of the group service (catalog item) for this line item, if it is a service.

provider_clinic_user_id
integer | null

The ID of the clinic user assigned to this item. May be null even when provider_clinic_user_name is present, for items imported from an external PIMS whose provider has not been matched to a clinic user.

provider_clinic_user_name
string | null

The display name of the clinic user assigned to this item. Derived from the clinic user when provider_clinic_user_id is present, or from the imported PIMS provider name otherwise.