Line Items Queries

Access line items from documents with pricing and tax details.

`LineItem` — Returns a single line item based on the `id` provided

query GetLineItem($id: ID) {
  LineItem(id: $id) {
    id
    line_itemable { id label }
    line_itemable_type
    sku
    label
    variant_type
    barcode
    variant { id label }
    location { id label }
    quantity
    quantity_aggregate
    price
    weight
    drop_shipping
    parent_id
    origin_id
    delivered_quantity
    committed
    on_hand
    available
    incoming
    shipped_quantity
    reserved
    description
    kit_line_item_id
    type
    batch_numbers { id }
  }
}

{
  "id": 100012
}

`LineItemCreditNotes` — Returns line items for credit notes

query GetLineItemCreditNotes(
  $where: QueryLineItemCreditNotesWhereWhereConditions,
  $orderBy: [QueryLineItemCreditNotesOrderByOrderByClause!],
  $groupBy: [QueryLineItemCreditNotesGroupByGroupByClause!]
) {
  LineItemCreditNotes(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      discount
      discount_type
      ecotax
      total
      customer { id label }
      tax_codes { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      calculate_price_from_components
      weight
      drop_shipping
      on_hand
      available
      incoming
      uncredited_quantity
      description
      replace_label
      kit_line_item_id
      type
      parent_id
      batch_numbers { id }
    }
  }
}

{
  "where": {
    "AND": [
      { "column": "CUSTOMER_ID", "operator": "EQ", "value": 100001 }
    ]
  },
  "orderBy": [
    { "column": "LABEL", "order": "ASC" }
  ]
}

`LineItemEstimates` — Returns line items for estimates

query GetLineItemEstimates(
  $where: QueryLineItemEstimatesWhereWhereConditions,
  $orderBy: [QueryLineItemEstimatesOrderByOrderByClause!],
  $groupBy: [QueryLineItemEstimatesGroupByGroupByClause!]
) {
  LineItemEstimates(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      estimate_number
      customer { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      calculate_price_from_components
      weight
      drop_shipping
      on_hand
      available
      incoming
      transformed_quantity
      billed_quantity
      unbilled_quantity
      paid_quantity
      unpaid_quantity
      ordered_quantity
      unordered_quantity
      description
      replace_label
      kit_line_item_id
      discount_type
      discount
      tax_amount
      ecotax
      total
      tax_codes { id label }
      type
      parent_id
      origin_id
      batch_numbers { id }
    }
  }
}

{
  "where": {
    "AND": [
      { "column": "BILLED_QUANTITY", "operator": "GT", "value": 0 }
    ]
  },
  "orderBy": [
    { "column": "BILLED_QUANTITY", "order": "DESC" }
  ]
}

`LineItemPurchases` — Returns line items for purchases

query GetLineItemPurchases(
  $where: QueryLineItemPurchasesWhereWhereConditions,
  $orderBy: [QueryLineItemPurchasesOrderByOrderByClause!],
  $groupBy: [QueryLineItemPurchasesGroupByGroupByClause!]
) {
  LineItemPurchases(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      supplier { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      weight
      drop_shipping
      on_hand
      available
      incoming
      reserved_quantity
      delivered_quantity
      uncommitted_quantity
      committed_quantity
      description
      kit_line_item_id
      type
      parent_id
      batch_numbers { id }
    }
  }
}

{
  "where": {
    "AND": [
      { "column": "DELIVERED", "operator": "GT", "value": 0 }
    ]
  },
  "orderBy": [
    { "column": "DELIVERED", "order": "DESC" }
  ]
}

`LineItemPurchaseReceipts` — Returns line items for purchase receipts

query GetLineItemPurchaseReceipts(
  $where: QueryLineItemPurchaseReceiptsWhereWhereConditions,
  $orderBy: [QueryLineItemPurchaseReceiptsOrderByOrderByClause!],
  $groupBy: [QueryLineItemPurchaseReceiptsGroupByGroupByClause!]
) {
  LineItemPurchaseReceipts(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      weight
      drop_shipping
      parent_id
      on_hand
      available
      incoming
      delivered_quantity
      reserved_quantity
      uncommitted_quantity
      committed_quantity
      description
      kit_line_item_id
      type
      batch_numbers { id }
    }
  }
}

