Skip to content

API reference · Schema

V1GoodsReceived

V1GoodsReceivedcontract v1.goods-received

grn_idUuid7required
outlet_idUuid7required
supplierobjectrequired
- supplier_idUuid7required
- namestringrequired
  min length 1max length 200
- kindenum (2)required
  realsimulated
- labelconst "Simulated supplier" | nullrequired
po_idUuid7 | nullrequired
received_atIsoDatetimerequired
received_byUuid7required
notestring | nullrequired
linesarray of objectrequired
- grn_line_idUuid7required
- po_line_idUuid7 | nullrequired
- ingredient_idUuid7required
- batch_idUuid7 | nullrequired
- qty_milliintegerrequired
  ≥ -9007199254740991≤ 9007199254740991
- unitstringrequired
  pattern ^[a-z][a-z_]{0,15}$
- unit_cost_minorintegerrequired
  ≥ -9007199254740991≤ 9007199254740991
- currencystringrequired
  pattern ^[A-Z]{3}$

Used by

get/v1/goods-received/{id}One goods-received note with its lines