InvoiceItem

View normalized Markdown

InvoiceItem data available to a scoped Management API integration.

graphql
type InvoiceItem {
  createdAt: DateTime!
  currency: String!
  description: String
  discardedAt: DateTime
  groupingName: String
  groupingSpan: TsRange
  id: ID!
  invoiceId: ID
  name: String
  number: String
  orderItemId: ID
  priceValueCents: BigInt
  pricingId: ID
  productId: ID
  quantity: Int
  shippingState: String
  taxes: [TaxLine!]!
  tombstone: Boolean!
  totalDiscountCents: BigInt!
  totalGrossValueCents: BigInt!
  totalNetValueCents: BigInt!
  updatedAt: DateTime!
}

Fields

InvoiceItem.createdAt · DateTime! non-null scalar

Record creation timestamp.

InvoiceItem.currency · String! non-null scalar

Currency of the gross total.

InvoiceItem.description · String scalar

Description.

InvoiceItem.discardedAt · DateTime scalar

When the record was discarded; null for an active record.

InvoiceItem.groupingName · String scalar

Grouping name.

InvoiceItem.groupingSpan · TsRange scalar

Grouping span.

InvoiceItem.id · ID! non-null scalar

Stable record identifier.

InvoiceItem.invoiceId · ID scalar

Invoice id.

InvoiceItem.name · String scalar

Display name when the resource provides one.

InvoiceItem.number · String scalar

External-facing record number when the resource provides one.

InvoiceItem.orderItemId · ID scalar

Order item id.

InvoiceItem.priceValueCents · BigInt scalar

Price value cents.

InvoiceItem.pricingId · ID scalar

Pricing id.

InvoiceItem.productId · ID scalar

Product id.

InvoiceItem.quantity · Int scalar

Quantity.

InvoiceItem.shippingState · String scalar

Shipping state.

InvoiceItem.taxes · [TaxLine!]! non-null object

Recorded tax components for this line.

InvoiceItem.tombstone · Boolean! non-null scalar

True when the discarded record represents a removal to propagate locally.

InvoiceItem.totalDiscountCents · BigInt! non-null scalar

Total line discount in the line currency.

InvoiceItem.totalGrossValueCents · BigInt! non-null scalar

Gross total including discounts and taxes, in minor currency units.

InvoiceItem.totalNetValueCents · BigInt! non-null scalar

Line total after discounts, excluding all taxes, in the line currency.

InvoiceItem.updatedAt · DateTime! non-null scalar

Timestamp used for incremental synchronization and cursor ordering.

Returned By

invoiceItem query

Member Of

InvoiceItemCollection object

Ready to Get Started?

Book a free demo or reach out — we’d love to hear from you.