{
  "where": {
    "AND": [
      { "column": "DELIVERED", "operator": "GT", "value": 0 }
    ]
  },
  "orderBy": [
    { "column": "DELIVERED", "order": "DESC" }
  ]
}

`LineItemProductReturns` — Returns line items for product returns

query GetLineItemProductReturns(
  $where: QueryLineItemProductReturnsWhereWhereConditions,
  $orderBy: [QueryLineItemProductReturnsOrderByOrderByClause!],
  $groupBy: [QueryLineItemProductReturnsGroupByGroupByClause!]
) {
  LineItemProductReturns(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      customer { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      weight
      drop_shipping
      parent_id
      on_hand
      available
      incoming
      shipped_quantity
      committed_quantity
      reserved_quantity
      description
      kit_line_item_id
      type
      batch_numbers { id }
    }
  }
}

{
  "where": {
    "AND": [
      { "column": "SHIPPED", "operator": "GT", "value": 0 }
    ]
  },
  "orderBy": [
    { "column": "COMMITTED", "order": "DESC" }
  ]
}

`LineItemInvoices` — Returns line items for invoices

query GetLineItemInvoices(
  $where: QueryLineItemInvoicesWhereWhereConditions,
  $orderBy: [QueryLineItemInvoicesOrderByOrderByClause!],
  $groupBy: [QueryLineItemInvoicesGroupByGroupByClause!]
) {
  LineItemInvoices(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      customer { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      calculate_price_from_components
      weight
      drop_shipping
      on_hand
      available
      incoming
      unbilled_quantity
      unpaid_quantity
      returned_quantity
      unreturned_quantity
      credited_quantity
      uncredited_quantity
      parent { id }
      description
      discount_type
      discount
      tax_amount
      ecotax
      total
      tax_codes { id label }
      replace_label
      kit_line_item_id
      type
      parent_id
      origin_id
      batch_numbers { id }
    }
  }
}

{
  "where": {
    "AND": [
      { "column": "RETURNED_QUANTITY", "operator": "GT", "value": 0 }
    ]
  },
  "orderBy": [
    { "column": "RETURNED_QUANTITY", "order": "DESC" }
  ]
}

`LineItemShippingOrders` — Returns line items for shipping orders

query GetLineItemShippingOrders(
  $where: QueryLineItemShippingOrdersWhereWhereConditions,
  $orderBy: [QueryLineItemShippingOrdersOrderByOrderByClause!],
  $groupBy: [QueryLineItemShippingOrdersGroupByGroupByClause!]
) {
  LineItemShippingOrders(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      weight
      drop_shipping
      parent_id
      origin_id
      on_hand
      available
      incoming
      committed_quantity
      uncommitted_quantity
      shipped_quantity
      reserved_quantity
      delivered_quantity
      description
      kit_line_item_id
      type
      batch_numbers { id }
    }
  }
}

{
  "where": {
    "AND": [
      { "column": "SHIPPED", "operator": "GT", "value": 0 }
    ]
  },
  "orderBy": [
    { "column": "QUANTITY_AGGREGATE", "order": "DESC" }
  ]
}

`LineItemStockAdjustments` — Returns line items for stock adjustments

query GetLineItemStockAdjustments(
  $where: QueryLineItemStockAdjustmentsWhereWhereConditions,
  $orderBy: [QueryLineItemStockAdjustmentsOrderByOrderByClause!],
  $groupBy: [QueryLineItemStockAdjustmentsGroupByGroupByClause!]
) {
  LineItemStockAdjustments(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      weight
      drop_shipping
      description
      on_hand
      available
      incoming
      kit_line_item_id
      type
      batch_numbers { id }
    }
  }
}

{
  "orderBy": [
    { "column": "ID", "order": "DESC" }
  ]
}

`LineItemRefunds` — Returns line items for refunds

