Purchase Receipts Queries

Access purchase receipts for received goods, including line items and accounting.

PurchaseReceipt — Returns a single purchase receipt by id

GraphQL

query GetPurchaseReceipt($id: ID!) {
  PurchaseReceipt(id: $id) {
    id
    label
    status
    dated_at
    shipping_at
    total_units
    supplier { id label }
    line_items {
      id
      variant { id label }
      quantity
    }
    purchases {
      paginatorInfo { total }
      data { id label }
    }
  }
}

PurchaseReceipts — Returns a paginated list of purchase receipts with sorting and filters

GraphQL

query PurchaseReceipts(
  $where: QueryPurchaseReceiptsWhereWhereConditions,
  $orderBy: [QueryPurchaseReceiptsOrderByOrderByClause!],
  $search: String,
  $first: Int,
  $page: Int
) {
  PurchaseReceipts(
    where: $where,
    orderBy: $orderBy,
    search: $search,
    first: $first,
    page: $page
  ) {
    paginatorInfo {
      total
      currentPage
    }
    data {
      id
      label
      status
      dated_at
      supplier { id label }
    }
  }
}

---

Available fields

Field	Type	Description
id	Int	Unique identifier.
label	String	Purchase receipt number.
status	PurchaseReceiptStatus	Current status.
dated_at	Date	Billing/Document date.
created_at	DateTime	Creation time.
shipping_at	Date	Expected shipment date.
total_units	Float	Total quantity.
total_units_aggregate	Float	Sum of units for filtered receipts.
supplier	Supplier	Linked supplier.
line_items	[LineItemPurchaseReceipt]	List of items received.
purchases_count	Int	Number of linked purchase orders.
purchases	[Purchase]	Source purchase orders.
location_label	String	Assigned location label.
integrations	[Integration]	Linked external platforms.
has_batch_numbers	Boolean	True if items have batch tracking.
tracking_completed	Boolean	True if all tracking info is entered.
stock_allocation_status	StockAllocationStatus	Status of stock commitment.
delivery_status	DeliveryStatus	Status of physical reception.
committed_quantity	Float	Confirmed quantity.
uncommitted_quantity	Float	Awaiting confirmation.
reserved_quantity	Float	Reserved quantity.
delivered_quantity	Float	Physically received quantity.
custom_fields	[EntityCustomField]	Custom fields for this entity.

---

Filters

The following fields can be used in the where parameter:

id, label, status, total_units, dated_at, created_at, updated_at, shipping_at, supplier_id, committed_quantity, uncommitted_quantity, delivered_quantity, reserved_quantity, purchases_count, variant_id, variant_label, variant_sku, location_id, batch_number_id, has_batch_numbers, tracking_completed, stock_allocation_status, delivery_status.

Example Filters:

Field	Example
id	{ "column": "ID", "operator": "EQ", "value": 200050 }
label	{ "column": "LABEL", "operator": "LIKE", "value": "%PR-2025%" }
status	{ "column": "STATUS", "operator": "EQ", "value": "delivered" }
supplier_id	{ "column": "SUPPLIER_ID", "operator": "EQ", "value": 100002 }
variant_id	{ "column": "VARIANT_ID", "operator": "EXISTS", "value": 200050 }
variant_sku	{ "column": "VARIANT_SKU", "operator": "EQ", "value": "SKU-BLUE" }
location_id	{ "column": "LOCATION_ID", "operator": "EXISTS", "value": 100 }
delivery_status	{ "column": "DELIVERY_STATUS", "operator": "EQ", "value": "delivered" }
dated_at	{ "column": "DATED_AT", "operator": "GTE", "value": "2025-01-01" }

---

Sorting

You can sort results using the orderBy parameter:

• id
• label
• status
• dated_at
• shipping_at
• total_units
• created_at
• supplier_id
• supplier_label
• location_label
• committed_quantity
• uncommitted_quantity
• delivered_quantity
• reserved_quantity

---

Grouping Options

You can group results for reports:

Field	Description
id	Group by internal ID.
year	Group by year of dated_at.
month	Group by month of dated_at.
day	Group by day of dated_at.

---

Enums

PurchaseReceiptStatus

Value	Description
unpublished	Draft status (no impact).
pending	Published and awaiting reception.
delivered	Document confirmed and items received.
cancelled	Document voided.

StockAllocationStatus

Value	Description
not_allocated	No stock allocated.
partially_allocated	Part of the stock allocated.
allocated	Full stock allocated.

DeliveryStatus

Value	Description
not_delivered	No items received.
partially_delivered	Part of the items received.
delivered	All items received.