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 @deprecated
url: String
order: Order
}

Fields

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

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

Invoice.privateMetafield ● String scalar miscellaneous

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 miscellaneous

Invoice.privateMetafields ● Metadata scalar miscellaneous

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 miscellaneous

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

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

Invoice.metafield ● String scalar miscellaneous

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 miscellaneous

Invoice.metafields ● Metadata scalar miscellaneous

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 miscellaneous

Invoice.status ● JobStatusEnum! non-null enum miscellaneous

Job status.

Invoice.createdAt ● DateTime! non-null scalar miscellaneous

Date and time at which invoice was created.

Invoice.updatedAt ● DateTime! non-null scalar miscellaneous

Date and time at which invoice was updated.

Invoice.message ● String scalar miscellaneous

Message associated with an invoice.

Invoice.id ● ID! non-null scalar miscellaneous

The ID of the object.

Invoice.number ● String scalar miscellaneous

Invoice number.

Invoice.externalUrl ● String deprecated scalar miscellaneous

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 miscellaneous

URL to view/download an invoice. This is an external URL to download the invoice if it has been provided.

Invoice.order ● Order object orders

Order related to the invoice.

Added in Saleor 3.10

Interfaces

ObjectWithMetadata interface miscellaneous

Job interface miscellaneous

Node interface miscellaneous

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