query GetLineItemRefunds(
  $where: QueryLineItemRefundsWhereWhereConditions,
  $orderBy: [QueryLineItemRefundsOrderByOrderByClause!],
  $groupBy: [QueryLineItemRefundsGroupByGroupByClause!]
) {
  LineItemRefunds(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      customer { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      calculate_price_from_components
      weight
      drop_shipping
      on_hand
      available
      incoming
      uncredited_quantity
      description
      replace_label
      kit_line_item_id
      type
      parent_id
      origin_id
      discount
      discount_type
      ecotax
      total
      tax_codes { id label }
      batch_numbers { id }
    }
  }
}

{
  "where": {
    "AND": [
      { "column": "CUSTOMER_ID", "operator": "EQ", "value": 100001 }
    ]
  },
  "orderBy": [
    { "column": "LABEL", "order": "ASC" }
  ]
}

`LineItemOrders` — Returns line items for orders

query GetLineItemOrders(
  $where: QueryLineItemOrdersWhereWhereConditions,
  $orderBy: [QueryLineItemOrdersOrderByOrderByClause!],
  $groupBy: [QueryLineItemOrdersGroupByGroupByClause!]
) {
  LineItemOrders(
    where: $where
    orderBy: $orderBy
    groupBy: $groupBy
  ) {
    data {
      id
      sku
      label
      variant_type
      barcode
      variant { id label }
      status
      shipping_at
      order_number
      customer { id label }
      line_itemable { id label }
      location { id label }
      quantity
      quantity_aggregate
      price
      weight
      drop_shipping
      on_hand
      available
      incoming
      shipped_quantity
      committed_quantity
      reserved_quantity
      delivered_quantity
      description
      kit_line_item_id
      type
      parent_id
      batch_numbers { id }
    }
  }
}

{
  "where": {
    "AND": [
      { "column": "RESERVED", "operator": "GT", "value": 0 }
    ]
  },
  "orderBy": [
    { "column": "COMMITTED", "order": "DESC" }
  ]
}

Available fields by content type

Common fields (most line item types)

Field	Type	Description
`id`	Int	Unique identifier of the line item.
`sku`	String	SKU of the variant.
`label`	String	Label of the variant.
`variant_type`	String	Type of the variant.
`barcode`	String	Barcode of the variant.
`variant`	Variant	Linked variant entity.
`location`	Location	Linked location entity.
`quantity`	Float	Quantity of the line item.
`quantity_aggregate`	Float	Aggregated quantity.
`price`	Float	Price of the line item.
`weight`	Int	Weight of the line item (its display order; higher weight → lower position).
`drop_shipping`	Int	Drop shipping flag.
`parent_id`	Int	Parent line item ID.
`origin_id`	Int	Origin line item ID.
`description`	String	Description of the line item.
`kit_line_item_id`	ID	Kit line item ID.
`type`	LineItemType	Line item type. Default: `normal`.
`batch_numbers`	[BatchNumber]	Linked batch numbers.

adjustment_type is not exposed directly on the line item types: it is available on LineItemable.

Stock level fields (depending on line item type)

Field	Type	Description
`on_hand`	Float	Stock on hand.
`available`	Float	Available stock.
`incoming`	Float	Incoming stock.
`committed_quantity`	Float	Committed stock.
`reserved_quantity`	Float	Reserved stock.

The base LineItem type also exposes committed and reserved, which are aliases of the two quantities above.

Credit Note specific fields

Field	Type	Description
`discount`	Float	Discount amount.
`discount_type`	DiscountType	Type of discount.
`ecotax`	Float	Eco-tax amount.
`total`	Float	Total amount.
`customer`	Customer	Linked customer.
`tax_codes`	[TaxCode]	Linked tax codes.
`uncredited_quantity`	Float	Uncredited quantity.

Estimate specific fields

Field	Type	Description
`estimate_number`	String	Estimate number.
`customer`	Customer	Linked customer.
`calculate_price_from_components`	Boolean	Calculate price from components.
`transformed_quantity`	Float	Transformed quantity.
`billed_quantity`	Float	Billed quantity.
`unbilled_quantity`	Float	Unbilled quantity.
`paid_quantity`	Float	Paid quantity.
`unpaid_quantity`	Float	Unpaid quantity.
`ordered_quantity`	Float	Ordered quantity.
`unordered_quantity`	Float	Unordered quantity.
`discount_type`	DiscountType	Type of discount.
`discount`	Float	Discount amount.
`tax_amount`	Float	Tax amount.
`ecotax`	Float	Eco-tax amount.
`total`	Float	Total amount.
`tax_codes`	[TaxCode]	Linked tax codes.

