Rezlynx API
pmsint_GetFinancialReport
This method is used to get a pre-configured financial report from the Rezlynx system, formatted in XML. The report structure must be pre-configured in Rezlynx (under System > Tools > Financial Report Export).
Parameters
Name | Type | Description |
---|---|---|
SessionID | string | Session ID, obtained at log-in |
SelectionCriteria | (XmlDocument) | Selection criteria |
PeriodID | int | Period ID |
KepyoReport | Boolean | Kepyo report flag |
KepyoUserDef1 | string | Kepyo user parameter #1 |
KepyoUserDef2 | string | Kepyo user parameter #2 |
Returned data
<Data><DOCUMENT><DEPOSITANALYSIS><DEPOSITANALYSISTOTALS><DEP_BFWD><DESCRIPTION>Deposit Balance Brought Forward</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_BFWD><DEP_RECVD><DESCRIPTION>Deposits Received</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_RECVD><DEP_REFUD><DESCRIPTION>Deposits Refunded</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_REFUD><DEP_RETND><DESCRIPTION>Deposits Retained</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_RETND><DEP_INHOUSE><DESCRIPTION>Deposits InHouse/InUse</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_INHOUSE><DEP_BAL_ACT><DESCRIPTION>Deposit Balance (Actual)</DESCRIPTION><NETTTOTAL>0</NETTTOTAL><TAXTOTAL>0</TAXTOTAL><GROSSTOTAL>0</GROSSTOTAL></DEP_BAL_ACT></DEPOSITANALYSISTOTALS><DEPOSITANALYSISTRANS><DEP_RECVD><TRANSID></TRANSID><ANALCODE></ANALCODE><DESCRIPTION></DESCRIPTION><QUANTITY></QUANTITY><GROSSPERUNIT></GROSSPERUNIT><GROSSTOTAL></GROSSTOTAL><NETTPERUNIT></NETTPERUNIT><NETTTOTAL></NETTTOTAL><TAXTOTAL></TAXTOTAL><COMPANYREF></COMPANYREF><SOURCE></SOURCE></DEP_RECVD><DEP_REFUD><TRANSID></TRANSID><ANALCODE></ANALCODE><DESCRIPTION></DESCRIPTION><QUANTITY></QUANTITY><GROSSPERUNIT></GROSSPERUNIT><GROSSTOTAL></GROSSTOTAL><NETTPERUNIT></NETTPERUNIT><NETTTOTAL></NETTTOTAL><TAXTOTAL></TAXTOTAL><COMPANYREF></COMPANYREF><SOURCE></SOURCE></DEP_REFUD><DEP_RETND><TRANSID></TRANSID><ANALCODE></ANALCODE><DESCRIPTION></DESCRIPTION><QUANTITY></QUANTITY><GROSSPERUNIT></GROSSPERUNIT><GROSSTOTAL></GROSSTOTAL><NETTPERUNIT></NETTPERUNIT><NETTTOTAL></NETTTOTAL><TAXTOTAL></TAXTOTAL><COMPANYREF></COMPANYREF><SOURCE></SOURCE></DEP_RETND><DEP_INHOUSE><TRANSID></TRANSID><ANALCODE></ANALCODE><DESCRIPTION></DESCRIPTION><QUANTITY></QUANTITY><GROSSPERUNIT></GROSSPERUNIT><GROSSTOTAL></GROSSTOTAL><NETTPERUNIT></NETTPERUNIT><NETTTOTAL></NETTTOTAL><TAXTOTAL></TAXTOTAL><COMPANYREF></COMPANYREF><SOURCE></SOURCE></DEP_INHOUSE></DEPOSITANALYSISTRANS></DEPOSITANALYSIS></DOCUMENT></Data>
Request URL
https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetFinancialReportRequest headers
Name | Type | Description |
---|---|---|
(optional) | string | Media type of the body sent to the API. |
Request body
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<pmsint_GetFinancialReport xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>SessionID1</SessionID>
<SelectionCriteria>text<cnbenq_CreateWebEnquiry><evtEnquiryWeb><StartDate>1900-01-01T01:01:01</StartDate><EndDate>1900-01-01T01:01:01</EndDate><Title>Title1</Title><Forename>Forename1</Forename><Surname>Surname1</Surname><Telephone>Telephone1</Telephone><Mobile>Mobile1</Mobile><Email>Email1</Email><Delegates>1</Delegates><EventName>EventName1</EventName><EnquiryNotes>EnquiryNotes1</EnquiryNotes></evtEnquiryWeb></cnbenq_CreateWebEnquiry></SelectionCriteria>
<PeriodID>1</PeriodID>
<GetFinancialReport>
<Data>Data1</Data>
</GetFinancialReport>
<KepyoReport>true</KepyoReport>
<KepyoUserDef1>KepyoUserDef11</KepyoUserDef1>
<KepyoUserDef2>KepyoUserDef21</KepyoUserDef2>
</pmsint_GetFinancialReport>
</Body>
</Envelope>
Responses
200 OK
Representations
<pmsint_GetFinancialReport xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>8f8e0e90-a9d6-4f29-b694-5aa1d773288d</SessionID>
<SelectionCriteria>
<REPORTTITLE xmlns="">test</REPORTTITLE>
</SelectionCriteria>
<PeriodID>1</PeriodID>
<KepyoReport>false</KepyoReport>
<KepyoUserDef1>STREETNUMBER</KepyoUserDef1>
<KepyoUserDef2>BUSINESSTYPE</KepyoUserDef2>
</pmsint_GetFinancialReport>
Code samples
@ECHO OFF
curl -v -X POST "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetFinancialReport"
-H "Content-Type: text/xml"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
var uri = "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetFinancialReport&" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetFinancialReport");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "text/xml");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetFinancialReport" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","text/xml");
},
type: "POST",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetFinancialReport";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"text/xml" forHTTPHeaderField:@"Content-Type"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetFinancialReport');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'text/xml',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Content-Type': 'text/xml',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx')
conn.request("POST", "pmsint_GetFinancialReport%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Content-Type': 'text/xml',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('developers.azure-api.net')
conn.request("POST", "/rezlynx-web-service/?soapAction=http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsint_GetFinancialReport&%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=pmsint_GetFinancialReport')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'text/xml'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body