Get Report Parameters
post
/config/sim/v2/setup/getReportParameters
Gets Report 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, options -
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 -
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.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 3599)
Response
Supported Media Types
- application/json
200 Response
A collection of Report 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 Report Parameters 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 Report Parameters objects.
Show Source
-
Array of:
object ReportParameters
Report Parameters record.
Nested Schema : ReportParameters
Type:
objectReport Parameters record.
Show Source
-
hierUnitId:
integer
Unique hierarchy unit value for the target hierarchy node.Example:
3599 -
options:
string
Minimum Length:
32Maximum Length:32Raw report-options bit string of length 32.Example:00000000000000000000000000000000 -
optionsExt:
object ReportParametersOptionsExt
Read Only:
trueRead-only helper object derived from options. Bit positions are 1-based.
Nested Schema : ReportParametersOptionsExt
Type:
objectRead Only:
trueRead-only helper object derived from options. Bit positions are 1-based.
Show Source
-
canadianGstCombineRates2Through8OnPropertyTaxReport:
boolean
Option bit 1. Canadian GST Combine Rates 2 thru 8 on Property Tax Report.
-
decrementTenderMediaTotalsWhenVoided:
boolean
Option bit 28. Decrement Tender Media Totals When Voided.
-
doNotPrintDiscountBreakdownOnFinancialReports:
boolean
Option bit 26. Do Not Print the Discount Breakdown on Financial Reports.
-
doNotPrintOrderTypeBreakdownOnFinancialReports:
boolean
Option bit 9. Do Not Print the Order Type Breakdown on Financial Reports.
-
doNotPrintServiceChargeBreakdownOnFinancialReports:
boolean
Option bit 27. Do Not Print the Service Charge Breakdown on Financial Reports.
-
doNotPrintTableSectionOnFinancialReports:
boolean
Option bit 7. Do Not Print the Table Section on Financial Reports.
-
includeFirstPrintedTimeInPmcClosedCheckReport:
boolean
Option bit 3. Include Time Check was First Printed in PMC Closed Check Report.
-
includeFirstPrintedTimeInReportingAnalyticsClosedCheckReport:
boolean
Option bit 4. Include Time Check was First Printed in Reporting and Analytics Closed Check Report.
-
includeTableIdInPmcClosedCheckReports:
boolean
Option bit 11. Include Table ID in PMC Closed Check Reports.
-
noFormFeedsBetweenEmployeesOnEmployeeReportsExceptFinancial:
boolean
Option bit 10. No Form Feeds Between Employees on Employee Reports, Except Financial.
-
omitSummarySectionsAndTotalLinesFromTimePeriodReports:
boolean
Option bit 2. Omit Summary Sections and Total Lines from Time Period Reports.
-
partialCutBetweenPagesAndFullCutBetweenPmcReports:
boolean
Option bit 16. Partial Cut Between Pages and Full Cut Between PMC Reports.
-
printOrderChannelBreakdownOnFinancialReports:
boolean
Option bit 12. Print Order Channel Breakdown on Financial Reports.
-
saveFinalCheckImage:
boolean
Option bit 23. Save the Final Check Image.
-
suppressEmployeePercentageOfTotalSales:
boolean
Option bit 22. Suppress Employee Percentage of Total Sales.
-
wrapNameOnReports:
boolean
Option bit 25. Wrap Name on Reports.