Rezlynx API
cim_FinancialExportReportV2
This method fetches financial export data from the CIM system, covering a specified time period.
Parameters
Name | Type | Description |
---|---|---|
sessionId | string | Session ID, obtained at login |
beforeTimestamp | dateTime | Date-time equal to or before which data is required |
afterTimestamp | dateTime | Date-time equal to or after which data is required |
useLessThanToDate | Boolean | Provides an option to return only the data that is less than the before timestamp which is required for financial export for LSE |
Returned data
- A set of financial transactions
Returned data (financial transaction)
Name | Type | Description |
---|---|---|
TransactionType | string | Transaction type (see below) |
AccountNumber | string | CIM account number |
AccountType | int | CIM account type |
TransactionReference | string | Transaction reference |
UniqueReferenceNumber | string | Unique reference number |
SecondReference | string | Supplementary reference number, if applicable |
Description | string | Transaction description |
DueDate | dateTime | Due date |
ForDate | dateTime | For date |
TransactionDate | dateTime | Transaction date |
GrossValue | decimal | Gross value |
NettValue | decimal | Nett value |
TaxValue | decimal | Tax value |
NominalCode | string | Nominal code |
SaleCode | string | Sales code |
PayCode | string | Payment code |
TaxCode | string | Tax code |
SiteId | string | Applicable site ID |
PeriodId | int | Applicable period ID |
PeriodFromDate | dateTime | Period 'from' date |
PeriodToDate | dateTime | Period 'to' date |
ModifiedDate | dateTime | Modified date |
ModifiedKey | int | Modified key |
Transaction type is one of the following:
- "Payment"
- "Invoice"
- "CreditNote"
- "Proforma"
Request URL
https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_FinancialExportReportV2Request headers
Name | Type | Description |
---|---|---|
(optional) | string | Media type of the body sent to the API. |
Request body
<cim_FinancialExportReportV2 xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<sessionId>16460170-51b1-452f-b40a-50be4492d496</sessionId>
<beforeTimestamp>2017-08-29T00:00:00</beforeTimestamp>
<afterTimestamp>2017-08-28T00:00:00</afterTimestamp>
<transactionList />
<useLessThanToDate>true</useLessThanToDate>
</cim_FinancialExportReportV2>
Responses
200 OK
Representations
<cim_FinancialExportReportV2Response xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_FinancialExportReportV2Result>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</cim_FinancialExportReportV2Result>
<afterTimestamp>2019-01-10T12:00:00</afterTimestamp>
<beforeTimestamp>2019-01-11T00:00:00</beforeTimestamp>
<transactionList>
<Items>
<FinancialExportTransaction>
<TransactionType>Invoice</TransactionType>
<AccountNumber>PAUL</AccountNumber>
<AccountType>2</AccountType>
<TransactionReference>CINV00000342</TransactionReference>
<UniqueReferenceNumber>CRS00244/BK00000278</UniqueReferenceNumber>
<SecondReference>9599</SecondReference>
<Description> CIM QA Site A BookRef-BK00000278/1 Guest - Mr Paul McCormick
Arrival 10/01/2019 Departure 13/01/2019; Nights = 3
Billing 10/01/2019 to 11/01/2019 Nights = 1 @ 130.00</Description>
<DueDate>2018-07-11T00:00:00</DueDate>
<ForDate>2019-01-10T00:00:00</ForDate>
<TransactionDate>2019-01-10T00:00:00</TransactionDate>
<GrossValue>156.0000</GrossValue>
<NettValue>130.0000</NettValue>
<TaxValue>26.0000</TaxValue>
<NominalCode>ACCOMM</NominalCode>
<SaleCode>ACCOMM</SaleCode>
<PayCode />
<TaxCode>VAT_20</TaxCode>
<SiteId>CIMA</SiteId>
<PeriodId>0</PeriodId>
<PeriodFromDate>0001-01-01T00:00:00</PeriodFromDate>
<PeriodToDate>0001-01-01T00:00:00</PeriodToDate>
<ModifiedDate>2019-01-10T12:11:24.023</ModifiedDate>
<ModifiedKey>9599</ModifiedKey>
</FinancialExportTransaction>
<FinancialExportTransaction>
<TransactionType>Invoice</TransactionType>
<AccountNumber>PAUL</AccountNumber>
<AccountType>2</AccountType>
<TransactionReference>CINV00000342</TransactionReference>
<UniqueReferenceNumber>CRS00244/BK00000278</UniqueReferenceNumber>
<SecondReference>9600</SecondReference>
<Description> CIM QA Site A BookRef-BK00000278/1 Guest - Mr Paul McCormick
Arrival 10/01/2019 Departure 13/01/2019; Nights = 3
Billing 11/01/2019 to 13/01/2019 Nights = 2 @ 120.00</Description>
<DueDate>2018-07-11T00:00:00</DueDate>
<ForDate>2019-01-10T00:00:00</ForDate>
<TransactionDate>2019-01-10T00:00:00</TransactionDate>
<GrossValue>216.0000</GrossValue>
<NettValue>180.0000</NettValue>
<TaxValue>36.0000</TaxValue>
<NominalCode>ACCOMM</NominalCode>
<SaleCode>ACCOMM</SaleCode>
<PayCode />
<TaxCode>VAT_20</TaxCode>
<SiteId>CIMA</SiteId>
<PeriodId>0</PeriodId>
<PeriodFromDate>0001-01-01T00:00:00</PeriodFromDate>
<PeriodToDate>0001-01-01T00:00:00</PeriodToDate>
<ModifiedDate>2019-01-10T12:11:24.147</ModifiedDate>
<ModifiedKey>9600</ModifiedKey>
</FinancialExportTransaction>
<FinancialExportTransaction>
<TransactionType>Invoice</TransactionType>
<AccountNumber>PAUL</AccountNumber>
<AccountType>2</AccountType>
<TransactionReference>CINV00000342</TransactionReference>
<UniqueReferenceNumber>CRS00244/BK00000278</UniqueReferenceNumber>
<SecondReference>9600</SecondReference>
<Description> CIM QA Site A BookRef-BK00000278/1 Guest - Mr Paul McCormick
Arrival 10/01/2019 Departure 13/01/2019; Nights = 3
Billing 11/01/2019 to 13/01/2019 Nights = 2 @ 120.00</Description>
<DueDate>2018-07-11T00:00:00</DueDate>
<ForDate>2019-01-10T00:00:00</ForDate>
<TransactionDate>2019-01-10T00:00:00</TransactionDate>
<GrossValue>24.0000</GrossValue>
<NettValue>20.0000</NettValue>
<TaxValue>4.0000</TaxValue>
<NominalCode>BFAST</NominalCode>
<SaleCode>BFAST</SaleCode>
<PayCode />
<TaxCode>VAT_20</TaxCode>
<SiteId>CIMA</SiteId>
<PeriodId>0</PeriodId>
<PeriodFromDate>0001-01-01T00:00:00</PeriodFromDate>
<PeriodToDate>0001-01-01T00:00:00</PeriodToDate>
<ModifiedDate>2019-01-10T12:11:24.147</ModifiedDate>
<ModifiedKey>9600</ModifiedKey>
</FinancialExportTransaction>
<FinancialExportTransaction>
<TransactionType>Invoice</TransactionType>
<AccountNumber>PAUL</AccountNumber>
<AccountType>2</AccountType>
<TransactionReference>CINV00000342</TransactionReference>
<UniqueReferenceNumber>CRS00244/BK00000278</UniqueReferenceNumber>
<SecondReference>9600</SecondReference>
<Description> CIM QA Site A BookRef-BK00000278/1 Guest - Mr Paul McCormick
Arrival 10/01/2019 Departure 13/01/2019; Nights = 3
Billing 11/01/2019 to 13/01/2019 Nights = 2 @ 120.00</Description>
<DueDate>2018-07-11T00:00:00</DueDate>
<ForDate>2019-01-10T00:00:00</ForDate>
<TransactionDate>2019-01-10T00:00:00</TransactionDate>
<GrossValue>48.0000</GrossValue>
<NettValue>40.0000</NettValue>
<TaxValue>8.0000</TaxValue>
<NominalCode>FOOD</NominalCode>
<SaleCode>FOOD</SaleCode>
<PayCode />
<TaxCode>VAT_20</TaxCode>
<SiteId>CIMA</SiteId>
<PeriodId>0</PeriodId>
<PeriodFromDate>0001-01-01T00:00:00</PeriodFromDate>
<PeriodToDate>0001-01-01T00:00:00</PeriodToDate>
<ModifiedDate>2019-01-10T12:11:24.147</ModifiedDate>
<ModifiedKey>9600</ModifiedKey>
</FinancialExportTransaction>
<FinancialExportTransaction>
<TransactionType>Invoice</TransactionType>
<AccountNumber>PAUL</AccountNumber>
<AccountType>2</AccountType>
<TransactionReference>CINV00000343</TransactionReference>
<UniqueReferenceNumber>CRS00245/BK00000279</UniqueReferenceNumber>
<SecondReference>9603</SecondReference>
<Description> CIM QA Site A BookRef-BK00000279/1 Guest - Mr Paul McCormick
Arrival 10/01/2019 Departure 12/01/2019; Nights = 2
Billing 10/01/2019 to 12/01/2019 Nights = 2 @ 120.00</Description>
<DueDate>2018-07-11T00:00:00</DueDate>
<ForDate>2019-01-10T00:00:00</ForDate>
<TransactionDate>2019-01-10T00:00:00</TransactionDate>
<GrossValue>216.0000</GrossValue>
<NettValue>180.0000</NettValue>
<TaxValue>36.0000</TaxValue>
<NominalCode>ACCOMM</NominalCode>
<SaleCode>ACCOMM</SaleCode>
<PayCode />
<TaxCode>VAT_20</TaxCode>
<SiteId>CIMA</SiteId>
<PeriodId>0</PeriodId>
<PeriodFromDate>0001-01-01T00:00:00</PeriodFromDate>
<PeriodToDate>0001-01-01T00:00:00</PeriodToDate>
<ModifiedDate>2019-01-10T12:21:35.84</ModifiedDate>
<ModifiedKey>9603</ModifiedKey>
</FinancialExportTransaction>
</Items>
</transactionList>
</cim_FinancialExportReportV2Response>
Code samples
@ECHO OFF
curl -v -X POST "https://pmsws.eu.guestline.net/rlxsoaprouter/rlxsoap.asmx?op=cim_FinancialExportReportV2"
-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=cim_FinancialExportReportV2&" + 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=cim_FinancialExportReportV2");
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=cim_FinancialExportReportV2" + $.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=cim_FinancialExportReportV2";
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=cim_FinancialExportReportV2');
$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", "cim_FinancialExportReportV2%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/cim_FinancialExportReportV2&%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=cim_FinancialExportReportV2')
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