X/Z Reporting

As well as processing transactions, axept® PRO supports functionality to report upon processed transactions. This section of the document will detail how reports can be obtained.

Reports

It is possible to generate the following reports on axept® PRO:

Report Type	Description
X	Provides overall totals of the transactions that have been processed since the last Z report.
Z	Same as an X report, however, running a Z report will revert all totals back to zero.

GET /reports

URL

https://(TerminalIP):8080/POSitiveWebLink/1.1.0/rest/reports

An HTTPS GET request should be sent to the above URL with the following parameters:

GET /reports Query String Parameters
Field Name	State	Data Type	Description
tid	Mandatory	String	This is the serial number of the PAX IM30 that should process the transaction.
reportType	Mandatory	String	Indicates which report to run. Possible values are: ZReport XReport
GET /reports Header Parameters
Authorization	Mandatory	String	This field should be populated with a value of Bearer 6945595921271780

GET Request Example

GET https://192.168.10.44:8080/POSitiveWebLink/1.1.0/rest/reports?tid=1640005298&reportType=XReport
HTTP/1.1
Content-Type: application/json
Authorization: Bearer 6945595921271780
User-Agent: PostmanRuntime/7.26.8
Accept: */*
Host: 192.168.0.75:8080
Accept-Encoding: gzip, deflate, br
Connection: keep-alive

GET Response Fields

In response to the GET, axept® PRO will return one of six response codes:

HTTP Response Code	Description
200	Request was successful.
206	Transaction in progress. Reports cannot be generated when a transaction is in progress.
400	Bad input parameter. Details would be returned in a text description.
403	Not Authorised
404	Not found. Details would be returned in a text description.
408	Request timeout.

GET Response '200' fields

If the HTTP response code is 200, the body will contain the following fields:

GET /reports Response Body Parameters
Field Name	Data Type	Description
reportType	String	The report type. Possible values are: ZReport XReport
reportResponse	Boolean	Indicates if the report generated successfully.
saleCount	Integer	The number of sale transactions processed since the last Z report.
refundCount	Integer	The number of refund transactions processed since the last Z report.
completionCount	Integer	The number of completion transactions processed since the last Z report.
cashbackCount	Integer	The number of cashback transactions processed since the last Z report.
gratuityCount	Integer	The number of sale transactions including a gratuity that have been processed since the last Z report.
saleAmount	Integer	The cumulative value of all sale transactions processed since the last Z report.
refundAmount	Integer	The cumulative value of all refund transactions processed since the last Z report.
completionAmount	Integer	The cumulative value of all completion transactions processed since the last Z report.
cashbackAmount	Integer	The cumulative value of all cashback transactions processed since the last Z report.
gratuityAmount	Integer	The cumulative value of all gratuity transactions processed since the last Z report.

GET Example Response

HTTP/1.1 200
Content-Type: application/json
Date: Wed, 20 Jan 2021 17:05:07 GMT
Allow: POST, GET, OPTIONS, DELETE
Access-Control-Max-Age: 86400
Access-Control-Allow-Methods: POST, GET, OPTIONS, DELETE
Access-Control-Allow-Headers: *
Access-Control-Allow-Origin: *
Connection: keep-alive
Content-Encoding: gzip
Transfer-Encoding: chunked
{
    "cashbackAmount": 0,
    "cashbackCount": 0,
    "completionAmount": 0,
    "completionCount": 0,
    "gratuityAmount": 0,
    "gratuityCount": 0,
    "refundAmount": 0,
    "refundCount": 0,
    "reportResponse": true,
    "reportType": "XReport",
    "saleAmount": 1400,
    "saleCount": 5
}