Skip to main content

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
  accountId: ID
  patientTitle: String
  patientDob: Date
  insuranceDetails: InvoiceInsuranceDetails
  healthcode: InvoiceHealthcodeStatus
  patientId: ID
  patient: Patient
  payeeDetails: String
  doctorId: ID
  doctor: User
  doctorHealthcodeIdentifier: String
  location: String @deprecated
  locationDetails: InvoiceLocation
  lineItems: [LineItem]
  payments: [InvoicePayment]
  refunds: [InvoiceRefund]
  tax: Float
  total: Float
  outstanding: Float
  refunded: Float
  comments: String
  extraInfo: String
  type: String
  paymentLinkUrl: String
  dateShared: DateTime
  metadata: [MetadataEntry!]
  createdAt: DateTime
  updatedAt: DateTime
  clinicalPathwayId: ID
  clinicalPathway: ClinicalPathway
}

Fields​

Invoice.id ● ID! non-null scalar​

Invoice.status ● String scalar​

Lifecycle status. Canonical values: active, cancelled.

Invoice.paidOrOutstanding ● String scalar​

Payment state derived from status and outstanding. Canonical values: Paid, Outstanding, Void.

Invoice.invoiceNumber ● Int scalar​

Invoice.paymentReference ● String scalar​

Invoice.date ● Date scalar​

Invoice.accountId ● ID scalar​

The billed account identifier (patient or insurer contact) stored on the invoice.

Invoice.patientTitle ● String scalar​

Invoice snapshot: patient title stored on the invoice at creation or last update. For the patient's current title, use patient.title.

Invoice.patientDob ● Date scalar​

Invoice snapshot: patient date of birth stored on the invoice at creation or last update. For the patient's current date of birth, use patient.dob.

Invoice.insuranceDetails ● InvoiceInsuranceDetails object​

Invoice snapshot: insurer details copied onto the invoice when created (policy number and authorisation code from the INSURER relationship matching accountId). Values may differ from the patient's current relatedAccounts if the relationship was updated after the invoice was issued.

Invoice.healthcode ● InvoiceHealthcodeStatus object​

Invoice snapshot: Healthcode submission status stored on the invoice.

Invoice.patientId ● ID scalar​

Invoice.patient ● Patient object​

Current data: live patient record. Fields such as firstName, lastName, sex, and address reflect the patient's details now and may differ from values stored on the invoice (for example if the patient has changed their name). Prefer patientTitle and patientDob on the invoice when you need invoice-time snapshots.

Invoice.payeeDetails ● String scalar​

Invoice.doctorId ● ID scalar​

Invoice.doctor ● User object​

Current data: live user record for the invoice doctor.

Invoice.doctorHealthcodeIdentifier ● String scalar​

Current data: Healthcode provider number from the invoice doctor's user profile. Used as the default for claim-level provider, payee provider, controlling specialist, and per-line provider at submission time. Reflects the doctor's current setting, not a value stored on the invoice.

Invoice.location ● String deprecated scalar​

DEPRECATED

Use locationDetails instead, which includes the full location object and metadata.

Use locationDetails instead, which includes the full location object and metadata.

Invoice.locationDetails ● InvoiceLocation object​

The location associated with the invoice, including any stored metadata (e.g. a secondary location identifier). Use this instead of location, which only returns the location name.

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​

Remaining amount due. Positive means unpaid. Queryable on Invoice; not available as a range or numeric filter.

Invoice.refunded ● Float scalar​

Invoice.comments ● String scalar​

Internal Notes.

Invoice.extraInfo ● String scalar​

Notes.

Invoice.type ● String scalar​

Invoice type. Canonical values: invoice, creditNote (credit note), paymentOnAccount (payment on account).

Invoice.paymentLinkUrl ● String scalar​

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

Invoice.dateShared ● DateTime scalar​

Invoice.metadata ● [MetadataEntry!] list object​

Invoice.createdAt ● DateTime scalar​

Invoice.updatedAt ● DateTime scalar​

Invoice.clinicalPathwayId ● ID scalar​

The clinical pathway id this invoice is linked to, if any.

Invoice.clinicalPathway ● ClinicalPathway object​

The clinical pathway this invoice is linked to, if any.

Returned By​

invoice query

Member Of​

AccountStatement object ● ClinicalPathwayAssignedObjects object ● InvoiceData object ● NewInvoiceResponsePayload object ● Patient object ● PayInvoicePayload object ● PayInvoiceWithPayload object ● PaymentOnAccountPayload object ● RefundPaymentPayload object

Implemented By​

Attachment union