API reference · Schema

V1SupplierReturn

V1SupplierReturncontract v1.supplier-return
  • supplier_return_idUuid7required
  • outlet_idUuid7required
  • supplierobjectrequired
    • supplier_idUuid7required
    • namestringrequired
      min length 1max length 200
    • kindenum (2)required
      realsimulated
    • labelconst "Simulated supplier" | nullrequired
  • goods_received_idUuid7 | nullrequired
  • reason_codestringrequired
  • notestringrequired
  • returned_byUuid7required
  • returned_atIsoDatetimerequired
  • linesarray of objectrequired
    • ingredient_idUuid7required
    • batch_idUuid7 | nullrequired
    • qty_milliintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • unitstringrequired
      pattern ^[a-z][a-z_]{0,15}$
    • unit_cost_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • unit_cost_per_1000_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • currencystringrequired
      pattern ^[A-Z]{3}$