Purchase specific fields

Field	Type	Description
`supplier`	Supplier	Linked supplier.
`delivered_quantity`	Float	Delivered quantity.
`committed_quantity`	Float	Committed quantity.
`reserved_quantity`	Float	Reserved quantity.
`uncommitted_quantity`	Float	Uncommitted quantity.

Purchase Receipt specific fields

Field	Type	Description
`delivered_quantity`	Float	Delivered quantity.
`committed_quantity`	Float	Committed quantity.
`reserved_quantity`	Float	Reserved quantity.
`uncommitted_quantity`	Float	Uncommitted quantity.

Product Return specific fields

Field	Type	Description
`customer`	Customer	Linked customer.
`shipped_quantity`	Float	Shipped quantity.
`committed_quantity`	Float	Committed quantity.
`reserved_quantity`	Float	Reserved quantity.

Order specific fields

Field	Type	Description
`customer`	Customer	Linked customer.
`shipped_quantity`	Float	Shipped quantity.
`delivered_quantity`	Float	Delivered quantity.
`committed_quantity`	Float	Committed quantity.
`reserved_quantity`	Float	Reserved quantity.
`returned_quantity`	Float	Returned quantity.
`unreturned_quantity`	Float	Unreturned quantity.
`drop_ship_delivered_quantity`	Float	Quantity delivered directly by the supplier (drop shipping).
`drop_ship_returned_quantity`	Float	Quantity returned on a drop-shipped line.
`unbilled_quantity`	Float	Unbilled quantity (requires `accounting.invoices` capability).

Invoice specific fields

Field	Type	Description
`unbilled_quantity`	Float	Unbilled quantity.
`unpaid_quantity`	Float	Unpaid quantity.
`returned_quantity`	Float	Returned quantity.
`unreturned_quantity`	Float	Unreturned quantity.
`credited_quantity`	Float	Credited quantity.
`uncredited_quantity`	Float	Uncredited quantity.
`discount_type`	DiscountType	Type of discount.
`discount`	Float	Discount amount.
`tax_amount`	Float	Tax amount.
`ecotax`	Float	Eco-tax amount.
`total`	Float	Total amount.
`tax_codes`	[TaxCode]	Linked tax codes.
`replace_label`	Boolean	Replace label flag.

Shipping Order specific fields

Field	Type	Description
`committed_quantity`	Float	Committed quantity.
`uncommitted_quantity`	Float	Uncommitted quantity.
`shipped_quantity`	Float	Shipped quantity.
`reserved_quantity`	Float	Reserved quantity.
`delivered_quantity`	Float	Delivered quantity.
`unbilled_quantity`	Float	Unbilled quantity (requires `accounting.invoices` capability).

Stock Adjustment specific fields

Field	Type	Description
`description`	String	Description for adjustment.
`price`	Float	Price value on adjustment.
`drop_shipping`	Int	Drop shipping flag.

Filters

You can create filters based on following fields (common to all types)

Field	Type	Example
id	Int	`{ "column": "ID", "operator": "EQ", "value": 100012 }`
sku	String	`{ "column": "SKU", "operator": "LIKE", "value": "%ABC%" }`
label	String	`{ "column": "LABEL", "operator": "LIKE", "value": "%Product%" }`
variant_type	String	`{ "column": "VARIANT_TYPE", "operator": "EQ", "value": "product" }`
barcode	String	`{ "column": "BARCODE", "operator": "EQ", "value": "123456789" }`
line_itemable_id	Int	`{ "column": "LINE_ITEMABLE_ID", "operator": "EQ", "value": 100001 }`
quantity	Float	`{ "column": "QUANTITY", "operator": "GT", "value": 0 }`
price	Float	`{ "column": "PRICE", "operator": "GT", "value": 10.0 }`
weight	Int	`{ "column": "WEIGHT", "operator": "GT", "value": 100 }`
drop_shipping	Int	`{ "column": "DROP_SHIPPING", "operator": "EQ", "value": 1 }`
parent_id	Int	`{ "column": "PARENT_ID", "operator": "EQ", "value": 100010 }`
origin_id	Int	`{ "column": "ORIGIN_ID", "operator": "EQ", "value": 100005 }`
committed	Float	`{ "column": "COMMITTED", "operator": "GT", "value": 0 }`
reserved	Float	`{ "column": "RESERVED", "operator": "GT", "value": 0 }`
shipped	Float	`{ "column": "SHIPPED", "operator": "GT", "value": 0 }`
delivered	Float	`{ "column": "DELIVERED", "operator": "GT", "value": 0 }`
variant_id	Int	`{ "column": "VARIANT_ID", "operator": "EQ", "value": 100001 }`
on_hand	Float	`{ "column": "ON_HAND", "operator": "GT", "value": 0 }`

