Skip to main content
Version: 3.x

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 @deprecated
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
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
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
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
Invoice.metafields.keys ● [String!] list scalar

Invoice.status ● JobStatusEnum! non-null enum

Job status.

Invoice.createdAt ● DateTime! non-null scalar

Date and time at which invoice was created.

Invoice.updatedAt ● DateTime! non-null scalar

Date and time at which invoice was updated.

Invoice.message ● String scalar

Message associated with an invoice.

Invoice.id ● ID! non-null scalar

The ID of the object.

Invoice.number ● String scalar

Invoice number.

Invoice.externalUrl ● String deprecated scalar

DEPRECATED

This field will be removed in Saleor 4.0. Use url field.This field will be removed in 4.0

URL to view an invoice.

Invoice.url ● String scalar

URL to view/download an invoice. This can be an internal URL if the Invoicing Plugin was used or an external URL if it has been provided.

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?