API reference · Schema

V1Goals

V1Goalscontract v1.goals
  • itemsarray of objectrequired
    • idUuid7required
    • outlet_idUuid7 | nullrequired
    • metricenum (2)required
      net_salesorders
    • target_valueintegerrequired
      > 0≤ 9007199254740991
    • currencystring | nullrequired
      pattern ^[A-Z]{3}$
    • period_fromstring (date)required
      pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
    • due_onstring (date)required
      pattern ^(?:(?:[0-9][0-9][2468][048]|[0-9][0-9][13579][26]|[0-9][0-9]0[48]|[02468][048]00|[13579][26]00)-02-29|[0-9]{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12][0-9]|3[01])|(?:0[469]|11)-(?:0[1-9]|[12][0-9]|30)|(?:02)-(?:0[1-9]|1[0-9]|2[0-8])))$
    • statusenum (4)required
      activeachievedmissedcancelled
    • basis_snapshot_idUuid7 | nullrequired

Used by