Skip to main content

Invoice

Represents an Invoice.

type Invoice implements ObjectWithMetadata, Job, Node {
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  status: JobStatusEnum!
  createdAt: DateTime!
  updatedAt: DateTime!
  message: String
  id: ID!
  number: String
  externalUrl: String
  url: String
  order: Order
}

Fields​

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

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

Invoice.privateMetafield ● String scalar​

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Invoice.privateMetafield.key ● String! non-null scalar​

Invoice.privateMetafields ● Metadata scalar​

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Invoice.privateMetafields.keys ● [String!] list scalar​

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

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

Invoice.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Invoice.metafield.key ● String! non-null scalar​

Invoice.metafields ● Metadata scalar​

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Added in Saleor 3.3
This API is currently in Feature Preview and can be subject to changes at later point.
Invoice.metafields.keys ● [String!] list scalar​

Invoice.status ● JobStatusEnum! non-null enum​

Job status.

Invoice.createdAt ● DateTime! non-null scalar​

Invoice.updatedAt ● DateTime! non-null scalar​

Invoice.message ● String scalar​

Invoice.id ● ID! non-null scalar​

The ID of the object.

Invoice.number ● String scalar​

Invoice.externalUrl ● String scalar​

Invoice.url ● String scalar​

URL to download an invoice.

Invoice.order ● Order object​

Order related to the invoice.

Added in Saleor 3.10

Interfaces​

ObjectWithMetadata interface​

Job interface​

Node interface​

An object with an ID

Member of​

InvoiceCreate object ● InvoiceDelete object ● InvoiceDeleted object ● InvoiceRequest object ● InvoiceRequestDelete object ● InvoiceRequested object ● InvoiceSendNotification object ● InvoiceSent object ● InvoiceUpdate object ● Order object

Was this page helpful?