Skip to main content

GoodsReceipt

An incoming or outgoing goods movement booked against a warehouse — supplier receipt, return-from-customer, manual stock correction. Carries the per-line quantities and prices that are posted to stock once the receipt is completed.

type GoodsReceipt implements Node {
id: ID!
currencyId: ID
currencyFactor: Float
amountTotal: Float
amountNet: Float
positionPrice: Float
taxStatus: String
userId: ID
warehouseId: ID
supplierId: ID
type: GoodsReceiptType!
goodsReceiptDateTime: DateTime!
customerId: ID
number: String!
comment: String
state: String!
currency: Currency
warehouse: Warehouse
supplier: Supplier
supplierOrders(
first: Int = 10
after: String
filter: SupplierOrderFilterInput
): SupplierOrderConnection
customer: Customer
tags(
first: Int = 10
after: String
filter: TagFilterInput
): TagConnection
lineItems(
first: Int = 10
after: String
filter: GoodsReceiptLineItemFilterInput
): GoodsReceiptLineItemConnection
stocks(
first: Int = 10
after: String
filter: StockFilterInput
): StockConnection
}

Fields

GoodsReceipt.id ● ID! non-null scalar

Global identifier for this entity.

GoodsReceipt.currencyId ● ID scalar

ID of the currency the receipt is denominated in.

GoodsReceipt.currencyFactor ● Float scalar

Currency conversion factor relative to the system default at the time the receipt was created. Frozen so historical receipts remain stable when rates change.

GoodsReceipt.amountTotal ● Float scalar

Grand total in the receipt's currency, including tax.

GoodsReceipt.amountNet ● Float scalar

Net total in the receipt's currency, excluding tax.

GoodsReceipt.positionPrice ● Float scalar

Sum of all line item prices before order-level discounts/charges, in the receipt's currency.

GoodsReceipt.taxStatus ● String scalar

Tax status of the receipt (gross, net, tax-free).

GoodsReceipt.userId ● ID scalar

ID of the admin user that created the goods receipt.

GoodsReceipt.warehouseId ● ID scalar

ID of the warehouse the stock is posted into.

GoodsReceipt.supplierId ● ID scalar

ID of the supplier, when the receipt is sourced from a supplier order.

GoodsReceipt.type ● GoodsReceiptType! non-null enum

Goods receipt type discriminator (e.g. supplier_order, manual, return_order). Determines which optional references (supplierId, customerId, returnOrderId, …) are meaningful.

GoodsReceipt.goodsReceiptDateTime ● DateTime! non-null scalar

Timestamp the goods movement happened (booked at completion).

GoodsReceipt.customerId ● ID scalar

ID of the customer, when the receipt is a return from a customer.

GoodsReceipt.number ● String! non-null scalar

Human-readable goods receipt number.

GoodsReceipt.comment ● String scalar

Free-form note attached to the goods receipt.

GoodsReceipt.state ● String! non-null scalar

Name of the receipt's state (e.g. open, completed, cancelled).

GoodsReceipt.currency ● Currency object

GoodsReceipt.warehouse ● Warehouse object

GoodsReceipt.supplier ● Supplier object

GoodsReceipt.supplierOrders ● SupplierOrderConnection object

GoodsReceipt.supplierOrders.first ● Int scalar
GoodsReceipt.supplierOrders.after ● String scalar
GoodsReceipt.supplierOrders.filter ● SupplierOrderFilterInput input

GoodsReceipt.customer ● Customer object

GoodsReceipt.tags ● TagConnection object

GoodsReceipt.tags.first ● Int scalar
GoodsReceipt.tags.after ● String scalar
GoodsReceipt.tags.filter ● TagFilterInput input

GoodsReceipt.lineItems ● GoodsReceiptLineItemConnection object

GoodsReceipt.lineItems.first ● Int scalar
GoodsReceipt.lineItems.after ● String scalar
GoodsReceipt.lineItems.filter ● GoodsReceiptLineItemFilterInput input

GoodsReceipt.stocks ● StockConnection object

GoodsReceipt.stocks.first ● Int scalar
GoodsReceipt.stocks.after ● String scalar
GoodsReceipt.stocks.filter ● StockFilterInput input

Interfaces

Node interface

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By

approveGoodsReceipt mutation ● completeGoodsReceipt mutation ● createGoodsReceipt mutation ● goodsReceipt query

Member Of

GoodsReceiptEdge object ● GoodsReceiptLineItem object ● Stock object