Get Format Parameters
post
/config/sim/v2/setup/getFormatParameters
Gets Format Parameters.
Request
Supported Media Types
- multipart/form-data
- application/json
The input body model that needs to be given.
Root Schema : schema
Type:
Show Source
object-
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, linesOnFirstPage, customerIdentityLabel -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
offset:
integer
Starting resource record index.Example:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order. All Format Parameter fields support orderBy.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria. All Format Parameter fields support searchCriteria.Example:
where equals(hierUnitId, 3599)
Response
Supported Media Types
- application/json
200 Response
A collection of Format Parameters.
Root Schema : schema
Type:
Show Source
object-
count:
integer
Current response record count.Example:
10 -
hasMore:
boolean
Flag indicating if there are more objects to fetch.Example:
true -
items:
array items
Array of Format Parameter objects.
-
limit:
integer
Server page size.Example:
10 -
offset:
integer
Starting resource record index.Example:
0 -
totalResults:
integer
Total number of rows.Example:
100
Nested Schema : items
Type:
arrayArray of Format Parameter objects.
Show Source
-
Array of:
object FormatParameter
Format Parameter record.
Nested Schema : FormatParameter
Type:
objectFormat Parameter record.
Show Source
-
cfdClosedBgImageName:
string
Closed-state Customer Facing Display background image name.Example:
closed.png -
cfdOptions:
string
Raw Customer Facing Display bit string of length 16.Example:
0000000000000000 -
cfdOptionsExt:
object cfdOptionsExt
Read-only derived helper object for meaningful Customer Facing Display options.
-
cfdWelcomeBgImageName:
string
Welcome/idle Customer Facing Display background image name.Example:
welcome.png -
checkSortType:
integer
Check sort/consolidation lookup value. Valid range is 0 to 8.Example:
0 -
customerIdentityLabel:
object customerIdentityLabel
Customer/Trade label to be displayed on the check tax invoice before Customer/Trade name when Inclusive Tax is exempted.
-
customerInfoSalesThreshold:
integer
Sales threshold for customer information prompt. Must be greater than taxInvoiceSalesThreshold when both values are non-zero.Example:
0 -
customerReceiptSortType:
integer
Customer receipt sort/consolidation lookup value. Valid range is 0 to 8.Example:
0 -
guestCheckInformationLines:
integer
Guest check information lines. Valid range is 0 to 32.Example:
4 -
hierUnitId:
integer
Unique hierarchy unit value.Example:
3599 -
lineFeedsBeforeFirstPage:
integer
Line feeds before first guest check page. Must be less than linesOnFirstPage when greater than 0.Example:
0 -
lineFeedsBeforeOtherPages:
integer
Line feeds before subsequent guest check pages. Must be less than linesOnOtherPages when greater than 0.Example:
0 -
linesOnFirstPage:
integer
Lines on first guest check page.Example:
40 -
linesOnOtherPages:
integer
Lines on subsequent guest check pages.Example:
40 -
minimumLinesPerRollCheckReceipt:
integer
Minimum lines per roll check/receipt.Example:
1 -
nluCondimentHelpScreenSortType:
integer
NLU condiment help screen sort method value. Valid range is 0 to 2.Example:
0 -
options:
string
Raw format-options bit string of length 80. Unsupported bits are reset and are not exposed in optionsExt.Example:
00000000000000000000000000000000000000000000000000000000000000000000000000000000 -
optionsExt:
object optionsExt
Read-only derived helper object for meaningful format options.
-
screenSortType:
integer
Screen sort/consolidation lookup value. Valid range is 0 to 8.Example:
0 -
taxInvoiceSalesThreshold:
integer
Sales threshold for tax invoice prompt.Example:
0
Nested Schema : cfdOptionsExt
Type:
objectRead-only derived helper object for meaningful Customer Facing Display options.
Show Source
-
displayCurrencySymbolOnCustomerFacingDisplay:
boolean
Bit 1. Display currency symbol on Customer Facing Display.Example:
true -
displayEmailAndPrintingReceiptPromptToServer:
boolean
Bit 2. Display Email and Printing Receipt Prompt to Server.Example:
false
Nested Schema : customerIdentityLabel
Type:
objectCustomer/Trade label to be displayed on the check tax invoice before Customer/Trade name when Inclusive Tax is exempted.
Example:
{
"1":"Customer",
"2":"Customer",
"3":"Customer"
}Nested Schema : optionsExt
Type:
objectRead-only derived helper object for meaningful format options.
Show Source
-
asianCharactersSingleWideOnGuestCheckAndReceipt:
boolean
Bit 48. Print Asian Characters Single Wide on Guest Check and Customer Receipt.Example:
false -
capsLockEnabledForOnScreenKeyboard:
boolean
Bit 53. Caps Lock Enabled for On-Screen Keyboard.Example:
false -
checkNumberDoubleWide:
boolean
Bit 2. Print Check Number Double Wide on Guest Checks and Customer Receipts.Example:
false -
disableChangeDueOnGuestChecksAndCustomerReceipt:
boolean
Bit 49. Disable Change Due on Guest Checks/Customer Receipt.Example:
false -
displayOrderChannelOnWorkstation:
boolean
Bit 65. Display Order Channel on Workstation.Example:
false -
doNotCenterHeaderAndTrailerPrinting:
boolean
Bit 32. Do not Center Header and Trailer Printing.Example:
false -
doNotConsolidateCurrentRoundItemsInPrintedGuestCheck:
boolean
Bit 58. Do Not Consolidate Current Round Items in Printed Guest Check.Example:
false -
doNotDisplayGuestCheckInfoLinesOnWorkstation:
boolean
Bit 25. Do Not Display Guest Check Info Lines on Workstation.Example:
false -
doNotDisplayPrintPriceForWaste:
boolean
Bit 56. Do not display/print price for Waste.Example:
false -
doNotPrintChangePaymentDueDoubleWide:
boolean
Bit 57. Do Not Print Change/Payment Due in Double Wide.Example:
false -
doNotPrintCheckOpenTimeOnCustomerReceipts:
boolean
Bit 33. Do not Print Check Open Time on Customer Receipts.Example:
false -
doNotPrintRevenueCenterNameLineInJournalHeaders:
boolean
Bit 18. Do Not Print Revenue Center Name Line in Journal Entry Headers.Example:
false -
doNotPrintSeatHeaders:
boolean
Bit 47. Do Not Print Seat Headers.Example:
false -
eliminateBlankLinesFromGuestChecks:
boolean
Bit 6. Eliminate Blank Lines from Guest Checks.Example:
false -
enableLegacyPosTheme:
boolean
Bit 63. Enable Legacy POS Theme.Example:
false -
enableTeamService:
boolean
Bit 29. Enable Team Service.Example:
false -
formatPrefixOnSeparateLineInCheckDetailArea:
boolean
Bit 50. Format Prefix On Separate Line in Check Detail Area.Example:
false -
hidePreviousRoundCondimentsOnDisplay:
boolean
Bit 35. Hide Previous Round Condiments on Display.Example:
false -
printAmountPaidDoubleWide:
boolean
Bit 15. Print Amount Paid Double-Wide on Guest Check and Receipts.Example:
false -
printEqualPaymentReceipts:
boolean
Bit 62. Print Equal Payment Receipts.Example:
false -
printEventNameAfterHeaderOnGuestChecksAndReceipts:
boolean
Bit 59. Print Event Name After Header on Guest Checks and Receipts.Example:
false -
printEventNameAfterTrailerOnGuestChecksAndReceipts:
boolean
Bit 60. Print Event Name After Trailer on Guest Checks and Receipts.Example:
false -
printFullCheckDetailDuringVoidClosedCheck:
boolean
Bit 51. Print Full Check Detail During Void Closed Check.Example:
false -
printGuestCheckAndReceiptHeaderInRed:
boolean
Bit 37. Print Guest Check and Receipt Header in Red.Example:
false -
printGuestCheckAndReceiptTrailerInRed:
boolean
Bit 38. Print Guest Check and Receipt Trailer in Red.Example:
false -
printGuestCheckInfoLinesAfterHeader:
boolean
Bit 27. Print Guest Check Info Lines After Header on Guest Checks.Example:
false -
printGuestCheckInfoLinesAfterTrailer:
boolean
Bit 28. Print Guest Check Info Lines After Trailer on Guest Checks.Example:
false -
printGuestCheckInfoLinesBeforeHeader:
boolean
Bit 26. Print Guest Check Info Lines Before Header on Guest Checks.Example:
false -
printGuestCountAtEndOfByRoundChecks:
boolean
Bit 34. Print Guest Count at End of By-Round Checks.Example:
false -
printOpenAndClosedDateTimeOnGuestCheck:
boolean
Bit 10. Print Open and Closed Date/Time on Guest Check.Example:
false -
printOrderNumberAtBottomOfReceipts:
boolean
Bit 21. Print order number at bottom of Receipts.Example:
false -
printPaymentCardDetailsOnGuestChecksAndCustomerReceipts:
boolean
Bit 64. Print payment card details on guest checks and customer receipts.Example:
false -
printPaymentLineOnGuestCheck:
boolean
Bit 30. Print Payment Line on Guest Check.Example:
false -
printPreviousBalanceEachRound:
boolean
Bit 11. Print Previous Balance Each Round.Example:
false -
printReprintInCheckHeader:
boolean
Bit 9. Print Reprint in the Check Header.Example:
false -
printSecondaryLanguageOnGuestChecksCustomerReceipt:
boolean
Bit 52. Print Secondary Language on Guest Checks/Customer Receipt.Example:
false -
printServiceTotalTimeOnChecks:
boolean
Bit 14. Print Service Total Time on Checks.Example:
false -
printSkuOrUpcNumber:
boolean
Bit 23. Print SKU or UPC Number.Example:
false -
printSplitCheckTrailerIfOnDemand:
boolean
Bit 5. Print Trailer Lines on Split Check if On-Demand.Example:
false -
printTaxExemptCouponTaxForgivenAmount:
boolean
Bit 17. Print Tax Exempt Coupon Tax Forgiven Amount.Example:
false -
printTeamMemberNamesOnGuestCheck:
boolean
Bit 41. Print Team Member Names on Guest Check.Example:
false -
printTendersAfterSummaryTotals:
boolean
Bit 12. Print Tenders After Summary Totals on Checks and Receipts.Example:
false -
printTransactionEmployeeAndWorkstationEachRound:
boolean
Bit 22. Print Transaction Employee number and Workstation number on Guest Check Each Round.Example:
false -
printTransactionNumber:
boolean
Bit 55. Print Transaction Number.Example:
false -
printVoidLineOnChecks:
boolean
Bit 16. Print Void Line on Checks.Example:
false -
printWorkstationNumber:
boolean
Bit 54. Print Workstation Number.Example:
false -
serviceRoundTotalsIncludeCurrentRoundOnly:
boolean
Bit 13. Service Round Totals Include Current Round Only.Example:
false -
showAndPrintTaxForgivenIndicator:
boolean
Bit 61. Enable to show and print Tax Forgiven Indicator.Example:
false -
showItemPrice:
boolean
Bit 1. Print Unit Price as well as Line Total on Checks.Example:
true -
skipBlankGuestCheckInfoLines:
boolean
Bit 24. Skip Blank Lines When Printing or Displaying Guest Check Info Lines.Example:
false -
sortAndConsolidateCurrentRoundItemsOnScreen:
boolean
Bit 46. Sort And Consolidate Current Round Items on Screen.Example:
false -
sortCurrentRoundCondimentsOnScreen:
boolean
Bit 45. Sort Current Round Condiments on Screen.Example:
false -
tableNumberDoubleWide:
boolean
Bit 3. Print Table Number Double Wide on Guest Checks Only.Example:
false