f0f1f2.studio Template reference
English
Open application
Interface

ICafeSetup

Definition

Namespace
Resto.Front.PrintTemplates.RmsEntityWrappers
Available since
3.5

Outlet settings: requisites, currency and display options. Reachable from any template through Model.CommonInfo.CafeSetup.

Detailed description

The model is available in every template, receipt and report alike. It supplies the outlet name and address, the legal entity requisites, the currency, and the free-form header and footer of a document.

The values come from four places in the back office — the outlet, the legal entity, the chain and the global settings; which field comes from which is in Where the requisites come from. The exact path to each field is in its own description; the groups sit here:

  • CafeName — Administration → Store Settings → General settings → Restaurant name.
  • CafeAddress, LegalName, LegalAddress, TaxId, AccountingReasonCode, Phone — General settings → Legal entity settings.
  • BillHeader, BillFooter, ReportHeader — Administration → Receipt templates, the "Guest Bill" and "Reports" blocks.
  • CurrencyIsoName, CurrencyShortName, ShortCurrencyName — Store Settings → Currency settings.
  • IncludeVatInDishPrice — Accounting settings → Inventory management settings; DisplayWaiterRevenueByDishes, DisplayRelativeNumberOfModifiers, CourseCustomNames — General settings → Advanced.

The header and the footer reach a template as finished text: ${…} substitutions are expanded by the till before the template sees the value. See BillHeader for the detail.

There are four currency names, and only two of them are typed by hand — see the currency directory:

  • CurrencyIsoName — the three-letter ISO code. The currency is picked from a closed list in Administration → Store Settings → Currency settings; the same code decides how many decimal places a conversion keeps.
  • CurrencyName — the name in the form the phrase "ALL SUMS IN …" needs, upper-cased. The till takes it from a built-in directory by the currency code; it cannot be configured.
  • CurrencyShortName — the abbreviation meant for reports. A text field at Currency settings → In reports: → basic unit.
  • ShortCurrencyName — the abbreviation the till's own interface uses. A text field at Currency settings → Graphics interface: → basic unit. This is the one to label a sum with.

The requisites of the organisation a document is issued to live in a separate model, IOrganizationDetailsInfo.

Available in documents

Access pathDocument types
Model.CommonInfo.CafeSetupAll document types

Properties

NameTypeDescription
AccountingReasonCodestringAccounting reason code
BillFooterstringGuest bill footer
BillHeaderstringGuest bill header
CafeAddressstringOutlet address
CafeNamestringOutlet name
CourseCustomNamesIDictionary<int, string>Custom courses names
CurrencyIsoNamestringStandard currency name (ISO)
CurrencyNamestringCurrency name
CurrencyShortNamestringShort currency name
DepartmentCodestringSubdivision code
DisplayRelativeNumberOfModifiersboolShow relative number of modifiers
DisplayWaiterRevenueByDishesboolShow waiter sales amount per item
IncludeVatInDishPriceboolVAT included in item price
LegalAddressstringRegistered address
LegalNamestringLegal entity name
PhonestringPhone
ReportHeaderstringReport header
ShortCurrencyNamestringGUI short currency name
TaxIdstringTax ID