/
POS Web Services API - Reporting
POS Web Services API - Reporting
- Former user (Deleted)
- Juan Poncedeleon
- Douglas Chow
Owned by Former user (Deleted)
Last updated: Dec 20, 2023 by Juan Poncedeleon
| Element | Attribute | Data Type | Optional | Notes |
| parameters | no | Parameters element contains a list of parameter element | ||
| userInfo | no | The userInfo parameter | ||
| userId | no | Web user id of employee trying to log in | ||
| password | no | Web password of employee trying to log in |
Response Message
<response apiVersion="1.00" clientId="its_me" apiName="wrs_login"
apiCategory="wrs" requestTimestamp="xxx" responseTimestamp="xxx">
<error code="0"
localizedDescription="some French words"
defaultDescription="something you understand"/>
</response>
| Element | Attribute | Data Type | Notes |
| error | error element contains error code and error descriptions | ||
| code | integer | 0 GENERAL_NO_ERROR 2101 REPORTV2_LOG_IN_FAILED_INVALID_CREDENTIAL | |
| localizedDescription | string | A description in the language corresponding to the locale setting in the original request. | |
| defaultDescription | string | A description in English. |
wrs_logout
This request does not do anything currently.
wrs_restart
This message sends a restart signal to current web service.
Request Message
<request apiVersion="1.00" apiKey="unless_you_know_this_key_you_cant_call_me" clientId="its_me"
apiName="wrs_restart" apiCategory="wrs" locale="en-US" requestTimestamp="xxx">
</request>
Response Message
No response
Web Reporting Service Core
ReportV2.getCustRepList
This message requests for a list of customized reports
Request Message
<request apiVersion="1.00" apiKey="darren1234" apiName="ReportV2.getCustRepList" apiCategory="wrs" requestTimestamp="2011-8-5 15:33:38.198">
<parameters>
<userInfo sessionId="admin13125728005341312572800549" siteName="djung" userId="admin"/>
</parameters>
</request>
| Element | Attribute | Data Type | Optional | Notes |
| parameters | no | Parameters element contains a list of parameter element | ||
| userInfo | no | The userInfo parameter | ||
| sessionId | string | yes | Session id for current request (for portal) | |
| siteName | string | yes | Name of site that this request makes to (for portal) | |
| userId | string | no | Web user id of employee trying to log in |
Response Message
<response apiVersion="1.0" apiName="ReportV2.getCustRepList" apiCategory="wrs" requestTimestamp="2011-8-5 15:33:38.198">
<error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-05 15:33:38.215"></error>
<data>
<custReports>
<custReport m_reportCustId="1" m_reportCustName="Server Shift End" m_reportCustTreePath="System Default" m_storeId="0">
<detailReport m_reportTitle="Breakdown Overview Summary" m_reportCustId="1" m_reportCustDetailId="1" m_storeId="0"></detailReport>
<detailReport m_reportTitle="Discount Breakdown" m_reportCustId="1" m_reportCustDetailId="2" m_storeId="0"></detailReport>
<detailReport m_reportTitle="Bill Discount Breakdown" m_reportCustId="1" m_reportCustDetailId="3" m_storeId="0"></detailReport>
<detailReport m_reportTitle="Bill Modification Breakdown" m_reportCustId="1" m_reportCustDetailId="4" m_storeId="0"></detailReport>
<detailReport m_reportTitle="Void Sales Breakdown" m_reportCustId="1" m_reportCustDetailId="5" m_storeId="0"></detailReport>
</custReport>
</custReports>
</data>
</response>
| Element | Attribute | Data Type | Notes |
| error | error element contains error code and error descriptions | ||
| code | integer | 0 GENERAL_NO_ERROR 1011 WRS_LOG_IN_REQUIRED | |
| localizedDescription | string | A description in the language corresponding to the locale setting in the original request. | |
| defaultDescription | string | A description in English. | |
| custreport | A customized report set | ||
| m_reportCustId | integer | A customized report id | |
| m_reportCustName | string | A name of customized report | |
| m_reportCustTreePath | string | A tree path of customized report | |
| m_storeId | integer | A store id of current report | |
| detailReport | |||
| m_reportTitle | string | A title for detailed customized report | |
| m_reportCustId | integer | A customized report id which this report is associated | |
| m_reportCustDetailId | integer | A detailed customized report id | |
| m_storeId | integer | A store id of current detailed report |
ReportV2.getSystemRepList
This message requests for a list of system reports.
Request Message
<request apiVersion="1.00" apiKey="darren1234" apiName="ReportV2.getSystemRepList" apiCategory="wrs" requestTimestamp="2011-8-8 10:08:29.594">
<parameters>
<userInfo sessionId="admin13128125034581312812503459" siteName="djung" userId="admin"></userInfo>
</parameters>
</request>
| Element | Attribute | Data Type | Optional | Notes |
| parameters | no | Parameters element contains a list of parameter element | ||
| userInfo | no | The userInfo parameter | ||
| sessionId | string | yes | Session id for current request (for portal) | |
| siteName | string | yes | Name of site that this request makes to (for portal) | |
| userId | string | no | Web user id of employee trying to log in |
Response Message
<response apiVersion="1.0" apiName="ReportV2.getSystemRepList" apiCategory="wrs" requestTimestamp="2011-8-8 10:08:29.594">
<error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-08 10:08:29.976"></error>
<data>
<systemReports>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.netSales.RPT_NetSalesSummary" reportName="Net Sales Summary" reportTreeName="Summary" reportTreePath="Net Sales"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.netSales.RPT_NetSalesPercentageSummary" reportName="Net Sales Percentage Summary" reportTreeName="Percentage Summary" reportTreePath="Net Sales"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.netSales.RPT_NetSalesGroupedByGroup" reportName="Net Sales Summary Grouped by Groups" reportTreeName="Grouped by Groups" reportTreePath="Net Sales"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.audit.RPT_POSAuditLogs" reportName="POS Audit Logs" reportTreeName="POS Audit Logs" reportTreePath="Audit"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.audit.RPT_CashDrawerOpen" reportName="Cash Drawer Open Report" reportTreeName="Cash Drawer Open Report" reportTreePath="Audit"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.export.RPT_FreePour" reportName="Free Pour" reportTreeName="Free Pour" reportTreePath="Exports"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.export.RPT_FreePour_TermInfo" reportName="Free Pour Terminal Info" reportTreeName="Free Pour Terminal Info" reportTreePath="Exports"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.export.RPT_TrackRite" reportName="Track Rite" reportTreeName="Track Rite" reportTreePath="Exports"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.timeAndAttendance.RPT_PayrollByEmployee" reportName="Payroll by Employee" reportTreeName="Payroll by Employee" reportTreePath="Time And Attendance.Bounded by Shift Start Time"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.timeAndAttendance.RPT_LabourSales" reportName="Labour vs Sales" reportTreeName="Labour vs Sales" reportTreePath="Time And Attendance"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.timeAndAttendance.RPT_LabourSalesByJobType" reportName="Labour vs Sales List by Job Types" reportTreeName="Labour vs Sales List by Job Types" reportTreePath="Time And Attendance"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.timeAndAttendance.RPT_DisplayClockInEmployee" reportName="Display Clocked In Employees" reportTreeName="Display Clocked In Employees" reportTreePath="Time And Attendance"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.timeAndAttendance.RPT_DisplayClockInEmployeeListByLocation" reportName="Display Clocked In Employees Listed By Location" reportTreeName="Display Clocked In Employees Listed By Location" reportTreePath="Time And Attendance"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.wastage.RPT_WastageSummary" reportName="Wastage Summary by Menu Items" reportTreeName="Wastage Summary by Menu Items" reportTreePath="Wastage"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.wastage.RPT_WastageByEmployee" reportName="Wastage Summary" reportTreeName="Wastage Summary List By Employees" reportTreePath="Wastage"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.wastage.RPT_WastageByCustomer" reportName="Wastage Summary" reportTreeName="Wastage Summary List By Customers" reportTreePath="Wastage"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.wastage.RPT_WastageByTerminal" reportName="Wastage Summary" reportTreeName="Wastage Summary List By Terminals" reportTreePath="Wastage"></systemReport>
<systemReport reportIdKey="chezTesoro.reports2.reports.base.wastage.RPT_WastageByStore" reportName="Wastage Summary" reportTreeName="Wastage Summary List By Stores" reportTreePath="Wastage"></systemReport>
</systemReports>
</data>
</response>
| Element | Attribute | Data Type | Notes |
| error | error element contains error code and error descriptions | ||
| code | integer | 0 GENERAL_NO_ERROR 1011 WRS_LOG_IN_REQUIRED | |
| localizedDescription | string | A description in the language corresponding to the locale setting in the original request. | |
| defaultDescription | string | A description in English. | |
| systemReport | A system report set | ||
| reportIdKey | integer | A system report id key. Usually a full class path | |
| reportName | string | A name of system report | |
| reportTreeName | string | A name that appears on the tree view. | |
| reportTreePath | integer | A tree path for the system report |
ReportV2.printReport
This message generates a report.
Request Message
<request apiVersion="1.00" apiKey="darren1234" apiName="ReportV2.printReport" apiCategory="wrs" requestTimestamp="2011-8-8 10:36:45.137">
<parameters>
<userInfo sessionId="admin13128136235181312813623518" siteName="djung" userId="admin" password=""></userInfo>
<report key="chezTesoro.reports2.reports.base.netSales.RPT_NetSalesSummary" start="08/08/2006 05:00:00" end="09/08/2006 04:59:59" exportType="HTML" orientation="auto"/>
</parameters>
</request>
| Element | Attribute | Data Type | Optional | Notes |
| parameters | no | Parameters element contains a list of parameter element | ||
| userInfo | no | The userInfo parameter | ||
| sessionId | string | yes | Session id for current request (for portal) | |
| siteName | string | yes | Name of site that this request makes to (for portal) | |
| userId | string | no | Web user id of employee trying to log in | |
| report | The information about the report trying to generate | |||
| key | string | no | The report key to be generated (full class path for system reports, report name for customized report) | |
| start | timestamp | no | The report start time (MM/DD/YYYY HH:mm:ss) | |
| end | timestamp | no | The report end time (MM/DD/YYYY HH:mm:ss) | |
| exportType | string | no | The report export type (either "HTML" or "PDF") | |
| orientation | string | no | The report orientation (either "auto" or "portrait" or "landscape") |
Response Message
<response apiVersion="1.0" apiName="ReportV2.printReport" apiCategory="wrs" requestTimestamp="2011-8-8 10:27:12.396">
<error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-08 10:27:26.06"></error>
<data>
<reportOutput outFile="1312813643909.html"></reportOutput>
</data>
</response>
| Element | Attribute | Data Type | Notes |
| error | error element contains error code and error descriptions | ||
| code | integer | 0 GENERAL_NO_ERROR 1011 WRS_LOG_IN_REQUIRED | |
| localizedDescription | string | A description in the language corresponding to the locale setting in the original request. | |
| defaultDescription | string | A description in English. | |
| reportOutput | A customized report set | ||
| ourFile | string | A file name for output report |
ReportV2.getReportInfo
This message requests for a detailed report setting information, such as profit centers, menu item filters, day parts, and a list of terminals/employees/stores/customers.
Request Message
<request apiVersion="1.00" apiKey="darren1234" apiName="ReportV2.getReportInfo" apiCategory="wrs" requestTimestamp="2011-8-8 10:46:33.397">
<parameters>
<userInfo sessionId="admin13128147933701312814793370" siteName="djung" userId="admin"></userInfo>
</parameters>
</request>
| Element | Attribute | Data Type | Optional | Notes |
| parameters | no | Parameters element contains a list of parameter element | ||
| userInfo | no | The userInfo parameter | ||
| sessionId | yes | Session id for current request (for portal) | ||
| siteName | yes | Name of site that this request makes to (for portal) | ||
| userId | no | Web user id of employee trying to log in |
Response Message
<response apiVersion="1.0" apiName="ReportV2.getReportInfo" apiCategory="wrs" requestTimestamp="2011-8-8 10:46:33.397">
<error code="0" localizedDescription="Request successfully processed." defaultDescription="Request successfully processed." responseTimestamp="2011-08-08 10:47:13.868"></error>
<data>
<timeInfo startOfToday="1312794000000" endOfToday="1312880399000"></timeInfo>
<pcFilters></pcFilters>
<miFilters></miFilters>
<dayParts>
<dayPart id="11" name="11" storeId="0"></dayPart>
</dayParts>
<terminals>
<terminal id="20" name="HostessStation" storeId="0"></terminal>
<terminal id="27" name="SidePatio" storeId="0"></terminal>
<terminal id="22" name="WicklowLounge" storeId="0"></terminal>
</terminals>
<employees>
<employee id="888" name="Admin Admin" storeId="0"></employee>
<employee id="1011" name="Tina Szyjak" storeId="0"></employee>
<employee id="1" name="Trainee Trainee" storeId="0"></employee>
<employee id="1298" name="Trevor Ellis" storeId="0"></employee>
<employee id="1274" name="Tylor Maitland" storeId="0"></employee>
<employee id="1253" name="William Ryan" storeId="0"></employee>
</employees>
<customers>
<customer id="352" name="Jen Bateman" storeId="0"></customer>
<customer id="397" name="Jeremy Hall" storeId="0"></customer>
<customer id="416" name="Tylor Maitland" storeId="0"></customer>
<customer id="279" name="Vaughan Newman" storeId="0"></customer>
<customer id="390" name="William Ryan" storeId="0"></customer>
<customer id="270" name="Zoran Kozuvarovski" storeId="0"></customer>
</customers>
<stores>
<store id="0" name="Main Store"></store>
</stores>
</data>
</response>
| Element | Attribute | Data Type | Notes |
| error | error element contains error code and error descriptions | ||
| code | integer | 0 GENERAL_NO_ERROR 1011 WRS_LOG_IN_REQUIRED | |
| localizedDescription | string | A description in the language corresponding to the locale setting in the original request. | |
| defaultDescription | string | A description in English. | |
| timeInfo | A customized report set | ||
| startOfToday | long | A timestamp indicates start time of today | |
| endOfToday | long | A timestamp indicates end time of today | |
| pcFilters/pcFilter | A list of current store's defined profit centers | ||
| miFilters/miFilter | A list of current store's defined menu item filters | ||
| dayParts/dayPart | A list of current store's defined day parts | ||
| terminals/terminal | A list of current store's terminals | ||
| employees/employee | A list of current store's employees | ||
| customers/customer | A list of current store's customers | ||
| stores/store | A list of current store's stores (only relevant for head offices) |
Related content
POS Web Services API
POS Web Services API
More like this
Portal Web Services API - Reporting
Portal Web Services API - Reporting
More like this
POS Web Services API - CRM
POS Web Services API - CRM
More like this
POS Web Services API - Menu Item Retrieval, Setup Info, General API Calls
POS Web Services API - Menu Item Retrieval, Setup Info, General API Calls
More like this
POS Web Services API - Transaction
POS Web Services API - Transaction
More like this
Web Services Error Codes
Web Services Error Codes
More like this