Reporting

Use the Reporting web service to retrieve the invoices based on the parameters that are sent .

Syntax

POST rest/InvoicesService/reporting 

Service Specifications

Input Parameters

Sample Request

The Reporting service request should contain the details of the Invoices that you want to collect.

It is in JSON format as the following:

invoice = {
	"authToken" : "YjI1MDc5ODUxNWEwMTkwMDQ4Mjg5YTgy",
	"merchantID" : "testMercahnt",
	"fromDate":"01/06/2023",
    "toDate":"01/07/2023",
    "currency":"",
    "invoiceStatus":"",
    "expiryFromDate":"",
    "expiryToDate":"",
    "invoiceType":"",
    "invoiceId":"",
    "includeDynamicFields": true,
    "responseOptionalFields":["0","1","2","3","4","5","6","7","8","9","10","11","12","13","14","15"],
    "usePagination":"true",
    "pageSize":"1",
    "pageNumber":"1"
}

Output Parameters

Invoices

Sample Response

Reporting service returns the response in JSON format.

The returned response as the following:

{
    "invoices": [
        {
            "originalInvoiceAmount": "1000.00",
            "approvalCode": "119657",
            "invoiceCreationDate": "25/08/2022 02:50:44 AM",
            "mobileNumber": "079999999999999",
            "dynamicFields": [
                {
                    "value": "MCP10587.1",
                    "key": "BookingReference"
                },
                {
                    "value": "16-10-2022 04:59:00",
                    "key": "CheckOut"
                },
                {
                    "value": "2 night, 1 room",
                    "key": "Reservation"
                },
                {
                    "value": "14-10-2022 04:59:00",
                    "key": "CheckIn"
                }
            ],
            "cardType": "Visa",
            "originalInvoiceCurrency": "SAR",
            "description": "Opera+Reservation",
            "paymentLink": "http://172.22.50.67:9082/URLShortener?t=zo9XKX",
            "maskedCardNumber": "401200******0026",
            "transactionId": "16613851109947471758",
            "RRN": "10101450304891",
            "expiryDate": "04/12/2022 08:34:44 AM",
            "authorizedCurrency": "SAR",
            "authorizedAmount": "1000.00",
            "invoiceType": "Pre-Auth & Completion",
            "paymentMethod": "",
            "invoiceId": "DOAA552992491",
            "invoiceStatus": "PAID",
            "email": "aseel.k@stspayone.com"
        }
    ],
    "numberOfPages": 16
}

Sample Code

import java.io.BufferedReader;
import java.io.DataOutputStream;
import java.io.IOException;
.
.
.
 String reportingInvoiceURL = "http://localhost:9081/URL2PayAdminWeb/rest/InvoicesService/reporting";
 
 try{
 JSONObject requestJson = new JSONObject();
 
 requestJson.put("merchantId", "2000568");
 
 
 requestJson.put("authToken", "ZGM1NDgzZTRhMmU2YTUzOGJhNzY1OTM5");
 
 requestJson.put("fromDate", "01/06/2023");
 requestJson.put("toDate", "20/06/2023");
 
 logger.info("the prepared JSON is : "+requestJson.toString());
 
 
 URL obj = new URL(reportingInvoiceURL);
 // Open a connection to the service
 HttpURLConnection con = (HttpURLConnection) obj.openConnection();
 
 // Set the request method to POST
 con.setRequestMethod("POST");
 
 // Set the request headers
 con.setRequestProperty("Content-Type", "application/json");
 con.setRequestProperty("Accept", "application/json");
 con.setRequestProperty("Accept-Encoding", "gzip, deflate, br");
 
 // Enable input and output streams
 con.setDoOutput(true);
 con.setDoInput(true);
 
 // Write the payload to the request body
 DataOutputStream wr = new DataOutputStream(con.getOutputStream());
 wr.writeBytes(requestJson.toString());
 wr.flush();
 wr.close();
 
 // Get the response from the service
 int responseCode = con.getResponseCode();
 
 // Read the response body
 BufferedReader in;
 if (responseCode >= 400) {
 in = new BufferedReader(new InputStreamReader(con.getErrorStream()));
 } else {
 in = new BufferedReader(new InputStreamReader(con.getInputStream()));
 }
 
 String inputLine;
 StringBuilder responseBuilder = new StringBuilder();
 
 while ((inputLine = in.readLine()) != null) {
 responseBuilder.append(inputLine);
 }
 in.close();
 
 // Print the response
 logger.info("Response Code: " + responseCode);
 logger.info("Response Body: " + responseBuilder.toString());
 
 JSONObject responseJson=new JSONObject(responseBuilder.toString()); 
 
 request.setAttribute("invoices", responseJson.toString());
 request.getRequestDispatcher("ReportingInvoiceResponse.jsp").forward(request,response);
 
 }catch (JSONException e) {
// TODO: handle exception
 e.printStackTrace();
}
}
}