Invoice Object
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
privateMetadata ● [MetadataItem!]!
List of private metadata items. Requires staff permissions to access.
privateMetafield ● String
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
key ● String!
privateMetafields ● Metadata
Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.
keys ● [String!]
metadata ● [MetadataItem!]!
List of public metadata items. Can be accessed without permissions.
metafield ● String
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
key ● String!
metafields ● Metadata
Public metadata. Use keys to control which fields you want to include. The default is to include everything.
keys ● [String!]
status ● JobStatusEnum!
Job status.
createdAt ● DateTime!
Date and time at which invoice was created.
updatedAt ● DateTime!
Date and time at which invoice was updated.
message ● String
Message associated with an invoice.
id ● ID!
The ID of the object.
number ● String
Invoice number.
url ● String
URL to view/download an invoice.
order ● Order
Order related to the invoice.
Show deprecatedHide deprecated
Interfaces
ObjectWithMetadata
Job
Node
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