API reference · Schema

V1CaresClaims

V1CaresClaimscontract v1.cares.claims
  • itemsarray of objectrequired
    • claim_idUuid7required
    • outlet_idUuid7required
    • offer_tenant_idUuid7required
    • offer_listing_idUuid7required
    • allocation_idUuid7 | nullrequired
    • statusenum (4)required
      requestedcancelledclosedreceived
    • total_minorintegerrequired
      ≥ -9007199254740991≤ 9007199254740991
    • currencystringrequired
      pattern ^[A-Z]{3}$
    • created_byUuid7required
    • created_atIsoDatetimerequired
    • linesarray of objectrequired
      • offer_line_idUuid7required
      • ingredient_idUuid7required
      • qty_milliintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • unitstringrequired
        pattern ^[a-z][a-z_]{0,15}$
      • unit_price_minorintegerrequired
        ≥ -9007199254740991≤ 9007199254740991
      • expires_onstring (date) | nullrequired
        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])))$
      • received_qty_milliinteger | nullrequired
        ≥ -9007199254740991≤ 9007199254740991
    • outcomeobjectrequired
      • verdictenum (3)required
        accepteddeclinednone
      • allocation_idUuid7 | nullrequired
      • decided_atIsoDatetime | nullrequired
      • linesarray of objectrequired
        Show fields of lines
        • offer_line_idUuid7required
        • handed_qty_milliintegerrequired
          ≥ -9007199254740991≤ 9007199254740991
  • labelsobjectrequired
    • dataconst "Measured on synthetic data"required
    • recipientsconst "to simulated recipients"required
  • note_keyconst "cares.note.check_local_rules"required
  • money_labelconst "Recorded, never processed"required

Used by