Skip to main content

LineItem

An entry in an invoice.

type LineItem {
  id: ID
  referenceId: ID
  referenceType: String
  date: Date
  title: String
  productType: String
  itemCode: String
  product: Product
  cost: Float
  price: Float
  quantity: Float
  taxRate: Float
  total: Float
  netTotal: Float
  healthcodeCode: String
  providerHealthcodeIdentifier: String
  healthcode: LineItemHealthcode
  priceResolution: LineItemPriceResolution
}

Fields​

LineItem.id ● ID scalar​

LineItem.referenceId ● ID scalar​

The ID of the object this line item is associated with.

LineItem.referenceType ● String scalar​

The type of object referenced by referenceId. Possible values are Booking, Record, Product, MembershipProduct, and Pathway.

LineItem.date ● Date scalar​

LineItem.title ● String scalar​

LineItem.productType ● String scalar​

LineItem.itemCode ● String scalar​

LineItem.product ● Product object​

Current data: related product for this line item, including metadata. Returns null when no product can be resolved.

LineItem.cost ● Float scalar​

LineItem.price ● Float scalar​

LineItem.quantity ● Float scalar​

LineItem.taxRate ● Float scalar​

LineItem.total ● Float scalar​

LineItem.netTotal ● Float scalar​

Invoice snapshot: line total including tax (total + total × taxRate / 100 when taxRate is set), matching Healthcode NetTotal.

LineItem.healthcodeCode ● String scalar​

Invoice snapshot: preferred Healthcode item code — healthcode.serviceCode when set, otherwise healthcode.industryStandardCode.

LineItem.providerHealthcodeIdentifier ● String scalar​

Current data: default Healthcode provider number for this line, from the invoice doctor's user profile (same default as doctorHealthcodeIdentifier). Submission may override per line.

LineItem.healthcode ● LineItemHealthcode object​

Invoice snapshot: Healthcode service and procedure codes stored on the line item.

LineItem.priceResolution ● LineItemPriceResolution object​

Invoice snapshot: billing-rule price resolution stored on this line item. Returns null when no billing-rule snapshot exists.

Member Of​

Invoice object