Invoice

Invoices are used to record the information related to charges incurred by patients.

type Invoice {
  id: ID!
  status: String
  paidOrOutstanding: String
  invoiceNumber: Int
  paymentReference: String
  date: Date
  patientId: ID
  patient: Patient
  payeeDetails: String
  doctorId: ID
  doctor: User
  location: String
  lineItems: [LineItem]
  payments: [InvoicePayment]
  refunds: [InvoiceRefund]
  tax: Float
  total: Float
  outstanding: Float
  refunded: Float
  comments: String
  extraInfo: String
  type: String
  paymentLinkUrl: String
  dateShared: DateTime
  createdAt: DateTime
  updatedAt: DateTime
}

Fields

Invoice.id ● ID! non-null scalar

Invoice.status ● String scalar

Invoice.paidOrOutstanding ● String scalar

Invoice.invoiceNumber ● Int scalar

Invoice.paymentReference ● String scalar

Invoice.date ● Date scalar

Invoice.patientId ● ID scalar

Invoice.patient ● Patient object

Invoice.payeeDetails ● String scalar

Invoice.doctorId ● ID scalar

Invoice.doctor ● User object

Invoice.location ● String scalar

Invoice.lineItems ● [LineItem] list object

Invoice.payments ● [InvoicePayment] list object

Invoice.refunds ● [InvoiceRefund] list object

Invoice.tax ● Float scalar

Invoice.total ● Float scalar

Invoice.outstanding ● Float scalar

Invoice.refunded ● Float scalar

Invoice.comments ● String scalar

Internal Notes.

Invoice.extraInfo ● String scalar

Notes.

Invoice.type ● String scalar

Invoice.paymentLinkUrl ● String scalar

Payment form url (requires integration, already paid invoices will not return the url).

Invoice.dateShared ● DateTime scalar

Invoice.createdAt ● DateTime scalar

Invoice.updatedAt ● DateTime scalar

Returned By

invoice query

Member Of

AccountStatement object ● Episode object ● InvoiceData object ● NewInvoiceResponsePayload object ● Patient object

Implemented By

Attachment union