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!
  amountNet: Float
  amountTotal: Float
  comment: String
  currencyFactor: Float
  currencyFactorCapturedAt: DateTime
  currencyFactorOriginSource: String
  currencyFactorOriginType: CurrencyFactorOriginType
  currencyFactorReferenceDate: DateTime
  currencyId: ID
  customerId: ID
  goodsReceiptDateTime: DateTime!
  number: String!
  positionPrice: Float
  state: String!
  supplierId: ID
  taxStatus: String
  type: GoodsReceiptType!
  userId: ID
  warehouseId: ID
  currency: Currency
  customer: Customer
  destinationStockMovements(
    first: Int = 10
    after: String
    filter: StockMovementFilterInput
  ): StockMovementConnection
  lineItems(
    first: Int = 10
    after: String
    filter: GoodsReceiptLineItemFilterInput
  ): GoodsReceiptLineItemConnection
  sourceStockMovements(
    first: Int = 10
    after: String
    filter: StockMovementFilterInput
  ): StockMovementConnection
  stocks(
    first: Int = 10
    after: String
    filter: StockFilterInput
  ): StockConnection
  supplier: Supplier
  supplierOrders(
    first: Int = 10
    after: String
    filter: SupplierOrderFilterInput
  ): SupplierOrderConnection
  tags(
    first: Int = 10
    after: String
    filter: TagFilterInput
  ): TagConnection
  warehouse: Warehouse
}

Fields

`GoodsReceipt.id` ● `ID!` non-null scalar

Global identifier for this entity.

`GoodsReceipt.amountNet` ● `Float` scalar

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

`GoodsReceipt.amountTotal` ● `Float` scalar

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

`GoodsReceipt.comment` ● `String` scalar

Free-form note attached to the goods receipt.

`GoodsReceipt.currencyFactor` ● `Float` scalar

Exchange rate the receipt is valued with, as units of the receipt's currency per one unit of the system default currency. Taken when the receipt is created and changeable until the receipt is part of a stock valuation report; stock value and the last purchase price are computed from it. currencyFactorOriginType tells where it comes from.

`GoodsReceipt.currencyFactorCapturedAt` ● `DateTime` scalar

Timestamp currencyFactor was taken or last set by hand. Null for receipts created before the origin was recorded.

`GoodsReceipt.currencyFactorOriginSource` ● `String` scalar

Provider of the exchange rate (ECB or Frankfurter) when currencyFactorOriginType is ExchangeRateImport, null otherwise.

`GoodsReceipt.currencyFactorOriginType` ● `CurrencyFactorOriginType` enum

Where currencyFactor comes from. Null for receipts created before the origin was recorded.

`GoodsReceipt.currencyFactorReferenceDate` ● `DateTime` scalar

Date the provider published the exchange rate for when currencyFactorOriginType is ExchangeRateImport, null otherwise.

`GoodsReceipt.currencyId` ● `ID` scalar

ID of the currency the receipt is denominated in.

`GoodsReceipt.customerId` ● `ID` scalar

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

`GoodsReceipt.goodsReceiptDateTime` ● `DateTime!` non-null scalar

Timestamp the goods movement happened (booked at completion).

`GoodsReceipt.number` ● `String!` non-null scalar

Human-readable goods receipt number.

`GoodsReceipt.positionPrice` ● `Float` scalar

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

`GoodsReceipt.state` ● `String!` non-null scalar

Technical name of the receipt's state: draft, created, approved, in_progress or completed.

`GoodsReceipt.supplierId` ● `ID` scalar

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

`GoodsReceipt.taxStatus` ● `String` scalar

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

`GoodsReceipt.type` ● `GoodsReceiptType!` non-null enum

Origin of the incoming stock: Supplier for a delivery against supplier orders (see supplierOrders), Customer for goods returned by a customer, Free for stock received without either.