Invoice

Represents an invoice.

type Invoice implements Node, ObjectWithMetadata, Job {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  status: JobStatusEnum!
  createdAt: DateTime!
  updatedAt: DateTime!
  message: String
  number: String!
  url: String
  externalUrl: String
  isValid: Boolean!
  isEditable: Boolean!
  timeline(
    kinds: [TimelineEntryKind!]
  ): [TimelineEntry!]!
}

Fields

Invoice.id ● ID! non-null scalar

The Globally Unique ID of this object

Invoice.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Invoice.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items. Requires proper staff permissions to access.

Invoice.status ● JobStatusEnum! non-null enum

Job status.

Invoice.createdAt ● DateTime! non-null scalar

Created date time of job in ISO 8601 format.

Invoice.updatedAt ● DateTime! non-null scalar

Date time of job last update in ISO 8601 format.

Invoice.message ● String scalar

Job message.

Invoice.number ● String! non-null scalar

Invoice number

Invoice.url ● String scalar

URL to download an invoice

Invoice.externalUrl ● String scalar

External URL for the invoice

Invoice.isValid ● Boolean! non-null scalar

Whether the invoice is valid

Invoice.isEditable ● Boolean! non-null scalar

Whether the invoice is editable

Invoice.timeline ● [TimelineEntry!]! non-null object

Unified change-history feed for this invoice. Projects the legacy InvoiceEvent log into a TimelineEntry list ordered most-recent-first, so invoice history renders through the same dashboard component as the order, seller and product timelines. Entries name the related order or refund when the event has one. Optional kinds argument filters server-side.

Invoice.timeline.kinds ● [TimelineEntryKind!] list enum

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Job interface

An async job that tracks status and progress.

Member Of

InvoiceCancel object ● InvoiceCreate object ● InvoiceDelete object ● InvoiceFinalize object ● InvoiceRefresh object ● InvoiceRequest object ● InvoiceRequestDelete object ● InvoiceSendNotification object ● InvoiceUpdate object ● NauticalOrder object ● Order object