API reference · Schema

TenancyOnboardV1

TenancyOnboardV1contract tenancy.onboard.v1
  • tenant_idUuid7required
  • owner_member_idUuid7required
  • outlet_idUuid7required
  • owner_namestringrequired
    min length 1max length 200
  • business_namestringrequired
    min length 1max length 200
  • kindenum (3)required
    restaurantcloud_kitchenshop
  • country_codestringrequired
    pattern ^[A-Z]{2}$
  • outletobjectrequired
    • namestringrequired
      min length 1max length 200
    • addressstringrequired
      min length 1max length 500
    • tzstringoptional
      pattern ^[A-Za-z]+\/[A-Za-z_]+$
    • hoursobjectoptional
      • opensstringrequired
        pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
      • closesstringrequired
        pattern ^([01][0-9]|2[0-3]):[0-5][0-9]$
    • tax_idsmap of stringrequired