Skip to main content

Invoice

The Invoice type represents an invoice, which is a document that contains the costs of energy usage.

type Invoice implements Node {
  id: UUID!
  type: InvoiceType!
  status: InvoiceStatus!
  totalPrice: Price!
  invoiceNumber: String!
  document: Asset
  from: Time
  until: Time
  createdAt: Time!
  creditInvoices: [Invoice!]
  creditInfo: InvoiceCreditInfo
  paymentMethod: InvoicePaymentMethod!
}

Fields​

Invoice.id ● UUID! non-null scalar​

The unique identifier of the invoice.

Invoice.type ● InvoiceType! non-null enum​

The type of the invoice (e.g., monthly, yearly, etc.).

Invoice.status ● InvoiceStatus! non-null enum​

The status of the invoice. This indicates the current state of the invoice.

Invoice.totalPrice ● Price! non-null object​

The total cost of the invoice.

Invoice.invoiceNumber ● String! non-null scalar​

The unique number of the invoice.

Invoice.document ● Asset object​

The invoice document that contains the costs of the energy usage.

Invoice.from ● Time scalar​

The from date of the invoice period.

Invoice.until ● Time scalar​

The end date of invoice period. This time is inclusive.

Invoice.createdAt ● Time! non-null scalar​

The date the invoice was created.

Invoice.creditInvoices ● [Invoice!] list object​

CreditInvoices is list of all credit invoices related to the invoice. An invoice can only have a single credit invoice, but that invoice can be credited itself, etc.

Invoice.creditInfo ● InvoiceCreditInfo object​

Credit info contains additional information about why an invoice was credited. Returns null for non-credit invoices.

Invoice.paymentMethod ● InvoicePaymentMethod! non-null enum​

The payment method indicates how the invoice will be paid.

Interfaces​

Node interface​

An object with a Globally Unique ID

Member Of​

Invoice object ● InvoiceEdge object