OBJECT

Invoice

Invoice items associated with an order.

link GraphQL Schema definition

  • type Invoice implements Node {
  • adjustments: [Adjustment!]!
  • amendments: [InvoiceAmendment!]!
  • annotations: [InvoiceAnnotation!]!
  • buyerBillingAddress: Address
  • buyerEmailAddress: String
  • buyerFirstName: String
  • buyerMessageToSeller: String
  • buyerPhone: String
  • buyerSurname: String
  • # Commission amount Denominated in cents. Only accessible to users:
  • # admin_authorized, seller_authorized.
  • commissionAmountCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # Commission amount In string with currency symbol. Only accessible to users:
  • # admin_authorized, seller_authorized.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • commissionAmountFormatted(currency: String): String
  • # Total commission tax amount for the invoice Denominated in cents. Only
  • # accessible to users: admin_authorized, seller_authorized.
  • commissionAmountTaxCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # Total commission tax amount for the invoice In string with currency symbol. Only
  • # accessible to users: admin_authorized, seller_authorized.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • commissionAmountTaxFormatted(currency: String): String
  • # The id used to identify the commission invoice.
  • commissionInvoiceId: String!
  • # Data for the commission invoice in PDF format (EXPENSIVE TO GENERATE) Only
  • # accessible to users: admin_authorized, seller_authorized.
  • commissionPdfData: String
  • # Link to retrieve the commission invoice in PDF format Only accessible to users:
  • # admin_authorized, seller_authorized.
  • commissionPdfLink: String
  • # Commission tax rate set in invoice
  • commissionTaxRate: Float
  • # The date the invoice was created.
  • createdAt: ISO8601DateTime!
  • deliveryType: DeliveryTypeEnum!
  • # The discount applied to the invoice. Negative value. Denominated in cents.
  • discountCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The discount applied to the invoice. Negative value. In string with currency
  • # symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • discountFormatted(currency: String): String!
  • externalIds: [ExternalID!]!
  • externalTaxApplied: Boolean!
  • id: ID!
  • # The id used to identify the invoice. Only accessible to users: admin_authorized,
  • # seller_authorized.
  • legacyId: Int!
  • lineItems: [LineItem!]!
  • # Merchant fee Denominated in cents. Only accessible to users: admin_authorized.
  • merchantFeeCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # Merchant fee In string with currency symbol. Only accessible to users:
  • # admin_authorized.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • merchantFeeFormatted(currency: String): String
  • # Total tax for service provided by marketplace operator to seller Denominated in
  • # cents. Only accessible to users: admin_authorized.
  • merchantFeeTaxTotalCents: Int @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # Total tax for service provided by marketplace operator to seller In string with
  • # currency symbol. Only accessible to users: admin_authorized.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • merchantFeeTaxTotalFormatted(currency: String): String
  • # Merchant fee tax rate set in invoice
  • merchantFeesTaxRate: Float
  • # Metadata key/values Only accessible to users: admin_authorized,
  • # seller_authorized.
  • metadata: [Metadatum!]!
  • order: Order!
  • # Seller exposed external ids from order Only accessible to users:
  • # admin_authorized, seller_authorized.
  • orderExternalIds: [ExternalID!]!
  • orderPurgedAt: ISO8601DateTime
  • # Data for the packing slip in PDF format (EXPENSIVE TO GENERATE) Only accessible
  • # to users: admin_authorized, seller_authorized.
  • packingSlipPdfData: String
  • # The date the invoice was paid.
  • paidAt: ISO8601DateTime
  • paymentInstrumentType: String
  • # data for the invoice in PDF format (EXPENSIVE TO GENERATE)
  • pdfData: String @deprecated( reason: "Use pdfData instead" )
  • # Link to retrieve the invoice in PDF format
  • pdfLink: String
  • # Postage tax rate on invoice
  • postageTaxRate: Float
  • refundRequests: [RefundRequest!]!
  • # Data for the remittance invoice in PDF format (EXPENSIVE TO GENERATE) Only
  • # accessible to users: admin_authorized, seller_authorized.
  • remittancePdfData: String
  • # Link to retrieve the remittance invoice in PDF format Only accessible to users:
  • # admin_authorized, seller_authorized.
  • remittancePdfLink: String @deprecated( reason: "Use remittancePdfData instead" )
  • # The date the remittance is processed. (This is the date the remittance_advice is
  • # created when advanced remittance is enabled) Only accessible to users:
  • # admin_authorized, seller_authorized.
  • remittedAt: ISO8601DateTime
  • seller: Seller!
  • shipments: [Shipment!]!
  • shippingAddress: Address
  • # The invoice postage cost. Denominated in cents.
  • shippingCostCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The invoice postage cost. In string with currency symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • shippingCostFormatted(currency: String): String!
  • # General description of the delivery method and estimated time in transit for the
  • # shipment.
  • shippingDescription: String!
  • # Message for user, informing them of the location from where their purchase will
  • # be shipped if applicable. Will return null if seller is multistore parent
  • # retailer.
  • #
  • # Arguments
  • # useCity: Whether to include the name of the city that the item
  • # is shipping from in the message.
  • shippingFromLocationMessage(useCity: Boolean): String
  • status: InvoiceStatusEnum! @deprecated( reason: "As an invoice can contain multiple line items, each of which which can be partially sent, partially refunded, partially awaiting return and partially cancelled all at the same time, a single status field is no longer sufficient to describe the status of an invoice. Instead, use statusFlags or look at refundRequests and invoiceAmendments to get the full picture. This field will be removed 2021-12-01. " )
  • statusFlags: [InvoiceStatusFlagEnum!]!
  • # The invoice subtotal, excluding discounts and postage. Tax is included for tax
  • # inclusive marketplaces. Denominated in cents.
  • subtotalCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The invoice subtotal, excluding discounts and postage. Tax is included for tax
  • # inclusive marketplaces. In string with currency symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • subtotalFormatted(currency: String): String!
  • # Tax rate on invoice
  • taxRate: Float
  • # The postage tax on the invoice. Denominated in cents.
  • taxShippingCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The postage tax on the invoice. In string with currency symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • taxShippingFormatted(currency: String): String!
  • # The tax on the invoice. Denominated in cents.
  • taxTotalCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # The tax on the invoice. In string with currency symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • taxTotalFormatted(currency: String): String!
  • # Total cost of the invoice, which includes subtotals and cost of shipping if
  • # applicable. Denominated in cents.
  • totalCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # Total cost of the invoice, which includes subtotals and cost of shipping if
  • # applicable. In string with currency symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • totalFormatted(currency: String): String!
  • # Total cost of the invoice, including adjustments. Denominated in cents.
  • totalIncludingAdjustmentsCents: Int! @deprecated( reason: "Prices can be larger than is representable by a graphql integer. Use the string version instead. This field will be removed no earlier than July 1st, 2025. " )
  • # Total cost of the invoice, including adjustments. In string with currency
  • # symbol.
  • #
  • # Arguments
  • # currency: Currency in which to display money fields. Defaults
  • # to the currency of the marketplace's home country.
  • totalIncludingAdjustmentsFormatted(
  • currency: String
  • ): String!
  • updatedAt: ISO8601DateTime!
  • }