Sorting

You can sort data based on following fields: id, label, sku, variant_type, barcode, line_itemable_id, quantity, variant_id, on_hand, incoming, available, kit_line_item_id, price, weight, drop_shipping, location_id, committed, reserved

query SortLineItems(
  $where: QueryLineItemsWhereWhereConditions
) {
  LineItems(
    where: $where
    orderBy: [{ column: LABEL, order: ASC }]
  ) {
    data {
      id
      label
      sku
      quantity
      price
      on_hand
      available
    }
  }
}

Example of data returned

{
  "data": {
    "LineItemEstimates": {
      "data": [
        {
          "id": 100001,
          "sku": "PROD-001",
          "label": "Product Name",
          "variant_type": "product",
          "barcode": "123456789",
          "quantity": 5.0,
          "price": 25.50,
          "on_hand": 100.0,
          "available": 95.0,
          "incoming": 0.0,
          "billed_quantity": 3.0,
          "unbilled_quantity": 2.0,
          "paid_quantity": 1.0,
          "unpaid_quantity": 4.0,
          "ordered_quantity": 0.0,
          "unordered_quantity": 5.0,
          "discount_type": "percentage",
          "discount": 10.0,
          "tax_amount": 2.55,
          "ecotax": 0.0,
          "total": 127.50
        }
      ]
    }
  }
}

Data Types

`DocumentTaxRate`

Field	Type	Description
`id`	Int	Tax rate ID.
`tax_amount`	Float	Amount of tax applied.
`tax_rate`	TaxRate	Tax rate details (label, rate).

`BatchNumberLineItemInput`

Field	Type	Description
`id`	ID	Batch number line item ID (for updates).
`quantity`	Float	Quantity for this batch.
`batch_number`	BatchNumberInput	Batch number details.
`serial_numbers`	[SerialNumberLineItemInput]	Serial numbers for this batch.
`serial_number_text`	String	Serial number text.

`LineItemsFilter`

Field	Type	Description
`column`	String	Column name to filter on.
`operator`	String	Filter operator (e.g., "EQ", "LIKE", "GT").
`value`	Mixed	Filter value.

`DocumentWeight`

Field	Type	Description
`amount`	Float	Weight amount.
`unit`	String	Weight unit (e.g. kg, lb).

Enums

`DiscountType`

Value	Description
`amount`	Fixed discount amount.
`percentage`	Percentage-based discount.

`LineItemType`

Value	Description
`normal`	Standard product line item (default).
`kit`	Kit/bundle line item.
`custom_product`	Custom product (variant_id = -1).
`deposit`	Deposit line item.
`shipping_cost`	Shipping cost line item.
`global_discount`	Global discount line item.
`packaging`	Packaging line item.

LineItem — Returns a single line item based on the id provided

LineItemCreditNotes — Returns line items for credit notes

LineItemEstimates — Returns line items for estimates

LineItemPurchases — Returns line items for purchases

LineItemPurchaseReceipts — Returns line items for purchase receipts

LineItemProductReturns — Returns line items for product returns

LineItemInvoices — Returns line items for invoices

LineItemShippingOrders — Returns line items for shipping orders

LineItemStockAdjustments — Returns line items for stock adjustments

LineItemRefunds — Returns line items for refunds

LineItemOrders — Returns line items for orders