The Rezlynx API is the Public API for the Rezlynx PMS, by which external parties (customers, partners and collaborators) can interact and share data with the system. It can be used for posting charges to rooms and guest folios, getting information on guests checking in to the property, and much more besides.
<p>Create a new event or update information about an existing event.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">EventRef</td>
<td align="left">string</td>
<td align="left">Event reference (if updating an existing event)</td>
</tr>
<tr class="evenRow">
<td align="left">ProfileRef</td>
<td align="left">string</td>
<td align="left">Profile reference for contact, if applicable</td>
</tr>
<tr class="oddRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference</td>
</tr>
<tr class="evenRow">
<td align="left">AgentRef</td>
<td align="left">string</td>
<td align="left">Agent reference</td>
</tr>
<tr class="oddRow">
<td align="left">StartDate</td>
<td align="left">dateTime</td>
<td align="left">Event start date-time</td>
</tr>
<tr class="evenRow">
<td align="left">EndDate</td>
<td align="left">dateTime</td>
<td align="left">Event end date-time</td>
</tr>
<tr class="oddRow">
<td align="left">EventStatus</td>
<td align="left">int</td>
<td align="left">Event status code (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">Delegates</td>
<td align="left">int</td>
<td align="left">Number of delegates</td>
</tr>
<tr class="oddRow">
<td align="left">EventName</td>
<td align="left">string</td>
<td align="left">Event name</td>
</tr>
<tr class="evenRow">
<td align="left">Coordinator</td>
<td align="left">string</td>
<td align="left">Name of co-ordinator</td>
</tr>
<tr class="oddRow">
<td align="left">EventType</td>
<td align="left">string</td>
<td align="left">Event type</td>
</tr>
<tr class="evenRow">
<td align="left">MarketSegment</td>
<td align="left">string</td>
<td align="left">Market segment</td>
</tr>
<tr class="oddRow">
<td align="left">MediaSource</td>
<td align="left">string</td>
<td align="left">Media source</td>
</tr>
<tr class="evenRow">
<td align="left">PORef</td>
<td align="left">string</td>
<td align="left">Purchase Order reference</td>
</tr>
<tr class="oddRow">
<td align="left">InternalNotes</td>
<td align="left">string</td>
<td align="left">Notes (internal)</td>
</tr>
<tr class="evenRow">
<td align="left">EventNotes</td>
<td align="left">string</td>
<td align="left">Notes (event)</td>
</tr>
<tr class="oddRow">
<td align="left">CustomNotes1</td>
<td align="left">string</td>
<td align="left">Notes (custom 1)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes2</td>
<td align="left">string</td>
<td align="left">Notes (custom 2)</td>
</tr>
<tr class="oddRow">
<td align="left">CustomNotes3</td>
<td align="left">string</td>
<td align="left">Notes (custom 3)</td>
</tr>
<tr class="evenRow">
<td align="left">Token</td>
<td align="left">string</td>
<td align="left">Token</td>
</tr>
<tr class="oddRow">
<td align="left">TokenSource</td>
<td align="left">(see below)</td>
<td align="left">Payment token source</td>
</tr>
<tr class="evenRow">
<td align="left">BillingNotes</td>
<td align="left">string</td>
<td align="left">Notes (billing)</td>
</tr>
</tbody>
</table>
<p><strong>Event status codes</strong> are as follows:</p>
<ul>
<li>1 = Provisional</li>
<li>2 = Tentative</li>
<li>3 = Confirmed</li>
<li>4 = Guaranteed</li>
<li>102 = Cancelled</li>
<li>103 = Resident</li>
<li>104 = Checked out</li>
</ul>
<p><strong>Token source</strong> can be one of the following:</p>
<ul>
<li>"Auric"</li>
<li>"Worldpay"</li>
<li>"PayDollar"</li>
<li>"SecureTrading"</li>
<li>"PaymentExpress"</li>
</ul>
<h2 class="">Returned data</h2>
<ul>
<li>The method returns the Event reference</li>
</ul>
cnb_SaveEventSoapIn
<cnb_SaveEvent xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnbEvent>
<EventRef />
<ProfileRef>PF00000001</ProfileRef>
<CompanyRef />
<AgentRef />
<StartDate>2019-06-01T00:00:00</StartDate>
<EndDate>2019-06-01T00:00:00</EndDate>
<EventStatus>1</EventStatus>
<Delegates>100</Delegates>
<EventName>Windsor wedding</EventName>
<Coordinator />
<EventType>WED</EventType>
<MarketSegment>Wedding</MarketSegment>
<MediaSource>BROCHURE</MediaSource>
<PORef />
<InternalNotes />
<EventNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<Token />
<TokenSource>Auric</TokenSource>
<BillingNotes />
</cnbEvent>
</cnb_SaveEvent>
cnb_SaveEventSoapOut
<cnb_SaveEventResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_SaveEventResult>
<EventRef>EVNT00027</EventRef>
</cnb_SaveEventResult>
</cnb_SaveEventResponse>
<p>Get all the details about a specific event.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">eventRef</td>
<td align="left">string</td>
<td align="left">Event reference</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">EventRef</td>
<td align="left">string</td>
<td align="left">Event reference</td>
</tr>
<tr class="evenRow">
<td align="left">ProfileRef</td>
<td align="left">string</td>
<td align="left">Profile reference, if linked to a profile</td>
</tr>
<tr class="oddRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference</td>
</tr>
<tr class="evenRow">
<td align="left">AgentRef</td>
<td align="left">string</td>
<td align="left">Agent reference</td>
</tr>
<tr class="oddRow">
<td align="left">StartDate</td>
<td align="left">dateTime</td>
<td align="left">Event start date-time</td>
</tr>
<tr class="evenRow">
<td align="left">EndDate</td>
<td align="left">dateTime</td>
<td align="left">Event end date-time</td>
</tr>
<tr class="oddRow">
<td align="left">EventStatus</td>
<td align="left">int</td>
<td align="left">Event status code (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">Delegates</td>
<td align="left">int</td>
<td align="left">Number of delegates</td>
</tr>
<tr class="oddRow">
<td align="left">EventName</td>
<td align="left">string</td>
<td align="left">Name of the event</td>
</tr>
<tr class="evenRow">
<td align="left">Coordinator</td>
<td align="left">string</td>
<td align="left">Name of the co-ordinator</td>
</tr>
<tr class="oddRow">
<td align="left">EventType</td>
<td align="left">string</td>
<td align="left">Event type</td>
</tr>
<tr class="evenRow">
<td align="left">MarketSegment</td>
<td align="left">string</td>
<td align="left">Market segment</td>
</tr>
<tr class="oddRow">
<td align="left">MediaSource</td>
<td align="left">string</td>
<td align="left">Media source</td>
</tr>
<tr class="evenRow">
<td align="left">PORef</td>
<td align="left">string</td>
<td align="left">Purchase Order reference</td>
</tr>
<tr class="oddRow">
<td align="left">InternalNotes</td>
<td align="left">string</td>
<td align="left">Notes (internal)</td>
</tr>
<tr class="evenRow">
<td align="left">EventNotes</td>
<td align="left">string</td>
<td align="left">Notes (event)</td>
</tr>
<tr class="oddRow">
<td align="left">CustomNotes1</td>
<td align="left">string</td>
<td align="left">Notes (custom 1)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes2</td>
<td align="left">string</td>
<td align="left">Notes (custom 2)</td>
</tr>
<tr class="oddRow">
<td align="left">CustomNotes3</td>
<td align="left">string</td>
<td align="left">Notes (custom 3)</td>
</tr>
<tr class="evenRow">
<td align="left">Token</td>
<td align="left">string</td>
<td align="left">Payment token</td>
</tr>
<tr class="oddRow">
<td align="left">TokenSource</td>
<td align="left">(see below)</td>
<td align="left">Payment token type</td>
</tr>
<tr class="evenRow">
<td align="left">BillingNotes</td>
<td align="left">string</td>
<td align="left">Notes (billing)</td>
</tr>
</tbody>
</table>
<p><strong>Event status codes</strong> are as follows:</p>
<ul>
<li>1 = Provisional</li>
<li>2 = Tentative</li>
<li>3 = Confirmed</li>
<li>4 = Guaranteed</li>
<li>102 = Cancelled</li>
<li>103 = Resident</li>
<li>104 = Checked out</li>
</ul>
<p><strong>Token source</strong> can be one of the following:</p>
<ul>
<li>"Auric"</li>
<li>"Worldpay"</li>
<li>"PayDollar"</li>
<li>"SecureTrading"</li>
<li>"PaymentExpress"</li>
</ul>
cnb_GetEventSoapIn
<cnb_GetEvent xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<eventRef>EVNT00022</eventRef>
</cnb_GetEvent>
cnb_GetEventSoapOut
<cnb_GetEventResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_GetEventResult>
<EventRef>EVNT00022</EventRef>
<ProfileRef />
<CompanyRef />
<AgentRef />
<StartDate>2019-06-01T00:00:00</StartDate>
<EndDate>2019-06-02T23:59:00</EndDate>
<EventStatus>1</EventStatus>
<Delegates>100</Delegates>
<EventName>Indoor caber tossing finals</EventName>
<Coordinator />
<EventType>CON</EventType>
<MarketSegment>CORPORATE</MarketSegment>
<PORef />
<InternalNotes />
<EventNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<TokenSource>Auric</TokenSource>
<BillingNotes />
</cnb_GetEventResult>
</cnb_GetEventResponse>
<p>Provides the ability to cancel an entire event, specifying a reason and notes if required.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">eventRef</td>
<td align="left">string</td>
<td align="left">Event reference</td>
</tr>
<tr class="evenRow">
<td align="left">cancelReason</td>
<td align="left">string</td>
<td align="left">Reason for the cancellation</td>
</tr>
<tr class="oddRow">
<td align="left">cancelNotes</td>
<td align="left">string</td>
<td align="left">Additional notes, if required</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">cnb_CancelEventResult</td>
<td align="left">(see below)</td>
<td align="left">indicates if the process was successful or not</td>
</tr>
</tbody>
</table>
<p><strong>Cancel event result</strong> can be one of the following:</p>
<ul>
<li>"Success"</li>
<li>"EventNotFound"</li>
<li>"CancellationReasonRequired"</li>
</ul>
cnb_CancelEventSoapIn
<cnb_CancelEvent xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<eventRef>EVNT00000022</eventRef>
<cancelReason>zombie apocalypse</cancelReason>
<cancelNotes>(not really)</cancelNotes>
</cnb_CancelEvent>
cnb_CancelEventSoapOut
<cnb_CancelEventResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_CancelEventResult>Success</cnb_CancelEventResult>
</cnb_CancelEventResponse>
<p>Get all cancellation reasons configured for the site.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<ul>
<li>None</li>
</ul>
<h2 class="">Returned data</h2>
<ul>
<li>A set of event cancellation reasons</li>
</ul>
<h2 class="">Returned data (cancellation reason)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">CancellationPenaltiesCode</td>
<td align="left">string</td>
<td align="left">Cancellation code</td>
</tr>
<tr class="evenRow">
<td align="left">Description</td>
<td align="left">string</td>
<td align="left">Cancellation description</td>
</tr>
<tr class="oddRow">
<td align="left">Cancellation</td>
<td align="left">boolean</td>
<td align="left">Cancellation flag</td>
</tr>
<tr class="evenRow">
<td align="left">Lost</td>
<td align="left">boolean</td>
<td align="left">Lost flag</td>
</tr>
<tr class="oddRow">
<td align="left">Reinstate</td>
<td align="left">boolean</td>
<td align="left">Reinstate flag</td>
</tr>
<tr class="evenRow">
<td align="left">Inactive</td>
<td align="left">boolean</td>
<td align="left">Active or inactive flag</td>
</tr>
<tr class="oddRow">
<td align="left">RFlag</td>
<td align="left">int</td>
<td align="left">Flag to indicate if marked as 'deleted'</td>
</tr>
</tbody>
</table>
cnb_GetAllCancellationReasonsSoapIn
<cnb_GetAllCancellationReasons />
cnb_GetAllCancellationReasonsSoapOut
<cnb_GetAllCancellationReasonsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_GetAllCancellationReasonsResult>
<CancellationReasons>
<evtCancellationReason>
<CancellationPenaltiesCode>BER</CancellationPenaltiesCode>
<Description>Bereavement</Description>
<Cancellation>true</Cancellation>
<Lost>false</Lost>
<Reinstate>false</Reinstate>
<Inactive>false</Inactive>
<RFlag>0</RFlag>
</evtCancellationReason>
<evtCancellationReason>
<CancellationPenaltiesCode>COD</CancellationPenaltiesCode>
<Description>Change Of Date</Description>
<Cancellation>true</Cancellation>
<Lost>true</Lost>
<Reinstate>false</Reinstate>
<Inactive>false</Inactive>
<RFlag>0</RFlag>
</evtCancellationReason>
<evtCancellationReason>
<CancellationPenaltiesCode>ERR</CancellationPenaltiesCode>
<Description>User Error</Description>
<Cancellation>true</Cancellation>
<Lost>true</Lost>
<Reinstate>false</Reinstate>
<Inactive>false</Inactive>
<RFlag>0</RFlag>
</evtCancellationReason>
<evtCancellationReason>
<CancellationPenaltiesCode>NOS</CancellationPenaltiesCode>
<Description>Insufficient Numbers</Description>
<Cancellation>true</Cancellation>
<Lost>true</Lost>
<Reinstate>false</Reinstate>
<Inactive>false</Inactive>
<RFlag>0</RFlag>
</evtCancellationReason>
<evtCancellationReason>
<CancellationPenaltiesCode>WEA</CancellationPenaltiesCode>
<Description>Weather</Description>
<Cancellation>true</Cancellation>
<Lost>false</Lost>
<Reinstate>false</Reinstate>
<Inactive>false</Inactive>
<RFlag>0</RFlag>
</evtCancellationReason>
</CancellationReasons>
</cnb_GetAllCancellationReasonsResult>
</cnb_GetAllCancellationReasonsResponse>
<p>Save a new function booking or update an existing function booking.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters (function booking)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">FunctionRef</td>
<td align="left">string</td>
<td align="left">Function reference (if updating an existing function booking)</td>
</tr>
<tr class="evenRow">
<td align="left">EventRef</td>
<td align="left">string</td>
<td align="left">Event reference</td>
</tr>
<tr class="oddRow">
<td align="left">FunctionType</td>
<td align="left">string</td>
<td align="left">Function type</td>
</tr>
<tr class="evenRow">
<td align="left">FunctionName</td>
<td align="left">string</td>
<td align="left">Function name</td>
</tr>
<tr class="oddRow">
<td align="left">FunctionStatus</td>
<td align="left">(see below)</td>
<td align="left">Function status</td>
</tr>
<tr class="evenRow">
<td align="left">StartDate</td>
<td align="left">dateTime</td>
<td align="left">Function start date</td>
</tr>
<tr class="oddRow">
<td align="left">EndDate</td>
<td align="left">dateTime</td>
<td align="left">Function end date</td>
</tr>
<tr class="evenRow">
<td align="left">Delegates</td>
<td align="left">int</td>
<td align="left">Number of delegates</td>
</tr>
<tr class="oddRow">
<td align="left">FunctionRoom</td>
<td align="left">string</td>
<td align="left">Function room reference</td>
</tr>
<tr class="evenRow">
<td align="left">FunctionLayout</td>
<td align="left">string</td>
<td align="left">Function layout</td>
</tr>
<tr class="oddRow">
<td align="left">FunctionRate</td>
<td align="left">string</td>
<td align="left">Function rate</td>
</tr>
<tr class="evenRow">
<td align="left">FunctionNotes</td>
<td align="left">string</td>
<td align="left">Any applicable notes</td>
</tr>
<tr class="oddRow">
<td align="left">FunRoomLayoutsForFunRoomID</td>
<td align="left">(object)</td>
<td align="left">Details of function room layouts</td>
</tr>
<tr class="evenRow">
<td align="left">> FunctionRoomLayoutsForFunRoomDTO</td>
<td align="left">(object)</td>
<td align="left">Detail of function room layout</td>
</tr>
<tr class="oddRow">
<td align="left">>> FunctionRoomLayoutId</td>
<td align="left">int</td>
<td align="left">Layout reference</td>
</tr>
<tr class="evenRow">
<td align="left">>> LayoutCode</td>
<td align="left">string</td>
<td align="left">Layout code</td>
</tr>
<tr class="oddRow">
<td align="left">>> FunctionRoomId</td>
<td align="left">int</td>
<td align="left">Function room reference</td>
</tr>
<tr class="evenRow">
<td align="left">>> MinCapacity</td>
<td align="left">int</td>
<td align="left">Minimum capacity</td>
</tr>
<tr class="oddRow">
<td align="left">>> MaxCapacity</td>
<td align="left">int</td>
<td align="left">Maximum capacity</td>
</tr>
<tr class="evenRow">
<td align="left">>> SetupTime</td>
<td align="left">int</td>
<td align="left">Set-up time</td>
</tr>
<tr class="oddRow">
<td align="left">>> BreakdownTime</td>
<td align="left">int</td>
<td align="left">Break-down time</td>
</tr>
<tr class="evenRow">
<td align="left">>> PictureId</td>
<td align="left">int</td>
<td align="left">Image reference</td>
</tr>
<tr class="oddRow">
<td align="left">>> LayoutDescription</td>
<td align="left">string</td>
<td align="left">Layout description</td>
</tr>
<tr class="evenRow">
<td align="left">>> DefaultLayout</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if this is the default layout</td>
</tr>
</tbody>
</table>
<p><strong>Function status</strong> can be one of the following:</p>
<ul>
<li>"ude_UserDefined1"</li>
<li>"ude_UserDefined2"</li>
<li>"ude_UserDefined3"</li>
<li>"ude_UserDefined4"</li>
<li>"ude_UserDefined5"</li>
<li>"ude_UserDefined6"</li>
<li>"ude_UserDefined7"</li>
<li>"ude_UserDefined9"</li>
<li>"ude_UserDefined10"</li>
<li>"ude_UserDefined11"</li>
<li>"ude_UserDefined12"</li>
<li>"ude_WaitList"</li>
<li>"ude_Cancelled"</li>
<li>"ude_Resident"</li>
<li>"ude_CheckedOut"</li>
<li>"ude_NoShow"</li>
</ul>
<h2 class="">Returned data</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">FunctionRef</td>
<td align="left">string</td>
<td align="left">Function reference for this function booking</td>
</tr>
</tbody>
</table>
cnb_SaveFunctionBookingSoapIn
<cnb_SaveFunctionBooking xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<funBooking>
<FunctionRef />
<EventRef>EVNT00027</EventRef>
<FunctionType>WEBF</FunctionType>
<FunctionName>Wedding breakfast</FunctionName>
<FunctionStatus>ude_UserDefined3</FunctionStatus>
<StartDate>2019-06-01T14:00:00</StartDate>
<EndDate>2019-06-01T17:00:00</EndDate>
<Delegates>100</Delegates>
<FunctionRoom>Ballroom</FunctionRoom>
<FunctionRate>ROOM_HIRE</FunctionRate>
<FunctionNotes>VIP wedding</FunctionNotes>
</funBooking>
</cnb_SaveFunctionBooking>
cnb_SaveFunctionBookingSoapOut
<cnb_SaveFunctionBookingResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_SaveFunctionBookingResult>
<FunctionRef>BK00000044</FunctionRef>
</cnb_SaveFunctionBookingResult>
</cnb_SaveFunctionBookingResponse>
<p>Get all the available layouts for a given function room.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">roomID</td>
<td align="left">string</td>
<td align="left">Function room reference (room name or number)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>Set of function room layouts</li>
</ul>
<h2 class="">Returned data (function room layout)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="evenRow">
<td align="left">FunctionRoomLayoutId</td>
<td align="left">int</td>
<td align="left">Layout ID</td>
</tr>
<tr class="oddRow">
<td align="left">LayoutCode</td>
<td align="left">string</td>
<td align="left">Layout code</td>
</tr>
<tr class="evenRow">
<td align="left">FunctionRoomId</td>
<td align="left">int</td>
<td align="left">Function room ID</td>
</tr>
<tr class="oddRow">
<td align="left">MinCapacity</td>
<td align="left">int</td>
<td align="left">Minimum room capacity with this layout</td>
</tr>
<tr class="evenRow">
<td align="left">MaxCapacity</td>
<td align="left">int</td>
<td align="left">Maximum room capacity with this layout</td>
</tr>
<tr class="oddRow">
<td align="left">SetupTime</td>
<td align="left">int</td>
<td align="left">Layout set-up time</td>
</tr>
<tr class="evenRow">
<td align="left">BreakdownTime</td>
<td align="left">int</td>
<td align="left">Layout breakdown time</td>
</tr>
<tr class="oddRow">
<td align="left">PictureId</td>
<td align="left">int</td>
<td align="left">Picture ID, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">LayoutDescription</td>
<td align="left">string</td>
<td align="left">Layout description</td>
</tr>
<tr class="oddRow">
<td align="left">DefaultLayout</td>
<td align="left">Boolean</td>
<td align="left">Is this the default layout?</td>
</tr>
</tbody>
</table>
cnb_GetFunRoomLayoutsForFunRoomIDSoapIn
<cnb_GetFunRoomLayoutsForFunRoomID xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<roomID>1004</roomID>
</cnb_GetFunRoomLayoutsForFunRoomID>
cnb_GetFunRoomLayoutsForFunRoomIDSoapOut
<cnb_GetFunRoomLayoutsForFunRoomIDResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_GetFunRoomLayoutsForFunRoomIDResult>
<FunctionLayouts>
<FunctionRoomLayoutsForFunRoomDTO>
<FunctionRoomLayoutId>3</FunctionRoomLayoutId>
<LayoutCode>CABERET</LayoutCode>
<FunctionRoomId>4</FunctionRoomId>
<MinCapacity>50</MinCapacity>
<MaxCapacity>200</MaxCapacity>
<SetupTime>60</SetupTime>
<BreakdownTime>60</BreakdownTime>
<PictureId>0</PictureId>
<LayoutDescription>Caberet</LayoutDescription>
<DefaultLayout>true</DefaultLayout>
</FunctionRoomLayoutsForFunRoomDTO>
</FunctionLayouts>
</cnb_GetFunRoomLayoutsForFunRoomIDResult>
</cnb_GetFunRoomLayoutsForFunRoomIDResponse>
<p>Fetch all the details about a specific function booking.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">bookRef</td>
<td align="left">string</td>
<td align="left">Function booking reference</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">FunctionRef</td>
<td align="left">string</td>
<td align="left">Function booking reference</td>
</tr>
<tr class="evenRow">
<td align="left">EventRef</td>
<td align="left">string</td>
<td align="left">Event reference</td>
</tr>
<tr class="oddRow">
<td align="left">FunctionType</td>
<td align="left">string</td>
<td align="left">Function type</td>
</tr>
<tr class="evenRow">
<td align="left">FunctionName</td>
<td align="left">string</td>
<td align="left">Function name</td>
</tr>
<tr class="oddRow">
<td align="left">FunctionStatus</td>
<td align="left">string</td>
<td align="left">Function status (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">StartDate</td>
<td align="left">dateTime</td>
<td align="left">Function start date-time</td>
</tr>
<tr class="oddRow">
<td align="left">EndDate</td>
<td align="left">dateTime</td>
<td align="left">Function end date-time</td>
</tr>
<tr class="evenRow">
<td align="left">Delegates</td>
<td align="left">int</td>
<td align="left">Number of delegates</td>
</tr>
<tr class="oddRow">
<td align="left">FunctionRoom</td>
<td align="left">string</td>
<td align="left">Function room reference</td>
</tr>
<tr class="evenRow">
<td align="left">FunctionLayout</td>
<td align="left">string</td>
<td align="left">Function layout code</td>
</tr>
<tr class="oddRow">
<td align="left">FunctionRate</td>
<td align="left">string</td>
<td align="left">Function rate</td>
</tr>
<tr class="evenRow">
<td align="left">FunctionNotes</td>
<td align="left">string</td>
<td align="left">Applicable notes</td>
</tr>
<tr class="oddRow">
<td align="left">FunRoomLayoutsForFunRoomID</td>
<td align="left">(object)</td>
<td align="left">Function room layouts, if applicable</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data (function room layout)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="evenRow">
<td align="left">FunctionRoomLayoutId</td>
<td align="left">int</td>
<td align="left">Layout ID</td>
</tr>
<tr class="oddRow">
<td align="left">LayoutCode</td>
<td align="left">string</td>
<td align="left">Layout code</td>
</tr>
<tr class="evenRow">
<td align="left">FunctionRoomId</td>
<td align="left">int</td>
<td align="left">Function room ID</td>
</tr>
<tr class="oddRow">
<td align="left">MinCapacity</td>
<td align="left">int</td>
<td align="left">Minimum room capacity with this layout</td>
</tr>
<tr class="evenRow">
<td align="left">MaxCapacity</td>
<td align="left">int</td>
<td align="left">Maximum room capacity with this layout</td>
</tr>
<tr class="oddRow">
<td align="left">SetupTime</td>
<td align="left">int</td>
<td align="left">Layout set-up time</td>
</tr>
<tr class="evenRow">
<td align="left">BreakdownTime</td>
<td align="left">int</td>
<td align="left">Layout breakdown time</td>
</tr>
<tr class="oddRow">
<td align="left">PictureId</td>
<td align="left">int</td>
<td align="left">Picture ID, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">LayoutDescription</td>
<td align="left">string</td>
<td align="left">Layout description</td>
</tr>
<tr class="oddRow">
<td align="left">DefaultLayout</td>
<td align="left">Boolean</td>
<td align="left">Is this the default layout?</td>
</tr>
</tbody>
</table>
<p><strong>Function status</strong> is one of the following:</p>
<ul>
<li>"ude_UserDefined1"</li>
<li>"ude_UserDefined2"</li>
<li>"ude_UserDefined3"</li>
<li>"ude_UserDefined4"</li>
<li>"ude_UserDefined5"</li>
<li>"ude_UserDefined6"</li>
<li>"ude_UserDefined7"</li>
<li>"ude_UserDefined8"</li>
<li>"ude_UserDefined9"</li>
<li>"ude_UserDefined10"</li>
<li>"ude_UserDefined11"</li>
<li>"ude_UserDefined12"</li>
<li>"ude_WaitList"</li>
<li>"ude_Cancelled"</li>
<li>"ude_Resident"</li>
<li>"ude_CheckedOut"</li>
<li>"ude_NoShow"</li>
</ul>
cnb_GetFunctionBookingSoapIn
<cnb_GetFunctionBooking xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK00000043</bookRef>
</cnb_GetFunctionBooking>
cnb_GetFunctionBookingSoapOut
<cnb_GetFunctionBookingResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_GetFunctionBookingResult>
<FunctionRef>BK00000043</FunctionRef>
<EventRef>EVNT00022</EventRef>
<FunctionType>FDM</FunctionType>
<FunctionName>Full Day Meeting</FunctionName>
<FunctionStatus>ude_UserDefined1</FunctionStatus>
<StartDate>2019-06-01T09:00:00</StartDate>
<EndDate>2019-06-01T17:00:00</EndDate>
<Delegates>100</Delegates>
<FunctionRoom>1004</FunctionRoom>
<FunctionLayout>CABERET</FunctionLayout>
<FunctionRate>ROOM_HIRE</FunctionRate>
<FunctionNotes />
<FunRoomLayoutsForFunRoomID>
<FunctionRoomLayoutsForFunRoomDTO>
<FunctionRoomLayoutId>3</FunctionRoomLayoutId>
<LayoutCode>CABERET</LayoutCode>
<FunctionRoomId>4</FunctionRoomId>
<MinCapacity>50</MinCapacity>
<MaxCapacity>200</MaxCapacity>
<SetupTime>60</SetupTime>
<BreakdownTime>60</BreakdownTime>
<PictureId>0</PictureId>
<LayoutDescription>Caberet</LayoutDescription>
<DefaultLayout>true</DefaultLayout>
</FunctionRoomLayoutsForFunRoomDTO>
</FunRoomLayoutsForFunRoomID>
</cnb_GetFunctionBookingResult>
</cnb_GetFunctionBookingResponse>
<p>Cancels a function booking which is part of an event.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">eventRef</td>
<td align="left">string</td>
<td align="left">Event reference</td>
</tr>
<tr class="evenRow">
<td align="left">bookRef</td>
<td align="left">string</td>
<td align="left">Function booking reference</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">cnb_CancelFunctionBookingResult</td>
<td align="left">(see below)</td>
<td align="left">indicates if the process was successful or not</td>
</tr>
</tbody>
</table>
<p><strong>Function booking result </strong> can be one of the following:</p>
<ul>
<li>"Success"</li>
<li>"HasDeposit"</li>
<li>"NotValidForCancel"</li>
<li>"BookingNotFound"</li>
<li>"AlreadyCancelled</li>
</ul>
cnb_CancelFunctionBookingSoapIn
<cnb_CancelFunctionBooking xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<eventRef>EVNT00022</eventRef>
<bookRef>BK00000043</bookRef>
</cnb_CancelFunctionBooking>
cnb_CancelFunctionBookingSoapOut
<cnb_CancelFunctionBookingResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_CancelFunctionBookingResult>Success</cnb_CancelFunctionBookingResult>
</cnb_CancelFunctionBookingResponse>
<p>This method provides the ability to save or update information about an event delegate.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">FunctionRef</td>
<td align="left">string</td>
<td align="left">Function reference (required)</td>
</tr>
<tr class="evenRow">
<td align="left">RoomPickID</td>
<td align="left">int</td>
<td align="left">Multi-room reference (1,2,3,...)</td>
</tr>
<tr class="oddRow">
<td align="left">FolioID</td>
<td align="left">int</td>
<td align="left">Delegate folio reference (1,2,3,...)</td>
</tr>
<tr class="evenRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Delegate surname (party representative)</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileRef</td>
<td align="left">string</td>
<td align="left">Profile reference, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference, if applicable</td>
</tr>
<tr class="oddRow">
<td align="left">NoOfGuests</td>
<td align="left">int</td>
<td align="left">Number of guests in party</td>
</tr>
<tr class="evenRow">
<td align="left">Table</td>
<td align="left">string</td>
<td align="left">Table name, if applicable</td>
</tr>
<tr class="oddRow">
<td align="left">TableTime</td>
<td align="left">string</td>
<td align="left">Table time</td>
</tr>
<tr class="evenRow">
<td align="left">Token</td>
<td align="left">string</td>
<td align="left">Token</td>
</tr>
<tr class="oddRow">
<td align="left">TokenSource</td>
<td align="left">(see below)</td>
<td align="left">Payment token source</td>
</tr>
<tr class="evenRow">
<td align="left">Notes</td>
<td align="left">string</td>
<td align="left">Optional notes</td>
</tr>
<tr class="oddRow">
<td align="left">DepositPayType</td>
<td align="left">string</td>
<td align="left">Deposit pay type</td>
</tr>
<tr class="evenRow">
<td align="left">DepositAmount</td>
<td align="left">decimal</td>
<td align="left">Deposit amount</td>
</tr>
<tr class="oddRow">
<td align="left">DepositComments</td>
<td align="left">string</td>
<td align="left">Deposit comments</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>'Success' only</li>
</ul>
<p><strong>Token source</strong> can be one of the following:</p>
<ul>
<li>"Auric"</li>
<li>"Worldpay"</li>
<li>"PayDollar"</li>
<li>"SecureTrading"</li>
<li>"PaymentExpress"</li>
</ul>
cnb_SaveDelegateSoapIn
<cnb_SaveDelegate xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnbDelegate>
<FunctionRef>BK00000016</FunctionRef>
<RoomPickID xsi:nil="true" />
<FolioID xsi:nil="true" />
<Surname>Hart</Surname>
<ProfileRef />
<CompanyRef />
<NoOfGuests>1</NoOfGuests>
<Table />
<TableTime>12:51:21</TableTime>
<TokenSource xsi:nil="true" />
<Notes />
<DepositAmount xsi:nil="true" />
</cnbDelegate>
</cnb_SaveDelegate>
cnb_SaveDelegateSoapOut
<cnb_SaveDelegateResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_SaveDelegateResult>Success</cnb_SaveDelegateResult>
</cnb_SaveDelegateResponse>
<p>Get all the details about a given delegate.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">FunctionRef</td>
<td align="left">string</td>
<td align="left">Function reference (required)</td>
</tr>
<tr class="evenRow">
<td align="left">RoomPickID</td>
<td align="left">int</td>
<td align="left">Multi-room reference (required)</td>
</tr>
<tr class="oddRow">
<td align="left">FolioID</td>
<td align="left">int</td>
<td align="left">Delegate folio reference (required)</td>
</tr>
<tr class="evenRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Delegate surname</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileRef</td>
<td align="left">string</td>
<td align="left">Delegate profile reference</td>
</tr>
<tr class="evenRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference</td>
</tr>
<tr class="oddRow">
<td align="left">NoOfGuests</td>
<td align="left">int</td>
<td align="left">Number of guests</td>
</tr>
<tr class="evenRow">
<td align="left">Table</td>
<td align="left">string</td>
<td align="left">Table name or number</td>
</tr>
<tr class="oddRow">
<td align="left">TableTime</td>
<td align="left">string</td>
<td align="left">Table reservation time</td>
</tr>
<tr class="evenRow">
<td align="left">Token</td>
<td align="left">string</td>
<td align="left">Payment token</td>
</tr>
<tr class="oddRow">
<td align="left">TokenSource</td>
<td align="left">(see below)</td>
<td align="left">Payment token source</td>
</tr>
<tr class="evenRow">
<td align="left">Notes</td>
<td align="left">string</td>
<td align="left">Custom notes</td>
</tr>
<tr class="oddRow">
<td align="left">DepositPayType</td>
<td align="left">string</td>
<td align="left">Payment type</td>
</tr>
<tr class="evenRow">
<td align="left">DepositAmount</td>
<td align="left">decimal</td>
<td align="left">Amount</td>
</tr>
<tr class="oddRow">
<td align="left">DepositComments</td>
<td align="left">string</td>
<td align="left">Comments</td>
</tr>
</tbody>
</table>
<p><strong>Note</strong> only the function reference, multi-room reference and delegate reference need to be supplied.</p>
<h2 class="">Returned data</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">FunctionRef</td>
<td align="left">string</td>
<td align="left">Function reference</td>
</tr>
<tr class="evenRow">
<td align="left">RoomPickID</td>
<td align="left">int</td>
<td align="left">Multi-room reference</td>
</tr>
<tr class="oddRow">
<td align="left">FolioID</td>
<td align="left">int</td>
<td align="left">Delegate folio reference</td>
</tr>
<tr class="evenRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Delegate surname</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileRef</td>
<td align="left">string</td>
<td align="left">Delegate profile reference</td>
</tr>
<tr class="evenRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference</td>
</tr>
<tr class="oddRow">
<td align="left">NoOfGuests</td>
<td align="left">int</td>
<td align="left">Number of guests</td>
</tr>
<tr class="evenRow">
<td align="left">Table</td>
<td align="left">string</td>
<td align="left">Table name or number</td>
</tr>
<tr class="oddRow">
<td align="left">TableTime</td>
<td align="left">string</td>
<td align="left">Table reservation time</td>
</tr>
<tr class="evenRow">
<td align="left">Token</td>
<td align="left">string</td>
<td align="left">Payment token</td>
</tr>
<tr class="oddRow">
<td align="left">TokenSource</td>
<td align="left">(see below)</td>
<td align="left">Payment token source</td>
</tr>
<tr class="evenRow">
<td align="left">Notes</td>
<td align="left">string</td>
<td align="left">Custom notes</td>
</tr>
<tr class="oddRow">
<td align="left">DepositPayType</td>
<td align="left">string</td>
<td align="left">Payment type</td>
</tr>
<tr class="evenRow">
<td align="left">DepositAmount</td>
<td align="left">decimal</td>
<td align="left">Amount</td>
</tr>
<tr class="oddRow">
<td align="left">DepositComments</td>
<td align="left">string</td>
<td align="left">Comments</td>
</tr>
</tbody>
</table>
<p><strong>Token source</strong> can be one of the following:</p>
<ul>
<li>"Auric"</li>
<li>"Worldpay"</li>
<li>"PayDollar"</li>
<li>"SecureTrading"</li>
<li>"PaymentExpress"</li>
</ul>
cnb_GetDelegateSoapIn
<cnb_GetDelegate xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnbDelegate>
<FunctionRef>BK00000016</FunctionRef>
<RoomPickID>1</RoomPickID>
<FolioID>2</FolioID>
<NoOfGuests xsi:nil="true" />
<TokenSource xsi:nil="true" />
<DepositAmount xsi:nil="true" />
</cnbDelegate>
</cnb_GetDelegate>
cnb_GetDelegateSoapOut
<cnb_GetDelegateResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_GetDelegateResult>
<FunctionRef>BK00000016</FunctionRef>
<RoomPickID>1</RoomPickID>
<FolioID>2</FolioID>
<Surname>Jenks</Surname>
<ProfileRef>PF00000002</ProfileRef>
<CompanyRef />
<NoOfGuests>1</NoOfGuests>
<Table />
<TableTime>15:00:00</TableTime>
<TokenSource xsi:nil="true" />
<Notes />
<DepositAmount xsi:nil="true" />
</cnb_GetDelegateResult>
</cnb_GetDelegateResponse>
<p>Used to remove a delegate from a function booking.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">FunctionRef</td>
<td align="left">string</td>
<td align="left">Function reference (required)</td>
</tr>
<tr class="evenRow">
<td align="left">RoomPickID</td>
<td align="left">int</td>
<td align="left">Multi-room reference (required)</td>
</tr>
<tr class="oddRow">
<td align="left">FolioID</td>
<td align="left">int</td>
<td align="left">Delegate folio reference (required)</td>
</tr>
<tr class="evenRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Delegate surname (party representative)</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileRef</td>
<td align="left">string</td>
<td align="left">Delegate profile reference, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference</td>
</tr>
<tr class="oddRow">
<td align="left">NoOfGuests</td>
<td align="left">int</td>
<td align="left">Number of guests</td>
</tr>
<tr class="evenRow">
<td align="left">Table</td>
<td align="left">string</td>
<td align="left">Table name or number</td>
</tr>
<tr class="oddRow">
<td align="left">TableTime</td>
<td align="left">string</td>
<td align="left">Table reservation time</td>
</tr>
<tr class="evenRow">
<td align="left">Token</td>
<td align="left">string</td>
<td align="left">Payment token</td>
</tr>
<tr class="oddRow">
<td align="left">TokenSource</td>
<td align="left">(see below)</td>
<td align="left">Payment token source</td>
</tr>
<tr class="evenRow">
<td align="left">Notes</td>
<td align="left">string</td>
<td align="left">Custom notes</td>
</tr>
<tr class="oddRow">
<td align="left">DepositPayType</td>
<td align="left">string</td>
<td align="left">Payment type</td>
</tr>
<tr class="evenRow">
<td align="left">DepositAmount</td>
<td align="left">decimal</td>
<td align="left">Amount</td>
</tr>
<tr class="oddRow">
<td align="left">DepositComments</td>
<td align="left">string</td>
<td align="left">Comments</td>
</tr>
</tbody>
</table>
<p><strong>Note</strong> only the function reference, multi-room reference and delegate reference need to be supplied.</p>
<h2 class="">Returned data</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">cnb_CancelDelegateResult</td>
<td align="left">(see below)</td>
<td align="left">indicates if the process was successful or not</td>
</tr>
</tbody>
</table>
<p><strong>Cancel delegate result</strong> can be one of the following:</p>
<ul>
<li>"Success"</li>
<li>"DelegateNotFound"</li>
<li>"HasDeposits"</li>
<li>"CancelFailed"</li>
</ul>
cnb_CancelDelegateSoapIn
<cnb_CancelDelegate xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnbDelegate>
<FunctionRef>BK00000016</FunctionRef>
<RoomPickID>1</RoomPickID>
<FolioID>3</FolioID>
<NoOfGuests xsi:nil="true" />
<TokenSource xsi:nil="true" />
<DepositAmount xsi:nil="true" />
</cnbDelegate>
</cnb_CancelDelegate>
cnb_CancelDelegateSoapOut
<cnb_CancelDelegateResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cnb_CancelDelegateResult>Success</cnb_CancelDelegateResult>
</cnb_CancelDelegateResponse>
<p>This method retrieves a guest profile.</p><table><tbody><tr class="evenRow"><td align="left"><strong>Profile requestor authentication</strong> Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them.</td></tr></tbody></table><h4>Parameters</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">ProfileRequestor</td><td align="left">(object)</td><td align="center"></td></tr><tr class="oddRow"><td align="left">> ProfileUniqueId</td><td align="left">string</td><td align="left">Unique profile ID, must be either a profile reference, unique email address or loyalty ID</td></tr><tr class="evenRow"><td align="left">> ProfileUniqueIdAuthenticatorValue</td><td align="left">string</td><td align="left">The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below</td></tr><tr class="oddRow"><td align="left">> AuthenticationMethod</td><td align="left">"PD"</td><td align="left">"PD" stands for "Person Details" and should always be set to this</td></tr><tr class="evenRow"><td align="left">> AuthenticationCode</td><td align="left">string</td><td align="left">The method of second line authentication to be used i.e. "Forename", "Surname" or "PostCode"</td></tr><tr class="oddRow"><td align="left">> AuthenticationValue</td><td align="left">string</td><td align="left">The authentication value, e.g. if the method is "Surname" and the profile is under the name of "Jones" then the value will be "Jones", if the method is "PostCode" then the value will be "SY26LG"</td></tr><tr class="evenRow"><td align="left">Filters</td><td align="left">"Checked Out", "Resident" or "Future"</td><td align="left">Optional filter to filter results according to the reservation status</td></tr><tr class="oddRow"><td align="left">ProfileSearchMode</td><td align="left">"Contact", "Guest" or "Both"</td><td align="left">Used to indicate whether searching for a reservation contact, reservation guest or both</td></tr></tbody></table><h4>Returned data (profile)</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">ProfileRef</td><td align="left">string</td><td align="left">Profile reference</td></tr><tr class="evenRow"><td align="left">Salutation</td><td align="left">string</td><td align="left">Title</td></tr><tr class="oddRow"><td align="left">Forename</td><td align="left">string</td><td align="left">Forename</td></tr><tr class="evenRow"><td align="left">Surname</td><td align="left">string</td><td align="left">Surname</td></tr><tr class="oddRow"><td align="left">EMailAddress</td><td align="left">string</td><td align="left">E-mail address</td></tr><tr class="evenRow"><td align="left">Gender</td><td align="left">string</td><td align="left">Gender</td></tr><tr class="oddRow"><td align="left">Street</td><td align="left">string</td><td align="left">Address street</td></tr><tr class="evenRow"><td align="left">Area</td><td align="left">string</td><td align="left">Address area</td></tr><tr class="oddRow"><td align="left">Town</td><td align="left">string</td><td align="left">Address town or city</td></tr><tr class="evenRow"><td align="left">County</td><td align="left">string</td><td align="left">Address county or state</td></tr><tr class="oddRow"><td align="left">PostCode</td><td align="left">string</td><td align="left">Address postcode or zip code</td></tr><tr class="evenRow"><td align="left">Country</td><td align="left">string</td><td align="left">Address country</td></tr><tr class="oddRow"><td align="left">TelephoneNo</td><td align="left">string</td><td align="left">Telephone number</td></tr><tr class="evenRow"><td align="left">FaxNo</td><td align="left">string</td><td align="left">Fax number</td></tr><tr class="oddRow"><td align="left">MobileNo</td><td align="left">string</td><td align="left">Mobile telephone number</td></tr><tr class="evenRow"><td align="left">Nationality</td><td align="left">string</td><td align="left">Nationality</td></tr><tr class="oddRow"><td align="left">Language</td><td align="left">string</td><td align="left">Language</td></tr><tr class="evenRow"><td align="left">CompanyRef</td><td align="left">string</td><td align="left">Company reference, if applicable</td></tr><tr class="oddRow"><td align="left">Vip</td><td align="left">int</td><td align="left">Integer VIP level (e.g. 1,2,3...)</td></tr><tr class="evenRow"><td align="left">DateOfBirth</td><td align="left">dateTime</td><td align="left">Date of birth</td></tr><tr class="oddRow"><td align="left">StudentID</td><td align="left">string</td><td align="left">Student ID, if applicable</td></tr><tr class="evenRow"><td align="left">TypeOfPerson</td><td align="left">"Adult", "Child" or "Infant"</td><td align="left">Adult status</td></tr><tr class="oddRow"><td align="left">PassportNumber</td><td align="left">string</td><td align="left">Passport number</td></tr><tr class="evenRow"><td align="left">PreferredRoomType</td><td align="left">string</td><td align="left">Preferred room type</td></tr><tr class="oddRow"><td align="left">MarketingOptIn</td><td align="left">int</td><td align="left">Opt-in to receive marketing information</td></tr><tr class="evenRow"><td align="left">Smoker</td><td align="left">int</td><td align="left">Smoker or not</td></tr><tr class="oddRow"><td align="left">BlackListed</td><td align="left">int</td><td align="left">Blacklisted or not</td></tr><tr class="evenRow"><td align="left">LoyaltyID</td><td align="left">string</td><td align="left">Loyalty ID</td></tr><tr class="oddRow"><td align="left">ProfileType</td><td align="left">"Private", "Agents", "Corporate", "TourGroup" or "TourSeries"</td><td align="left">Profile type</td></tr><tr class="evenRow"><td align="left">ExcludeFromThirdPartyMailings</td><td align="left">Boolean</td><td align="left">Indicates if person chose to be excluded from third-party mailings</td></tr><tr class="oddRow"><td align="left">Suffix</td><td align="left">string</td><td align="left">Name suffix</td></tr><tr class="evenRow"><td align="left">MiddleName</td><td align="left">string</td><td align="left">Middle name</td></tr><tr class="oddRow"><td align="left">AddressLine1</td><td align="left">string</td><td align="left">Address line 1</td></tr><tr class="evenRow"><td align="left">AddressLine2</td><td align="left">string</td><td align="left">Address line 2</td></tr><tr class="oddRow"><td align="left">State</td><td align="left">string</td><td align="left">Address state</td></tr><tr class="evenRow"><td align="left">PublicNotes</td><td align="left">string</td><td align="left">Notes (public)</td></tr><tr class="oddRow"><td align="left">PrivateNotes</td><td align="left">string</td><td align="left">Notes (private)</td></tr><tr class="evenRow"><td align="left">CustomNotes1</td><td align="left">string</td><td align="left">Notes (custom 1)</td></tr><tr class="oddRow"><td align="left">CustomNotes2</td><td align="left">string</td><td align="left">Notes (custom 2)</td></tr><tr class="evenRow"><td align="left">CustomNotes3</td><td align="left">string</td><td align="left">Notes (custom 3)</td></tr></tbody></table>
pmsprf_GetProfileSummaryV2SoapIn
<pmsprf_GetProfileSummaryV2 xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionId>a6a70a2d-1ac0-4da0-815a-98cd825a822e</SessionId>
<ProfileRequestor>
<ProfileUniqueId>PF000024</ProfileUniqueId>
<ProfileUniqueIdAuthenticatorValue />
<AuthenticationMethod>PD</AuthenticationMethod>
<AuthenticationCode>Surname</AuthenticationCode>
<AuthenticationValue>Valli</AuthenticationValue>
</ProfileRequestor>
</pmsprf_GetProfileSummaryV2>
pmsprf_GetProfileSummaryV2SoapOut
<pmsprf_GetProfileSummaryV2Response xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_GetProfileSummaryV2Result>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprf_GetProfileSummaryV2Result>
<Profile>
<ProfileRef>PF000024</ProfileRef>
<Salutation>Mr</Salutation>
<Forename>Zen</Forename>
<Surname>Valli</Surname>
<EMailAddress>zunaid.valli@guestline.com</EMailAddress>
<Gender>U</Gender>
<Street>Guestline House Shrewsbury Business Park</Street>
<Area>Sitka Drive</Area>
<Town>Shrewsbury</Town>
<County>Shropshire</County>
<PostCode>SY2 6LG</PostCode>
<Country>United Kingdom</Country>
<TelephoneNo>0123456789</TelephoneNo>
<FaxNo />
<MobileNo />
<Nationality>British</Nationality>
<Language>English</Language>
<CompanyRef />
<Vip>0</Vip>
<DateOfBirth>1754-01-01T00:00:00</DateOfBirth>
<StudentID />
<TypeOfPerson>Adult</TypeOfPerson>
<PassportNumber />
<PreferredRoomType />
<MarketingOptIn>0</MarketingOptIn>
<Smoker>0</Smoker>
<BlackListed>0</BlackListed>
<LoyaltyID />
<ProfileType>Private</ProfileType>
<ExcludeFromThirdPartyMailings>true</ExcludeFromThirdPartyMailings>
<Suffix />
<MiddleName />
<AddressLine1 />
<AddressLine2 />
<State />
<PublicNotes />
<PrivateNotes />
<CustomNotes1>Gluten</CustomNotes1>
<CustomNotes2>No Duvet</CustomNotes2>
<CustomNotes3 />
</Profile>
</pmsprf_GetProfileSummaryV2Response>
pmsprf_UpdateProfileSummaryV2
pmsprf_UpdateProfileSummaryV2SoapIn
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<pmsprf_UpdateProfileSummaryV2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionId>SessionId1</SessionId>
<ProfileRequestor>
<ProfileUniqueId>ProfileUniqueId1</ProfileUniqueId>
<ProfileUniqueIdAuthenticatorValue>ProfileUniqueIdAuthenticatorValue1</ProfileUniqueIdAuthenticatorValue>
<AuthenticationMethod>AuthenticationMethod1</AuthenticationMethod>
<AuthenticationCode>AuthenticationCode1</AuthenticationCode>
<AuthenticationValue>AuthenticationValue1</AuthenticationValue>
</ProfileRequestor>
<StreetAddress>StreetAddress1</StreetAddress>
<AreaAddress>AreaAddress1</AreaAddress>
<Town>Town1</Town>
<County>County1</County>
<Country>Country1</Country>
<Postcode>Postcode1</Postcode>
<TelNumber>TelNumber1</TelNumber>
<FaxNumber>FaxNumber1</FaxNumber>
<MobileNo>MobileNo1</MobileNo>
<Email>Email1</Email>
<MarketingOptIn>1</MarketingOptIn>
<Password>Password1</Password>
<CompanyRef>CompanyRef1</CompanyRef>
<Salutation>Salutation1</Salutation>
<Forename>Forename1</Forename>
<Surname>Surname1</Surname>
<Greeting>Greeting1</Greeting>
<VIP>1</VIP>
<Blacklisted>1</Blacklisted>
<TypeOfPerson>1</TypeOfPerson>
<Nationality>Nationality1</Nationality>
<Language>Language1</Language>
<DOB>1900-01-01T01:01:01</DOB>
<Smoker>1</Smoker>
<ProfileType>1</ProfileType>
<LoyaltyID>LoyaltyID1</LoyaltyID>
<StudentID>StudentID1</StudentID>
<Gender>Gender1</Gender>
<PassportNumber>PassportNumber1</PassportNumber>
<PreferredRoomType>PreferredRoomType1</PreferredRoomType>
<ExcludeFromThirdPartyMailings>true</ExcludeFromThirdPartyMailings>
<PublicNotes>PublicNotes1</PublicNotes>
<PrivateNotes>PrivateNotes1</PrivateNotes>
<CustomNotes1>CustomNotes11</CustomNotes1>
<CustomNotes2>CustomNotes21</CustomNotes2>
<CustomNotes3>CustomNotes31</CustomNotes3>
</pmsprf_UpdateProfileSummaryV2>
</Body>
</Envelope>
pmsprf_UpdateProfileSummaryV2SoapOut
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<pmsprf_UpdateProfileSummaryV2Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_UpdateProfileSummaryV2Result>
<ExceptionCode>1</ExceptionCode>
<ExceptionDescription>ExceptionDescription1</ExceptionDescription>
</pmsprf_UpdateProfileSummaryV2Result>
</pmsprf_UpdateProfileSummaryV2Response>
</Body>
</Envelope>
<p>Create a new Company Account / Company Profile.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionId</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">CompanyRef</td><td align="left">string</td><td align="left">Company account reference (leave blank)</td></tr><tr class="oddRow"><td align="left">CompanyType</td><td align="left">"Agent", "Corporate", "TourGroup" or "TourSeries"</td><td align="left">Company type</td></tr><tr class="evenRow"><td align="left">MarketSegment</td><td align="left">string</td><td align="left">Market segment</td></tr><tr class="oddRow"><td align="left">Name</td><td align="left">string</td><td align="left">Company name</td></tr><tr class="evenRow"><td align="left">Address1</td><td align="left">string</td><td align="left">Company address line 1</td></tr><tr class="oddRow"><td align="left">Area</td><td align="left">string</td><td align="left">Company address area</td></tr><tr class="evenRow"><td align="left">Town</td><td align="left">string</td><td align="left">Company address town or city</td></tr><tr class="oddRow"><td align="left">County</td><td align="left">string</td><td align="left">Company address county or state</td></tr><tr class="evenRow"><td align="left">Country</td><td align="left">string</td><td align="left">Company address country</td></tr><tr class="oddRow"><td align="left">PostCode</td><td align="left">string</td><td align="left">Company address post code or zip code</td></tr><tr class="evenRow"><td align="left">Telephone</td><td align="left">string</td><td align="left">Telephone number</td></tr><tr class="oddRow"><td align="left">Fax1</td><td align="left">string</td><td align="left">Fax number #1</td></tr><tr class="evenRow"><td align="left">Fax2</td><td align="left">string</td><td align="left">Fax number #2</td></tr><tr class="oddRow"><td align="left">Email</td><td align="left">string</td><td align="left">Email address</td></tr><tr class="evenRow"><td align="left">RegistrationNumber</td><td align="left">string</td><td align="left">Company registration number</td></tr><tr class="oddRow"><td align="left">ContactProfileRef</td><td align="left">string</td><td align="left">Contact person profile reference</td></tr><tr class="evenRow"><td align="left">CreditFacility</td><td align="left">int</td><td align="left">Credit facility ('1' for yes and '0' for no)</td></tr><tr class="oddRow"><td align="left">CreditLimit</td><td align="left">decimal</td><td align="left">Amount of any credit limit</td></tr><tr class="evenRow"><td align="left">Hold</td><td align="left">int</td><td align="left">Hold option ('1' for yes and '0' for no)</td></tr><tr class="oddRow"><td align="left">ABTA</td><td align="left">string</td><td align="left">ABTA reference, if applicable</td></tr><tr class="evenRow"><td align="left">ATOL</td><td>string</td><td align="left">ATOL reference, if applicable</td></tr><tr class="oddRow"><td align="left">IATA</td><td align="left">string</td><td align="left">IATA reference, if applicable</td></tr><tr class="evenRow"><td align="left">Notes</td><td align="left">string</td><td align="left">Notes</td></tr></tbody></table><h2 class="">Returned data</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">CompanyRef</td><td align="left">string</td><td align="left">Company account reference for newly created account</td></tr></tbody></table>
pmscom_CreateCompanyProfileSoapIn
<pmscom_CreateCompanyProfile xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionId>7ce4a576-86e0-494c-ad1c-f4de37a7017a</SessionId>
<CompanyRef />
<CompanyType>Agent</CompanyType>
<MarketSegment>Free lunch</MarketSegment>
<Name>Acme Travel Agent</Name>
<Address1>Guestline House</Address1>
<Area>Shrewsbury Business Park</Area>
<Town>Shrewsbury</Town>
<County>Shropshire</County>
<Country>England</Country>
<PostCode>SY26LG</PostCode>
<Telephone>01743282300</Telephone>
<Fax1>01743232213</Fax1>
<Fax2 />
<Email>terri.tandy@guestline.com</Email>
<RegistrationNumber>123456</RegistrationNumber>
<ContactProfileRef />
<CreditFacility>1</CreditFacility>
<CreditLimit>10000</CreditLimit>
<Hold>0</Hold>
<ABTA />
<ATOL>A67676</ATOL>
<IATA />
<Notes />
</pmscom_CreateCompanyProfile>
pmscom_CreateCompanyProfileSoapOut
<pmscom_CreateCompanyProfileResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscom_CreateCompanyProfileResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmscom_CreateCompanyProfileResult>
<CompanyRef>ACME00000001</CompanyRef>
</pmscom_CreateCompanyProfileResponse>
<p>Update the details of an existing Company Account / Company Profile.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionId</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">CompanyRef</td><td align="left">string</td><td align="left">Company account reference</td></tr><tr class="oddRow"><td align="left">CompanyType</td><td align="left">"Agent", "Corporate", "TourGroup" or "TourSeries"</td><td align="left">Company type</td></tr><tr class="evenRow"><td align="left">MarketSegment</td><td align="left">string</td><td align="left">Market segment</td></tr><tr class="oddRow"><td align="left">Name</td><td align="left">string</td><td align="left">Company name</td></tr><tr class="evenRow"><td align="left">Address1</td><td align="left">string</td><td align="left">Company address line 1</td></tr><tr class="oddRow"><td align="left">Area</td><td align="left">string</td><td align="left">Company address area</td></tr><tr class="evenRow"><td align="left">Town</td><td align="left">string</td><td align="left">Company address town or city</td></tr><tr class="oddRow"><td align="left">County</td><td align="left">string</td><td align="left">Company address county or state</td></tr><tr class="evenRow"><td align="left">Country</td><td align="left">string</td><td align="left">Company address country</td></tr><tr class="oddRow"><td align="left">PostCode</td><td align="left">string</td><td align="left">Company address post code or zip code</td></tr><tr class="evenRow"><td align="left">Telephone</td><td align="left">string</td><td align="left">Telephone number</td></tr><tr class="oddRow"><td align="left">Fax1</td><td align="left">string</td><td align="left">Fax number #1</td></tr><tr class="evenRow"><td align="left">Fax2</td><td align="left">string</td><td align="left">Fax number #2</td></tr><tr class="oddRow"><td align="left">Email</td><td align="left">string</td><td align="left">Email address</td></tr><tr class="evenRow"><td align="left">RegistrationNumber</td><td align="left">string</td><td align="left">Company registration number</td></tr><tr class="oddRow"><td align="left">ContactProfileRef</td><td align="left">string</td><td align="left">Contact person profile reference</td></tr><tr class="evenRow"><td align="left">CreditFacility</td><td align="left">int</td><td align="left">Credit facility ('1' for yes and '0' for no)</td></tr><tr class="oddRow"><td align="left">CreditLimit</td><td align="left">decimal</td><td align="left">Amount of any credit limit</td></tr><tr class="evenRow"><td align="left">Hold</td><td align="left">int</td><td align="left">Hold option ('1' for yes and '0' for no)</td></tr><tr class="oddRow"><td align="left">ABTA</td><td align="left">string</td><td align="left">ABTA reference, if applicable</td></tr><tr class="evenRow"><td align="left">ATOL</td><td>string</td><td align="left">ATOL reference, if applicable</td></tr><tr class="oddRow"><td align="left">IATA</td><td align="left">string</td><td align="left">IATA reference, if applicable</td></tr><tr class="evenRow"><td align="left">Notes</td><td align="left">string</td><td align="left">Notes</td></tr></tbody></table>
pmscom_UpdateCompanyProfileSoapIn
<pmscom_UpdateCompanyProfile xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionId>7ce4a576-86e0-494c-ad1c-f4de37a7017a</SessionId>
<CompanyRef />
<CompanyType>Agent</CompanyType>
<MarketSegment>Free lunch</MarketSegment>
<Name>Acme Travel Agent</Name>
<Address1>Guestline House</Address1>
<Area>Shrewsbury Business Park</Area>
<Town>Shrewsbury</Town>
<County>Shropshire</County>
<Country>England</Country>
<PostCode>SY26LG</PostCode>
<Telephone>01743282300</Telephone>
<Fax1>01743232213</Fax1>
<Fax2 />
<Email>terri.tandy@guestline.com</Email>
<RegistrationNumber>123456</RegistrationNumber>
<ContactProfileRef />
<CreditFacility>1</CreditFacility>
<CreditLimit>10000</CreditLimit>
<Hold>0</Hold>
<ABTA />
<ATOL>A67676</ATOL>
<IATA />
<Notes />
</pmscom_UpdateCompanyProfile>
pmscom_UpdateCompanyProfileSoapOut
<pmscom_CreateCompanyProfileResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscom_CreateCompanyProfileResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmscom_CreateCompanyProfileResult>
</pmscom_CreateCompanyProfileResponse>
<p>Fetch the list of all room types for the given Site ID.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID obtained at log-in</td></tr><tr class="evenRow"><td align="left">SiteID</td><td align="left">string</td><td align="left">Site ID</td></tr></tbody></table><h2 class="">Returned data (room type)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">RoomTypeCode</td><td align="left">string</td><td align="left">Room type</td></tr><tr class="evenRow"><td align="left">RoomTypeGroupCode</td><td align="left">string</td><td align="left">Room type group</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Room type description</td></tr><tr class="evenRow"><td align="left">RoomTypeClass</td><td align="left">"Bedroom", "FunctionRoom" or "Other"</td><td align="left">Room type class</td></tr><tr class="oddRow"><td align="left">Pax</td><td align="left">int</td><td align="left">Maximum capacity of room (number of people)</td></tr><tr class="evenRow"><td align="left">SystemSource</td><td align="left">(see below)</td><td align="left">(internal flag)</td></tr><tr class="oddRow"><td align="left">RFlag</td><td align="left">int</td><td align="left">(internal flag - indicates "marked for deletion")</td></tr></tbody></table><p><strong>SystemSource</strong> can be one of the following:</p><ul><li>Unknown</li><li>Rezlynx</li><li>PublicPortal</li><li>AgentPortal</li><li>CorporatePortal</li><li>Roomlynx</li><li>CRS</li><li>BWCRS</li><li>WebService</li></ul>
pmscfg_RoomTypeListSoapIn
<pmscfg_RoomTypeList xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
<SiteID>VENDORCITY</SiteID>
</pmscfg_RoomTypeList>
pmscfg_RoomTypeListSoapOut
<pmscfg_RoomTypeListResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscfg_RoomTypeListResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmscfg_RoomTypeListResult>
<RoomTypeList>
<RoomTypes>
<RoomTypeItem>
<RoomTypeCode>COTTAGE_1</RoomTypeCode>
<RoomTypeGroupCode>BEDROOMS</RoomTypeGroupCode>
<Description>1 Bed Cottage</Description>
<RoomTypeClass>Bedroom</RoomTypeClass>
<Pax>2</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>COTTAGE_2</RoomTypeCode>
<RoomTypeGroupCode>BEDROOMS</RoomTypeGroupCode>
<Description>2 Bed Cottage</Description>
<RoomTypeClass>Bedroom</RoomTypeClass>
<Pax>4</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>COTTAGE_3</RoomTypeCode>
<RoomTypeGroupCode>BEDROOMS</RoomTypeGroupCode>
<Description>3 Bed Cottage</Description>
<RoomTypeClass>Bedroom</RoomTypeClass>
<Pax>6</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>DBL_STANDARD</RoomTypeCode>
<RoomTypeGroupCode>BEDROOMS</RoomTypeGroupCode>
<Description>Standard Double</Description>
<RoomTypeClass>Bedroom</RoomTypeClass>
<Pax>2</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>DBL_SUPERIOR</RoomTypeCode>
<RoomTypeGroupCode>BEDROOMS</RoomTypeGroupCode>
<Description>Superior Double</Description>
<RoomTypeClass>Bedroom</RoomTypeClass>
<Pax>2</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>FAMILY</RoomTypeCode>
<RoomTypeGroupCode>BEDROOMS</RoomTypeGroupCode>
<Description>Family Room</Description>
<RoomTypeClass>Bedroom</RoomTypeClass>
<Pax>6</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>FUNCTION</RoomTypeCode>
<RoomTypeGroupCode>FUNCTION</RoomTypeGroupCode>
<Description>General function room</Description>
<RoomTypeClass>FunctionRoom</RoomTypeClass>
<Pax>999</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>MEETING_ROOM</RoomTypeCode>
<RoomTypeGroupCode>FUNCTION</RoomTypeGroupCode>
<Description>Meeting Room</Description>
<RoomTypeClass>Bedroom</RoomTypeClass>
<Pax>500</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>PENTHOUSE</RoomTypeCode>
<RoomTypeGroupCode>BEDROOMS</RoomTypeGroupCode>
<Description>Penthouse Suite</Description>
<RoomTypeClass>Bedroom</RoomTypeClass>
<Pax>4</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>PUBLIC</RoomTypeCode>
<RoomTypeGroupCode>PUBLIC</RoomTypeGroupCode>
<Description>Public Rooms</Description>
<RoomTypeClass>Other</RoomTypeClass>
<Pax>0</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>SUITE</RoomTypeCode>
<RoomTypeGroupCode>BEDROOMS</RoomTypeGroupCode>
<Description>Suite</Description>
<RoomTypeClass>Bedroom</RoomTypeClass>
<Pax>4</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
<RoomTypeItem>
<RoomTypeCode>TREATMENT</RoomTypeCode>
<RoomTypeGroupCode>SPA</RoomTypeGroupCode>
<Description>Treatment Room</Description>
<RoomTypeClass>Other</RoomTypeClass>
<Pax>2</Pax>
<SystemSource>Rezlynx</SystemSource>
<RFlag>0</RFlag>
</RoomTypeItem>
</RoomTypes>
</RoomTypeList>
</pmscfg_RoomTypeListResponse>
<p>This is a general method for fetching bookings or reservations from the PMS. Filter parameters are used to refine
the search, e.g. you can filter for residents-only or for a reservation with a specific booking reference, or
search for a reservation against a specific guest name. You can use the <strong>ReturnAllGuestsInNameSearches</strong>
parameter to determine if the method returns information on every individual guest in the room or only the
principal guest in the room.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left">More</td>
<td align="left"><a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Booking-vs-reservation">Booking
vs reservation</a></td>
</tr>
</tbody>
</table>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID</td>
</tr>
<tr class="evenRow">
<td align="left">Filters</td>
<td align="left">-</td>
<td align="left">(see below)</td>
</tr>
</tbody>
</table>
<p><strong>Note</strong> - we recommend to send across <u>all</u> parameters in the request (even the ones that are
'MinOccurs=0' in the <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#WSDL">WSDL</a>) and only populate the
ones you want to update.</p>
<h2 class="">Parameters (Filters)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">BookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="evenRow">
<td align="left">RoomPickID</td>
<td align="left">int</td>
<td align="left">Integer indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
<tr class="oddRow">
<td align="left">Forename</td>
<td align="left">string</td>
<td align="left">Guest first name</td>
</tr>
<tr class="evenRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Guest surname</td>
</tr>
<tr class="oddRow">
<td align="left">ForenameOrSurname</td>
<td align="left">string</td>
<td align="left">Used to search for a name which exists in either the forename field or the surname field</td>
</tr>
<tr class="evenRow">
<td align="left">ProfileRef</td>
<td align="left">string</td>
<td align="left">Guest profile reference</td>
</tr>
<tr class="oddRow">
<td align="left">LoyaltyID</td>
<td align="left">string</td>
<td align="left">Loyalty ID</td>
</tr>
<tr class="evenRow">
<td align="left">BookingStatus</td>
<td align="left">(object)</td>
<td align="left">Set of booking statuses to search against, see <a class="tc-tiddlylink tc-tiddlylink-resolves"
href="/doc/booking-status">Booking status</a></td>
</tr>
<tr class="oddRow">
<td align="left">> BookingSearchBookingStatus</td>
<td align="left">string</td>
<td align="left">"PreArrival", "Resident", "Cancelled", "CheckedOut" or "NoShow", see <a class="tc-tiddlylink tc-tiddlylink-resolves"
href="/doc/booking-status">Booking status</a></td>
</tr>
<tr class="evenRow">
<td align="left">GroupAllotmentRef</td>
<td align="left">string</td>
<td align="left">Group Allotment reference</td>
</tr>
<tr class="oddRow">
<td align="left">MultiRoomReference</td>
<td align="left">string</td>
<td align="left">Free text description field used as a heading for multi-room reservations</td>
</tr>
<tr class="evenRow">
<td align="left">RoomID</td>
<td align="left">string</td>
<td align="left">Room number or name</td>
</tr>
<tr class="oddRow">
<td align="left">ArrivalDate</td>
<td align="left">dateTime</td>
<td align="left">Guest planned arrival date</td>
</tr>
<tr class="evenRow">
<td align="left">DepartureDate</td>
<td align="left">dateTime</td>
<td align="left">Guest planned departure date</td>
</tr>
<tr class="oddRow">
<td align="left">CreationDate</td>
<td align="left">dateTime</td>
<td align="left">Reservation creation date</td>
</tr>
<tr class="evenRow">
<td align="left">BookingType</td>
<td align="left">string</td>
<td align="left">Booking or reservation type (see below)</td>
</tr>
<tr class="oddRow">
<td align="left">ShiftAllowances</td>
<td align="left">string</td>
<td align="left">Option to search against guest <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/shift-allowances">Shift
allowances</a>, if used: "All" or "CurrentDay"</td>
</tr>
<tr class="evenRow">
<td align="left">Limit</td>
<td align="left">int</td>
<td align="left">Limits the number of records returned, default 200</td>
</tr>
<tr class="oddRow">
<td align="left">CRSRef</td>
<td align="left">string</td>
<td align="left">External Central Reservation System reference</td>
</tr>
<tr class="evenRow">
<td align="left">ReturnAllGuestsInNameSearches</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if all guests in the reservation should be returned or just the principal
guest</td>
</tr>
<tr class="oddRow">
<td align="left">LastEditFrom</td>
<td align="left">dateTime</td>
<td align="left">Option to search against the date-time when the reservation was last edited ('from'
date-time)</td>
</tr>
<tr class="evenRow">
<td align="left">LastEditTo</td>
<td align="left">dateTime</td>
<td align="left">Option to search against the date-time when the reservation was last edited ('to'
date-time)</td>
</tr>
<tr class="oddRow">
<td align="left">CreatedFrom</td>
<td align="left">dateTime</td>
<td align="left">Option to search against the date-time when the reservation was created ('from' date-time)</td>
</tr>
<tr class="evenRow">
<td align="left">CreatedTo</td>
<td align="left">dateTime</td>
<td align="left">Option to search against the date-time when the reservation was created ('to' date-time)</td>
</tr>
<tr class="oddRow">
<td align="left">SystemSource</td>
<td align="left">string</td>
<td align="left">System origin of this reservation (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">DistributionChannelID</td>
<td align="left">int</td>
<td align="left">Distribution Channel ID for reservation (if applicable)</td>
</tr>
<tr class="oddRow">
<td align="left">PreCheckIn</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if pre-checked-in or not (if applicable)</td>
</tr>
<tr class="evenRow">
<td align="left">RezlynxCRS</td>
<td align="left">string</td>
<td align="left">Rezlynx Central Reservation System reference</td>
</tr>
<tr class="oddRow">
<td align="left">IncludeMasterBookings</td>
<td align="left">Boolean</td>
<td align="left">Indicates if master bookings should be included or excluded from the returned set of reservations (see Booking Type below) <code>!new in 1.500!</code></td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>Search results consisting of a set of reservations, depending on the search filters used</li>
</ul>
<h2 class="">Returned data (Reservation)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">RoomId</td>
<td align="left">string</td>
<td align="left">Room ID (room number or name)</td>
</tr>
<tr class="evenRow">
<td align="left">BookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="oddRow">
<td align="left">RoomPickID</td>
<td align="left">int</td>
<td align="left">Integer indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
<tr class="evenRow">
<td align="left">BookingType</td>
<td align="left">string</td>
<td align="left">Booking or reservation type (see below)</td>
</tr>
<tr class="oddRow">
<td align="left">BookingStatus</td>
<td align="left">string</td>
<td align="left">"PreArrival", "Resident", "Cancelled", "CheckedOut" or "NoShow", see <a class="tc-tiddlylink tc-tiddlylink-resolves"
href="/doc/booking-status">Booking status</a></td>
</tr>
<tr class="evenRow">
<td align="left">RoomTypeCode</td>
<td align="left">string</td>
<td align="left">Room type code</td>
</tr>
<tr class="oddRow">
<td align="left">PackageCode</td>
<td align="left">string</td>
<td align="left">Package code, if part of a package</td>
</tr>
<tr class="evenRow">
<td align="left">Arrival</td>
<td align="left">dateTime</td>
<td align="left">Guest planned arrival date (reservation start)</td>
</tr>
<tr class="oddRow">
<td align="left">Departure</td>
<td align="left">dateTime</td>
<td align="left">Guest planned departure date (reservation finish)</td>
</tr>
<tr class="evenRow">
<td align="left">Creation</td>
<td align="left">dateTime</td>
<td align="left">Reservation creation date</td>
</tr>
<tr class="oddRow">
<td align="left">GroupAllotmentRef</td>
<td align="left">string</td>
<td align="left">Group Allotment reference</td>
</tr>
<tr class="evenRow">
<td align="left">MultiRoomReference</td>
<td align="left">string</td>
<td align="left">Free text description field used as a heading for multi-room reservations</td>
</tr>
<tr class="oddRow">
<td align="left">Contact</td>
<td>(object)</td>
<td>Contact person details, see <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/booking-search-objects">Booking
search objects</a></td>
</tr>
<tr class="evenRow">
<td align="left">Guests</td>
<td align="left">(object)</td>
<td align="left">Guest details, see <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/booking-search-objects">Booking
search objects</a></td>
</tr>
<tr class="oddRow">
<td align="left">Company</td>
<td align="left">(object)</td>
<td align="left">Name and reference for company through which reservation made, if applicable, see <a class="tc-tiddlylink tc-tiddlylink-resolves"
href="/doc/booking-search-objects">Booking search objects</a></td>
</tr>
<tr class="evenRow">
<td align="left">Agent</td>
<td>(object)</td>
<td align="left">Name and reference for agent through which reservation made, if applicable, see <a class="tc-tiddlylink tc-tiddlylink-resolves"
href="/doc/booking-search-objects">Booking search objects</a></td>
</tr>
<tr class="oddRow">
<td align="left">Source</td>
<td align="left">(object)</td>
<td>Name and reference for reservation source, if applicable, see <a class="tc-tiddlylink tc-tiddlylink-resolves"
href="/doc/booking-search-objects">Booking search objects</a></td>
</tr>
<tr class="evenRow">
<td align="left">Ledger</td>
<td align="left">(object)</td>
<td align="left">Name and reference for ledger, if applicable, see <a class="tc-tiddlylink tc-tiddlylink-resolves"
href="/doc/booking-search-objects">Booking search objects</a></td>
</tr>
<tr class="oddRow">
<td align="left">PostsAllowed</td>
<td align="left">string</td>
<td align="left">Indicates any posting restrictions for the reservation: either "All" (all postings
allowed), "None" (no postings allowed) or "CallsOnly" (only phone postings allowed)</td>
</tr>
<tr class="evenRow">
<td align="left">ShiftAllowances</td>
<td align="left">(object)</td>
<td align="left">Set of all <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/shift-allowances">Shift
allowances</a> for the reservation, see <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/booking-search-objects">Booking
search objects</a></td>
</tr>
<tr class="oddRow">
<td align="left">AlarmCall</td>
<td align="left">string</td>
<td align="left">Alarm call time, if set</td>
</tr>
<tr class="evenRow">
<td align="left">MovieAccess</td>
<td align="left">string</td>
<td align="left"><a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/movie-access">Movie Access</a>
code, if used</td>
</tr>
<tr class="oddRow">
<td align="left">FunctionBookingDescription</td>
<td align="left">string</td>
<td>Description if function room reservation</td>
</tr>
<tr class="evenRow">
<td align="left">BookRefRoomPickID</td>
<td align="left">string</td>
<td align="left">Long-form booking reference, including Room Pick ID, e.g. "BK000034/1"</td>
</tr>
<tr class="oddRow">
<td align="left">AllowRoomMoves</td>
<td align="left">Boolean</td>
<td align="left">Flag to indicate if room moves are allowed</td>
</tr>
<tr class="evenRow">
<td align="left">EventName</td>
<td align="left">string</td>
<td>Name, if reservation is part of a C&B event</td>
</tr>
<tr class="oddRow">
<td align="left">MarketSegment</td>
<td align="left">string</td>
<td align="left">Market segment, for marketing purposes</td>
</tr>
<tr class="evenRow">
<td align="left">TotalCostNett</td>
<td align="left">decimal</td>
<td align="left">Total cost of the booking (nett of tax)</td>
</tr>
<tr class="oddRow">
<td align="left">TotalCostGross</td>
<td align="left">decimal</td>
<td align="left">Total cost of the booking (gross, including tax)</td>
</tr>
<tr class="evenRow">
<td align="left">LastEdited</td>
<td align="left">dateTime</td>
<td align="left">Date-time the reservation was last edited or changed (not including changes made at a room
block, group or multi-room level)</td>
</tr>
<tr class="oddRow">
<td align="left">GDSRef</td>
<td align="left">string</td>
<td align="left">GDS reference, if booking came via an external GDS</td>
</tr>
<tr class="evenRow">
<td align="left">CRSRef1</td>
<td align="left">string</td>
<td align="left">Rezlynx CRS reference</td>
</tr>
<tr class="oddRow">
<td align="left">CRSRes2</td>
<td align="left">string</td>
<td align="left">-</td>
</tr>
<tr class="evenRow">
<td align="left">CRSRef2</td>
<td align="left">string</td>
<td align="left">External CRS reference, if reservation came via an external CRS</td>
</tr>
<tr class="oddRow">
<td align="left">SystemSource</td>
<td align="left">string</td>
<td align="left">System origin of this reservation (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">DistributionChannelId</td>
<td align="left">int</td>
<td align="left">Distribution Channel ID, if the reservation came via a distribution channel</td>
</tr>
<tr class="oddRow">
<td align="left">PreCheckIn</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if pre-checked-in or not (if applicable)</td>
</tr>
<tr class="evenRow">
<td align="left">RezlynxCRS</td>
<td align="left">string</td>
<td align="left">Rezlynx CRS reference</td>
</tr>
</tbody>
</table>
<p><strong>Booking type</strong> must be one of the following:</p>
<ul>
<li>"Bedroom" = normal bedroom reservation</li>
<li>"Function" = function room reservation</li>
<li>"Nra" = non-resident account, i.e. not linked to a room</li>
<li>"Master" = master booking <code>!new in 1.500!</code></li>
</ul>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note</strong> Master bookings are dummy room reservations, similar to an NRA but
linked to a group or multi-room reservation. Both master bookings and NRAs can be useful for managing
accounts.</td>
</tr>
</tbody>
</table>
<p><strong>SystemSource</strong> must be one of the following:</p>
<ul>
<li>"Unknown"</li>
<li>"Rezlynx"</li>
<li>"PublicPortal"</li>
<li>"AgentPortal"</li>
<li>"CorporatePortal"</li>
<li>"Roomlynx"</li>
<li>"CRS"</li>
<li>"BWCRS"</li>
<li>"WebService"</li>
<li>"CentralInvoicing"</li>
<li>"SalesAndCatering"</li>
</ul>
pmsbkg_BookingSearchSoapIn
<pmsbkg_BookingSearch xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>dda11037-65f5-4bf1-acb9-4fb187176e5c</SessionID>
<Filters>
<BookRef />
<RoomPickID xsi:nil="true" />
<Forename />
<Surname />
<ForenameOrSurname />
<ProfileRef />
<LoyaltyID />
<BookingStatus />
<GroupAllotmentRef />
<MultiRoomReference />
<RoomID />
<ArrivalDate xsi:nil="true" />
<DepartureDate xsi:nil="true" />
<CreationDate xsi:nil="true" />
<BookingType xsi:nil="true" />
<ShiftAllowances xsi:nil="true" />
<Limit>200</Limit>
<CRSRef />
<ReturnAllGuestsInNameSearches>true</ReturnAllGuestsInNameSearches>
<LastEditFrom xsi:nil="true" />
<LastEditTo xsi:nil="true" />
<CreatedFrom>2017-08-29T09:17:45.235262</CreatedFrom>
<CreatedTo>2017-09-19T09:17:45.2317592</CreatedTo>
<SystemSource xsi:nil="true" />
<DistributionChannelID xsi:nil="true" />
<PreCheckIn>false</PreCheckIn>
<RezlynxCRS />
<IncludeMasterBookings>false</IncludeMasterBookings>
</Filters>
</pmsbkg_BookingSearch>
pmsbkg_BookingSearchSoapOut
<pmsbkg_BookingSearchResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_BookingSearchResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsbkg_BookingSearchResult>
<SearchResults>
<Reservations>
<Reservation>
<RoomId />
<BookRef>BK000018</BookRef>
<RoomPickId>1</RoomPickId>
<BookingType>Bedroom</BookingType>
<BookingStatus>PreArrival</BookingStatus>
<RoomTypeCode>DBL_STANDARD</RoomTypeCode>
<PackageCode>BAR_BB</PackageCode>
<Arrival>2017-09-04T00:00:00</Arrival>
<Departure>2017-09-05T00:00:00</Departure>
<Creation>2017-08-29T11:09:35</Creation>
<Contact>
<Name>Mr Paul Smith</Name>
<Salutation>Mr</Salutation>
<Forename>Paul</Forename>
<Surname>Smith</Surname>
<TypeOfPerson>Adult</TypeOfPerson>
<Gender>Male</Gender>
<ProfileRef>PF000066</ProfileRef>
<LoyaltyID />
</Contact>
<Guests>
<Guest>
<Name>Mr Paul Smith</Name>
<Salutation>Mr</Salutation>
<Forename>Paul</Forename>
<Surname>Smith</Surname>
<TypeOfPerson>Adult</TypeOfPerson>
<Gender>Male</Gender>
<ProfileRef>PF000066</ProfileRef>
<LoyaltyID />
<FolioID>1</FolioID>
</Guest>
</Guests>
<PostsAllowed>All</PostsAllowed>
<BookRefRoomPickID>BK000018/1</BookRefRoomPickID>
<AllowRoomMoves>true</AllowRoomMoves>
<MarketSegment>BAR</MarketSegment>
<TotalCostNett>66.6600</TotalCostNett>
<TotalCostGross>80.0000</TotalCostGross>
<LastEdited>2017-08-29T14:04:11</LastEdited>
<GDSRef />
<CRSRef1 />
<CRSRef2 />
<SystemSource>Unknown</SystemSource>
<DistributionChannelId>0</DistributionChannelId>
<PreCheckIn>false</PreCheckIn>
<RezlynxCRS />
</Reservation>
<Reservation>
<RoomId>112</RoomId>
<BookRef>BK000019</BookRef>
<RoomPickId>1</RoomPickId>
<BookingType>Bedroom</BookingType>
<BookingStatus>PreArrival</BookingStatus>
<RoomTypeCode>DBL_STANDARD</RoomTypeCode>
<PackageCode>BAR_BB</PackageCode>
<Arrival>2017-09-06T00:00:00</Arrival>
<Departure>2017-09-07T00:00:00</Departure>
<Creation>2017-08-29T11:12:08</Creation>
<Contact>
<Name>Mr Tom Jones</Name>
<Salutation>Mr</Salutation>
<Forename>Tom</Forename>
<Surname>Jones</Surname>
<TypeOfPerson>Adult</TypeOfPerson>
<Gender>Male</Gender>
<ProfileRef>PF000068</ProfileRef>
<LoyaltyID />
</Contact>
<Guests>
<Guest>
<Name>Mr Tom Jones</Name>
<Salutation>Mr</Salutation>
<Forename>Tom</Forename>
<Surname>Jones</Surname>
<TypeOfPerson>Adult</TypeOfPerson>
<Gender>Male</Gender>
<ProfileRef>PF000068</ProfileRef>
<LoyaltyID />
<FolioID>1</FolioID>
</Guest>
</Guests>
<PostsAllowed>All</PostsAllowed>
<BookRefRoomPickID>BK000019/1</BookRefRoomPickID>
<AllowRoomMoves>false</AllowRoomMoves>
<MarketSegment>BAR</MarketSegment>
<TotalCostNett>66.6600</TotalCostNett>
<TotalCostGross>80.0000</TotalCostGross>
<LastEdited>2017-08-29T11:12:08</LastEdited>
<GDSRef />
<CRSRef1 />
<CRSRef2 />
<SystemSource>Unknown</SystemSource>
<DistributionChannelId>0</DistributionChannelId>
<PreCheckIn>false</PreCheckIn>
<RezlynxCRS />
</Reservation>
</Reservations>
</SearchResults>
</pmsbkg_BookingSearchResponse>
Allows the posting of payments or credits to a room bill for a resident booking.
<h4>Parameters</h4>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking or reservation reference</td></tr><tr class="oddRow"><td align="left">PaymentCode</td><td align="left">string</td><td align="left">Payment type code (the set of all codes can be obtained using <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#pmscfg_PayTypeList">pmscfg_PayTypeList</a>)</td></tr><tr class="evenRow"><td align="left">Value</td><td align="left">decimal</td><td align="left">Amount of payment</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Description of payment</td></tr><tr class="evenRow"><td align="left">FolioID</td><td align="left">int</td><td align="left">Folio ID, if required</td></tr><tr class="oddRow"><td align="left">BillSplitID</td><td align="left">int</td><td align="left">Bill split ID, if required</td></tr></tbody></table>
<h4>Returned data</h4>
None
pmschg_PostPaymentToRoomSoapIn
<pmschg_PostPaymentToRoom xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<BookRef>BK00005</BookRef>
<PaymentCode>CASH</PaymentCode>
<Value>6.00</Value>
<Description>Cash</Description>
<FolioID>1</FolioID>
<BillSplitID>0</BillSplitID>
</pmschg_PostPaymentToRoom>
pmschg_PostPaymentToRoomSoapOut
<pmschg_PostPaymentToRoomResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmschg_PostPaymentToRoomResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmschg_PostPaymentToRoomResult>
</pmschg_PostPaymentToRoomResponse>
<p>Perform a pre-check-in of the specified reservation. Currently this does nothing except set a pre-check-in flag against the reservation, indicating that some process or event has occurred, the details of which are dependent on the operational procedures for the given customer site.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Long-format booking or reservation reference, e.g. 'BK000052/1'</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsbkg_PreCheckInSoapIn
<pmsbkg_PreCheckIn xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<BookRef>BK000052/1</BookRef>
</pmsbkg_PreCheckIn>
pmsbkg_PreCheckInSoapOut
<pmsbkg_PreCheckInResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_PreCheckInResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsbkg_PreCheckInResult>
</pmsbkg_PreCheckInResponse>
<p>Request to upgrade a reservation room type and/or apply a product upsell.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID obtained at log-in</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Reservation reference</td></tr><tr class="oddRow"><td align="left">RoomPickID</td><td align="left">int</td><td align="left">Room integer (1,2,...)</td></tr><tr class="evenRow"><td align="left">Surname</td><td align="left">string</td><td align="left">Guest surname (required)</td></tr><tr class="oddRow"><td align="left">ArrivalDate</td><td align="left">dateTime</td><td align="left">Arrival due date (required)</td></tr><tr class="evenRow"><td align="left">RoomTypeCode</td><td align="left">string</td><td align="left">New room type</td></tr><tr class="oddRow"><td align="left">UpsellCode</td><td align="left">string</td><td align="left">Upsell product code</td></tr><tr class="evenRow"><td align="left">Value</td><td align="left">decimal</td><td align="left">Value of upsell</td></tr><tr class="oddRow"><td align="left">Notes</td><td align="left">string</td><td align="left">Optional notes to support upgrade request</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsres_RoomUpgradeSoapIn
<pmsres_RoomUpgrade xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
<BookRef>BK000052</BookRef>
<RoomPickID>1</RoomPickID>
<Surname>Adams</Surname>
<ArrivalDate>2018-05-09T10:25:37</ArrivalDate>
<RoomTypeCode>COTTAGE_2</RoomTypeCode>
<UpsellCode>GUARDIAN</UpsellCode>
<Value>99.00</Value>
<Notes />
</pmsres_RoomUpgrade>
pmsres_RoomUpgradeSoapOut
<pmsres_RoomUpgradeResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsres_RoomUpgradeResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsres_RoomUpgradeResult>
</pmsres_RoomUpgradeResponse>
This method provides a way of retrieving accounts from the Central Invoicing Module by providing various search criteria as parameters.
<div id="dvGetAccounts">
<h2 class="">
Parameters
</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID</td>
</tr>
<tr class="evenRow">
<td align="left">likeAccountRef</td>
<td align="left">string</td>
<td align="left">Account reference</td>
</tr>
<tr class="oddRow">
<td align="left">likeAccountName</td>
<td align="left">string</td>
<td align="left">Account name</td>
</tr>
<tr class="evenRow">
<td align="left">likeStreet</td>
<td align="left">string</td>
<td align="left">Street</td>
</tr>
<tr class="oddRow">
<td align="left">likeArea</td>
<td align="left">string</td>
<td align="left">Area</td>
</tr>
<tr class="evenRow">
<td align="left">likeTown</td>
<td align="left">string</td>
<td align="left">Town</td>
</tr>
<tr class="oddRow">
<td align="left">likeCounty</td>
<td align="left">string</td>
<td align="left">County</td>
</tr>
<tr class="evenRow">
<td align="left">likeCountry</td>
<td align="left">string</td>
<td align="left">Country</td>
</tr>
<tr class="oddRow">
<td align="left">likePostcode</td>
<td align="left">string</td>
<td align="left">Postcode</td>
</tr>
<tr class="evenRow">
<td align="left">likeTelNo</td>
<td align="left">string</td>
<td align="left">Telephone number</td>
</tr>
<tr class="oddRow">
<td align="left">likeEmail</td>
<td align="left">string</td>
<td align="left">Email address</td>
</tr>
<tr class="evenRow">
<td align="left">limit</td>
<td align="left">int</td>
<td align="left">Maximum number of results returned</td>
</tr>
<tr class="oddRow">
<td align="left">likeStudentID</td>
<td align="left">string</td>
<td align="left">Student ID</td>
</tr>
<tr class="evenRow">
<td align="left">LinkedToCompany</td>
<td align="left">string</td>
<td align="left">Company reference, if linked to company</td>
</tr>
<tr class="oddRow">
<td align="left">LinkedToProfile</td>
<td align="left">string</td>
<td align="left">Profile reference, if linked to profile</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>A set of CIM accounts</li>
</ul>
<h2>Returned data (CIM account)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="evenRow">
<td align="left">Reference</td>
<td align="left">string</td>
<td align="left">Account reference</td>
</tr>
<tr class="oddRow">
<td align="left">Name</td>
<td align="left">string</td>
<td align="left">Account name</td>
</tr>
<tr class="evenRow">
<td align="left">LinkedToProfileRef</td>
<td align="left">string</td>
<td align="left">Profile reference linked to this account</td>
</tr>
<tr class="oddRow">
<td align="left">LinkedToCompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference linked to this account</td>
</tr>
<tr class="evenRow">
<td align="left">DefaultAddressType</td>
<td align="left">"LinkedAddress" or "CustomAddress"</td>
<td align="left">Address type</td>
</tr>
<tr class="oddRow">
<td align="left">Street</td>
<td align="left">string</td>
<td align="left">Address street name</td>
</tr>
<tr class="evenRow">
<td align="left">Area</td>
<td align="left">string</td>
<td align="left">Address area</td>
</tr>
<tr class="oddRow">
<td align="left">Town</td>
<td align="left">string</td>
<td align="left">Address town or city</td>
</tr>
<tr class="evenRow">
<td align="left">County</td>
<td align="left">string</td>
<td align="left">Address county or state</td>
</tr>
<tr class="oddRow">
<td align="left">Country</td>
<td align="left">string</td>
<td align="left">Address country</td>
</tr>
<tr class="evenRow">
<td align="left">Postcode</td>
<td align="left">string</td>
<td align="left">Address post code or zip code</td>
</tr>
<tr class="oddRow">
<td align="left">AccountRegistrationNumber</td>
<td align="left">string</td>
<td align="left">Account registration number</td>
</tr>
<tr class="evenRow">
<td align="left">TelNo</td>
<td align="left">string</td>
<td align="left">Telephone number</td>
</tr>
<tr class="oddRow">
<td align="left">FaxNo1</td>
<td align="left">string</td>
<td align="left">Fax number 1</td>
</tr>
<tr class="evenRow">
<td align="left">FaxNo2</td>
<td align="left">string</td>
<td align="left">Fax number 2</td>
</tr>
<tr class="oddRow">
<td align="left">Email</td>
<td align="left">string</td>
<td align="left">Email address</td>
</tr>
<tr class="evenRow">
<td align="left">PaymentDays</td>
<td align="left">int</td>
<td align="left">Number of payment days</td>
</tr>
<tr class="oddRow">
<td align="left">Notes</td>
<td align="left">string</td>
<td align="left">Custom notes</td>
</tr>
<tr class="evenRow">
<td align="left">IsCreditAccount</td>
<td align="left">boolean</td>
<td align="left">Is this a credit account</td>
</tr>
<tr class="oddRow">
<td align="left">IsOnHold</td>
<td align="left">boolean</td>
<td align="left">Is this account on hold</td>
</tr>
<tr class="evenRow">
<td align="left">CreditLimit</td>
<td align="left">decimal</td>
<td align="left">Credit limit</td>
</tr>
<tr class="oddRow">
<td align="left">StudentID</td>
<td align="left">string</td>
<td align="left">Student ID, if applicable</td>
</tr>
</tbody>
</table>
</div>
cim_GetAccountsSoapIn
<cim_GetAccounts xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>string</SessionID>
<likeAccountRef>string</likeAccountRef>
<likeAccountName>string</likeAccountName>
<likeStreet>string</likeStreet>
<likeArea>string</likeArea>
<likeTown>string</likeTown>
<likeCounty>string</likeCounty>
<likeCountry>string</likeCountry>
<likePostcode>string</likePostcode>
<likeTelNo>string</likeTelNo>
<likeEmail>string</likeEmail>
<limit>int</limit>
<likeStudentID>string</likeStudentID>
<accounts>
</accounts>
<LinkedToCompany>string</LinkedToCompany>
<LinkedToProfile>string</LinkedToProfile>
</cim_GetAccounts>
cim_GetAccountsSoapOut
<cim_GetAccountsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_GetAccountsResult>
<ExceptionCode>int</ExceptionCode>
<ExceptionDescription>string</ExceptionDescription>
</cim_GetAccountsResult>
<accounts>
<Items>
<CIMAccount>
<Reference>string</Reference>
<Name>string</Name>
<LinkedToProfileRef>string</LinkedToProfileRef>
<LinkedToCompanyRef>string</LinkedToCompanyRef>
<DefaultAddressType>LinkedAddress or CustomAddress</DefaultAddressType>
<Street>string</Street>
<Area>string</Area>
<Town>string</Town>
<County>string</County>
<Country>string</Country>
<Postcode>string</Postcode>
<AccountRegistrationNumber>string</AccountRegistrationNumber>
<TelNo>string</TelNo>
<FaxNo1>string</FaxNo1>
<FaxNo2>string</FaxNo2>
<Email>string</Email>
<PaymentDays>int</PaymentDays>
<Notes>string</Notes>
<IsCreditAccount>boolean</IsCreditAccount>
<IsOnHold>boolean</IsOnHold>
<CreditLimit>decimal</CreditLimit>
<StudentID>string</StudentID>
</CIMAccount>
<CIMAccount>
<Reference>string</Reference>
<Name>string</Name>
<LinkedToProfileRef>string</LinkedToProfileRef>
<LinkedToCompanyRef>string</LinkedToCompanyRef>
<DefaultAddressType>LinkedAddress or CustomAddress</DefaultAddressType>
<Street>string</Street>
<Area>string</Area>
<Town>string</Town>
<County>string</County>
<Country>string</Country>
<Postcode>string</Postcode>
<AccountRegistrationNumber>string</AccountRegistrationNumber>
<TelNo>string</TelNo>
<FaxNo1>string</FaxNo1>
<FaxNo2>string</FaxNo2>
<Email>string</Email>
<PaymentDays>int</PaymentDays>
<Notes>string</Notes>
<IsCreditAccount>boolean</IsCreditAccount>
<IsOnHold>boolean</IsOnHold>
<CreditLimit>decimal</CreditLimit>
<StudentID>string</StudentID>
</CIMAccount>
</Items>
</accounts>
</cim_GetAccountsResponse>
This method creates a new company account for the Central Invoicing Module.
<div id="dvCimCreateAccount">
<h2 class="">
Parameters
</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID</td>
</tr>
<tr class="evenRow">
<td align="left">AccountRef</td>
<td align="left">string</td>
<td align="left">Account reference</td>
</tr>
<tr class="oddRow">
<td align="left">Name</td>
<td align="left">string</td>
<td align="left">Account name</td>
</tr>
<tr class="evenRow">
<td align="left">LinkedProfileType</td>
<td align="left">"NotLinked", "Profile" or "Company"</td>
<td align="left">Type of linked profile</td>
</tr>
<tr class="oddRow">
<td align="left">LinkedToProfileValue</td>
<td align="left">string</td>
<td align="left">Profile reference of linked profile</td>
</tr>
<tr class="evenRow">
<td align="left">AddressType</td>
<td align="left">"LinkedAddress" or "CustomAddress"</td>
<td align="left">Address type</td>
</tr>
<tr class="oddRow">
<td align="left">Street</td>
<td align="left">string</td>
<td align="left">Street</td>
</tr>
<tr class="evenRow">
<td align="left">AddressLine1</td>
<td align="left">string</td>
<td align="left">First address line</td>
</tr>
<tr class="oddRow">
<td align="left">AddressLine2</td>
<td align="left">string</td>
<td align="left">Second address line</td>
</tr>
<tr class="evenRow">
<td align="left">Area</td>
<td align="left">string</td>
<td align="left">Area</td>
</tr>
<tr class="oddRow">
<td align="left">Town</td>
<td align="left">string</td>
<td align="left">Town</td>
</tr>
<tr class="evenRow">
<td align="left">County</td>
<td align="left">string</td>
<td align="left">County</td>
</tr>
<tr class="oddRow">
<td align="left">Country</td>
<td align="left">string</td>
<td align="left">Country</td>
</tr>
<tr class="evenRow">
<td align="left">Postcode</td>
<td align="left">string</td>
<td align="left">Postcode</td>
</tr>
<tr class="oddRow">
<td align="left">AccountRegistrationNumber</td>
<td align="left">string</td>
<td align="left">Account registration number</td>
</tr>
<tr class="evenRow">
<td align="left">TelNo</td>
<td align="left">string</td>
<td align="left">Telephone number</td>
</tr>
<tr class="oddRow">
<td align="left">FaxNo1</td>
<td align="left">string</td>
<td align="left">First fax number</td>
</tr>
<tr class="evenRow">
<td align="left">FaxNo2</td>
<td align="left">string</td>
<td align="left">Second fax number</td>
</tr>
<tr class="oddRow">
<td align="left">Email</td>
<td align="left">string</td>
<td align="left">Email address</td>
</tr>
<tr class="evenRow">
<td align="left">PaymentDays</td>
<td align="left">int</td>
<td align="left">Payment days</td>
</tr>
<tr class="oddRow">
<td align="left">Notes</td>
<td align="left">string</td>
<td align="left">Account notes</td>
</tr>
<tr class="evenRow">
<td align="left">StudentID</td>
<td align="left">string</td>
<td align="left">Student ID, if applicable</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>None</li>
</ul>
</div>
cim_CreateAccountSoapIn
<cim_CreateAccount xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>16460170-51b1-452f-b40a-50be4492d496</SessionID>
<AccountRef>12345</AccountRef>
<Name>Acme Consulting</Name>
<LinkedProfileType>NotLinked</LinkedProfileType>
<LinkedToProfileValue></LinkedToProfileValue>
<AddressType>CustomAddress</AddressType>
<Street>Champions Avenue</Street>
<AddressLine1>27 Champions Avenue</AddressLine1>
<AddressLine2></AddressLine2>
<Area></Area>
<Town>Marchess-on-Sea</Town>
<County>Worcestershire</County>
<Country>England</Country>
<Postcode>WO45 2LX</Postcode>
<AccountRegistrationNumber>A8787373</AccountRegistrationNumber>
<TelNo>01383500333</TelNo>
<FaxNo1></FaxNo1>
<FaxNo2></FaxNo2>
<Email>info@acmeconsulting.com</Email>
<PaymentDays>60</PaymentDays>
<Notes></Notes>
<StudentID></StudentID>
</cim_CreateAccount>
cim_CreateAccountSoapOut
<cim_CreateAccountResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_CreateAccountResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</cim_CreateAccountResult>
</cim_CreateAccountResponse>
<p>This method provides the ability to update account details, e.g. address, for a CIM account.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID</td></tr><tr class="evenRow"><td align="left">AccountRef</td><td align="left">string</td><td align="left">Account reference</td></tr><tr class="oddRow"><td align="left">Name</td><td align="left">string</td><td align="left">Account name</td></tr><tr class="evenRow"><td align="left">LinkedProfileType</td><td align="left">"NotLinked", "Profile" or "Company"</td><td align="left">Type of linked profile</td></tr><tr class="oddRow"><td align="left">LinkedToProfileValue</td><td align="left">string</td><td align="left">Linked to profile value</td></tr><tr class="evenRow"><td align="left">AddressType</td><td align="left">"LinkedAddress" or "CustomAddress"</td><td align="left">Address type</td></tr><tr class="oddRow"><td align="left">Street</td><td align="left">string</td><td align="left">Street</td></tr><tr class="evenRow"><td align="left">AddressLine1</td><td align="left">string</td><td align="left">First address line</td></tr><tr class="oddRow"><td align="left">AddressLine2</td><td align="left">string</td><td align="left">Second address line</td></tr><tr class="evenRow"><td align="left">Area</td><td align="left">string</td><td align="left">Area</td></tr><tr class="oddRow"><td align="left">Town</td><td align="left">string</td><td align="left">Town</td></tr><tr class="evenRow"><td align="left">County</td><td align="left">string</td><td align="left">County</td></tr><tr class="oddRow"><td align="left">Country</td><td align="left">string</td><td align="left">Country</td></tr><tr class="evenRow"><td align="left">Postcode</td><td align="left">string</td><td align="left">Postcode</td></tr><tr class="oddRow"><td align="left">AccountRegistrationNumber</td><td align="left">string</td><td align="left">Account registration number</td></tr><tr class="evenRow"><td align="left">TelNo</td><td align="left">string</td><td align="left">Telephone number</td></tr><tr class="oddRow"><td align="left">FaxNo1</td><td align="left">string</td><td align="left">First Fax number</td></tr><tr class="evenRow"><td align="left">FaxNo2</td><td align="left">string</td><td align="left">Second Fax number</td></tr><tr class="oddRow"><td align="left">Email</td><td align="left">string</td><td align="left">Email address</td></tr><tr class="evenRow"><td align="left">PaymentDays</td><td align="left">int</td><td align="left">Payment days</td></tr><tr class="oddRow"><td align="left">Notes</td><td align="left">string</td><td align="left">Account notes</td></tr><tr class="evenRow"><td align="left">StudentID</td><td align="left">string</td><td align="left">Student ID</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
cim_UpdateAccountSoapIn
<cim_UpdateAccount xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>string</SessionID>
<AccountRef>string</AccountRef>
<Name>string</Name>
<LinkedProfileType>NotLinked or Profile or Company</LinkedProfileType>
<LinkedToProfileValue>string</LinkedToProfileValue>
<AddressType>LinkedAddress or CustomAddress</AddressType>
<Street>string</Street>
<AddressLine1>string</AddressLine1>
<AddressLine2>string</AddressLine2>
<Area>string</Area>
<Town>string</Town>
<County>string</County>
<Country>string</Country>
<Postcode>string</Postcode>
<AccountRegistrationNumber>string</AccountRegistrationNumber>
<TelNo>string</TelNo>
<FaxNo1>string</FaxNo1>
<FaxNo2>string</FaxNo2>
<Email>string</Email>
<PaymentDays>int</PaymentDays>
<Notes>string</Notes>
<StudentID>string</StudentID>
</cim_UpdateAccount>
cim_UpdateAccountSoapOut
<cim_UpdateAccountResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_UpdateAccountResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</cim_UpdateAccountResult>
</cim_UpdateAccountResponse>
<p>This method retrieves outstanding transactions for a given CIM account.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID</td></tr><tr class="evenRow"><td align="left">AccountRef</td><td align="left">string</td><td align="left">Account reference</td></tr><tr class="oddRow"><td align="left">DocumentRef</td><td align="left">string</td><td align="left">Document reference</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>A set of CIM transactions</li></ul><h2 class="">Returned data (CIM transaction)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AccountRef</td><td align="left">string</td><td align="left">Account reference</td></tr><tr class="evenRow"><td align="left">Status</td><td align="left">(see below)</td><td align="left">Account status</td></tr><tr class="oddRow"><td align="left">TimeStamp</td><td align="left">dateTime</td><td align="left">Transaction date-time stamp</td></tr><tr class="evenRow"><td align="left">DocumentRef</td><td align="left">string</td><td align="left">Document reference</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Account description</td></tr><tr class="evenRow"><td align="left">GrossValue</td><td align="left">decimal</td><td align="left">Transaction gross value</td></tr><tr class="oddRow"><td align="left">Balance</td><td align="left">decimal</td><td align="left">Current balance</td></tr><tr class="evenRow"><td align="left">SiteID</td><td align="left">string</td><td align="left">Relevant Site ID</td></tr><tr class="oddRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Relevant booking reference</td></tr><tr class="evenRow"><td align="left">PaymentDue</td><td align="left">dateTime</td><td align="left">Date-time payment is due</td></tr></tbody></table><p><strong>Status</strong> is one of the following:</p><ul><li>"Unknown"</li><li>"PendingIssue"</li><li>"DebitUnPaid"</li><li>"DebitPartPaid"</li><li>"DebitFullyPaid"</li><li>"CreditPartUsed"</li><li>"CreditFullyUsed"</li><li>"CreditUnused"</li></ul>
cim_GetTransactionsSoapIn
<cim_GetTransactions xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>16460170-51b1-452f-b40a-50be4492d496</SessionID>
<AccountRef>123455</AccountRef>
<DocumentRef>GG8883</DocumentRef>
<transactions>
</transactions>
</cim_GetTransactions>
cim_GetTransactionsSoapOut
<cim_GetTransactionsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_GetTransactionsResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</cim_GetTransactionsResult>
<transactions>
<Items>
<CIMTransaction>
<AccountRef>string</AccountRef>
<Status>Unknown</Status>
<TimeStamp>dateTime</TimeStamp>
<DocumentRef>string</DocumentRef>
<Description>string</Description>
<GrossValue>decimal</GrossValue>
<Balance>decimal</Balance>
<SiteID>string</SiteID>
<BookRef>string</BookRef>
<PaymentDue>dateTime</PaymentDue>
</CIMTransaction>
<CIMTransaction>
<AccountRef>string</AccountRef>
<Status>Unknown</Status>
<TimeStamp>dateTime</TimeStamp>
<DocumentRef>string</DocumentRef>
<Description>string</Description>
<GrossValue>decimal</GrossValue>
<Balance>decimal</Balance>
<SiteID>string</SiteID>
<BookRef>string</BookRef>
<PaymentDue>dateTime</PaymentDue>
</CIMTransaction>
</Items>
</transactions>
</cim_GetTransactionsResponse>
This method provides the ability to add a payment onto a CIM account, if the Central Invoicing Module is enabled for the site.
The method also provides the option to allocate the payment to given invoices.
<div id="dvAddPayment">
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionId</td>
<td align="left">string</td>
<td align="left">Session ID</td>
</tr>
<tr class="evenRow">
<td align="left">AccountRef</td>
<td align="left">string</td>
<td align="left">Account reference</td>
</tr>
<tr class="oddRow">
<td align="left">PaymentCode</td>
<td align="left">string</td>
<td align="left">Payment code</td>
</tr>
<tr class="evenRow">
<td align="left">Value</td>
<td align="left">decimal</td>
<td align="left">Payment value</td>
</tr>
<tr class="oddRow">
<td align="left">Description</td>
<td align="left">string</td>
<td align="left">Description of payment</td>
</tr>
<tr class="evenRow">
<td align="left">ForDate</td>
<td align="left">dateTime</td>
<td align="left">Date of payment</td>
</tr>
<tr class="oddRow">
<td align="left">Allocate</td>
<td align="left">bool</td>
<td align="left">Flag to determine if the newly added payment would be allocated to any invoice</td>
</tr>
<tr class="evenRow">
<td align="left">Invoices</td>
<td align="left">(AllocateInvoiceDetails, see below)</td>
<td align="left">List of AllocateInvoiceDetails</td>
</tr>
</tbody>
</table>
<h3>Parameters (AllocateInvoiceDetails)</h3>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">DocumentRef</td>
<td align="left">string</td>
<td align="left">Invoice unique identifier</td>
</tr>
<tr class="evenRow">
<td align="left">Value</td>
<td align="left">decimal</td>
<td align="left">Invoice amount</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>None</li>
</ul>
</div>
cim_AddPaymentSoapIn
<cim_AddPayment xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>16460170-51b1-452f-b40a-50be4492d496</SessionID>
<AccountRef>12345</AccountRef>
<PaymentCode>VISA</PaymentCode>
<Value>120.00</Value>
<Description>balance due</Description>
<ForDate>2018-03-29T12:30:14.6042212+01:00</ForDate>
<Allocate>true</Allocate>
<Invoices>
<AllocateInvoiceDetails>
<DocumentRef>INV00001</DocumentRef>
<Value>100</Value>
</AllocateInvoiceDetails>
<AllocateInvoiceDetails>
<DocumentRef>INV00002</DocumentRef>
<Value>200</Value>
</AllocateInvoiceDetails>
</Invoices>
</cim_AddPayment>
cim_AddPaymentSoapOut
<cim_AddPaymentResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_AddPaymentResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</cim_AddPaymentResult>
</cim_AddPaymentResponse>
<p>Get the list of configured Media Source codes.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr></tbody></table><h2 class="">Returned data (Media Codes)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">MediaSourceCode</td><td align="left">string</td><td align="left">Media Source code</td></tr><tr class="evenRow"><td align="left">MediaSourceGroupCode</td><td align="left">string</td><td align="left">Media Source group code to which it belongs</td></tr><tr class="oddRow"><td align="left">StartDate</td><td align="left">dateTime</td><td align="left">Effective start date</td></tr><tr class="evenRow"><td align="left">EndDate</td><td align="left">dateTime</td><td align="left">Effective end date</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Description</td></tr></tbody></table>
pmscfg_GetMediaCodesSoapIn
<pmscfg_GetMediaCodes xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>655a013f-920f-4f8e-94dc-befe690370dd</SessionID>
</pmscfg_GetMediaCodes>
pmscfg_GetMediaCodesSoapOut
<pmscfg_GetMediaCodesResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscfg_GetMediaCodesResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmscfg_GetMediaCodesResult>
<MediaCodeList>
<MediaCodes>
<MediaCode>
<MediaSourceCode>AUTUMN_2013</MediaSourceCode>
<MediaSourceGroupCode>CAMPAIGNS</MediaSourceGroupCode>
<StartDate>2013-09-01T00:00:00</StartDate>
<EndDate>2013-11-30T00:00:00</EndDate>
<Description>Autumn 2013 Newsletter</Description>
</MediaCode>
<MediaCode>
<MediaSourceCode>BOOKINGCOM</MediaSourceCode>
<MediaSourceGroupCode>ONLINE</MediaSourceGroupCode>
<StartDate>2013-08-14T00:00:00</StartDate>
<EndDate>2023-12-31T00:00:00</EndDate>
<Description>Booking.com</Description>
</MediaCode>
<MediaCode>
<MediaSourceCode>BROCHURE</MediaSourceCode>
<MediaSourceGroupCode>GENERAL</MediaSourceGroupCode>
<StartDate>2002-02-02T00:00:00</StartDate>
<EndDate>2020-02-02T00:00:00</EndDate>
<Description>Brochure</Description>
</MediaCode>
<MediaCode>
<MediaSourceCode>FLOWER_SHOW</MediaSourceCode>
<MediaSourceGroupCode>CAMPAIGNS</MediaSourceGroupCode>
<StartDate>2013-01-01T00:00:00</StartDate>
<EndDate>2014-12-31T00:00:00</EndDate>
<Description>Flower Show</Description>
</MediaCode>
<MediaCode>
<MediaSourceCode>LATEROOMS</MediaSourceCode>
<MediaSourceGroupCode>ONLINE</MediaSourceGroupCode>
<StartDate>2013-08-14T00:00:00</StartDate>
<EndDate>2023-12-31T00:00:00</EndDate>
<Description>Laterooms</Description>
</MediaCode>
<MediaCode>
<MediaSourceCode>RECOMMEND</MediaSourceCode>
<MediaSourceGroupCode>GENERAL</MediaSourceGroupCode>
<StartDate>2002-02-02T00:00:00</StartDate>
<EndDate>2020-02-02T00:00:00</EndDate>
<Description>Recommendation</Description>
</MediaCode>
<MediaCode>
<MediaSourceCode>REPEAT</MediaSourceCode>
<MediaSourceGroupCode>GENERAL</MediaSourceGroupCode>
<StartDate>2002-02-02T00:00:00</StartDate>
<EndDate>2020-02-02T00:00:00</EndDate>
<Description>Regular and Repeat Business</Description>
</MediaCode>
<MediaCode>
<MediaSourceCode>SUMMER_2013</MediaSourceCode>
<MediaSourceGroupCode>CAMPAIGNS</MediaSourceGroupCode>
<StartDate>2013-06-01T00:00:00</StartDate>
<EndDate>2013-08-31T00:00:00</EndDate>
<Description>Summer 2013 Newsletter</Description>
</MediaCode>
<MediaCode>
<MediaSourceCode>TRINITY</MediaSourceCode>
<MediaSourceGroupCode>CONF_AGENTS</MediaSourceGroupCode>
<StartDate>2013-08-14T00:00:00</StartDate>
<EndDate>2023-12-31T00:00:00</EndDate>
<Description>Trinity Conferences</Description>
</MediaCode>
</MediaCodes>
</MediaCodeList>
</pmscfg_GetMediaCodesResponse>
<p><code>!restricted!</code> This method is <u>not</u> for general use.</p><p>Creates a link between a <strong>ResDairy</strong> restaurant table booking and a <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#Rezlynx%20PMS">Rezlynx PMS</a> reservation.</p><table><tbody><tr class="evenRow"><td align="left"><strong>Note</strong> This method is only applicable to sites where <strong>ResDiary</strong> is enabled.</td></tr></tbody></table><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">BookingList</td><td align="left">(object)</td><td align="center"></td></tr><tr class="oddRow"><td align="left">> Booking</td><td align="left">(object)</td><td align="center"></td></tr><tr class="evenRow"><td align="left">>> ResDiaryBooking</td><td align="left">(object)</td><td align="center"></td></tr><tr class="oddRow"><td align="left">>>> BookRef</td><td>string</td><td align="left">Rezlynx reservation reference</td></tr><tr class="evenRow"><td align="left">>>> RoomPickID</td><td align="left">int</td><td align="left">Rezlynx reservation room integer (1,2,...)</td></tr><tr class="oddRow"><td align="left">>>> FolioID</td><td align="left">int</td><td align="left">Rezlynx reservation folio integer (1,2,...)</td></tr><tr class="evenRow"><td align="left">>>> ResDiaryReference</td><td align="left">string</td><td align="left">ResDiary reference</td></tr><tr class="oddRow"><td align="left">>>> ProfileRef</td><td align="left">string</td><td align="left">Rezlynx guest profile reference</td></tr><tr class="evenRow"><td align="left">>>> MicrositeName</td><td align="left">string</td><td align="left">ResDiary microsite name</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsres_CreateResDiaryBookingSoapIn
<pmsres_CreateResDiaryBooking xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
<BookingList>
<Booking>
<ResDiaryBooking>
<BookRef>BK000052</BookRef>
<RoomPickID>1</RoomPickID>
<FolioID>1</FolioID>
<ResDiaryReference>ABCD1234</ResDiaryReference>
<ProfileRef>PF000024</ProfileRef>
<MicrositeName />
</ResDiaryBooking>
<ResDiaryBooking>
<BookRef>BK000048</BookRef>
<RoomPickID>1</RoomPickID>
<FolioID>1</FolioID>
<ResDiaryReference>ABCD5678</ResDiaryReference>
<ProfileRef>PF000025</ProfileRef>
<MicrositeName />
</ResDiaryBooking>
</Booking>
</BookingList>
</pmsres_CreateResDiaryBooking>
pmsres_CreateResDiaryBookingSoapOut
<pmsres_CreateResDiaryBookingResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsres_CreateResDiaryBookingResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsres_CreateResDiaryBookingResult>
</pmsres_CreateResDiaryBookingResponse>
<p>Provides the ability to add a reservation product to an existing booking. You can either use the value that has been configured for that product in the PMS or specify a value that will overwrite the normal price.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID obtained at log-in</td></tr><tr class="evenRow"><td align="left">UpsellItem</td><td align="left">(object)</td><td align="center"></td></tr><tr class="oddRow"><td align="left">> BookRef</td><td align="left">string</td><td align="left">Reservation reference</td></tr><tr class="evenRow"><td align="left">> RoomPickID</td><td align="left">int</td><td align="left">Room integer (1,2,...)</td></tr><tr class="oddRow"><td align="left">> ProductCode</td><td align="left">string</td><td align="left">Upsell product code</td></tr><tr class="evenRow"><td align="left">> Value</td><td align="left">decimal</td><td align="left">Upsell value</td></tr><tr class="oddRow"><td align="left">> Quantity</td><td align="left">int</td><td align="left">Quantity, if applicable</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsres_AddReservationUpsellSoapIn
<pmsres_AddReservationUpsell xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
<UpsellItem>
<BookRef>BK000052</BookRef>
<RoomPickID>1</RoomPickID>
<ProductCode>PAMPER1</ProductCode>
<Value>99.00</Value>
<Quantity>1</Quantity>
</UpsellItem>
</pmsres_AddReservationUpsell>
pmsres_AddReservationUpsellSoapOut
<pmsres_AddReservationUpsellResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsres_AddReservationUpsellResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsres_AddReservationUpsellResult>
</pmsres_AddReservationUpsellResponse>
<p>Create a guest feedback entry for a given guest profile. The feedback entry can be linked to a reservation (PMS bedroom booking, function booking, conference event or CRS reservation) and can be tagged with parameters such as type, severity and priority.</p><h4>Parameters</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">ProfileRef</td><td align="left">string</td><td align="left">Profile reference</td></tr><tr class="oddRow"><td align="left">LinkedTo</td><td align="left">"None", "Bedroom", "EntryLevelCNB", "AdvCNB" or "CRS"</td><td align="left">Type of reservation this feedback entry is linked to</td></tr><tr class="evenRow"><td align="left">LinkRef</td><td align="left">string</td><td align="left">Reservation reference</td></tr><tr class="oddRow"><td align="left">LinkSubRef</td><td align="left">int</td><td align="left">Reservation sub-reference, if applicable</td></tr><tr class="evenRow"><td align="left">Type</td><td align="left">"Complaint", "Positive" or "Suggestion"</td><td align="left">Type of feedback (optional)</td></tr><tr class="oddRow"><td align="left">Priority</td><td align="left">int</td><td align="left">Priority number 1 to 10 (optional)</td></tr><tr class="evenRow"><td align="left">Description</td><td align="left">string</td><td align="left">Free text description of the feedback comment</td></tr><tr class="oddRow"><td align="left">Severity</td><td align="left">"None", "VerySerious", "Serious", "Reasonable" or "UnActionable"</td><td align="left">Severity rating (optional)</td></tr></tbody></table><h4>Returned data</h4><ul><li>None</li></ul>
pmsprf_CreateProfileFeedBackSoapIn
<pmsprf_CreateProfileFeedBack xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>e3acd937-568a-4276-8552-7a064207fc7c</SessionID>
<ProfileRef>PF000079</ProfileRef>
<LinkedTo>Bedroom</LinkedTo>
<LinkRef>BK000001</LinkRef>
<LinkSubRef>1</LinkSubRef>
<Type>Suggestion</Type>
<Priority>5</Priority>
<Description>Lovely stay, but we would prefer running water in the bathroom</Description>
<Severity>None</Severity>
</pmsprf_CreateProfileFeedBack>
pmsprf_CreateProfileFeedBackSoapOut
<pmsprf_CreateProfileFeedBackResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_CreateProfileFeedBackResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprf_CreateProfileFeedBackResult>
</pmsprf_CreateProfileFeedBackResponse>
<p>This method can be used to link a pre-existing guest profile to a reservation.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking or reservation reference</td></tr><tr class="oddRow"><td align="left">RoomPickID</td><td align="left">int</td><td align="left">Integer indicating which of a multi-room reservation this is (1,2,3,...)</td></tr><tr class="evenRow"><td align="left">ProfileRef</td><td align="left">string</td><td align="left">Profile reference</td></tr><tr class="oddRow"><td align="left">FolioID</td><td align="left">int</td><td align="left">Integer indicating which guest of a multi-folio reservation this is (1,2,3,...)</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsres_LinkProfileSoapIn
<pmsres_LinkProfile xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<BookRef>BK000039</BookRef>
<RoomPickID>1</RoomPickID>
<ProfileRef>PF000024</ProfileRef>
<FolioID>1</FolioID>
</pmsres_LinkProfile>
pmsres_LinkProfileSoapOut
<pmsres_LinkProfileResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsres_LinkProfileResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No errors</ExceptionDescription>
</pmsres_LinkProfileResult>
</pmsres_LinkProfileResponse>
<p>This is the authentication method used to log in to create an API session. All subsequent methods require the <code>SessionID</code> parameter which is obtained in response to this <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#LogIn">LogIn</a> method, if successful.</p><h2 class="">Authentication</h2><p>Authentication is on the basis of <code>Site ID</code>, <code>OperatorCode</code>, <code>InterfaceID</code> and <code>Password</code>. These credentials will be supplied by your Guestline representative. Note that as a further security measure, only certain API methods will be available, based on your InterfaceID.</p><h2 class="">Session management</h2><p>The session expires after a period of inactivity, in which case it will be necessary to log in again and create a new session. An expired session can be identified by return code 7007 - see <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#List%20of%20error%20codes">List of error codes</a>.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SiteID</td><td>string</td><td align="left">indicates the customer site to be accessed</td></tr><tr class="evenRow"><td align="left">InterfaceID</td><td align="left">int</td><td align="left">identifies the external system accessing the API</td></tr><tr class="oddRow"><td align="left">OperatorCode</td><td align="left">string</td><td align="left">account username</td></tr><tr class="evenRow"><td align="left">Password</td><td align="left">string</td><td align="left">account password</td></tr></tbody></table><h2 class="">Returned data</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID used for all subsequent methods</td></tr></tbody></table>
LogInSoapIn
<LogIn xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SiteID>HEADLAMT</SiteID>
<InterfaceID>355</InterfaceID>
<OperatorCode>CUSTALLIANCE</OperatorCode>
<Password>w%/HUxl0M%xS7Qfv@tTOeX+@f</Password>
</LogIn>
LogInSoapOut
<LogInResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<LogInResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</LogInResult>
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
</LogInResponse>
<p>This method is used to close an API session.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID returned from <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#LogIn">LogIn</a></td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>none</li></ul>
LogOutSoapIn
<LogOut xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
</LogOut>
LogOutSoapOut
<LogOutResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<LogOutResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</LogOutResult>
</LogOutResponse>
<p>This method instructs the Rezlynx system to send out a profile password email to the owner of the profile, i.e. the person with the given email address. The email is based on a template configured in the PMS.</p><p><strong>Note</strong> the profile must be <u>unique</u>, i.e. the method will fail if there is more than one profile sharing the same email address. Uniqueness cannot be guaranteed in the system.</p><h4>Parameters</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">strEmail</td><td align="left">string</td><td align="left">-</td></tr><tr class="oddRow"><td align="left">EmailAddress</td><td align="left">string</td><td align="left">Person's email address, as stored in the profile</td></tr></tbody></table>
pmsprf_SendProfilePasswordSoapIn
<pmsint_SendProfilePassword xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<EmailAddress>george.strange@guestline.com</EmailAddress>
</pmsint_SendProfilePassword>
pmsprf_SendProfilePasswordSoapOut
<pmsint_SendProfilePassword xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<EmailAddress>george.strange@guestline.com</EmailAddress>
</pmsint_SendProfilePassword>
<p><code>!restricted!</code> This method is <u>not</u> for general use.</p><p>Cancel a reservation.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">strBookRef</td><td align="left">string</td><td align="left">Reservation reference</td></tr><tr class="oddRow"><td align="left">strProfileRef</td><td align="left">string</td><td align="left">Profile reference</td></tr><tr class="evenRow"><td align="left">strPassword</td><td align="left">string</td><td align="left">Password</td></tr></tbody></table><h2 class="">Returned data</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">CancelReference</td><td align="left">string</td><td align="center"></td></tr></tbody></table>
pmsres_CancelReservationSoapIn
<pmsres_CancelReservation xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
<strBookRef>string</strBookRef>
<strProfileRef>string</strProfileRef>
<strPassword>string</strPassword>
<CancelReservation>
<CancelReference>string</CancelReference>
</CancelReservation>
</pmsres_CancelReservation>
pmsres_CancelReservationSoapOut
<pmsres_CancelReservationResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsres_CancelReservationResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsres_CancelReservationResult>
<CancelReservation>
<CancelReference>string</CancelReference>
</CancelReservation>
</pmsres_CancelReservationResponse>
<p><code>!restricted!</code> This method is <u>not</u> for general use.</p><p>Create a new reservation.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">ProfileRef</td><td align="left">string</td><td align="left">Profile reference</td></tr><tr class="oddRow"><td align="left">ArrivalDate</td><td align="left">dateTime</td><td align="left">Arrival date</td></tr><tr class="evenRow"><td align="left">DepartureDate</td><td align="left">dateTime</td><td align="left">Departue date</td></tr><tr class="oddRow"><td align="left">PackageCode</td><td align="left">string</td><td align="left">Package code, if applicable</td></tr><tr class="evenRow"><td align="left">RoomTypeCode</td><td align="left">string</td><td align="left">Room type code</td></tr><tr class="oddRow"><td align="left">NumAdults</td><td align="left">int</td><td align="left">Number of adults</td></tr><tr class="evenRow"><td align="left">NumChildren</td><td align="left">int</td><td align="left">Number of children</td></tr><tr class="oddRow"><td align="left">NumInfants</td><td align="left">int</td><td align="left">Number of infants</td></tr><tr class="evenRow"><td align="left">ECommAuthCode</td><td align="left">string</td><td align="left">eCommerce authorisation code</td></tr><tr class="oddRow"><td align="left">ECommPrePaidDepositValue</td><td align="left">decimal</td><td align="left">eCommerce pre-paid deposit value</td></tr><tr class="evenRow"><td align="left">ECommPrePaidDepositPayType</td><td align="left">string</td><td align="left">eCommerce pre-paid deposit pay type code</td></tr><tr class="oddRow"><td align="left">ConfEmailTemplate</td><td align="left">string</td><td align="left">Confirmation email template</td></tr><tr class="evenRow"><td align="left">BookingStatus</td><td align="left">int</td><td align="left">Booking status code</td></tr><tr class="oddRow"><td align="left">UpSellProducts</td><td align="left">(object)</td><td align="center"></td></tr><tr class="evenRow"><td align="left">> cpmsres_ReservationProduct</td><td align="left">(object)</td><td align="center"></td></tr><tr class="oddRow"><td align="left">>> ProductCode</td><td align="left">string</td><td align="left">Product code</td></tr><tr class="evenRow"><td align="left">>> ForFolioId</td><td align="left">int</td><td align="left">Folio ID</td></tr><tr class="oddRow"><td align="left">>> Quantity</td><td align="left">float</td><td align="left">Quantity</td></tr><tr class="evenRow"><td align="left">>> NettValueEach</td><td align="left">decimal</td><td align="left">Net value</td></tr><tr class="oddRow"><td align="left">>> ChargeModeOverride</td><td align="left">"NoOverride", "PerRoom", "PerPerson", "PerAdult", "PerChild", "PerInfant" or "SingleCharge"</td><td align="left">Charge mode override</td></tr><tr class="evenRow"><td align="left">>> PostingModeOverride</td><td align="left">"NoOverride", "PostEveryBlock" or "PostOnArrivalBlock"</td><td align="center"></td></tr><tr class="oddRow"><td align="left">MediaCode</td><td align="left">string</td><td align="left">Posting mode override</td></tr></tbody></table><h2 class="">Returned data</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">BookRefRoomRef</td><td align="left">string</td><td align="left">Full format reservation reference</td></tr></tbody></table>
pmsres_CreateReservationV2SoapIn
<pmsres_CreateReservationV2 xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
<ProfileRef>string</ProfileRef>
<ArrivalDate>dateTime</ArrivalDate>
<DepartureDate>dateTime</DepartureDate>
<PackageCode>string</PackageCode>
<RoomTypeCode>string</RoomTypeCode>
<NumAdults>int</NumAdults>
<NumChildren>int</NumChildren>
<NumInfants>int</NumInfants>
<ECommAuthCode>string</ECommAuthCode>
<ECommPrePaidDepositValue>decimal</ECommPrePaidDepositValue>
<ECommPrePaidDepositPayType>string</ECommPrePaidDepositPayType>
<ConfEmailTemplate>string</ConfEmailTemplate>
<BookingStatus>int</BookingStatus>
<UpSellProducts>
<cpmsres_ReservationProduct>
<ProductCode>string</ProductCode>
<ForFolioId>int</ForFolioId>
<Quantity>float</Quantity>
<NettValueEach>decimal</NettValueEach>
<ChargeModeOverride>NoOverride or PerRoom or PerPerson or PerAdult or PerChild or PerInfant or SingleCharge</ChargeModeOverride>
<PostingModeOverride>NoOverride or PostEveryBlock or PostOnArrivalBlock</PostingModeOverride>
</cpmsres_ReservationProduct>
<cpmsres_ReservationProduct>
<ProductCode>string</ProductCode>
<ForFolioId>int</ForFolioId>
<Quantity>float</Quantity>
<NettValueEach>decimal</NettValueEach>
<ChargeModeOverride>NoOverride or PerRoom or PerPerson or PerAdult or PerChild or PerInfant or SingleCharge</ChargeModeOverride>
<PostingModeOverride>NoOverride or PostEveryBlock or PostOnArrivalBlock</PostingModeOverride>
</cpmsres_ReservationProduct>
</UpSellProducts>
<MediaCode>string</MediaCode>
<CreateReservation>
<BookRefRoomRef>string</BookRefRoomRef>
</CreateReservation>
</pmsres_CreateReservationV2>
pmsres_CreateReservationV2SoapOut
<pmsres_CreateReservationV2Response xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsres_CreateReservationV2Result>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsres_CreateReservationV2Result>
<CreateReservation>
<BookRefRoomRef>BK000052/1</BookRefRoomRef>
</CreateReservation>
</pmsres_CreateReservationV2Response>
<p>Returns the list of available and eligible rooms from which to allocate a room to the given reservation.</p>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID, obtained at log-in</td>
</tr>
<tr class="evenRow">
<td align="left">BookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference (long-form)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data (room item)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">RoomId</td>
<td align="left">string</td>
<td align="left">Room reference (room name or number)</td>
</tr>
<tr class="evenRow">
<td align="left">RoomTypeCode</td>
<td align="left">string</td>
<td align="left">Room type code</td>
</tr>
<tr class="oddRow">
<td align="left">RoomDescription</td>
<td align="left">string</td>
<td align="left">Room description</td>
</tr>
<tr class="evenRow">
<td align="left">SubGroupCode</td>
<td align="left">string</td>
<td align="left">Room sub-group</td>
</tr>
</tbody>
</table>
pmsfoh_GetAllocationRoomListSoapIn
<pmsfoh_GetAllocationRoomList xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>639c76f8-7280-4858-a8e1-e5b809cf63db</SessionID>
<BookRef>BK000054/1</BookRef>
<AllocatableList />
</pmsfoh_GetAllocationRoomList>
pmsfoh_GetAllocationRoomListSoapOut
<pmsfoh_GetAllocationRoomListResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsfoh_GetAllocationRoomListResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsfoh_GetAllocationRoomListResult>
<AllocatableList>
<Items>
<RoomSummaryShortItem>
<RoomId>105</RoomId>
<RoomTypeCode>DBL_STANDARD</RoomTypeCode>
<RoomDescription>Sunflower Room</RoomDescription>
<SubGroupCode>SUNFLOWER</SubGroupCode>
</RoomSummaryShortItem>
<RoomSummaryShortItem>
<RoomId>106</RoomId>
<RoomTypeCode>DBL_STANDARD</RoomTypeCode>
<RoomDescription>Tulip Room</RoomDescription>
<SubGroupCode>TULIP</SubGroupCode>
</RoomSummaryShortItem>
<RoomSummaryShortItem>
<RoomId>110</RoomId>
<RoomTypeCode>DBL_STANDARD</RoomTypeCode>
<RoomDescription>Standard Double</RoomDescription>
<SubGroupCode>DAISY</SubGroupCode>
</RoomSummaryShortItem>
</Items>
</AllocatableList>
</pmsfoh_GetAllocationRoomListResponse>
<p>Add a deposit to an existing reservation.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID obtained at log-in</td></tr><tr class="evenRow"><td align="left">BookRefRoomRef</td><td align="left">string</td><td align="left">Full format reservation reference (e.g. BK000052/1)</td></tr><tr class="oddRow"><td align="left">PaymentCode</td><td align="left">string</td><td align="left">Payment type code</td></tr><tr class="evenRow"><td align="left">Value</td><td align="left">decimal</td><td align="left">Deposit value</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsres_ReservationRoomAddDepositSoapIn
<pmsres_ReservationRoomAddDeposit xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
<BookRefRoomRef>BK000052/1</BookRefRoomRef>
<PaymentCode>VISA</PaymentCode>
<Value>99.00</Value>
</pmsres_ReservationRoomAddDeposit>
pmsres_ReservationRoomAddDepositSoapOut
<pmsres_ReservationRoomAddDepositResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsres_ReservationRoomAddDepositResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsres_ReservationRoomAddDepositResult>
</pmsres_ReservationRoomAddDepositResponse>
<p>This method will fetch a summary of profile information for a given profile, along with summary information about all reservations relating to that profile. This can be filtered for past, present or future bookings.</p><table><tbody><tr class="evenRow"><td align="left"><strong>Shared profiles</strong> Note that in the case of a profile shared at the group level, any reservations related to it when using this endpoint will only be for the site you are logged into on the web service.</td></tr></tbody></table><table><tbody><tr class="evenRow"><td align="left"><strong>Profile requestor authentication</strong> Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them.</td></tr></tbody></table><h4>Parameters</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">ProfileRequestor</td><td align="left">(object)</td><td align="center"></td></tr><tr class="oddRow"><td align="left">> ProfileUniqueId</td><td align="left">string</td><td align="left">Unique profile ID, must be either a profile reference, unique email address or loyalty ID</td></tr><tr class="evenRow"><td align="left">> ProfileUniqueIdAuthenticatorValue</td><td align="left">string</td><td align="left">The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below</td></tr><tr class="oddRow"><td align="left">> AuthenticationMethod</td><td align="left">"PD"</td><td align="left">"PD" stands for "Person Details" and should always be set to this</td></tr><tr class="evenRow"><td align="left">> AuthenticationCode</td><td align="left">string</td><td align="left">The method of second line authentication to be used i.e. "Forename", "Surname" or "PostCode"</td></tr><tr class="oddRow"><td align="left">> AuthenticationValue</td><td align="left">string</td><td align="left">The authentication value, e.g. if the method is "Surname" and the profile is under the name of "Jones" then the value will be "Jones", if the method is "PostCode" then the value will be "SY26LG"</td></tr><tr class="evenRow"><td align="left">Filters</td><td align="left">"C", "R" or "F"</td><td align="left">Optional filter to filter results according to the reservation status (C = Checked out, R = Resident, F = Future, i.e. pre-arrival)</td></tr><tr class="oddRow"><td align="left">ProfileSearchMode</td><td align="left">"Contact", "Guest" or "Both"</td><td align="left">Profile search mode</td></tr></tbody></table><h4>Returned data (reservation summary)</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking or reservation reference</td></tr><tr class="evenRow"><td align="left">RoomPickId</td><td align="left">int</td><td align="left">Room pick integer, if part of a multi-room reservation (1,2,3,...)</td></tr><tr class="oddRow"><td align="left">GroupRef</td><td align="left">string</td><td align="left">Group reference, if applicable</td></tr><tr class="evenRow"><td align="left">PORef</td><td align="left">string</td><td align="left">PO reference</td></tr><tr class="oddRow"><td align="left">BookingStatus</td><td align="left">int</td><td align="left">Booking status code (see below)</td></tr><tr class="evenRow"><td align="left">DateArrive</td><td align="left">dateTime</td><td align="left">Arrival date-time (start of reservation)</td></tr><tr class="oddRow"><td align="left">DateDepart</td><td align="left">dateTime</td><td align="left">Departure date-time (end of reservation)</td></tr><tr class="evenRow"><td align="left">Adults</td><td align="left">int</td><td align="left">Number of adults</td></tr><tr class="oddRow"><td align="left">Children</td><td align="left">int</td><td align="left">Number of children</td></tr><tr class="evenRow"><td align="left">Infants</td><td align="left">int</td><td align="left">Number of infants</td></tr><tr class="oddRow"><td align="left">RoomTypeCode</td><td align="left">string</td><td align="left">Room type code</td></tr><tr class="evenRow"><td align="left">PackageCode</td><td align="left">string</td><td align="left">Package code</td></tr><tr class="oddRow"><td align="left">CompanyRef</td><td align="left">string</td><td align="left">Company reference, if applicable</td></tr><tr class="evenRow"><td align="left">BookerTitle</td><td align="left">string</td><td align="left">Booker title</td></tr><tr class="oddRow"><td align="left">BookerSurname</td><td align="left">string</td><td align="left">Booker surname</td></tr><tr class="evenRow"><td align="left">BookerForename</td><td align="left">string</td><td align="left">Booker forename</td></tr><tr class="oddRow"><td align="left">PrimaryGuestTitle</td><td align="left">string</td><td align="left">Primary guest title</td></tr><tr class="evenRow"><td align="left">PrimaryGuestSurname</td><td align="left">string</td><td align="left">Primary guest surname</td></tr><tr class="oddRow"><td align="left">PrimaryGuestForename</td><td align="left">string</td><td align="left">Primary guest forename</td></tr><tr class="evenRow"><td align="left">PrimaryGuestPackageCode</td><td align="left">string</td><td align="left">Primary guest package code</td></tr><tr class="oddRow"><td align="left">CreatedTimestamp</td><td align="left">dateTime</td><td align="left">Date-time reservation was created</td></tr><tr class="evenRow"><td align="left">EditTimestamp</td><td align="left">dateTime</td><td align="left">Date-time reservation was last edited</td></tr><tr class="oddRow"><td align="left">DepositPaid</td><td align="left">decimal</td><td align="left">Deposit value (paid)</td></tr><tr class="evenRow"><td align="left">DepositDue</td><td align="left">decimal</td><td align="left">Deposit value (due)</td></tr><tr class="oddRow"><td align="left">RoomId</td><td align="left">string</td><td align="left">Room name or number</td></tr><tr class="evenRow"><td align="left">Charge1stNight</td><td align="left">decimal</td><td align="left">Gross value of charge (first night of stay)</td></tr><tr class="oddRow"><td align="left">Charge1stNightNett</td><td align="left">decimal</td><td align="left">Nett value of charge (first night of stay)</td></tr><tr class="evenRow"><td align="left">ChargeTotal</td><td align="left">decimal</td><td align="left">Gross total charge for stay</td></tr><tr class="oddRow"><td align="left">ChargeTotalNett</td><td align="left">decimal</td><td align="left">Nett total charge for stay</td></tr><tr class="evenRow"><td align="left">BookingType</td><td align="left">"Bedroom", "Function" or "Nra"</td><td align="left">Booking type (bedroom, function room or non-resident acount)</td></tr></tbody></table><h4>Booking status codes</h4><table><tbody><tr class="evenRow"><th align="left">Code</th><th align="left">Meaning</th></tr><tr class="oddRow"><td align="left">1-12</td><td align="left">Pre-arrival</td></tr><tr class="evenRow"><td align="left">102</td><td align="left">Cancelled</td></tr><tr class="oddRow"><td align="left">103</td><td align="left">Resident</td></tr><tr class="evenRow"><td align="left">104</td><td align="left">Checked out</td></tr></tbody></table>
pmsprf_GetProfileSummaryWithStaysSoapIn
<pmsprf_GetProfileSummaryWithStays xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>624337e5-e564-4278-bfbd-d25d234f3a98</SessionID>
<ProfileRequestor>
<ProfileUniqueId>PF00499</ProfileUniqueId>
<ProfileUniqueIdAuthenticatorValue />
<AuthenticationMethod>PD</AuthenticationMethod>
<AuthenticationCode>Surname</AuthenticationCode>
<AuthenticationValue>Williams</AuthenticationValue>
</ProfileRequestor>
<Filters>F</Filters>
</pmsprf_GetProfileSummaryWithStays>
pmsprf_GetProfileSummaryWithStaysSoapOut
<pmsprf_GetProfileSummaryWithStaysResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_GetProfileSummaryWithStaysResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprf_GetProfileSummaryWithStaysResult>
<ProfileSummaryWithStays>
<Salutation>Miss</Salutation>
<Forename>Megan</Forename>
<Surname>Williams</Surname>
<EMailAddress>megan.williams@guestline.com</EMailAddress>
<Reservations>
<ReservationSummaryItem>
<BookRef>BK00014</BookRef>
<RoomPickId>1</RoomPickId>
<GroupRef />
<PORef />
<BookingStatus>3</BookingStatus>
<DateArrive>2016-06-30T00:00:00</DateArrive>
<DateDepart>2016-07-01T00:00:00</DateDepart>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
<RoomTypeCode>DOUBLE</RoomTypeCode>
<PackageCode>FLEX_BB</PackageCode>
<CompanyRef />
<BookerTitle>Miss</BookerTitle>
<BookerSurname>Williams</BookerSurname>
<BookerForename>Megan</BookerForename>
<PrimaryGuestTitle>Miss</PrimaryGuestTitle>
<PrimaryGuestSurname>Williams</PrimaryGuestSurname>
<PrimaryGuestForename>Megan</PrimaryGuestForename>
<PrimaryGuestPackageCode>FLEX_BB</PrimaryGuestPackageCode>
<CreatedTimestamp>2016-06-16T16:28:36</CreatedTimestamp>
<EditTimestamp>0001-01-01T00:00:00</EditTimestamp>
<DepositPaid>0.0000</DepositPaid>
<DepositDue>0.0000</DepositDue>
<RoomId>18</RoomId>
<Charge1stNight>120.0000</Charge1stNight>
<Charge1stNightNett>0</Charge1stNightNett>
<ChargeTotal>120.0000</ChargeTotal>
<ChargeTotalNett>0</ChargeTotalNett>
</ReservationSummaryItem>
<ReservationSummaryItem>
<BookRef>BK00015</BookRef>
<RoomPickId>1</RoomPickId>
<GroupRef />
<PORef />
<BookingStatus>3</BookingStatus>
<DateArrive>2016-06-30T00:00:00</DateArrive>
<DateDepart>2016-07-01T00:00:00</DateDepart>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
<RoomTypeCode>DOUBLE</RoomTypeCode>
<PackageCode>FLEX_BB</PackageCode>
<CompanyRef />
<BookerTitle>Miss</BookerTitle>
<BookerSurname>Williams</BookerSurname>
<BookerForename>Megan</BookerForename>
<PrimaryGuestTitle>Miss</PrimaryGuestTitle>
<PrimaryGuestSurname>Williams</PrimaryGuestSurname>
<PrimaryGuestForename>Megan</PrimaryGuestForename>
<PrimaryGuestPackageCode>FLEX_BB</PrimaryGuestPackageCode>
<CreatedTimestamp>2016-06-16T16:52:32</CreatedTimestamp>
<EditTimestamp>0001-01-01T00:00:00</EditTimestamp>
<DepositPaid>0.0000</DepositPaid>
<DepositDue>0.0000</DepositDue>
<RoomId>1</RoomId>
<Charge1stNight>120.0000</Charge1stNight>
<Charge1stNightNett>0</Charge1stNightNett>
<ChargeTotal>120.0000</ChargeTotal>
<ChargeTotalNett>0</ChargeTotalNett>
</ReservationSummaryItem>
<ReservationSummaryItem>
<BookRef>BK00016</BookRef>
<RoomPickId>1</RoomPickId>
<GroupRef />
<PORef />
<BookingStatus>3</BookingStatus>
<DateArrive>2016-06-30T00:00:00</DateArrive>
<DateDepart>2016-07-01T00:00:00</DateDepart>
<Adults>1</Adults>
<Children>0</Children>
<Infants>0</Infants>
<RoomTypeCode>DOUBLE</RoomTypeCode>
<PackageCode>FLEX_BB</PackageCode>
<CompanyRef />
<BookerTitle>Miss</BookerTitle>
<BookerSurname>Williams</BookerSurname>
<BookerForename>Megan</BookerForename>
<PrimaryGuestTitle>Miss</PrimaryGuestTitle>
<PrimaryGuestSurname>Williams</PrimaryGuestSurname>
<PrimaryGuestForename>Megan</PrimaryGuestForename>
<PrimaryGuestPackageCode>FLEX_BB</PrimaryGuestPackageCode>
<CreatedTimestamp>2016-06-16T17:00:34</CreatedTimestamp>
<EditTimestamp>0001-01-01T00:00:00</EditTimestamp>
<DepositPaid>0.0000</DepositPaid>
<DepositDue>0.0000</DepositDue>
<RoomId>12</RoomId>
<Charge1stNight>130.0000</Charge1stNight>
<Charge1stNightNett>0</Charge1stNightNett>
<ChargeTotal>130.0000</ChargeTotal>
<ChargeTotalNett>0</ChargeTotalNett>
</ReservationSummaryItem>
<ReservationSummaryItem>
<BookRef>BK00017</BookRef>
<RoomPickId>1</RoomPickId>
<GroupRef />
<PORef />
<BookingStatus>3</BookingStatus>
<DateArrive>2016-06-30T00:00:00</DateArrive>
<DateDepart>2016-07-01T00:00:00</DateDepart>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
<RoomTypeCode>DOUBLE</RoomTypeCode>
<PackageCode>FLEX_BB</PackageCode>
<CompanyRef />
<BookerTitle>Miss</BookerTitle>
<BookerSurname>Williams</BookerSurname>
<BookerForename>Megan</BookerForename>
<PrimaryGuestTitle>Miss</PrimaryGuestTitle>
<PrimaryGuestSurname>Williams</PrimaryGuestSurname>
<PrimaryGuestForename>Megan</PrimaryGuestForename>
<PrimaryGuestPackageCode>FLEX_BB</PrimaryGuestPackageCode>
<CreatedTimestamp>2016-06-16T17:02:33</CreatedTimestamp>
<EditTimestamp>0001-01-01T00:00:00</EditTimestamp>
<DepositPaid>0.0000</DepositPaid>
<DepositDue>0.0000</DepositDue>
<RoomId>15</RoomId>
<Charge1stNight>120.0000</Charge1stNight>
<Charge1stNightNett>0</Charge1stNightNett>
<ChargeTotal>120.0000</ChargeTotal>
<ChargeTotalNett>0</ChargeTotalNett>
</ReservationSummaryItem>
<ReservationSummaryItem>
<BookRef>BK00018</BookRef>
<RoomPickId>1</RoomPickId>
<GroupRef />
<PORef />
<BookingStatus>1</BookingStatus>
<DateArrive>2016-08-24T00:00:00</DateArrive>
<DateDepart>2016-08-28T00:00:00</DateDepart>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
<RoomTypeCode>DOUBLE</RoomTypeCode>
<PackageCode>FLEX_BB</PackageCode>
<CompanyRef />
<BookerTitle>Miss</BookerTitle>
<BookerSurname>Williams</BookerSurname>
<BookerForename>Megan</BookerForename>
<PrimaryGuestTitle>Miss</PrimaryGuestTitle>
<PrimaryGuestSurname>Williams</PrimaryGuestSurname>
<PrimaryGuestForename>Megan</PrimaryGuestForename>
<PrimaryGuestPackageCode>FLEX_BB</PrimaryGuestPackageCode>
<CreatedTimestamp>2016-08-24T15:39:21</CreatedTimestamp>
<EditTimestamp>0001-01-01T00:00:00</EditTimestamp>
<DepositPaid>0.0000</DepositPaid>
<DepositDue>0.0000</DepositDue>
<RoomId />
<Charge1stNight>120.0000</Charge1stNight>
<Charge1stNightNett>0</Charge1stNightNett>
<ChargeTotal>480.0000</ChargeTotal>
<ChargeTotalNett>0</ChargeTotalNett>
</ReservationSummaryItem>
</Reservations>
</ProfileSummaryWithStays>
</pmsprf_GetProfileSummaryWithStaysResponse>
<p>Allocate a room to a reservation.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID obtained at log-in</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Reservation reference</td></tr><tr class="oddRow"><td align="left">RoomId</td><td align="left">string</td><td align="left">Room reference (room number or name)</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsres_ReservationRoomAllocationSoapIn
<pmsres_ReservationRoomAllocation xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
<BookRef>BK000052</BookRef>
<RoomId>102</RoomId>
</pmsres_ReservationRoomAllocation>
pmsres_ReservationRoomAllocationSoapOut
<pmsres_ReservationRoomAllocationResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsres_ReservationRoomAllocationResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsres_ReservationRoomAllocationResult>
</pmsres_ReservationRoomAllocationResponse>
<p>Un-allocate the allocated room from a reservation.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID obtained at log-in</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Reservation reference</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsres_ReservationRoomUnAllocateSoapIn
<pmsres_ReservationRoomUnAllocate xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
<BookRef>BK000052</BookRef>
</pmsres_ReservationRoomUnAllocate>
pmsres_ReservationRoomUnAllocateSoapOut
<pmsres_ReservationRoomUnAllocateResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsres_ReservationRoomUnAllocateResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsres_ReservationRoomUnAllocateResult>
</pmsres_ReservationRoomUnAllocateResponse>
<p>Check-in a room. Note that a room can only be checked-in if it meets all the necessary criteria, including the current day matching the reservation arrival date and the physical room having been allocated to a reservation.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking or reservation reference</td></tr><tr class="oddRow"><td align="left">AutoAddCheckInProducts</td><td align="left">boolean</td><td align="left">Flag to indicate if check-in product upgrades should be added automatically</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsbkg_CheckInSoapIn
<pmsbkg_CheckIn xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<BookRef>BK000052</BookRef>
<AutoAddCheckInProducts>false</AutoAddCheckInProducts>
</pmsbkg_CheckIn>
pmsbkg_CheckInSoapOut
<pmsbkg_CheckInResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_CheckInResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsbkg_CheckInResult>
</pmsbkg_CheckInResponse>
<p>Creates a new person profile, with the given details.</p>
<h4>Parameters</h4>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID, obtained at log-in</td>
</tr>
<tr class="evenRow">
<td align="left">Salutation</td>
<td align="left">string</td>
<td align="left">Title, e.g. "Mr"</td>
</tr>
<tr class="oddRow">
<td align="left">Forename</td>
<td align="left">string</td>
<td align="left">Forename</td>
</tr>
<tr class="evenRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Surname</td>
</tr>
<tr class="oddRow">
<td align="left">DateOfBirth</td>
<td align="left">dateTime</td>
<td align="left">Date of birth</td>
</tr>
<tr class="evenRow">
<td align="left">Email</td>
<td align="left">string</td>
<td align="left">Email address</td>
</tr>
<tr class="oddRow">
<td align="left">Gender</td>
<td align="left">string</td>
<td align="left">Gender and type of person (adult / child / infant), see below</td>
</tr>
<tr class="evenRow">
<td align="left">StreetAddress</td>
<td align="left">string</td>
<td align="left">Address street</td>
</tr>
<tr class="oddRow">
<td align="left">AreaAddress</td>
<td align="left">string</td>
<td align="left">Address area</td>
</tr>
<tr class="evenRow">
<td align="left">Town</td>
<td align="left">string</td>
<td align="left">Address town or city</td>
</tr>
<tr class="oddRow">
<td align="left">Postcode</td>
<td align="left">string</td>
<td align="left">Address postcode or zipcode</td>
</tr>
<tr class="evenRow">
<td align="left">County</td>
<td align="left">string</td>
<td align="left">Address county or state</td>
</tr>
<tr class="oddRow">
<td align="left">Country</td>
<td align="left">string</td>
<td align="left">Address country</td>
</tr>
<tr class="evenRow">
<td align="left">TelNumber</td>
<td align="left">string</td>
<td align="left">Telephone number</td>
</tr>
<tr class="oddRow">
<td align="left">MobileNumber</td>
<td align="left">string</td>
<td align="left">Mobile number</td>
</tr>
<tr class="evenRow">
<td align="left">FaxNumber</td>
<td align="left">string</td>
<td align="left">Fax number</td>
</tr>
<tr class="oddRow">
<td align="left">Nationality</td>
<td align="left">string</td>
<td align="left">Nationality</td>
</tr>
<tr class="evenRow">
<td align="left">Language</td>
<td align="left">string</td>
<td align="left">Language</td>
</tr>
<tr class="oddRow">
<td align="left">Password</td>
<td align="left">string</td>
<td align="left">Password to access the profile</td>
</tr>
<tr class="evenRow">
<td align="left">MarketingOptIn</td>
<td align="left">int</td>
<td align="left">Marketing mailing preference (0 = false, 1 = true, i.e. yes opt-in to marketing)</td>
</tr>
<tr class="oddRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">LoyaltyId</td>
<td align="left">string</td>
<td align="left">Loyalty ID, if applicable</td>
</tr>
<tr class="oddRow">
<td align="left">StudentID</td>
<td align="left">string</td>
<td align="left">Student ID, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">PassportNumber</td>
<td align="left">string</td>
<td align="left">Passport number</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileType</td>
<td align="left">int</td>
<td align="left">Profile type (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">Greeting</td>
<td align="left">string</td>
<td align="left">Optional preferred greeting</td>
</tr>
<tr class="oddRow">
<td align="left">PreferredRoomType</td>
<td align="left">string</td>
<td align="left">Preferred room type</td>
</tr>
<tr class="evenRow">
<td align="left">VipLevel</td>
<td align="left">int</td>
<td align="left">VIP level</td>
</tr>
<tr class="oddRow">
<td align="left">Smoker</td>
<td align="left">int</td>
<td align="left">Smoker or not (0 = false, 1 = true)</td>
</tr>
<tr class="evenRow">
<td align="left">BlackListed</td>
<td align="left">int</td>
<td align="left">Blacklisted or not (0 = false, 1 = true)</td>
</tr>
<tr class="oddRow">
<td align="left">ExcludeFromThirdPartyMailings</td>
<td align="left">Boolean</td>
<td align="left">Third-party mailing preference</td>
</tr>
<tr class="evenRow">
<td align="left">PublicNotes</td>
<td align="left">string</td>
<td align="left">Notes (public)</td>
</tr>
<tr class="oddRow">
<td align="left">PrivateNotes</td>
<td align="left">string</td>
<td align="left">Notes (private)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes1</td>
<td align="left">string</td>
<td align="left">Notes (custom #1)</td>
</tr>
<tr class="oddRow">
<td align="left">CustomNotes2</td>
<td align="left">string</td>
<td align="left">Notes (custom #2)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes3</td>
<td align="left">string</td>
<td align="left">Notes (custom #3)</td>
</tr>
</tbody>
</table>
<p><strong>Gender</strong> can be one of these values:</p>
<ul>
<li>"U" = Adult, gender unknown (default)</li>
<li>"M" = Adult male</li>
<li>"F" = Adult female</li>
<li>"C" = Child, gender unknown</li>
<li>"I" = Infant, gender unknown</li>
</ul>
<p><strong>ProfileType</strong> can be one of these values:</p>
<ul>
<li>0 = Private</li>
<li>1 = Agents</li>
<li>2 = Corporate</li>
<li>3 = TourGroup</li>
<li>4 = TourSeries</li>
</ul>
<h4>Returned data</h4>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">CreatedProfileRef</td>
<td align="left">string</td>
<td align="left">The profile reference for the newly created profile</td>
</tr>
</tbody>
</table>
pmsprf_CreateNewProfileSoapIn
<pmsprf_CreateNewProfile xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>5ba003b7-9a6d-4c4d-bf6a-bf4ccd464f23</SessionID>
<Forename>David</Forename>
<Surname>Holden</Surname>
<DateOfBirth>0001-01-01T00:00:00</DateOfBirth>
<Email>david@digitalsauce.com</Email>
<Gender>M</Gender>
<TelNumber>07825887953</TelNumber>
<Password>b8efb990-4a55-479f-9ced-eeee6a0bbe7d</Password>
<MarketingOptIn>0</MarketingOptIn>
<CreatedProfileRef />
<ProfileType xsi:nil="true" />
<VipLevel>1</VipLevel>
<Smoker xsi:nil="true" />
<BlackListed xsi:nil="true" />
<ExcludeFromThirdPartyMailings>true</ExcludeFromThirdPartyMailings>
</pmsprf_CreateNewProfile>
pmsprf_CreateNewProfileSoapOut
<pmsprf_CreateNewProfileResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_CreateNewProfileResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprf_CreateNewProfileResult>
<CreatedProfileRef>PF001493</CreatedProfileRef>
</pmsprf_CreateNewProfileResponse>
pmsavl_AvailAndRateV2
pmsavl_AvailAndRateV2SoapIn
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<pmsavl_AvailAndRateV2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>SessionID1</SessionID>
<ArrivalDateTime>1900-01-01T01:01:01</ArrivalDateTime>
<DepartureDateTime>1900-01-01T01:01:01</DepartureDateTime>
<PromotionalCode>PromotionalCode1</PromotionalCode>
<PackageCode>PackageCode1</PackageCode>
<RoomTypeCode>RoomTypeCode1</RoomTypeCode>
<RoomTypeDescriptionLike>RoomTypeDescriptionLike1</RoomTypeDescriptionLike>
<RoomTypeGroup>RoomTypeGroup1</RoomTypeGroup>
<MinCharge>1</MinCharge>
<MaxCharge>1</MaxCharge>
<DateVariance>1</DateVariance>
<Adults>1</Adults>
<Children>1</Children>
<Infants>1</Infants>
<AvailAndRate>
<AvailablePackageItems>
<cpmsavl_AvailAndRate_PackageItem>
<PackageCode>PackageCode1</PackageCode>
<PackageNotes>PackageNotes1</PackageNotes>
<RoomTypeCode>RoomTypeCode1</RoomTypeCode>
<AvailableToSell>1</AvailableToSell>
<ArrivalDateTime>1900-01-01T01:01:01</ArrivalDateTime>
<DepartureDateTime>1900-01-01T01:01:01</DepartureDateTime>
<AverageAdultRate>1</AverageAdultRate>
<TotalAdultCharge>1</TotalAdultCharge>
<AverageChildRateOR>1</AverageChildRateOR>
<TotalChildChargeOR>1</TotalChildChargeOR>
<AverageChildRateSH>1</AverageChildRateSH>
<TotalChildChargeSH>1</TotalChildChargeSH>
</cpmsavl_AvailAndRate_PackageItem>
<cpmsavl_AvailAndRate_PackageItem xsi:nil="true" />
<cpmsavl_AvailAndRate_PackageItem>
<PackageCode>PackageCode2</PackageCode>
<PackageNotes>PackageNotes2</PackageNotes>
<RoomTypeCode>RoomTypeCode2</RoomTypeCode>
<AvailableToSell>-2147483647</AvailableToSell>
<ArrivalDateTime>0001-01-01T00:00:00</ArrivalDateTime>
<DepartureDateTime>0001-01-01T00:00:00</DepartureDateTime>
<AverageAdultRate>-79228162514264337593543950335</AverageAdultRate>
<TotalAdultCharge>-79228162514264337593543950335</TotalAdultCharge>
<AverageChildRateOR>-79228162514264337593543950335</AverageChildRateOR>
<TotalChildChargeOR>-79228162514264337593543950335</TotalChildChargeOR>
<AverageChildRateSH>-79228162514264337593543950335</AverageChildRateSH>
<TotalChildChargeSH>-79228162514264337593543950335</TotalChildChargeSH>
</cpmsavl_AvailAndRate_PackageItem>
<cpmsavl_AvailAndRate_PackageItem xsi:nil="true" />
<cpmsavl_AvailAndRate_PackageItem>
<PackageCode>PackageCode3</PackageCode>
<PackageNotes>PackageNotes3</PackageNotes>
<RoomTypeCode>RoomTypeCode3</RoomTypeCode>
<AvailableToSell>2147483647</AvailableToSell>
<ArrivalDateTime>9999-12-31T23:59:59.9999999</ArrivalDateTime>
<DepartureDateTime>9999-12-31T23:59:59.9999999</DepartureDateTime>
<AverageAdultRate>79228162514264337593543950335</AverageAdultRate>
<TotalAdultCharge>79228162514264337593543950335</TotalAdultCharge>
<AverageChildRateOR>79228162514264337593543950335</AverageChildRateOR>
<TotalChildChargeOR>79228162514264337593543950335</TotalChildChargeOR>
<AverageChildRateSH>79228162514264337593543950335</AverageChildRateSH>
<TotalChildChargeSH>79228162514264337593543950335</TotalChildChargeSH>
</cpmsavl_AvailAndRate_PackageItem>
</AvailablePackageItems>
</AvailAndRate>
</pmsavl_AvailAndRateV2>
</Body>
</Envelope>
pmsavl_AvailAndRateV2SoapOut
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<pmsavl_AvailAndRateV2Response xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsavl_AvailAndRateV2Result>
<ExceptionCode>1</ExceptionCode>
<ExceptionDescription>ExceptionDescription1</ExceptionDescription>
</pmsavl_AvailAndRateV2Result>
<AvailAndRate>
<AvailablePackageItems>
<cpmsavl_AvailAndRate_PackageItem>
<PackageCode>PackageCode1</PackageCode>
<PackageNotes>PackageNotes1</PackageNotes>
<RoomTypeCode>RoomTypeCode1</RoomTypeCode>
<AvailableToSell>1</AvailableToSell>
<ArrivalDateTime>1900-01-01T01:01:01</ArrivalDateTime>
<DepartureDateTime>1900-01-01T01:01:01</DepartureDateTime>
<AverageAdultRate>1</AverageAdultRate>
<TotalAdultCharge>1</TotalAdultCharge>
<AverageChildRateOR>1</AverageChildRateOR>
<TotalChildChargeOR>1</TotalChildChargeOR>
<AverageChildRateSH>1</AverageChildRateSH>
<TotalChildChargeSH>1</TotalChildChargeSH>
</cpmsavl_AvailAndRate_PackageItem>
<cpmsavl_AvailAndRate_PackageItem xsi:nil="true" />
<cpmsavl_AvailAndRate_PackageItem>
<PackageCode>PackageCode2</PackageCode>
<PackageNotes>PackageNotes2</PackageNotes>
<RoomTypeCode>RoomTypeCode2</RoomTypeCode>
<AvailableToSell>-2147483647</AvailableToSell>
<ArrivalDateTime>0001-01-01T00:00:00</ArrivalDateTime>
<DepartureDateTime>0001-01-01T00:00:00</DepartureDateTime>
<AverageAdultRate>-79228162514264337593543950335</AverageAdultRate>
<TotalAdultCharge>-79228162514264337593543950335</TotalAdultCharge>
<AverageChildRateOR>-79228162514264337593543950335</AverageChildRateOR>
<TotalChildChargeOR>-79228162514264337593543950335</TotalChildChargeOR>
<AverageChildRateSH>-79228162514264337593543950335</AverageChildRateSH>
<TotalChildChargeSH>-79228162514264337593543950335</TotalChildChargeSH>
</cpmsavl_AvailAndRate_PackageItem>
<cpmsavl_AvailAndRate_PackageItem xsi:nil="true" />
<cpmsavl_AvailAndRate_PackageItem>
<PackageCode>PackageCode3</PackageCode>
<PackageNotes>PackageNotes3</PackageNotes>
<RoomTypeCode>RoomTypeCode3</RoomTypeCode>
<AvailableToSell>2147483647</AvailableToSell>
<ArrivalDateTime>9999-12-31T23:59:59.9999999</ArrivalDateTime>
<DepartureDateTime>9999-12-31T23:59:59.9999999</DepartureDateTime>
<AverageAdultRate>79228162514264337593543950335</AverageAdultRate>
<TotalAdultCharge>79228162514264337593543950335</TotalAdultCharge>
<AverageChildRateOR>79228162514264337593543950335</AverageChildRateOR>
<TotalChildChargeOR>79228162514264337593543950335</TotalChildChargeOR>
<AverageChildRateSH>79228162514264337593543950335</AverageChildRateSH>
<TotalChildChargeSH>79228162514264337593543950335</TotalChildChargeSH>
</cpmsavl_AvailAndRate_PackageItem>
</AvailablePackageItems>
</AvailAndRate>
</pmsavl_AvailAndRateV2Response>
</Body>
</Envelope>
<p>Get company ledger information, for a given company.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">AccountCode</td><td align="left">string</td><td align="left">Company account reference code</td></tr><tr class="oddRow"><td align="left">AccountName</td><td align="left">string</td><td align="left">Company account name</td></tr></tbody></table><h2 class="">Returned data (Company Account)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">CompanyRef</td><td align="left">string</td><td align="left">Company reference</td></tr><tr class="evenRow"><td align="left">CompanyName</td><td align="left">string</td><td align="left">Company name</td></tr><tr class="oddRow"><td align="left">HoldStatus</td><td align="left">int</td><td align="left">Hold status code</td></tr><tr class="evenRow"><td align="left">CreditRemaining</td><td align="left">decimal</td><td align="left">Amount of credit remaining</td></tr></tbody></table>
pmsint_GetCompanyAccountsSoapIn
<pmsint_GetCompanyAccounts xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>95f79ba6-73db-4e6a-8be9-7f43d416ee82</SessionID>
<AccountCode>BOOTS</AccountCode>
<AccountName />
<CompanyAccounts />
</pmsint_GetCompanyAccounts>
pmsint_GetCompanyAccountsSoapOut
<pmsint_GetCompanyAccountsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetCompanyAccountsResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetCompanyAccountsResult>
<CompanyAccounts>
<CompanyAccounts>
<cpmsint_GetCompanyAccounts_CompanyAccountItem>
<CompanyRef>BOOTS</CompanyRef>
<CompanyName>Boots The Chemist</CompanyName>
<HoldStatus>0</HoldStatus>
<CreditRemaining>500000.0000</CreditRemaining>
</cpmsint_GetCompanyAccounts_CompanyAccountItem>
</CompanyAccounts>
</CompanyAccounts>
</pmsint_GetCompanyAccountsResponse>
Allows postings to be made direct to a company ledger account.
<h4>Parameters</h4>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">AccountCode</td><td align="left">string</td><td align="left">Account reference code</td></tr><tr class="oddRow"><td align="left">LineItems</td><td align="left">(object)</td><td align="left">Set of line items (see below)</td></tr></tbody></table>
<h4>Parameters (line item)</h4>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">ForDate</td><td align="left">dateTime</td><td align="left">Item date-time stamp</td></tr><tr class="evenRow"><td align="left">AnalCode</td><td align="left">string</td><td align="left">Item sales analysis code</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Item description</td></tr><tr class="evenRow"><td align="left">Quantity</td><td align="left">double</td><td align="left">Item quantity</td></tr><tr class="oddRow"><td align="left">GrossTotal</td><td align="left">decimal</td><td align="left">Item gross total amount</td></tr></tbody></table>
<h4>Returned data</h4>
<p>None</p>
pmschg_LedgerFreePostingSoapIn
<pmschg_LedgerFreePosting xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>3909309f-ab2d-4e85-92f3-92a3bfe81ca6</SessionID>
<AccountCode>GUESTLINE</AccountCode>
<LineItems>
<LedgerItems>
<cpmschg_LedgerPostingItem>
<ForDate>2017-11-01T00:00:00</ForDate>
<AnalCode>BEV_EVEN</AnalCode>
<Description>Pauls Test</Description>
<Quantity>1</Quantity>
<GrossTotal>1.50</GrossTotal>
</cpmschg_LedgerPostingItem>
<cpmschg_LedgerPostingItem>
<ForDate>2017-11-02T00:00:00</ForDate>
<AnalCode>EPOS_BAR_PM</AnalCode>
<Description>Pauls Test</Description>
<Quantity>1</Quantity>
<GrossTotal>2.00</GrossTotal>
</cpmschg_LedgerPostingItem>
</LedgerItems>
</LineItems>
</pmschg_LedgerFreePosting>
pmschg_LedgerFreePostingSoapOut
<pmschg_LedgerFreePostingResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmschg_LedgerFreePostingResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmschg_LedgerFreePostingResult>
</pmschg_LedgerFreePostingResponse>
<p>Perform room check-out, referenced by Room ID, Telephone extension (for PABX interfaces) or Booking reference. Note that a room can only be checked out if the room balance is zero or the booking has been configured to send the balance to a company account or sales ledger.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">CheckOutMethod</td><td align="left">"CheckOutMethod_RoomID", "CheckOutMethod_TelExtNo" or "CheckOutMethod_Booking_RoomRef"</td><td align="left">Check-out method, i.e. form of reference, either Room ID (room name or number), Telephone extension or long-form Booking reference</td></tr><tr class="oddRow"><td align="left">CheckOutParameter</td><td align="left">string</td><td align="left">Value of reference parameter (depending on CheckOutMethod)</td></tr><tr class="evenRow"><td align="left">EmailFolioBill</td><td align="left">boolean</td><td align="left">Flag to indicate if bill should be e-mailed</td></tr><tr class="oddRow"><td align="left">EmailAddress</td><td align="left">string</td><td align="left">E-mail destination address, if bill sent out by e-mail</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsbkg_CheckOutSoapIn
<pmsbkg_CheckOut xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<CheckOutMethod>CheckOutMethod_RoomID</CheckOutMethod>
<CheckOutParameter>109</CheckOutParameter>
<EmailFolioBill>true</EmailFolioBill>
<EmailAddress>guest@acmemail.com</EmailAddress>
</pmsbkg_CheckOut>
pmsbkg_CheckOutSoapOut
<pmsbkg_CheckOutResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_CheckOutResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsbkg_CheckOutResult>
Close a current financial period and open a new period.
<h4>Parameters</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">PeriodType</td><td align="left">(see below)</td><td align="left">Period type to close</td></tr></tbody></table><p><strong>PeriodType</strong> can be one of the following:</p><ul><li>"PeriodType_Shift"</li><li>"PeriodType_Day"</li><li>"PeriodType_Week"</li><li>"PeriodType_Month"</li><li>"PeriodType_Year"</li></ul><h4>Returned data</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">ClosedPeriodID</td><td align="left">int</td><td align="left">Period ID for closed period</td></tr><tr class="evenRow"><td align="left">NewPeriodID</td><td align="left">int</td><td align="left">Period ID for newly starting period</td></tr></tbody></table>
pmsfoh_ClosePeriodSoapIn
<pmsfoh_ClosePeriod xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<PeriodType>PeriodType_Day</PeriodType>
<ClosePeriod />
</pmsfoh_ClosePeriod>
pmsfoh_ClosePeriodSoapOut
<pmsfoh_ClosePeriodResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsfoh_ClosePeriodResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsfoh_ClosePeriodResult>
<ClosePeriod>
<ClosedPeriodID>2</ClosedPeriodID>
<NewPeriodID>3</NewPeriodID>
</ClosePeriod>
</pmsfoh_ClosePeriodResponse>
<p>This method can be used to obtain room-related movements or transactions, including check-in events, check-out events, room-moves and changes to alarm calls. If you require near-real-time notification of check-ins and check-outs then this is the method to use.</p><p>The method is called with a <strong>transaction ID</strong>, obtained from the last time the method was called, and it returns all movements or transactions since that transaction ID. The transaction ID starts at 1 and increments for each transaction in the system, indefinitely.</p><table><tbody><tr class="evenRow"><td align="left">Wondering what value the current transaction ID is set to? You can find out by logging in to Rezlynx and accessing the INI settings.</td></tr></tbody></table><p>Note any filtering of results must be done after the method returns, there are no filter parameters. If you want more information about a room, guest or reservation, you can use <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#pmsbkg_BookingSearch">pmsbkg_BookingSearch</a> to delve deeper into the data.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID</td></tr><tr class="evenRow"><td align="left">TransID</td><td align="left">int</td><td align="left">Transaction ID of the last transaction or movement from which new data is requested</td></tr><tr class="oddRow"><td align="left">IncludeMovieAccess</td><td align="left">Boolean</td><td align="left">Flag to determine if <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#Movie%20Access">Movie Access</a> should be included in the response</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>Returned data consists of the set of all movement items since the specified transaction ID</li></ul><h2 class="">Returned data (Movement item)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">TransID</td><td align="left">int</td><td align="left">Transaction ID for this particular transaction or movement</td></tr><tr class="evenRow"><td align="left">EntryType</td><td align="left">int</td><td align="left">Code for the type of movement (see below)</td></tr><tr class="oddRow"><td align="left">EntryTimeStamp</td><td align="left">dateTime</td><td align="left">Date-time stamp for the transaction or movement</td></tr><tr class="evenRow"><td align="left">RoomID</td><td align="left">string</td><td align="left">Room number or name</td></tr><tr class="oddRow"><td align="left">TelNo1</td><td align="left">string</td><td align="left">Room telephone extension number 1, if applicable</td></tr><tr class="evenRow"><td align="left">TelNo2</td><td align="left">string</td><td align="left">Room telephone extension number 2, if applicable</td></tr><tr class="oddRow"><td align="left">TelNo3</td><td align="left">string</td><td align="left">Room telephone extension number 3, if applicable</td></tr><tr class="evenRow"><td align="left">TelNo4</td><td align="left">string</td><td align="left">Room telephone extension number 4, if applicable</td></tr><tr class="oddRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Rezlynx booking reference for the reservation</td></tr><tr class="evenRow"><td align="left">RoomPickID</td><td align="left">int</td><td align="left">Room integer count used for multi-room bookings</td></tr><tr class="oddRow"><td align="left">FolioID</td><td align="left">int</td><td align="left">Folio number, if more than one folio</td></tr><tr class="evenRow"><td align="left">Salutation</td><td align="left">string</td><td align="left">Title for guest</td></tr><tr class="oddRow"><td align="left">Forename</td><td align="left">string</td><td align="left">First name of guest</td></tr><tr class="evenRow"><td align="left">Surname</td><td align="left">string</td><td align="left">Surname of guest</td></tr><tr class="oddRow"><td align="left">AlarmTime</td><td align="left">string</td><td align="left">Alarm call time, if set</td></tr><tr class="evenRow"><td align="left">Param1</td><td align="left">string</td><td align="left">Optional string parameter, depends on EntryType</td></tr><tr class="oddRow"><td align="left">Param2</td><td>int</td><td align="left">Optional integer parameter, depends on EntryType</td></tr><tr class="evenRow"><td align="left">InterfacePostingMode</td><td align="left">int</td><td align="left">The posting mode for this room (see below)</td></tr><tr class="oddRow"><td align="left">RoomMove</td><td align="left">(object)</td><td align="left">Further details, in case of a room move</td></tr><tr class="evenRow"><td align="left">MovieAccess</td><td align="left">string</td><td align="left"><a class="tc-tiddlylink tc-tiddlylink-resolves" href="#Movie%20Access">Movie Access</a> code</td></tr></tbody></table><h2 class="">EntryType codes</h2><table><tbody><tr class="evenRow"><th align="left"> Code</th><th align="left">Description</th></tr><tr class="oddRow"><td align="center">10</td><td align="left">room check-in</td></tr><tr class="evenRow"><td align="center">20</td><td align="left">room check-out</td></tr><tr class="oddRow"><td align="center">30</td><td align="left">room-move</td></tr><tr class="evenRow"><td align="center">40</td><td align="left">change to alarm time (i.e. wake-up call)</td></tr><tr class="oddRow"><td align="center">50</td><td align="left">guest check-in</td></tr><tr class="evenRow"><td align="center">60</td><td align="left">guest check-out</td></tr><tr class="oddRow"><td align="center">70</td><td align="left">change to ‘InterfacePostingMode’</td></tr><tr class="evenRow"><td align="center">80</td><td align="left">guest added to room</td></tr><tr class="oddRow"><td align="center">90</td><td align="left">guest removed from room reservation</td></tr><tr class="evenRow"><td align="center">100</td><td align="left">change to guest details</td></tr><tr class="oddRow"><td align="center">110</td><td align="left">change to guest profile details</td></tr><tr class="evenRow"><td align="center">120</td><td align="left">guest unlinked</td></tr><tr class="oddRow"><td align="center">130</td><td align="left">change to ‘MovieAccess’</td></tr><tr class="evenRow"><td align="center">140</td><td align="left">check-out reversed or undone</td></tr><tr class="oddRow"><td align="center">150</td><td align="left">room unallocated from reservation</td></tr><tr class="evenRow"><td align="center">160</td><td align="left">room allocated to reservation</td></tr></tbody></table><h2 class="">Interface Posting Modes</h2><table><tbody><tr class="evenRow"><th align="left"> Code</th><th align="left">Description</th></tr><tr class="oddRow"><td align="center">0</td><td align="left">All allowed, i.e. all postings allowed for this room</td></tr><tr class="evenRow"><td align="center">1</td><td align="left">None allowed, i.e. no postings allowed for this room</td></tr><tr class="oddRow"><td align="center">2</td><td align="left">Phone only, i.e. only charges for telephone calls allowed</td></tr></tbody></table>
pmsfoh_GetMovementsSoapIn
<pmsfoh_GetMovements xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>8e1b1a80-61ae-411e-a8a5-863f9b32d259</SessionID>
<TransID>866</TransID>
<IncludeMovieAccess>false</IncludeMovieAccess>
</pmsfoh_GetMovements>
pmsfoh_GetMovementsSoapOut
<pmsfoh_GetMovementsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsfoh_GetMovementsResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsfoh_GetMovementsResult>
<GetMovements>
<MovementData>
<cpmsfoh_GetMovements_MovementItem>
<TransID>867</TransID>
<EntryType>30</EntryType>
<EntryTimeStamp>2017-10-19T15:18:07</EntryTimeStamp>
<RoomID>110</RoomID>
<TelNo1 />
<TelNo2 />
<TelNo3 />
<TelNo4 />
<BookRef>BK000938</BookRef>
<RoomPickID>1</RoomPickID>
<FolioID>1</FolioID>
<Salutation>Mr</Salutation>
<Forename>James</Forename>
<Surname>John</Surname>
<AlarmTime />
<Param1>118</Param1>
<Param2>0</Param2>
<InterfacePostingMode>0</InterfacePostingMode>
<RoomMove>
<OldRoom>
<RoomID>118</RoomID>
<TelNo1 />
<TelNo2 />
<TelNo3 />
<TelNo4 />
</OldRoom>
</RoomMove>
</cpmsfoh_GetMovements_MovementItem>
</MovementData>
</GetMovements>
</pmsfoh_GetMovementsResponse>
pmsprf_GetProfileEvents
pmsprf_GetProfileEventsSoapIn
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<pmsprf_GetProfileEvents xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionId>SessionId1</SessionId>
<TransId>1</TransId>
<EventResults>
<Events>
<GuestProfileEventItem>
<TransID>1</TransID>
<EventType>FolioCreated</EventType>
<EventTimeStamp>1900-01-01T01:01:01</EventTimeStamp>
<AllocatedRoomID>AllocatedRoomID1</AllocatedRoomID>
<BookRefRoomRef>BookRefRoomRef1</BookRefRoomRef>
<GuestProfileRef>GuestProfileRef1</GuestProfileRef>
<FolioID>1</FolioID>
<Forename>Forename1</Forename>
<Surname>Surname1</Surname>
<Title>Title1</Title>
<GuestStatus>FutureArrival</GuestStatus>
<ArrivalDate>1900-01-01T01:01:01</ArrivalDate>
<DepartureDate>1900-01-01T01:01:01</DepartureDate>
<PMSPackageCode>PMSPackageCode1</PMSPackageCode>
<SPAPackageCode>SPAPackageCode1</SPAPackageCode>
<ReservationType>BedRoom</ReservationType>
<FolioIndex>1</FolioIndex>
</GuestProfileEventItem>
<GuestProfileEventItem xsi:nil="true" />
<GuestProfileEventItem>
<TransID>-9223372036854775807</TransID>
<EventType>FolioCancelled</EventType>
<EventTimeStamp>0001-01-01T00:00:00</EventTimeStamp>
<AllocatedRoomID>AllocatedRoomID2</AllocatedRoomID>
<BookRefRoomRef>BookRefRoomRef2</BookRefRoomRef>
<GuestProfileRef>GuestProfileRef2</GuestProfileRef>
<FolioID>-2147483647</FolioID>
<Forename>Forename2</Forename>
<Surname>Surname2</Surname>
<Title>Title2</Title>
<GuestStatus>CheckedIn</GuestStatus>
<ArrivalDate>0001-01-01T00:00:00</ArrivalDate>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<PMSPackageCode>PMSPackageCode2</PMSPackageCode>
<SPAPackageCode>SPAPackageCode2</SPAPackageCode>
<ReservationType>FunctionRoom</ReservationType>
<FolioIndex>-2147483647</FolioIndex>
</GuestProfileEventItem>
<GuestProfileEventItem xsi:nil="true" />
<GuestProfileEventItem>
<TransID>9223372036854775807</TransID>
<EventType>FolioModified</EventType>
<EventTimeStamp>9999-12-31T23:59:59.9999999</EventTimeStamp>
<AllocatedRoomID>AllocatedRoomID3</AllocatedRoomID>
<BookRefRoomRef>BookRefRoomRef3</BookRefRoomRef>
<GuestProfileRef>GuestProfileRef3</GuestProfileRef>
<FolioID>2147483647</FolioID>
<Forename>Forename3</Forename>
<Surname>Surname3</Surname>
<Title>Title3</Title>
<GuestStatus>CheckedOut</GuestStatus>
<ArrivalDate>9999-12-31T23:59:59.9999999</ArrivalDate>
<DepartureDate>9999-12-31T23:59:59.9999999</DepartureDate>
<PMSPackageCode>PMSPackageCode3</PMSPackageCode>
<SPAPackageCode>SPAPackageCode3</SPAPackageCode>
<ReservationType>NRA</ReservationType>
<FolioIndex>2147483647</FolioIndex>
</GuestProfileEventItem>
</Events>
</EventResults>
</pmsprf_GetProfileEvents>
</Body>
</Envelope>
pmsprf_GetProfileEventsSoapOut
<?xml version="1.0" encoding="utf-8"?>
<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
<Body>
<pmsprf_GetProfileEventsResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_GetProfileEventsResult>
<ExceptionCode>1</ExceptionCode>
<ExceptionDescription>ExceptionDescription1</ExceptionDescription>
</pmsprf_GetProfileEventsResult>
<EventResults>
<Events>
<GuestProfileEventItem>
<TransID>1</TransID>
<EventType>FolioCreated</EventType>
<EventTimeStamp>1900-01-01T01:01:01</EventTimeStamp>
<AllocatedRoomID>AllocatedRoomID1</AllocatedRoomID>
<BookRefRoomRef>BookRefRoomRef1</BookRefRoomRef>
<GuestProfileRef>GuestProfileRef1</GuestProfileRef>
<FolioID>1</FolioID>
<Forename>Forename1</Forename>
<Surname>Surname1</Surname>
<Title>Title1</Title>
<GuestStatus>FutureArrival</GuestStatus>
<ArrivalDate>1900-01-01T01:01:01</ArrivalDate>
<DepartureDate>1900-01-01T01:01:01</DepartureDate>
<PMSPackageCode>PMSPackageCode1</PMSPackageCode>
<SPAPackageCode>SPAPackageCode1</SPAPackageCode>
<ReservationType>BedRoom</ReservationType>
<FolioIndex>1</FolioIndex>
</GuestProfileEventItem>
<GuestProfileEventItem xsi:nil="true" />
<GuestProfileEventItem>
<TransID>-9223372036854775807</TransID>
<EventType>FolioCancelled</EventType>
<EventTimeStamp>0001-01-01T00:00:00</EventTimeStamp>
<AllocatedRoomID>AllocatedRoomID2</AllocatedRoomID>
<BookRefRoomRef>BookRefRoomRef2</BookRefRoomRef>
<GuestProfileRef>GuestProfileRef2</GuestProfileRef>
<FolioID>-2147483647</FolioID>
<Forename>Forename2</Forename>
<Surname>Surname2</Surname>
<Title>Title2</Title>
<GuestStatus>CheckedIn</GuestStatus>
<ArrivalDate>0001-01-01T00:00:00</ArrivalDate>
<DepartureDate>0001-01-01T00:00:00</DepartureDate>
<PMSPackageCode>PMSPackageCode2</PMSPackageCode>
<SPAPackageCode>SPAPackageCode2</SPAPackageCode>
<ReservationType>FunctionRoom</ReservationType>
<FolioIndex>-2147483647</FolioIndex>
</GuestProfileEventItem>
<GuestProfileEventItem xsi:nil="true" />
<GuestProfileEventItem>
<TransID>9223372036854775807</TransID>
<EventType>FolioModified</EventType>
<EventTimeStamp>9999-12-31T23:59:59.9999999</EventTimeStamp>
<AllocatedRoomID>AllocatedRoomID3</AllocatedRoomID>
<BookRefRoomRef>BookRefRoomRef3</BookRefRoomRef>
<GuestProfileRef>GuestProfileRef3</GuestProfileRef>
<FolioID>2147483647</FolioID>
<Forename>Forename3</Forename>
<Surname>Surname3</Surname>
<Title>Title3</Title>
<GuestStatus>CheckedOut</GuestStatus>
<ArrivalDate>9999-12-31T23:59:59.9999999</ArrivalDate>
<DepartureDate>9999-12-31T23:59:59.9999999</DepartureDate>
<PMSPackageCode>PMSPackageCode3</PMSPackageCode>
<SPAPackageCode>SPAPackageCode3</SPAPackageCode>
<ReservationType>NRA</ReservationType>
<FolioIndex>2147483647</FolioIndex>
</GuestProfileEventItem>
</Events>
</EventResults>
</pmsprf_GetProfileEventsResponse>
</Body>
</Envelope>
<p>Update the value of a custom attribute for a given Company Account.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionId</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">CompanyRef</td><td align="left">string</td><td align="left">Company Account reference</td></tr><tr class="oddRow"><td align="left">AttributeCode</td><td align="left">string</td><td align="left">Attribute code (as configured on Rezlynx PMS)</td></tr><tr class="evenRow"><td align="left">NewValue</td><td align="left">string</td><td align="left">New attribute value (must be a valid value for the given attribute)</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmscom_UpdateCompanyAttributeSoapIn
<pmscom_UpdateCompanyAttribute xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionId>7ce4a576-86e0-494c-ad1c-f4de37a7017a</SessionId>
<CompanyRef>ACME00000002</CompanyRef>
<AttributeCode>ACC_STATUS</AttributeCode>
<NewValue>option 2</NewValue>
</pmscom_UpdateCompanyAttribute>
pmscom_UpdateCompanyAttributeSoapOut
<pmscom_UpdateCompanyAttributeResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscom_UpdateCompanyAttributeResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmscom_UpdateCompanyAttributeResult>
</pmscom_UpdateCompanyAttributeResponse>
<p><code>!restricted!</code> This method is <u>not</u> for general use.</p><p>This method returns a table of room availability which mimics the 'Property Availability' screen in <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#Rezlynx%20PMS">Rezlynx PMS</a>. The table includes the number of available rooms for each room type for 60 days from the requested date.</p><table><tbody><tr class="evenRow"><td><strong>Note</strong> the number of available rooms is an integer value which could be negative if the hotel has overbooked.</td></tr></tbody></table><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">StartDate</td><td align="left">dateTime</td><td align="left">Start date for start of availability block</td></tr></tbody></table><h2 class="">Returned data (availability)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">Headers</td><td align="left">(object)</td><td align="left">Table column headers</td></tr><tr class="evenRow"><td align="left">> Header</td><td align="left">(object)</td><td align="left">Indvidual column header</td></tr><tr class="oddRow"><td align="left">>> Day</td><td align="left">String</td><td align="left">Day of week, as displayed in the Rezlynx UI, e.g. "Thu"</td></tr><tr class="evenRow"><td align="left">>> DisplayDate</td><td align="left">String</td><td align="left">Date, as displayed in the Rezlynx UI, e.g. "02/May/2018"</td></tr><tr class="oddRow"><td align="left">Data</td><td align="left">(object)</td><td align="left">Table rows</td></tr><tr class="evenRow"><td align="left">> Item</td><td align="left">(object)</td><td align="left">Individual row</td></tr><tr class="oddRow"><td align="left">>> RoomTypeCode</td><td align="left">String</td><td align="left">Room type</td></tr><tr class="evenRow"><td align="left">>> RoomTypeGroup</td><td align="left">String</td><td align="left">Room type group</td></tr><tr class="oddRow"><td align="left">>> Availability</td><td align="left">(object)</td><td align="left">Row data</td></tr><tr class="evenRow"><td align="left">>>> Item</td><td align="left">Integer</td><td align="left">Number of rooms available</td></tr></tbody></table>
pmsavl_AvailAndRateSoapIn
<pmsfoh_GetAvailability xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2a55028f-7680-4215-9b88-324edd2a614a</SessionID>
<StartDate>2018-05-02T12:18:57+01:00</StartDate>
</pmsfoh_GetAvailability>
pmsavl_AvailAndRateSoapOut
<cpmsfoh_GetAvailability>
<AvailabilityList xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19" />
<Availability xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<Headers>
<Header>
<Day>Room Type</Day>
<DisplayDate />
</Header>
<Header>
<Day>Group</Day>
<DisplayDate />
</Header>
<Header>
<Day>Wed</Day>
<DisplayDate>02/May/2018</DisplayDate>
</Header>
<Header>
<Day>Thu</Day>
<DisplayDate>03/May/2018</DisplayDate>
</Header>
<Header>
<Day>Fri</Day>
<DisplayDate>04/May/2018</DisplayDate>
</Header>
<Header>
<Day>Sat</Day>
<DisplayDate>05/May/2018</DisplayDate>
</Header>
<Header>
<Day>Sun</Day>
<DisplayDate>06/May/2018</DisplayDate>
</Header>
<Header>
<Day>Mon</Day>
<DisplayDate>07/May/2018</DisplayDate>
</Header>
<Header>
<Day>Tue</Day>
<DisplayDate>08/May/2018</DisplayDate>
</Header>
<Header>
<Day>Wed</Day>
<DisplayDate>09/May/2018</DisplayDate>
</Header>
<Header>
<Day>Thu</Day>
<DisplayDate>10/May/2018</DisplayDate>
</Header>
<Header>
<Day>Fri</Day>
<DisplayDate>11/May/2018</DisplayDate>
</Header>
<Header>
<Day>Sat</Day>
<DisplayDate>12/May/2018</DisplayDate>
</Header>
<Header>
<Day>Sun</Day>
<DisplayDate>13/May/2018</DisplayDate>
</Header>
<Header>
<Day>Mon</Day>
<DisplayDate>14/May/2018</DisplayDate>
</Header>
<Header>
<Day>Tue</Day>
<DisplayDate>15/May/2018</DisplayDate>
</Header>
<Header>
<Day>Wed</Day>
<DisplayDate>16/May/2018</DisplayDate>
</Header>
<Header>
<Day>Thu</Day>
<DisplayDate>17/May/2018</DisplayDate>
</Header>
<Header>
<Day>Fri</Day>
<DisplayDate>18/May/2018</DisplayDate>
</Header>
<Header>
<Day>Sat</Day>
<DisplayDate>19/May/2018</DisplayDate>
</Header>
<Header>
<Day>Sun</Day>
<DisplayDate>20/May/2018</DisplayDate>
</Header>
<Header>
<Day>Mon</Day>
<DisplayDate>21/May/2018</DisplayDate>
</Header>
<Header>
<Day>Tue</Day>
<DisplayDate>22/May/2018</DisplayDate>
</Header>
<Header>
<Day>Wed</Day>
<DisplayDate>23/May/2018</DisplayDate>
</Header>
<Header>
<Day>Thu</Day>
<DisplayDate>24/May/2018</DisplayDate>
</Header>
<Header>
<Day>Fri</Day>
<DisplayDate>25/May/2018</DisplayDate>
</Header>
<Header>
<Day>Sat</Day>
<DisplayDate>26/May/2018</DisplayDate>
</Header>
<Header>
<Day>Sun</Day>
<DisplayDate>27/May/2018</DisplayDate>
</Header>
<Header>
<Day>Mon</Day>
<DisplayDate>28/May/2018</DisplayDate>
</Header>
<Header>
<Day>Tue</Day>
<DisplayDate>29/May/2018</DisplayDate>
</Header>
<Header>
<Day>Wed</Day>
<DisplayDate>30/May/2018</DisplayDate>
</Header>
<Header>
<Day>Thu</Day>
<DisplayDate>31/May/2018</DisplayDate>
</Header>
<Header>
<Day>Fri</Day>
<DisplayDate>01/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Sat</Day>
<DisplayDate>02/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Sun</Day>
<DisplayDate>03/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Mon</Day>
<DisplayDate>04/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Tue</Day>
<DisplayDate>05/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Wed</Day>
<DisplayDate>06/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Thu</Day>
<DisplayDate>07/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Fri</Day>
<DisplayDate>08/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Sat</Day>
<DisplayDate>09/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Sun</Day>
<DisplayDate>10/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Mon</Day>
<DisplayDate>11/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Tue</Day>
<DisplayDate>12/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Wed</Day>
<DisplayDate>13/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Thu</Day>
<DisplayDate>14/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Fri</Day>
<DisplayDate>15/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Sat</Day>
<DisplayDate>16/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Sun</Day>
<DisplayDate>17/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Mon</Day>
<DisplayDate>18/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Tue</Day>
<DisplayDate>19/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Wed</Day>
<DisplayDate>20/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Thu</Day>
<DisplayDate>21/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Fri</Day>
<DisplayDate>22/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Sat</Day>
<DisplayDate>23/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Sun</Day>
<DisplayDate>24/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Mon</Day>
<DisplayDate>25/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Tue</Day>
<DisplayDate>26/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Wed</Day>
<DisplayDate>27/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Thu</Day>
<DisplayDate>28/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Fri</Day>
<DisplayDate>29/Jun/2018</DisplayDate>
</Header>
<Header>
<Day>Sat</Day>
<DisplayDate>30/Jun/2018</DisplayDate>
</Header>
</Headers>
<Data>
<Item>
<RoomTypeCode>COTTAGE_1</RoomTypeCode>
<RoomTypeGroup>BEDROOMS</RoomTypeGroup>
<Availability>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
</Availability>
</Item>
<Item>
<RoomTypeCode>COTTAGE_2</RoomTypeCode>
<RoomTypeGroup>BEDROOMS</RoomTypeGroup>
<Availability>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
<Item>1</Item>
</Availability>
</Item>
<Item>
<RoomTypeCode>COTTAGE_3</RoomTypeCode>
<RoomTypeGroup>BEDROOMS</RoomTypeGroup>
<Availability>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
<Item>2</Item>
</Availability>
</Item>
<Item>
<RoomTypeCode>DBL_STANDARD</RoomTypeCode>
<RoomTypeGroup>BEDROOMS</RoomTypeGroup>
<Availability>
<Item>9</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
<Item>12</Item>
</Availability>
</Item>
<Item>
<RoomTypeCode>DBL_SUPERIOR</RoomTypeCode>
<RoomTypeGroup>BEDROOMS</RoomTypeGroup>
<Availability>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
<Item>15</Item>
</Availability>
</Item>
<Item>
<RoomTypeCode>FAMILY</RoomTypeCode>
<RoomTypeGroup>BEDROOMS</RoomTypeGroup>
<Availability>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
</Availability>
</Item>
<Item>
<RoomTypeCode>PENTHOUSE</RoomTypeCode>
<RoomTypeGroup>BEDROOMS</RoomTypeGroup>
<Availability>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>3</Item>
<Item>3</Item>
<Item>3</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
<Item>4</Item>
</Availability>
</Item>
</Data>
</Availability>
</cpmsfoh_GetAvailability>
<p>Get a list of all rooms based on their occupancy status, e.g. all occupied rooms or all out-of-service rooms.</p>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID, obtained at log-in</td>
</tr>
<tr class="evenRow">
<td align="left">StatusCode</td>
<td align="left">int</td>
<td align="left">Room status code to search against (numeric code)</td>
</tr>
</tbody>
</table>
<p><strong>Room status codes</strong> are as follows:</p>
<ul>
<li>2000 = Out of service</li>
<li>2001 = Occupied</li>
<li>2002 = Vacant</li>
</ul>
<table>
<tbody>
<tr class="evenRow">
<td align="left">More</td>
<td align="left"><a class="tc-tiddlylink tc-tiddlylink-resolves" href="#Room%20Status%20codes">Room Status
codes</a></td>
</tr>
</tbody>
</table>
<h2 class="">Returned data (per room)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">strRoomID</td>
<td>string</td>
<td align="left">Room reference (room name or number)</td>
</tr>
<tr class="evenRow">
<td align="left">iRFlag</td>
<td>long</td>
<td align="left">(internal flag, indicates if record marked for deletion)</td>
</tr>
<tr class="oddRow">
<td align="left">strRoomDescription</td>
<td>string</td>
<td align="left">Room description</td>
</tr>
<tr class="evenRow">
<td align="left">strSubGroupCode</td>
<td>string</td>
<td align="left">Sub-group</td>
</tr>
<tr class="oddRow">
<td align="left">strOwnerCode</td>
<td>string</td>
<td align="left">Owner</td>
</tr>
<tr class="evenRow">
<td align="left">strRoomTypeCode</td>
<td>string</td>
<td align="left">Room type</td>
</tr>
<tr class="oddRow">
<td align="left">dtAvailableFrom</td>
<td>dateTime</td>
<td align="left">Date from when room available</td>
</tr>
<tr class="evenRow">
<td align="left">iStatus</td>
<td>long</td>
<td align="left">Room occupancy status code (numeric)</td>
</tr>
<tr class="oddRow">
<td align="left">iHKStatus</td>
<td>long</td>
<td align="left">Housekeeping status code (numeric)</td>
</tr>
<tr class="evenRow">
<td align="left">strHKCode</td>
<td>string</td>
<td align="left">Housekeeping status code (text)</td>
</tr>
<tr class="oddRow">
<td align="left">iAAPriority</td>
<td>long</td>
<td align="left">Auto-Allocate priority number (highest numbers allocated first)</td>
</tr>
<tr class="evenRow">
<td align="left">strNextToRoomID</td>
<td>string</td>
<td align="left">Adjacent room reference, if used</td>
</tr>
<tr class="oddRow">
<td align="left">strTelNo1</td>
<td>string</td>
<td align="left">Telephone extension number #1</td>
</tr>
<tr class="evenRow">
<td align="left">strTelNo2</td>
<td>string</td>
<td align="left">Telephone extension number #2</td>
</tr>
<tr class="oddRow">
<td align="left">strTelNo3</td>
<td>string</td>
<td align="left">Telephone extension number #3</td>
</tr>
<tr class="evenRow">
<td align="left">strTelNo4</td>
<td>string</td>
<td align="left">Telephone extension number #4</td>
</tr>
<tr class="oddRow">
<td align="left">strTag1</td>
<td>string</td>
<td align="left">Tag #1</td>
</tr>
<tr class="evenRow">
<td align="left">strTag2</td>
<td>string</td>
<td align="left">Tag #2</td>
</tr>
<tr class="oddRow">
<td align="left">iSmoke</td>
<td>long</td>
<td align="left">Smoking room flag</td>
</tr>
<tr class="evenRow">
<td align="left">iPAX</td>
<td>long</td>
<td align="left">Capacity, in number of persons</td>
</tr>
<tr class="oddRow">
<td align="left">iRoomIDClass</td>
<td>long</td>
<td align="left">Room class</td>
</tr>
<tr class="evenRow">
<td align="left">iParam2</td>
<td>long</td>
<td align="left">Parameter #2 (number)</td>
</tr>
<tr class="oddRow">
<td align="left">strNotes</td>
<td>string</td>
<td align="left">Notes</td>
</tr>
<tr class="evenRow">
<td align="left">iParam1</td>
<td>long</td>
<td align="left">Parameter #1 (number)</td>
</tr>
</tbody>
</table>
pmsint_GetRoomsByStatusCodeSoapIn
<pmsint_GetRoomsByStatusCode xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>918d8ea2-0276-4816-9c73-6af50e8de0a4</SessionID>
<StatusCode>2100</StatusCode>
</pmsint_GetRoomsByStatusCode>
pmsint_GetRoomsByStatusCodeSoapOut
<pmsint_GetRoomsByStatusCodeResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetRoomsByStatusCodeResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetRoomsByStatusCodeResult>
<GetStatusCodes>
<Rooms>
<cpmsint_GetRoomsByStatusCode_Room>
<strRoomID>102</strRoomID>
<iRFlag>0</iRFlag>
<strRoomDescription>Daisy Room</strRoomDescription>
<strSubGroupCode>DAISY</strSubGroupCode>
<strOwnerCode />
<strRoomTypeCode>DBL_SUPERIOR</strRoomTypeCode>
<dtAvailableFrom>1899-12-30T00:00:00</dtAvailableFrom>
<iStatus>2100</iStatus>
<iHKStatus>1300</iHKStatus>
<strHKCode />
<iAAPriority>0</iAAPriority>
<strNextToRoomID>101</strNextToRoomID>
<strTelNo1 />
<strTelNo2 />
<strTelNo3 />
<strTelNo4 />
<strTag1 />
<strTag2 />
<iSmoke>0</iSmoke>
<iPAX>2</iPAX>
<iRoomIDClass>0</iRoomIDClass>
<iParam2>0</iParam2>
<strNotes />
<iParam1>0</iParam1>
</cpmsint_GetRoomsByStatusCode_Room>
<cpmsint_GetRoomsByStatusCode_Room>
<strRoomID>103</strRoomID>
<iRFlag>0</iRFlag>
<strRoomDescription>Primrose Room</strRoomDescription>
<strSubGroupCode>PRIMROSE</strSubGroupCode>
<strOwnerCode />
<strRoomTypeCode>DBL_SUPERIOR</strRoomTypeCode>
<dtAvailableFrom>1899-12-30T00:00:00</dtAvailableFrom>
<iStatus>2100</iStatus>
<iHKStatus>1300</iHKStatus>
<strHKCode />
<iAAPriority>0</iAAPriority>
<strNextToRoomID>102</strNextToRoomID>
<strTelNo1 />
<strTelNo2 />
<strTelNo3 />
<strTelNo4 />
<strTag1 />
<strTag2 />
<iSmoke>0</iSmoke>
<iPAX>2</iPAX>
<iRoomIDClass>0</iRoomIDClass>
<iParam2>0</iParam2>
<strNotes />
<iParam1>0</iParam1>
</cpmsint_GetRoomsByStatusCode_Room>
<cpmsint_GetRoomsByStatusCode_Room>
<strRoomID>901</strRoomID>
<iRFlag>0</iRFlag>
<strRoomDescription>The Ballroom</strRoomDescription>
<strSubGroupCode>FUNCTIONS</strSubGroupCode>
<strOwnerCode />
<strRoomTypeCode>FUNCTION</strRoomTypeCode>
<dtAvailableFrom>1899-12-30T00:00:00</dtAvailableFrom>
<iStatus>2100</iStatus>
<iHKStatus>1200</iHKStatus>
<strHKCode />
<iAAPriority>0</iAAPriority>
<strNextToRoomID />
<strTelNo1 />
<strTelNo2 />
<strTelNo3 />
<strTelNo4 />
<strTag1 />
<strTag2 />
<iSmoke>0</iSmoke>
<iPAX>0</iPAX>
<iRoomIDClass>50</iRoomIDClass>
<iParam2>0</iParam2>
<strNotes />
<iParam1>0</iParam1>
</cpmsint_GetRoomsByStatusCode_Room>
<cpmsint_GetRoomsByStatusCode_Room>
<strRoomID>BLUEROOM</strRoomID>
<iRFlag>0</iRFlag>
<strRoomDescription>Blue Room</strRoomDescription>
<strSubGroupCode>FIRST_FLOOR</strSubGroupCode>
<strOwnerCode />
<strRoomTypeCode>DBL_SUPERIOR</strRoomTypeCode>
<dtAvailableFrom>1899-12-30T00:00:00</dtAvailableFrom>
<iStatus>2100</iStatus>
<iHKStatus>1300</iHKStatus>
<strHKCode />
<iAAPriority>0</iAAPriority>
<strNextToRoomID />
<strTelNo1 />
<strTelNo2 />
<strTelNo3 />
<strTelNo4 />
<strTag1 />
<strTag2 />
<iSmoke>0</iSmoke>
<iPAX>0</iPAX>
<iRoomIDClass>0</iRoomIDClass>
<iParam2>0</iParam2>
<strNotes />
<iParam1>0</iParam1>
</cpmsint_GetRoomsByStatusCode_Room>
</Rooms>
</GetStatusCodes>
</pmsint_GetRoomsByStatusCodeResponse>
<p>Get room status for a given room reference, including both occupancy status and house-keeping status. If the room
reference is blank, this method will return the room status for every room in the property.</p>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID, obtained at log-in</td>
</tr>
<tr class="evenRow">
<td align="left">RoomID</td>
<td align="left">string</td>
<td align="left">Room reference (room name or number)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">RoomId</td>
<td align="left">string</td>
<td align="left">Room reference (room name or number); leave blank to return the room status for <u>all</u>
rooms</td>
</tr>
<tr class="evenRow">
<td align="left">RoomDescription</td>
<td align="left">string</td>
<td align="left">Room description</td>
</tr>
<tr class="oddRow">
<td align="left">SubGroupCode</td>
<td align="left">string</td>
<td align="left">Room sub-group</td>
</tr>
<tr class="evenRow">
<td align="left">RoomtypeCode</td>
<td align="left">string</td>
<td align="left">Room type</td>
</tr>
<tr class="oddRow">
<td align="left">Status</td>
<td align="left">string</td>
<td align="left">Room occupancy status (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">HKStatus</td>
<td align="left">string</td>
<td align="left">Room housekeeping status (see below)</td>
</tr>
<tr class="oddRow">
<td align="left">Smoke</td>
<td align="left">int</td>
<td align="left">Smoking flag</td>
</tr>
<tr class="evenRow">
<td align="left">RoomStatusDescription</td>
<td align="left">string</td>
<td align="left">Room occupancy status description</td>
</tr>
<tr class="oddRow">
<td align="left">HKDescription</td>
<td align="left">string</td>
<td align="left">Room housekeeping status description</td>
</tr>
</tbody>
</table>
<p><strong>Room occupancy status</strong> can be one of:</p>
<ul>
<li>"Status_OutOfService"</li>
<li>"Status_Occupied"</li>
<li>"Status_Vacant"</li>
</ul>
<p><strong>Room housekeeping status</strong> can be one of:</p>
<ul>
<li>"HKStatus_DoNothing"</li>
<li>"HKStatus_Freshen"</li>
<li>"HKStatus_PartialClean"</li>
<li>"HKStatus_FullClean"</li>
<li>"HKStatus_Custom1"</li>
<li>"HKStatus_Custom2"</li>
<li>"HKStatus_Custom3"</li>
<li>"HKStatus_Custom4"</li>
</ul>
<table>
<tbody>
<tr class="evenRow">
<td align="left">More</td>
<td align="left"><a class="tc-tiddlylink tc-tiddlylink-resolves" href="#Room%20Status%20codes">Room Status
codes</a></td>
</tr>
</tbody>
</table>
pmsint_GetRoomStatusSoapIn
<pmsint_GetRoomStatus xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>918d8ea2-0276-4816-9c73-6af50e8de0a4</SessionID>
<RoomID>107</RoomID>
</pmsint_GetRoomStatus>
pmsint_GetRoomStatusSoapOut
<pmsint_GetRoomStatusResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetRoomStatusResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetRoomStatusResult>
<GetRoomStatus>
<RoomStatus>
<cpmsint_GetRoomStatus_RoomStatusItem>
<RoomId>107</RoomId>
<RoomDescription>Meadow Cottage</RoomDescription>
<SubGroupCode>MEADOW</SubGroupCode>
<RoomtypeCode>COTTAGE_1</RoomtypeCode>
<Status>Status_Occupied</Status>
<HKStatus>HKStatus_FullClean</HKStatus>
<Smoke>0</Smoke>
<RoomStatusDescription>Occupied</RoomStatusDescription>
<HKDescription>Departure / Dirty Room</HKDescription>
</cpmsint_GetRoomStatus_RoomStatusItem>
</RoomStatus>
</GetRoomStatus>
</pmsint_GetRoomStatusResponse>
<p>This method retrieves a list of all rooms configured in the PMS.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID obtained at log-in</td></tr></tbody></table><h2 class="">Returned data (rooms)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">RoomID</td><td align="left">101</td><td align="left">Room reference (room name or number)</td></tr></tbody></table>
pmsint_GetRoomsSoapIn
<pmsint_GetRooms xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>2368549e-1c2d-49d5-8230-b1a4a5ce9a6d</SessionID>
</pmsint_GetRooms>
pmsint_GetRoomsSoapOut
<pmsint_GetRoomsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetRoomsResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetRoomsResult>
<GetRooms>
<Rooms>
<Room>
<RoomID>101</RoomID>
</Room>
<Room>
<RoomID>102</RoomID>
</Room>
<Room>
<RoomID>103</RoomID>
</Room>
<Room>
<RoomID>104</RoomID>
</Room>
<Room>
<RoomID>FAMILY_ROOM</RoomID>
</Room>
</Rooms>
</GetRooms>
</pmsint_GetRoomsResponse>
<p>Retrieve a list of all arrivals on a specified date, i.e. residents guests scheduled to check-in on that day.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">ArrivalDate</td><td align="left">dateTime</td><td align="left">Arrival date</td></tr></tbody></table><h2 class="">Returned data (arrival)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">DepositPaid</td><td align="left">decimal</td><td align="left">Amount of any deposit paid</td></tr><tr class="evenRow"><td align="left">DepositDue</td><td align="left">decimal</td><td align="left">Amount of any deposit</td></tr><tr class="oddRow"><td align="left">Infants</td><td align="left">int</td><td align="left">Number of infants</td></tr><tr class="evenRow"><td align="left">Children</td><td align="left">int</td><td align="left">Number of children</td></tr><tr class="oddRow"><td align="left">Adults</td><td align="left">int</td><td align="left">Number of adults</td></tr><tr class="evenRow"><td align="left">RoomType</td><td align="left">string</td><td align="left">Room type</td></tr><tr class="oddRow"><td align="left">Package</td><td align="left">string</td><td align="left">Package code</td></tr><tr class="evenRow"><td align="left">Company</td><td align="left">string</td><td align="left">Company name, if applicable</td></tr><tr class="oddRow"><td align="left">Notes</td><td align="left">string</td><td align="left">Notes</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking or reservation reference, e.g. 'BK000070'</td></tr><tr class="oddRow"><td align="left">BookRefRoomRef</td><td align="left">string</td><td align="left">Long-format booking or reservation reference, e.g. 'BK000070/1'</td></tr><tr class="evenRow"><td align="left">ETA</td><td align="left">dateTime</td><td align="left">Estimated time of arrival</td></tr><tr class="oddRow"><td align="left">Salutation</td><td align="left">string</td><td align="left">Guest form of address or title</td></tr><tr class="evenRow"><td align="left">Surname</td><td align="left">string</td><td align="left">Guest surname</td></tr><tr class="oddRow"><td align="left">Forename</td><td align="left">string</td><td align="left">Guest forename</td></tr><tr class="evenRow"><td align="left">RoomID</td><td align="left">string</td><td align="left">Room reference (room name or number)</td></tr><tr class="oddRow"><td align="left">ProfileReference</td><td align="left">string</td><td align="left">Guest profile reference</td></tr><tr class="evenRow"><td align="left">DepositOutstanding</td><td align="left">decimal</td><td align="left">Amount of deposit outstanding (calculated difference between deposit due and deposit paid)</td></tr><tr class="oddRow"><td align="left">TotalNights</td><td align="left">int</td><td align="left">Total number of nights booked</td></tr><tr class="evenRow"><td align="left">PrivateNotes</td><td align="left">string</td><td align="left">Notes (private)</td></tr><tr class="oddRow"><td align="left">PublicNotes</td><td align="left">string</td><td align="left">Notes (public)</td></tr><tr class="evenRow"><td align="left">CustomNotes1</td><td align="left">string</td><td align="left">Notes (custom #1)</td></tr><tr class="oddRow"><td align="left">CustomNotes2</td><td align="left">string</td><td align="left">Notes (custom #2)</td></tr><tr class="evenRow"><td align="left">CustomNotes3</td><td align="left">string</td><td align="left">Notes (custom #3)</td></tr><tr class="oddRow"><td align="left">ExternalNotes</td><td align="left">string</td><td align="left">Notes (external)</td></tr><tr class="evenRow"><td align="left">PreCalcChargesTotalGross</td><td align="left">decimal</td><td align="left">Total gross amount of booking</td></tr><tr class="oddRow"><td align="left">PreCalcChargesTotalNett</td><td align="left">decimal</td><td align="left">Total net amount of booking</td></tr><tr class="evenRow"><td align="left">Master</td><td align="left">boolean</td><td align="left">Flag set to true if master booking</td></tr></tbody></table>
pmsint_GetArrivalsSoapIn
<pmsint_GetArrivals xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<ArrivalDate>2018-06-14T15:14:00</ArrivalDate>
<GetArrivals>
</GetArrivals>
</pmsint_GetArrivals>
pmsint_GetArrivalsSoapOut
<pmsint_GetArrivalsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetArrivalsResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetArrivalsResult>
<GetArrivals>
<Arrivals>
<cpmsint_GetArrivals_ArrivalItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>BAR_BB</Package>
<Company />
<Notes />
<BookRef>BK000071</BookRef>
<BookRefRoomRef>BK000071/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Salutation>Miss</Salutation>
<Surname>Jenks</Surname>
<Forename>Sarah</Forename>
<RoomID>111</RoomID>
<ProfileReference>PF000090</ProfileReference>
<DepositOutstanding>0.0000</DepositOutstanding>
<TotalNights>1</TotalNights>
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<PreCalcChargesTotalGross>80.0000</PreCalcChargesTotalGross>
<PreCalcChargesTotalNett>66.6600</PreCalcChargesTotalNett>
<Master>false</Master>
</cpmsint_GetArrivals_ArrivalItem>
</Arrivals>
</GetArrivals>
</pmsint_GetArrivalsResponse>
<p>Retrieve a list of all departures on a specified date, i.e. resident guests scheduled to check-out on that day.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">DepartureDate</td><td align="left">dateTime</td><td align="left">Departure date</td></tr></tbody></table><h2 class="">Returned data (departure)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">DepositPaid</td><td align="left">decimal</td><td align="left">Amount of any deposit paid</td></tr><tr class="evenRow"><td align="left">DepositDue</td><td align="left">decimal</td><td align="left">Amount of any deposit</td></tr><tr class="oddRow"><td align="left">Infants</td><td align="left">int</td><td align="left">Number of infants</td></tr><tr class="evenRow"><td align="left">Children</td><td align="left">int</td><td align="left">Number of children</td></tr><tr class="oddRow"><td align="left">Adults</td><td align="left">int</td><td align="left">Number of adults</td></tr><tr class="evenRow"><td align="left">RoomType</td><td align="left">string</td><td align="left">Room type</td></tr><tr class="oddRow"><td align="left">Package</td><td align="left">string</td><td align="left">Package code</td></tr><tr class="evenRow"><td align="left">Company</td><td align="left">string</td><td align="left">Company name, if applicable</td></tr><tr class="oddRow"><td align="left">Notes</td><td align="left">string</td><td align="left">Notes</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking or reservation reference, e.g. 'BK000070'</td></tr><tr class="oddRow"><td align="left">BookRefRoomRef</td><td align="left">string</td><td align="left">Long-format booking or reservation reference, e.g. 'BK000070/1'</td></tr><tr class="evenRow"><td align="left">ETA</td><td align="left">dateTime</td><td align="left">Estimated time of arrival</td></tr><tr class="oddRow"><td align="left">Salutation</td><td align="left">string</td><td align="left">Guest form of address or title</td></tr><tr class="evenRow"><td align="left">Surname</td><td align="left">string</td><td align="left">Guest surname</td></tr><tr class="oddRow"><td align="left">Forename</td><td align="left">string</td><td align="left">Guest forename</td></tr><tr class="evenRow"><td align="left">RoomID</td><td align="left">string</td><td align="left">Room reference (room name or number)</td></tr><tr class="oddRow"><td align="left">ETD</td><td align="left">dateTime</td><td align="left">Estimated time of departure</td></tr><tr class="evenRow"><td align="left">PrivateNotes</td><td align="left">string</td><td align="left">Notes (private)</td></tr><tr class="oddRow"><td align="left">PublicNotes</td><td align="left">string</td><td align="left">Notes (public)</td></tr><tr class="evenRow"><td align="left">CustomNotes1</td><td align="left">string</td><td align="left">Notes (custom #1)</td></tr><tr class="oddRow"><td align="left">CustomNotes2</td><td align="left">string</td><td align="left">Notes (custom #2)</td></tr><tr class="evenRow"><td align="left">CustomNotes3</td><td align="left">string</td><td align="left">Notes (custom #3)</td></tr><tr class="oddRow"><td align="left">ExternalNotes</td><td align="left">string</td><td align="left">Notes (external)</td></tr><tr class="evenRow"><td align="left">Master</td><td align="left">boolean</td><td align="left">Flag set to true if master booking</td></tr><tr class="oddRow"><td align="left">RoomBalance</td><td align="left">decimal</td><td align="left">Amount of balance due</td></tr></tbody></table>
pmsint_GetDeparturesSoapIn
<pmsint_GetDepartures xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<DepartureDate>2018-06-14T15:14:00</DepartureDate>
<GetDepartures>
</GetDepartures>
</pmsint_GetDepartures>
pmsint_GetDeparturesSoapOut
<pmsint_GetDeparturesResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetDeparturesResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetDeparturesResult>
<GetDepartures>
<Departures>
<cpmsint_GetDepartures_DepartureItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_2</RoomType>
<Package>24_HOUR</Package>
<Company />
<Notes />
<BookRef>BK000063</BookRef>
<BookRefRoomRef>BK000063/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Salutation>Mr</Salutation>
<Surname>Smith</Surname>
<Forename>Paul</Forename>
<RoomID>108</RoomID>
<ETD>1899-12-30T00:00:00</ETD>
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
<RoomBalance>234.0000</RoomBalance>
</cpmsint_GetDepartures_DepartureItem>
<cpmsint_GetDepartures_DepartureItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_3</RoomType>
<Package>BAR1</Package>
<Company />
<Notes />
<BookRef>BK000068</BookRef>
<BookRefRoomRef>BK000068/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Salutation>Mr</Salutation>
<Surname>Olteanu</Surname>
<Forename>Mihai</Forename>
<RoomID>109</RoomID>
<ETD>1899-12-30T00:00:00</ETD>
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
<RoomBalance>201.0000</RoomBalance>
</cpmsint_GetDepartures_DepartureItem>
<cpmsint_GetDepartures_DepartureItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_SUPERIOR</RoomType>
<Package>24_HOUR</Package>
<Company />
<Notes />
<BookRef>BK000065</BookRef>
<BookRefRoomRef>BK000065/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Salutation>Mr</Salutation>
<Surname>Test</Surname>
<Forename>System</Forename>
<RoomID>117</RoomID>
<ETD>1899-12-30T00:00:00</ETD>
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
<RoomBalance>154.0000</RoomBalance>
</cpmsint_GetDepartures_DepartureItem>
<cpmsint_GetDepartures_DepartureItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_SUPERIOR</RoomType>
<Package>24_HOUR</Package>
<Company />
<Notes />
<BookRef>BK000066</BookRef>
<BookRefRoomRef>BK000066/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Salutation>Mr</Salutation>
<Surname>Murray</Surname>
<Forename>Andy</Forename>
<RoomID>118</RoomID>
<ETD>1899-12-30T00:00:00</ETD>
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
<RoomBalance>154.0000</RoomBalance>
</cpmsint_GetDepartures_DepartureItem>
<cpmsint_GetDepartures_DepartureItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>24_HOUR</Package>
<Company />
<Notes />
<BookRef>BK000064</BookRef>
<BookRefRoomRef>BK000064/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Salutation>Miss</Salutation>
<Surname>Tester</Surname>
<Forename>Alison</Forename>
<RoomID>120</RoomID>
<ETD>1899-12-30T00:00:00</ETD>
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
<RoomBalance>139.0000</RoomBalance>
</cpmsint_GetDepartures_DepartureItem>
</Departures>
</GetDepartures>
</pmsint_GetDeparturesResponse>
<p>Retrieve a list of all departures on a specified date, i.e. resident guests scheduled to check-out on that day, but also with some additional information such as email address, arrival date, departure date and number of nights. A profile attribute parameter can also be specified to fetch custom attribute values stored against the guest profile.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">DepartureDate</td><td align="left">dateTime</td><td align="left">Departure date</td></tr><tr class="oddRow"><td align="left">ProfileAttribute</td><td align="left">string</td><td align="left">Name of profile attribute (optional)</td></tr></tbody></table><h2 class="">Returned data (departure)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">DepositPaid</td><td align="left">decimal</td><td align="left">Amount of any deposit paid</td></tr><tr class="evenRow"><td align="left">Infants</td><td align="left">int</td><td align="left">Number of infants</td></tr><tr class="oddRow"><td align="left">Children</td><td align="left">int</td><td align="left">Number of children</td></tr><tr class="evenRow"><td align="left">Adults</td><td align="left">int</td><td align="left">Number of adults</td></tr><tr class="oddRow"><td align="left">RoomType</td><td align="left">string</td><td align="left">Room type</td></tr><tr class="evenRow"><td align="left">Package</td><td align="left">string</td><td align="left">Package code</td></tr><tr class="oddRow"><td align="left">Company</td><td align="left">string</td><td align="left">Company name, if applicable</td></tr><tr class="evenRow"><td align="left">Notes</td><td align="left">string</td><td align="left">Notes</td></tr><tr class="oddRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking or reservation reference, e.g. 'BK000070'</td></tr><tr class="evenRow"><td align="left">BookRefRoomRef</td><td align="left">string</td><td align="left">Long-format booking or reservation reference, e.g. 'BK000070/1'</td></tr><tr class="oddRow"><td align="left">ETA</td><td align="left">dateTime</td><td align="left">Estimated time of arrival</td></tr><tr class="evenRow"><td align="left">Salutation</td><td align="left">string</td><td align="left">Guest form of address or title</td></tr><tr class="oddRow"><td align="left">Surname</td><td align="left">string</td><td align="left">Guest surname</td></tr><tr class="evenRow"><td align="left">Forename</td><td align="left">string</td><td align="left">Guest forename</td></tr><tr class="oddRow"><td align="left">RoomID</td><td align="left">string</td><td align="left">Room reference (room name or number)</td></tr><tr class="evenRow"><td align="left">Email</td><td align="left">string</td><td align="left">E-mail address</td></tr><tr class="oddRow"><td align="left">ProfileReference</td><td align="left">string</td><td align="left">Profile reference</td></tr><tr class="evenRow"><td align="left">Arrival</td><td align="left">dateTime</td><td align="left">Date of arrival</td></tr><tr class="oddRow"><td align="left">Departure</td><td align="left">dateTime</td><td align="left">Date of departure</td></tr><tr class="evenRow"><td align="left">TotalNights</td><td align="left">int</td><td align="left">Total number of nights of stay</td></tr><tr class="oddRow"><td align="left">AttributeValue</td><td align="left">string</td><td align="left">Profile attribute value for specified profile attribute, if requested</td></tr><tr class="evenRow"><td align="left">ETD</td><td align="left">dateTime</td><td align="left">Estimated time of departure</td></tr><tr class="oddRow"><td align="left">PrivateNotes</td><td align="left">string</td><td align="left">Notes (private)</td></tr><tr class="evenRow"><td align="left">PublicNotes</td><td align="left">string</td><td align="left">Notes (public)</td></tr><tr class="oddRow"><td align="left">CustomNotes1</td><td align="left">string</td><td align="left">Notes (custom #1)</td></tr><tr class="evenRow"><td align="left">CustomNotes2</td><td align="left">string</td><td align="left">Notes (custom #2)</td></tr><tr class="oddRow"><td align="left">CustomNotes3</td><td align="left">string</td><td align="left">Notes (custom #3)</td></tr><tr class="evenRow"><td align="left">ExternalNotes</td><td align="left">string</td><td align="left">Notes (external)</td></tr><tr class="oddRow"><td align="left">Master</td><td align="left">boolean</td><td align="left">Flag set to true if master booking</td></tr><tr class="evenRow"><td align="left">RoomBalance</td><td align="left">decimal</td><td align="left">Amount of balance due</td></tr><tr class="oddRow"><td align="left">BookingType</td><td align="left">"Bedroom", "Function" or "Nra"</td><td align="left">Booking type (bedroom, function room or non-resident account)</td></tr></tbody></table>
pmsfoh_GetDeparturesExtendedSoapIn
<pmsfoh_GetDeparturesExtended xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<DepartureDate>2018-06-14T15:14:00</DepartureDate>
<ProfileAttribute>???</ProfileAttribute>
<GetDeparturesListExtended />
</pmsfoh_GetDeparturesExtended>
pmsfoh_GetDeparturesExtendedSoapOut
<pmsfoh_GetDeparturesExtendedResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsfoh_GetDeparturesExtendedResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsfoh_GetDeparturesExtendedResult>
<GetDeparturesListExtended>
<ReservationDepartureItemExtended>
<DepositPaid>0</DepositPaid>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_1</RoomType>
<Package>24_HOUR</Package>
<Company />
<Notes />
<BookRef>BK000073</BookRef>
<BookRefRoomRef>BK000073/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Salutation>Mr</Salutation>
<Surname>Jones</Surname>
<ForeName>Chris</ForeName>
<RoomID />
<ProfileReference />
<Arrival>2018-06-28T00:00:00</Arrival>
<Departure>2018-06-29T00:00:00</Departure>
<TotalNights>1</TotalNights>
<ETD>1899-12-30T00:00:00</ETD>
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
<RoomBalance>0</RoomBalance>
<BookingType>Bedroom</BookingType>
</ReservationDepartureItemExtended>
</GetDeparturesListExtended>
</pmsfoh_GetDeparturesExtendedResponse>
<p>Retrieves a list of resident bookings, either currently resident (if no dates are provided), or over a specified period (if dates are given).</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">FromDate</td><td align="left">dateTime</td><td align="left">Optional from-date</td></tr><tr class="oddRow"><td align="left">ToDate</td><td align="left">dateTime</td><td align="left">Optional to-date</td></tr><tr class="evenRow"><td align="left">BookingType</td><td align="left">"bkt_Bedroom", "bkt_FunctionRoom" or "bkt_NRA"</td><td align="left">Booking type - either bedroom, function room, NRA (Non Resident Account), or all (if nothing specified)</td></tr></tbody></table><h2 class="">Returned data (resident)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">DepositPaid</td><td align="left">decimal</td><td align="left">Amount of deposit already paid</td></tr><tr class="evenRow"><td align="left">DepositDue</td><td align="left">decimal</td><td align="left">Amount of deposit due</td></tr><tr class="oddRow"><td align="left">Infants</td><td align="left">int</td><td align="left">Number of infants</td></tr><tr class="evenRow"><td align="left">Children</td><td align="left">int</td><td align="left">Number of children</td></tr><tr class="oddRow"><td align="left">Adults</td><td align="left">int</td><td align="left">Number of adults</td></tr><tr class="evenRow"><td align="left">RoomType</td><td align="left">string</td><td align="left">Room type code</td></tr><tr class="oddRow"><td align="left">Package</td><td align="left">string</td><td align="left">Package code</td></tr><tr class="evenRow"><td align="left">Company</td><td align="left">string</td><td align="left">Company name</td></tr><tr class="oddRow"><td align="left">Notes</td><td align="left">string</td><td align="left">Optional notes</td></tr><tr class="evenRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Reservation or booking reference</td></tr><tr class="oddRow"><td align="left">BookRefRoomRef</td><td align="left">string</td><td align="left">Long-format reservation reference, e.g. "BK000054/1"</td></tr><tr class="evenRow"><td align="left">ETA</td><td align="left">dateTime</td><td align="left">Estimated time of arrival</td></tr><tr class="oddRow"><td align="left">Arrival</td><td align="left">dateTime</td><td align="left">Arrival date</td></tr><tr class="evenRow"><td align="left">Departure</td><td align="left">dateTime</td><td align="left">Departure date</td></tr><tr class="oddRow"><td align="left">Salutation</td><td align="left">string</td><td align="left">Guest form of address</td></tr><tr class="evenRow"><td align="left">Surname</td><td align="left">string</td><td align="left">Guest surname</td></tr><tr class="oddRow"><td align="left">Forename</td><td align="left">string</td><td align="left">Guest forename</td></tr><tr class="evenRow"><td align="left">RoomID</td><td align="left">string</td><td align="left">Room reference (room number or name)</td></tr><tr class="oddRow"><td align="left">MovieAccess</td><td align="left">string</td><td align="left"><a class="tc-tiddlylink tc-tiddlylink-resolves" href="#Movie%20Access">Movie Access</a> code</td></tr><tr class="evenRow"><td align="left">PrivateNotes</td><td align="left">string</td><td align="left">Notes (private)</td></tr><tr class="oddRow"><td align="left">PublicNotes</td><td align="left">string</td><td align="left">Notes (public)</td></tr><tr class="evenRow"><td align="left">CustomNotes1</td><td align="left">string</td><td align="left">Notes (custom #1)</td></tr><tr class="oddRow"><td align="left">CustomNotes2</td><td align="left">string</td><td align="left">Notes (custom #2)</td></tr><tr class="evenRow"><td align="left">CustomNotes3</td><td align="left">string</td><td align="left">Notes (custom #3)</td></tr><tr class="oddRow"><td align="left">ExternalNotes</td><td align="left">string</td><td align="left">Notes (external)</td></tr><tr class="evenRow"><td align="left">Master</td><td align="left">boolean</td><td align="left">Master reservation flag</td></tr></tbody></table>
pmsint_GetResidentsSoapIn
<pmsint_GetResidents xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>918d8ea2-0276-4816-9c73-6af50e8de0a4</SessionID>
<FromDate>2018-05-01T10:31:59</FromDate>
<ToDate>2018-05-31T10:31:59</ToDate>
<BookingType xsi:nil="true" />
</pmsint_GetResidents>
pmsint_GetResidentsSoapOut
<pmsint_GetResidentsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetResidentsResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetResidentsResult>
<GetResidents>
<Residents>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>PENTHOUSE</RoomType>
<Package>BAR_BB</Package>
<Company />
<Notes />
<BookRef>BK000051</BookRef>
<BookRefRoomRef>BK000051/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-05T00:00:00</Arrival>
<Departure>2018-05-08T00:00:00</Departure>
<Salutation />
<Surname>Galli</Surname>
<Forename>Matteo</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>-7.7700</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_2</RoomType>
<Package>BAR_BB</Package>
<Company />
<Notes />
<BookRef>BK000052</BookRef>
<BookRefRoomRef>BK000052/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-09T00:00:00</Arrival>
<Departure>2018-05-16T00:00:00</Departure>
<Salutation>Mr</Salutation>
<Surname>Adams</Surname>
<Forename>Mike</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>BAR_RO</Package>
<Company />
<Notes />
<BookRef>BK000053</BookRef>
<BookRefRoomRef>BK000053/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-16T00:00:00</Arrival>
<Departure>2018-05-19T00:00:00</Departure>
<Salutation />
<Surname>Galli</Surname>
<Forename>Matteo</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>BAR_RO</Package>
<Company />
<Notes />
<BookRef>BK000054</BookRef>
<BookRefRoomRef>BK000054/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-15T00:00:00</Arrival>
<Departure>2018-05-18T00:00:00</Departure>
<Salutation />
<Surname>Galli</Surname>
<Forename>Matteo</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>INC_FULL</Package>
<Company />
<Notes />
<BookRef>BK000055</BookRef>
<BookRefRoomRef>BK000055/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-10T00:00:00</Arrival>
<Departure>2018-05-11T00:00:00</Departure>
<Salutation />
<Surname>Adams</Surname>
<Forename />
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_STANDARD</RoomType>
<Package>INC_FULL</Package>
<Company>Boots The Chemist</Company>
<Notes />
<BookRef>BK000044</BookRef>
<BookRefRoomRef>BK000044/3</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-01T00:00:00</Arrival>
<Departure>2018-05-03T00:00:00</Departure>
<Salutation />
<Surname>Adams Doggie</Surname>
<Forename />
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_1</RoomType>
<Package>FLOWER_SHOW</Package>
<Company />
<Notes />
<BookRef>BK000058</BookRef>
<BookRefRoomRef>BK000058/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-23T00:00:00</Arrival>
<Departure>2018-05-24T00:00:00</Departure>
<Salutation>Mr</Salutation>
<Surname>Smith</Surname>
<Forename />
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_1</RoomType>
<Package>24_HOUR</Package>
<Company />
<Notes />
<BookRef>BK000059</BookRef>
<BookRefRoomRef>BK000059/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-29T00:00:00</Arrival>
<Departure>2018-05-30T00:00:00</Departure>
<Salutation>Mrs</Salutation>
<Surname>Windsor</Surname>
<Forename>Elizabeth</Forename>
<RoomID />
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>DBL_SUPERIOR</RoomType>
<Package>INC_FULL</Package>
<Company />
<Notes />
<BookRef>BK000050</BookRef>
<BookRefRoomRef>BK000050/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-01T00:00:00</Arrival>
<Departure>2018-05-02T00:00:00</Departure>
<Salutation>Ms</Salutation>
<Surname>Bobbin</Surname>
<Forename>Claire</Forename>
<RoomID>104</RoomID>
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>FUNCTION</RoomType>
<Package>FUNC_RO_HALF</Package>
<Company />
<Notes />
<BookRef>BK000056</BookRef>
<BookRefRoomRef>BK000056/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-10T09:00:00</Arrival>
<Departure>2018-05-18T00:00:00</Departure>
<Salutation>Mr</Salutation>
<Surname>Adams</Surname>
<Forename>Mike</Forename>
<RoomID>901</RoomID>
<MovieAccess />
<PrivateNotes />
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
<cpmsint_GetResidents_ResidentItem>
<DepositPaid>0</DepositPaid>
<DepositDue>0.0000</DepositDue>
<Infants>0</Infants>
<Children>0</Children>
<Adults>1</Adults>
<RoomType>COTTAGE_1</RoomType>
<Package>24_HOUR</Package>
<Company />
<Notes>guest likes extra pillows</Notes>
<BookRef>BK000057</BookRef>
<BookRefRoomRef>BK000057/1</BookRefRoomRef>
<ETA>1899-12-30T00:00:00</ETA>
<Arrival>2018-05-17T00:00:00</Arrival>
<Departure>2018-05-18T00:00:00</Departure>
<Salutation>Mr</Salutation>
<Surname>Agg</Surname>
<Forename>James</Forename>
<RoomID>COTAMARYLLIS</RoomID>
<MovieAccess />
<PrivateNotes>guest likes extra pillows</PrivateNotes>
<PublicNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
<ExternalNotes />
<Master>false</Master>
</cpmsint_GetResidents_ResidentItem>
</Residents>
</GetResidents>
</pmsint_GetResidentsResponse>
Retrieve a list of all room balances across the entire site.
<h4>Parameters</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr></tbody></table><h4>Returned data (balance item)</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">Balance</td><td align="left">decimal</td><td align="left">Balance amount</td></tr><tr class="evenRow"><td align="left">Package</td><td align="left">string</td><td align="left">Package code</td></tr><tr class="oddRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking or reservation reference, e.g. "BK000052"</td></tr><tr class="evenRow"><td align="left">BookRefRoomRef</td><td align="left">string</td><td align="left">Long-format booking or reservation reference, e.g. "BK000052/1"</td></tr><tr class="oddRow"><td align="left">Arrival</td><td align="left">dateTime</td><td align="left">Arrival date</td></tr><tr class="evenRow"><td align="left">Departure</td><td align="left">dateTime</td><td align="left">Departure date</td></tr><tr class="oddRow"><td align="left">Surname</td><td align="left">string</td><td align="left">Guest surname</td></tr><tr class="evenRow"><td align="left">RoomID</td><td align="left">string</td><td align="left">Room reference (room number or name)</td></tr></tbody></table>
pmsint_GetRoomBalancesSoapIn
<pmsint_GetRoomBalances xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<GetRoomBalances />
</pmsint_GetRoomBalances>
pmsint_GetRoomBalancespOut
<pmsint_GetRoomBalancesResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetRoomBalancesResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetRoomBalancesResult>
<GetRoomBalances>
<RoomBalances>
<cpmsint_GetRoomBalances_RoomBalanceItem>
<Balance>5486.5900</Balance>
<Package>BAR_BB</Package>
<BookRef>BK000032</BookRef>
<BookRefRoomRef>BK000032/1</BookRefRoomRef>
<Arrival>2018-02-06T00:00:00</Arrival>
<Departure>2018-02-07T00:00:00</Departure>
<Surname>X</Surname>
<RoomID>101</RoomID>
</cpmsint_GetRoomBalances_RoomBalanceItem>
<cpmsint_GetRoomBalances_RoomBalanceItem>
<Balance>937.7300</Balance>
<Package>24_HOUR</Package>
<BookRef>BK000033</BookRef>
<BookRefRoomRef>BK000033/1</BookRefRoomRef>
<Arrival>2018-02-06T00:00:00</Arrival>
<Departure>2018-02-08T00:00:00</Departure>
<Surname>Adams</Surname>
<RoomID>102</RoomID>
</cpmsint_GetRoomBalances_RoomBalanceItem>
<cpmsint_GetRoomBalances_RoomBalanceItem>
<Balance>209.0000</Balance>
<Package>24_HOUR</Package>
<BookRef>BK000057</BookRef>
<BookRefRoomRef>BK000057/1</BookRefRoomRef>
<Arrival>2018-05-17T00:00:00</Arrival>
<Departure>2018-05-18T00:00:00</Departure>
<Surname>Agg</Surname>
<RoomID>COTAMARYLLIS</RoomID>
</cpmsint_GetRoomBalances_RoomBalanceItem>
</RoomBalances>
</GetRoomBalances>
</pmsint_GetRoomBalancesResponse>
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).
<h4>Parameters</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">SelectionCriteria</td><td align="left">(XmlDocument)</td><td align="left">Selection criteria</td></tr><tr class="oddRow"><td align="left">PeriodID</td><td align="left">int</td><td align="left">Period ID</td></tr><tr class="evenRow"><td align="left">KepyoReport</td><td align="left">Boolean</td><td align="left">Kepyo report flag</td></tr><tr class="oddRow"><td align="left">KepyoUserDef1</td><td align="left">string</td><td align="left">Kepyo user parameter #1</td></tr><tr class="evenRow"><td align="left">KepyoUserDef2</td><td align="left">string</td><td align="left">Kepyo user parameter #2</td></tr></tbody></table><h4>Returned data</h4><pre class="xml hljs"><code><span class="hljs-tag"><<span class="hljs-title">Data</span>></span>&lt;DOCUMENT&gt;&lt;DEPOSITANALYSIS&gt;&lt;DEPOSITANALYSISTOTALS&gt;&lt;DEP_BFWD&gt;&lt;DESCRIPTION&gt;Deposit Balance Brought Forward&lt;/DESCRIPTION&gt;&lt;NETTTOTAL&gt;0&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;0&lt;/TAXTOTAL&gt;&lt;GROSSTOTAL&gt;0&lt;/GROSSTOTAL&gt;&lt;/DEP_BFWD&gt;&lt;DEP_RECVD&gt;&lt;DESCRIPTION&gt;Deposits Received&lt;/DESCRIPTION&gt;&lt;NETTTOTAL&gt;0&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;0&lt;/TAXTOTAL&gt;&lt;GROSSTOTAL&gt;0&lt;/GROSSTOTAL&gt;&lt;/DEP_RECVD&gt;&lt;DEP_REFUD&gt;&lt;DESCRIPTION&gt;Deposits Refunded&lt;/DESCRIPTION&gt;&lt;NETTTOTAL&gt;0&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;0&lt;/TAXTOTAL&gt;&lt;GROSSTOTAL&gt;0&lt;/GROSSTOTAL&gt;&lt;/DEP_REFUD&gt;&lt;DEP_RETND&gt;&lt;DESCRIPTION&gt;Deposits Retained&lt;/DESCRIPTION&gt;&lt;NETTTOTAL&gt;0&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;0&lt;/TAXTOTAL&gt;&lt;GROSSTOTAL&gt;0&lt;/GROSSTOTAL&gt;&lt;/DEP_RETND&gt;&lt;DEP_INHOUSE&gt;&lt;DESCRIPTION&gt;Deposits InHouse/InUse&lt;/DESCRIPTION&gt;&lt;NETTTOTAL&gt;0&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;0&lt;/TAXTOTAL&gt;&lt;GROSSTOTAL&gt;0&lt;/GROSSTOTAL&gt;&lt;/DEP_INHOUSE&gt;&lt;DEP_BAL_ACT&gt;&lt;DESCRIPTION&gt;Deposit Balance (Actual)&lt;/DESCRIPTION&gt;&lt;NETTTOTAL&gt;0&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;0&lt;/TAXTOTAL&gt;&lt;GROSSTOTAL&gt;0&lt;/GROSSTOTAL&gt;&lt;/DEP_BAL_ACT&gt;&lt;/DEPOSITANALYSISTOTALS&gt;&lt;DEPOSITANALYSISTRANS&gt;&lt;DEP_RECVD&gt;&lt;TRANSID&gt;&lt;/TRANSID&gt;&lt;ANALCODE&gt;&lt;/ANALCODE&gt;&lt;DESCRIPTION&gt;&lt;/DESCRIPTION&gt;&lt;QUANTITY&gt;&lt;/QUANTITY&gt;&lt;GROSSPERUNIT&gt;&lt;/GROSSPERUNIT&gt;&lt;GROSSTOTAL&gt;&lt;/GROSSTOTAL&gt;&lt;NETTPERUNIT&gt;&lt;/NETTPERUNIT&gt;&lt;NETTTOTAL&gt;&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;&lt;/TAXTOTAL&gt;&lt;COMPANYREF&gt;&lt;/COMPANYREF&gt;&lt;SOURCE&gt;&lt;/SOURCE&gt;&lt;/DEP_RECVD&gt;&lt;DEP_REFUD&gt;&lt;TRANSID&gt;&lt;/TRANSID&gt;&lt;ANALCODE&gt;&lt;/ANALCODE&gt;&lt;DESCRIPTION&gt;&lt;/DESCRIPTION&gt;&lt;QUANTITY&gt;&lt;/QUANTITY&gt;&lt;GROSSPERUNIT&gt;&lt;/GROSSPERUNIT&gt;&lt;GROSSTOTAL&gt;&lt;/GROSSTOTAL&gt;&lt;NETTPERUNIT&gt;&lt;/NETTPERUNIT&gt;&lt;NETTTOTAL&gt;&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;&lt;/TAXTOTAL&gt;&lt;COMPANYREF&gt;&lt;/COMPANYREF&gt;&lt;SOURCE&gt;&lt;/SOURCE&gt;&lt;/DEP_REFUD&gt;&lt;DEP_RETND&gt;&lt;TRANSID&gt;&lt;/TRANSID&gt;&lt;ANALCODE&gt;&lt;/ANALCODE&gt;&lt;DESCRIPTION&gt;&lt;/DESCRIPTION&gt;&lt;QUANTITY&gt;&lt;/QUANTITY&gt;&lt;GROSSPERUNIT&gt;&lt;/GROSSPERUNIT&gt;&lt;GROSSTOTAL&gt;&lt;/GROSSTOTAL&gt;&lt;NETTPERUNIT&gt;&lt;/NETTPERUNIT&gt;&lt;NETTTOTAL&gt;&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;&lt;/TAXTOTAL&gt;&lt;COMPANYREF&gt;&lt;/COMPANYREF&gt;&lt;SOURCE&gt;&lt;/SOURCE&gt;&lt;/DEP_RETND&gt;&lt;DEP_INHOUSE&gt;&lt;TRANSID&gt;&lt;/TRANSID&gt;&lt;ANALCODE&gt;&lt;/ANALCODE&gt;&lt;DESCRIPTION&gt;&lt;/DESCRIPTION&gt;&lt;QUANTITY&gt;&lt;/QUANTITY&gt;&lt;GROSSPERUNIT&gt;&lt;/GROSSPERUNIT&gt;&lt;GROSSTOTAL&gt;&lt;/GROSSTOTAL&gt;&lt;NETTPERUNIT&gt;&lt;/NETTPERUNIT&gt;&lt;NETTTOTAL&gt;&lt;/NETTTOTAL&gt;&lt;TAXTOTAL&gt;&lt;/TAXTOTAL&gt;&lt;COMPANYREF&gt;&lt;/COMPANYREF&gt;&lt;SOURCE&gt;&lt;/SOURCE&gt;&lt;/DEP_INHOUSE&gt;&lt;/DEPOSITANALYSISTRANS&gt;&lt;/DEPOSITANALYSIS&gt;&lt;/DOCUMENT&gt;<span class="hljs-tag"></<span class="hljs-title">Data</span>></span></code></pre>
pmsint_GetFinancialReportSoapIn
<?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>
pmsint_GetFinancialReportSoapOut
<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>
<p>Send an e-mail from the logged-on web service user account to an internal recipient within the same site (same Site ID).</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">Recipient</td><td align="left">string</td><td align="left">Email address of recipient</td></tr><tr class="oddRow"><td align="left">Subject</td><td align="left">string</td><td align="left">Email subject</td></tr><tr class="evenRow"><td align="left">Body</td><td align="left">string</td><td align="left">Email body content</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsint_SendEmailSoapIn
<pmsint_SendEmail xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>918d8ea2-0276-4816-9c73-6af50e8de0a4</SessionID>
<Recipient>whoever@acme.com</Recipient>
<Subject>GDPR compliance</Subject>
<Body>Please confirm compliance with new EU regulation as per previous correspondence.
Kind regards,
P Panther</Body>
</pmsint_SendEmail></soap:Body></soap:Envelope>
pmsint_SendEmailSoapOut
<pmsint_SendEmailResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_SendEmailResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_SendEmailResult>
</pmsint_SendEmailResponse>
Get financial period information for either a period ID or period type.
<h4>Parameters</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">iPeriodID</td><td align="left">int</td><td align="left">Period ID</td></tr><tr class="oddRow"><td align="left">enmPeriodType</td><td align="left">short</td><td align="left">Period type code</td></tr></tbody></table><h4>Returned data (period list item)</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">strKey</td><td align="left">string</td><td align="left">?</td></tr><tr class="evenRow"><td align="left">iPeriodTypeID</td><td align="left">long</td><td align="left">Period type ID</td></tr><tr class="oddRow"><td align="left">strPeriodDescription</td><td align="left">string</td><td align="left">Period description</td></tr><tr class="evenRow"><td align="left">iPeriodType</td><td align="left">"ppt_EndOfShift", "ppt_EndOfDay", "ppt_EndOfWeek", "ppt_EndOfMonth" or "ppt_EndOfYear"</td><td align="left">Period type</td></tr><tr class="oddRow"><td align="left">iPeriodID</td><td align="left">long</td><td align="left">Period ID</td></tr><tr class="evenRow"><td align="left">dtOpenPeriod</td><td align="left">dateTime</td><td align="left">Date and time period opened</td></tr><tr class="oddRow"><td align="left">dtClosePeriod</td><td align="left">dateTime</td><td align="left">Date and time period closed</td></tr><tr class="evenRow"><td align="left">iStatus</td><td align="left">"psf_Open", "psf_Closing" or "psf_Closed"</td><td align="left">Period current status (open, closing or closed)</td></tr><tr class="oddRow"><td align="left">strOperatorCode</td><td align="left">string</td><td align="left">Operator</td></tr></tbody></table>
pmsint_GetPeriodListSoapIn
<pmsint_GetPeriodList xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>639c76f8-7280-4858-a8e1-e5b809cf63db</SessionID>
<iPeriodID>1</iPeriodID>
<enmPeriodType>2</enmPeriodType>
<GetPeriodList />
</pmsint_GetPeriodList>
pmsint_GetPeriodListSoapOut
<pmsint_GetPeriodListResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsint_GetPeriodListResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsint_GetPeriodListResult>
<GetPeriodList>
<Periods>
<cpmsint_GetPeriodListItem>
<strKey>3</strKey>
<iPeriodTypeID>999</iPeriodTypeID>
<strPeriodDescription />
<iPeriodType>ppt_EndOfDay</iPeriodType>
<iPeriodID>3</iPeriodID>
<dtOpenPeriod>1990-01-01T00:00:00</dtOpenPeriod>
<dtClosePeriod>2017-10-17T14:13:10</dtClosePeriod>
<iStatus>psf_Closed</iStatus>
<strOperatorCode>MCCORMICKP</strOperatorCode>
</cpmsint_GetPeriodListItem>
</Periods>
</GetPeriodList>
</pmsint_GetPeriodListResponse>
<p>Return the list of configured housekeeping status codes and descriptions, i.e. corresponding to 'Clean', 'Dirty',
etc.</p>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID, obtained at log-in</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data (housekeeping code)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">iRoomStatusID</td>
<td align="left">int</td>
<td align="left">Housekeeping code (numeric)</td>
</tr>
<tr class="evenRow">
<td align="left">iParameter1</td>
<td align="left">int</td>
<td align="left">(internal use only)</td>
</tr>
<tr class="oddRow">
<td align="left">strDescription</td>
<td align="left">string</td>
<td align="left">Text description, as it appears on the screen</td>
</tr>
<tr class="evenRow">
<td align="left">strDisplayCode</td>
<td align="left">string</td>
<td align="left">Text abbreviation, as it appears in abbreviated form</td>
</tr>
</tbody>
</table>
<table>
<tbody>
<tr class="evenRow">
<td align="left">More</td>
<td align="left"><a class="tc-tiddlylink tc-tiddlylink-resolves" href="#Room%20Status%20codes">Room Status
codes</a></td>
</tr>
</tbody>
</table>|
pmscfg_HouseKeepingCodesSoapIn
<pmscfg_HouseKeepingCodes xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>a6a70a2d-1ac0-4da0-815a-98cd825a822e</SessionID>
</pmscfg_HouseKeepingCodes>
pmscfg_HouseKeepingCodesSoapOut
<pmscfg_HouseKeepingCodesResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscfg_HouseKeepingCodesResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmscfg_HouseKeepingCodesResult>
<HouseKeepingCodes>
<HouseKeepingCodes>
<cpmscfg_HKCodes_HKItem>
<iRoomStatusID>1000</iRoomStatusID>
<iParameter1>0</iParameter1>
<strDescription>Room is Clean</strDescription>
<strDisplayCode>CLEAN</strDisplayCode>
</cpmscfg_HKCodes_HKItem>
<cpmscfg_HKCodes_HKItem>
<iRoomStatusID>1100</iRoomStatusID>
<iParameter1>0</iParameter1>
<strDescription>Sheet Change</strDescription>
<strDisplayCode>SHEET</strDisplayCode>
</cpmscfg_HKCodes_HKItem>
<cpmscfg_HKCodes_HKItem>
<iRoomStatusID>1200</iRoomStatusID>
<iParameter1>0</iParameter1>
<strDescription>Stayover </strDescription>
<strDisplayCode>STAY</strDisplayCode>
</cpmscfg_HKCodes_HKItem>
<cpmscfg_HKCodes_HKItem>
<iRoomStatusID>1300</iRoomStatusID>
<iParameter1>0</iParameter1>
<strDescription>Departure / Dirty Room</strDescription>
<strDisplayCode>DIRTY</strDisplayCode>
</cpmscfg_HKCodes_HKItem>
<cpmscfg_HKCodes_HKItem>
<iRoomStatusID>1400</iRoomStatusID>
<iParameter1>0</iParameter1>
<strDescription>Unknown1</strDescription>
<strDisplayCode>UserDefined1</strDisplayCode>
</cpmscfg_HKCodes_HKItem>
</HouseKeepingCodes>
</HouseKeepingCodes>
</pmscfg_HouseKeepingCodesResponse>
This method returns the list of Sales Analysis Codes used by the PMS, e.g. BARFOOD, BARDRINK, PHONE, etc. Charges should be posted against the appropriate code when using a posting method such as pmschg_PostToRoom. Note that the particular codes in use are customisable on the PMS and will vary from site to site.
<h3>Parameters</h3>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID</td></tr></tbody></table>
<h3>Returned data</h3>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AnalCode</td><td align="left">string</td><td align="left">Name of the analysis code, e.g. "BARFOOD"</td></tr><tr class="evenRow"><td align="left">Description</td><td align="left">string</td><td>Short description of the analysis code, e.g. "food served in bar room"</td></tr><tr class="oddRow"><td align="left">GroupCode</td><td align="left">string</td><td align="left">Name of the group to which this code belongs, e.g. "FOOD"</td></tr><tr class="evenRow"><td align="left">TaxRule</td><td align="left">string</td><td align="left">Name of the tax rule which applies to this analysis code, e.g. "VAT_20"</td></tr><tr class="oddRow"><td align="left">Usage</td><td align="left">string</td><td align="left">"acr_NoRestrictions" or "acr_InternalPostingsOnly" or "acr_ExternalPostingsOnly"</td></tr></tbody></table>
pmscfg_AnalListSoapIn
<pmscfg_AnalList xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>723c4f82-22cc-47a8-ba77-f87bbe53f045</SessionID>
<AnalysisCodeList>
</AnalysisCodeList>
</pmscfg_AnalList>
pmscfg_AnalListSoapOut
<pmscfg_AnalListResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscfg_AnalListResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmscfg_AnalListResult>
<AnalysisCodeList>
<AnalCodes>
<cpmscfg_AnalList_AnalItem>
<AnalCode>ACCOM</AnalCode>
<Description>Accommodation</Description>
<GroupCode>ACCOM</GroupCode>
<TaxRule>VAT_20</TaxRule>
<Usage>acr_NoRestrictions</Usage>
</cpmscfg_AnalList_AnalItem>
<cpmscfg_AnalList_AnalItem>
<AnalCode>ACCOM_4</AnalCode>
<Description>Accommodation 4% VAT</Description>
<GroupCode>ACCOM</GroupCode>
<TaxRule>VAT_04</TaxRule>
<Usage>acr_NoRestrictions</Usage>
</cpmscfg_AnalList_AnalItem>
<cpmscfg_AnalList_AnalItem>
<AnalCode>BAR</AnalCode>
<Description>Bar Items</Description>
<GroupCode>CATERING</GroupCode>
<TaxRule>VAT_20</TaxRule>
<Usage>acr_NoRestrictions</Usage>
</cpmscfg_AnalList_AnalItem>
<cpmscfg_AnalList_AnalItem>
<AnalCode>WEDD_WINE</AnalCode>
<Description>Wedding Wine</Description>
<GroupCode>WEDDING</GroupCode>
<TaxRule>VAT_20</TaxRule>
<Usage>acr_NoRestrictions</Usage>
</cpmscfg_AnalList_AnalItem>
</AnalCodes>
</AnalysisCodeList>
</pmscfg_AnalListResponse>
This method returns the list of Payment Types used by the PMS, e.g. Cash, Visa, Mastercard. Payments which are posted to the room should be posted with the appropriate Payment Type, e.g. using pmschg_PostPaymentToRoom. Note that the particular payment types in use are customisable on the PMS and will vary from site to site.
<h4>Parameters</h4>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID</td></tr></tbody></table>
<h4>Returned Data</h4>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">PayCode</td><td align="left">string</td><td align="left">Name of payment type</td></tr><tr class="evenRow"><td align="left">Description</td><td align="left">string</td><td align="left">Description of payment type</td></tr><tr class="oddRow"><td align="left">LedgerCode</td><td align="left">string</td><td align="left">Payment type code as appears on ledger accounts</td></tr><tr class="evenRow"><td align="left">CreditCardType</td><td align="left">string</td><td align="left">Credit card type code</td></tr></tbody></table>
pmscfg_PayTypeListSoapIn
<pmscfg_PayTypeList xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>723c4f82-22cc-47a8-ba77-f87bbe53f045</SessionID>
<PayTypeList>
</PayTypeList>
</pmscfg_PayTypeList>
pmscfg_PayTypeListSoapOut
<pmscfg_PayTypeListResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscfg_PayTypeListResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No Error</ExceptionDescription>
</pmscfg_PayTypeListResult>
<PayTypeList>
<PayCodes>
<cpmscfg_PayTypeList_PayTypeItem>
<PayCode>AMEX</PayCode>
<Description>American Express</Description>
<LedgerCode></LedgerCode>
<CreditCardType>600</CreditCardType>
</cpmscfg_PayTypeList_PayTypeItem>
<cpmscfg_PayTypeList_PayTypeItem>
<PayCode>CASH</PayCode>
<Description>Cash</Description>
<LedgerCode></LedgerCode>
<CreditCardType></CreditCardType>
</cpmscfg_PayTypeList_PayTypeItem>
<cpmscfg_PayTypeList_PayTypeItem>
<PayCode>MASTERCARD</PayCode>
<Description>Mastercard</Description>
<LedgerCode></LedgerCode>
<CreditCardType>700</CreditCardType>
</cpmscfg_PayTypeList_PayTypeItem>
</PayCodes>
</PayTypeList>
</pmscfg_PayTypeListResponse>
<p>Maintains an active link between the Rezlynx server and client device </p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">strDeviceParam</td><td align="left">string</td><td align="left">?</td></tr><tr class="oddRow"><td align="left">strClientLanIPAddress</td><td align="left">string</td><td align="left">?</td></tr><tr class="evenRow"><td align="left">strClientLanName</td><td align="left">string</td><td align="left">?</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsdev_HeartBeatSoapIn
<pmsdev_HeartBeat xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<strDeviceParam>string</strDeviceParam>
<strClientLanIPAddress>string</strClientLanIPAddress>
<strClientLanName>string</strClientLanName>
<objHeartBeat />
</pmsdev_HeartBeat>
pmsdev_HeartBeatSoapOut
<pmsdev_HeartBeatResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsdev_HeartBeatResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsdev_HeartBeatResult>
<objHeartBeat />
</pmsdev_HeartBeatResponse>
This method returns the current itemised bill or folio for a resident guest.
<div id="DIV_1">
<h2 id="H2_4">
Parameters
</h2>
<table>
<thead>
<tr>
<th scope="col">Name</th>
<th scope="col">Type</th>
<th scope="col">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>SessionID</td>
<td>string</td>
<td>Session ID</td>
</tr>
<tr>
<td>RoomID</td>
<td>String</td>
<td>Room name or number</td>
</tr>
<tr>
<td>FolioID</td>
<td>int</td>
<td>Folio ID, in case of multiple folios for the room</td>
</tr>
<tr>
<td>
ItemFormat
</td>
<td>
int
</td>
<td>
Format for presenting line items (default '0')
</td>
</tbody>
</table>
<strong>ItemFormat</strong> can be one of the following:<ul><li>0 = show all items</li><li>1 = show only non-ledger items</li><li>2 = show ledger items as paid</li><li>3 = show ledger items with zero balance</li><li>4 = show ledger items as paid with zero balance</li></ul>
<h2 id="H2_27">
Returned data
</h2>
<table>
<tbody id="TBODY_29">
<tr id="TR_30">
<th id="TH_31">
Name
</th>
<th id="TH_32">
Type
</th>
<th id="TH_33">
Description
</th>
</tr>
<tr id="TR_34">
<td id="TD_35">
Items
</td>
<td id="TD_36">
(object)
</td>
<td id="TD_37">
List of folio line items (see below)
</td>
</tr>
<tr id="TR_38">
<td id="TD_39">
Balance
</td>
<td id="TD_40">
decimal
</td>
<td id="TD_41">
Total balance for the folio
</td>
</tr>
</tbody>
</table>
<h2 id="H2_42">
Returned data (Folio line item)
</h2>
<table id="TABLE_43">
<tbody id="TBODY_44">
<tr id="TR_45">
<th id="TH_46">
Name
</th>
<th id="TH_47">
Type
</th>
<th id="TH_48">
Description
</th>
</tr>
<tr id="TR_49">
<td id="TD_50">
iTransID
</td>
<td id="TD_51">
int
</td>
<td id="TD_52">
Transaction ID for the item
</td>
</tr>
<tr id="TR_53">
<td id="TD_54">
strSourceSiteID
</td>
<td id="TD_55">
string
</td>
<td id="TD_56">
Site ID
</td>
</tr>
<tr id="TR_57">
<td id="TD_58">
dtTimestamp
</td>
<td id="TD_59">
dateTime
</td>
<td id="TD_60">
Date-time stamp for the transaction
</td>
</tr>
<tr id="TR_61">
<td id="TD_62">
dtForDate
</td>
<td id="TD_63">
dateTime
</td>
<td id="TD_64">
Period system date to which transaction applies
</td>
</tr>
<tr id="TR_65">
<td id="TD_66">
iForStayResourceBlock
</td>
<td id="TD_67">
int
</td>
<td id="TD_68">
?
</td>
</tr>
<tr id="TR_69">
<td id="TD_70">
strSystemArea
</td>
<td id="TD_71">
string
</td>
<td id="TD_72">
?
</td>
</tr>
<tr id="TR_73">
<td id="TD_74">
strOperatorCode
</td>
<td id="TD_75">
string
</td>
<td id="TD_76">
Operator code of charge item source, e.g. API vendor
</td>
</tr>
<tr id="TR_77">
<td id="TD_78">
iEntryType
</td>
<td id="TD_79">
int
</td>
<td id="TD_80">
Entry Type code
</td>
</tr>
<tr id="TR_81">
<td id="TD_82">
iItemType
</td>
<td id="TD_83">
int
</td>
<td id="TD_84">
Item Type code
</td>
</tr>
<tr id="TR_85">
<td id="TD_86">
strAnalCode
</td>
<td id="TD_87">
string
</td>
<td id="TD_88">
Sales analysis code
</td>
</tr>
<tr id="TR_89">
<td id="TD_90">
strBookRef
</td>
<td id="TD_91">
string
</td>
<td id="TD_92">
Booking reference
</td>
</tr>
<tr id="TR_93">
<td id="TD_94">
strProfileRef
</td>
<td id="TD_95">
string
</td>
<td id="TD_96">
Profile reference
</td>
</tr>
<tr id="TR_97">
<td id="TD_98">
iRoomPickID
</td>
<td id="TD_99">
int
</td>
<td id="TD_100">
Room Pick ID (integer used for multi-room bookings)
</td>
</tr>
<tr id="TR_101">
<td id="TD_102">
iFolioID
</td>
<td id="TD_103">
int
</td>
<td id="TD_104">
Folio ID, in case of multiple folios per room
</td>
</tr>
<tr id="TR_105">
<td id="TD_106">
iSourceTransID
</td>
<td id="TD_107">
long
</td>
<td id="TD_108">
?
</td>
</tr>
<tr id="TR_109">
<td id="TD_110">
iFolioSplitID
</td>
<td id="TD_111">
int
</td>
<td id="TD_112">
Folio split ID if using 'bill split'
</td>
</tr>
<tr id="TR_113">
<td id="TD_114">
strRoomID
</td>
<td id="TD_115">
string
</td>
<td id="TD_116">
Room name or number
</td>
</tr>
<tr id="TR_117">
<td id="TD_118">
strCompanyRef
</td>
<td id="TD_119">
string
</td>
<td id="TD_120">
Company reference
</td>
</tr>
<tr id="TR_121">
<td id="TD_122">
strInvoiceID
</td>
<td id="TD_123">
string
</td>
<td id="TD_124">
Invoice ID
</td>
</tr>
<tr id="TR_125">
<td id="TD_126">
strDescription
</td>
<td id="TD_127">
string
</td>
<td id="TD_128">
Item description
</td>
</tr>
<tr id="TR_129">
<td id="TD_130">
strPaymentCode
</td>
<td id="TD_131">
string
</td>
<td id="TD_132">
Item payment code, if payment
</td>
</tr>
<tr id="TR_133">
<td id="TD_134">
iCurrencyConvID
</td>
<td id="TD_135">
int
</td>
<td id="TD_136">
?
</td>
</tr>
<tr id="TR_137">
<td id="TD_138">
strTaxRule
</td>
<td id="TD_139">
string
</td>
<td id="TD_140">
Applicable Tax Rule
</td>
</tr>
<tr id="TR_141">
<td id="TD_142">
cNettPerUnit
</td>
<td id="TD_143">
decimal
</td>
<td id="TD_144">
Item individual amount, nett of tax
</td>
</tr>
<tr id="TR_145">
<td id="TD_146">
cGrossPerUnit
</td>
<td id="TD_147">
decimal
</td>
<td id="TD_148">
Item individual amount, gross including tax
</td>
</tr>
<tr id="TR_149">
<td id="TD_150">
dQuantity
</td>
<td id="TD_151">
double
</td>
<td id="TD_152">
Item quantity
</td>
</tr>
<tr id="TR_153">
<td id="TD_154">
cNettTotal
</td>
<td id="TD_155">
decimal
</td>
<td id="TD_156">
Item total amount, nett of tax
</td>
</tr>
<tr id="TR_157">
<td id="TD_158">
cTaxTotal
</td>
<td id="TD_159">
decimal
</td>
<td id="TD_160">
Total amount of tax due
</td>
</tr>
<tr id="TR_161">
<td id="TD_162">
cGrossTotal
</td>
<td id="TD_163">
decimal
</td>
<td id="TD_164">
Item total amount, gross including tax
</td>
</tr>
<tr id="TR_165">
<td id="TD_166">
strPackageCode
</td>
<td id="TD_167">
string
</td>
<td id="TD_168">
Package code, if applicable
</td>
</tr>
<tr id="TR_169">
<td id="TD_170">
iPackageTag
</td>
<td id="TD_171">
int
</td>
<td id="TD_172">
?
</td>
</tr>
<tr id="TR_173">
<td id="TD_174">
iStatus
</td>
<td id="TD_175">
int
</td>
<td id="TD_176">
?
</td>
</tr>
<tr id="TR_177">
<td id="TD_178">
iParam1
</td>
<td id="TD_179">
int
</td>
<td id="TD_180">
?
</td>
</tr>
<tr id="TR_181">
<td id="TD_182">
strParam2
</td>
<td id="TD_183">
string
</td>
<td id="TD_184">
?
</td>
</tr>
</tbody>
</table>
</div>
<p><strong>EntryType</strong> can be one of the following:</p><ul><li>50 = Direct post</li><li>100 = Folio charge</li><li>110 = Folio surcharge</li><li>200 = Folio credit</li><li>220 = Folio adjustment</li><li>300 = Folio deposit advance</li><li>310 = Folio deposit refund</li><li>320 = Folio deposit in-house</li><li>330 = Folio deposit used</li><li>340 = Folio deposit retained (not used)</li><li>350 = Folio deposit tax refund</li><li>500 = Invoiced business</li><li>700 = Ledger debit</li><li>800 = Ledger credit</li></ul><p><strong>ItemType</strong> can be one of the following:</p><ul><li>0 = General</li><li>50 = Package header</li><li>100 = Adult accomodation</li><li>110 = Child SH accomodation</li><li>120 = Child OR accomodation</li><li>30 = Function room hire</li><li>200 = Manual product</li><li>250 = Auto-inclusive product</li><li>300 = Supplement</li><li>400 = Surcharge</li><li>500 = Deposit</li><li>550 = Ledger credit card debit</li><li>560 = Ledger credit card credit</li><li>700 = Foreign exchange</li></ul><p><strong>Financial status</strong> can be one of the following:</p><ul><li>0 = Default</li><li>50 = Direct post paid off</li><li>100 = Advance deposit transfer now transferred</li><li>200 = In-house deposit transfer now used</li><li>300 = Ledger transfer now transferred</li><li>350 = Folio deposit tax refund</li><li>400 = Booking transfer now transferred</li><li>500 = Folio charge deleted</li><li>510 = Folio credit deleted</li><li>600 = Folio charge deleted for adjustment</li><li>900 = Folio credit transferred</li><li>1000 = Folio charge paid off</li></ul>
pmsbkg_RoomFolioItemsAndBalanceSoapIn
<pmsbkg_RoomFolioItemsAndBalance xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>d9de5589-5781-45bd-a5bd-a385f6d19bce</SessionID>
<RoomID>110</RoomID>
<FolioID>1</FolioID>
<ItemFormat>0</ItemFormat>
</pmsbkg_RoomFolioItemsAndBalance>
pmsbkg_RoomFolioItemsAndBalanceSoapOut
<pmsbkg_RoomFolioItemsAndBalanceResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_RoomFolioItemsAndBalanceResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsbkg_RoomFolioItemsAndBalanceResult>
<RoomFolioItemsAndBalance>
<Items>
<cpmsbkg_RoomFolioItemsAndBalance_Item>
<iTransID>11653</iTransID>
<strSourceSiteID>VENDORCITY</strSourceSiteID>
<dtTimestamp>2018-03-19T11:42:42</dtTimestamp>
<dtForDate>2018-03-19T00:00:00</dtForDate>
<iForStayResourceBlock>0</iForStayResourceBlock>
<strSystemArea>56</strSystemArea>
<strOperatorCode>XNPROTEL</strOperatorCode>
<iEntryType>100</iEntryType>
<iItemType>50</iItemType>
<strAnalCode>PTR</strAnalCode>
<strBookRef>BK000039</strBookRef>
<strProfileRef />
<iRoomPickID>1</iRoomPickID>
<iFolioID>1</iFolioID>
<iSourceTransID>0</iSourceTransID>
<iFolioSplitID>1</iFolioSplitID>
<strRoomID>110</strRoomID>
<strCompanyRef />
<strInvoiceID />
<strDescription>Dallas Rest:108118</strDescription>
<strPaymentCode />
<iCurrencyConvID>0</iCurrencyConvID>
<strTaxRule>NO_VAT</strTaxRule>
<cNettPerUnit>19.8200</cNettPerUnit>
<cGrossPerUnit>23.9300</cGrossPerUnit>
<dQuantity>5</dQuantity>
<cNettTotal>19.8200</cNettTotal>
<cTaxTotal>4.1100</cTaxTotal>
<cGrossTotal>23.9300</cGrossTotal>
<strPackageCode />
<iPackageTag>11653</iPackageTag>
<iStatus>0</iStatus>
<iParam1>0</iParam1>
<strParam2 />
</cpmsbkg_RoomFolioItemsAndBalance_Item>
<cpmsbkg_RoomFolioItemsAndBalance_Item>
<iTransID>11686</iTransID>
<strSourceSiteID>VENDORCITY</strSourceSiteID>
<dtTimestamp>2018-03-19T12:18:02</dtTimestamp>
<dtForDate>2018-03-19T00:00:00</dtForDate>
<iForStayResourceBlock>0</iForStayResourceBlock>
<strSystemArea>56</strSystemArea>
<strOperatorCode>XNPROTEL</strOperatorCode>
<iEntryType>100</iEntryType>
<iItemType>50</iItemType>
<strAnalCode>PTR</strAnalCode>
<strBookRef>BK000039</strBookRef>
<strProfileRef />
<iRoomPickID>1</iRoomPickID>
<iFolioID>1</iFolioID>
<iSourceTransID>0</iSourceTransID>
<iFolioSplitID>1</iFolioSplitID>
<strRoomID>110</strRoomID>
<strCompanyRef />
<strInvoiceID />
<strDescription>Dallas Rest:108121</strDescription>
<strPaymentCode />
<iCurrencyConvID>0</iCurrencyConvID>
<strTaxRule>NO_VAT</strTaxRule>
<cNettPerUnit>26.3300</cNettPerUnit>
<cGrossPerUnit>31.6100</cGrossPerUnit>
<dQuantity>3</dQuantity>
<cNettTotal>26.3300</cNettTotal>
<cTaxTotal>5.2800</cTaxTotal>
<cGrossTotal>31.6100</cGrossTotal>
<strPackageCode />
<iPackageTag>11686</iPackageTag>
<iStatus>0</iStatus>
<iParam1>0</iParam1>
<strParam2 />
</cpmsbkg_RoomFolioItemsAndBalance_Item>
</Items>
<Balance>decimal</Balance>
</RoomFolioItemsAndBalance>
</pmsbkg_RoomFolioItemsAndBalanceResponse>
<p>Updates the alarm call time for any given room. This could be used, for example, to set an alarm call by triggering another interface to implement the call.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">RoomID</td><td align="left">string</td><td align="left">Room reference (room name or number)</td></tr><tr class="oddRow"><td align="left">AlarmCall</td><td align="left">dateTime</td><td align="left">Alarm call time</td></tr><tr class="evenRow"><td align="left">SetAlarmCall</td><td align="left">Boolean</td><td align="left">'true' to set an alarm call or 'false' to cancel</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsbkg_UpdateAlarmCallSoapIn
<pmsbkg_UpdateAlarmCall xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>a6a70a2d-1ac0-4da0-815a-98cd825a822e</SessionID>
<RoomID>216</RoomID>
<AlarmCall>0001-01-01T07:30:00</AlarmCall>
<SetAlarmCall>true</SetAlarmCall>
</pmsbkg_UpdateAlarmCall>
pmsbkg_UpdateAlarmCallSoapOut
<pmsbkg_UpdateAlarmCallResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_UpdateAlarmCallResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsbkg_UpdateAlarmCallResult>
</pmsbkg_UpdateAlarmCallResponse>
<p>Set the housekeeping status for a room. The status must be specified by its numeric code. The room may be referenced
by room ID or telephone extension number.</p>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID, obtained at log-in</td>
</tr>
<tr class="evenRow">
<td align="left">enmSetHouseKeepingCodeMethod</td>
<td align="left">string</td>
<td align="left">Flag to indicate if using room or extension number (see below)</td>
</tr>
<tr class="oddRow">
<td align="left">RoomID</td>
<td align="left">string</td>
<td align="left">Room reference (room name or number) or extension number, depending on value of
enmSetHouseKeepingCodeMethod</td>
</tr>
<tr class="evenRow">
<td align="left">HouseKeepingCode</td>
<td align="left">int</td>
<td align="left">Housekeeping code (numeric). This must be a valid code reference as returned by <a
class="tc-tiddlylink tc-tiddlylink-resolves" href="#pmscfg_HouseKeepingCodes">pmscfg_HouseKeepingCodes</a> (see <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#Room%20Status%20codes">Room Status
codes</a>)</td>
</tr>
</tbody>
</table>
<p><strong>enmSetHouseKeepingCodeMethod</strong> can have of two values:</p>
<ul>
<li>"SetHouseKeepingCodeMethod_RoomID"</li>
<li>"SetHouseKeepingCodeMethod_TelExtNo"</li>
</ul>
<h2 class="">Returned data</h2>
<ul>
<li>None</li>
</ul>
pmsbkg_SetHouseKeepingCodeV2SoapIn
<pmsbkg_SetHouseKeepingCodev2 xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>a6a70a2d-1ac0-4da0-815a-98cd825a822e</SessionID>
<enmSetHouseKeepingCodeMethod>SetHouseKeepingCodeMethod_RoomID</enmSetHouseKeepingCodeMethod>
<RoomID>216</RoomID>
<HouseKeepingCode>1300</HouseKeepingCode>
</pmsbkg_SetHouseKeepingCodev2>
pmsbkg_SetHouseKeepingCodeV2SoapOut
<pmsbkg_SetHouseKeepingCodev2Response xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_SetHouseKeepingCodev2Result>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsbkg_SetHouseKeepingCodev2Result>
</pmsbkg_SetHouseKeepingCodev2Response>
This allows the posting of an ePOS Z-read, including both Sales and Payments codes within a single method.
A Z-read is a tally of sales and payments put through an ePOS till (often referred to as 'cashing up'). It is common practice to run a z-read report at the end of a shift or work period and clear it down ready for the next shift. This information is posted to the PMS so that the PMS can account for all of the different sales and payment items and pass this information on to the accounting system for the property, for analysis purposes.
It is possible to post a Z-read after each set of till transactions, however this can generate a lot of data overhead so in general it is preferred to post a Z-read at the end of each shift or work period.
Note the total of Sales and Payments must sum to zero or else the z-read will be rejected with an error code.
<h4>Parameters</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">PaymentsList</td><td align="left">object</td><td align="left">List of ZReadPayments items (see below)</td></tr><tr class="oddRow"><td align="left">SalesList</td><td align="left">object</td><td align="left">List of ZReadSales items (see below)</td></tr></tbody></table><h4>Parameters (ZReadPayment)</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">PayTypeCode</td><td align="left">string</td><td align="left">Payment type code (codes can be obtained through the API using <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#pmscfg_PayTypeList">pmscfg_PayTypeList</a>)</td></tr><tr class="evenRow"><td align="left">Amount</td><td align="left">decimal</td><td align="left">Financial amount</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Text description of item</td></tr><tr class="evenRow"><td align="left">UserTag1</td><td align="left">string</td><td align="left">Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes)</td></tr><tr class="oddRow"><td align="left">UserTag2</td><td align="left">string</td><td align="left">Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes)</td></tr></tbody></table><h4>Parameters (ZReadSale)</h4><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AnalysisCode</td><td align="left">string</td><td align="left">Sales analysis code (codes can be obtained through the API using <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#pmscfg_AnalList">pmscfg_AnalList</a>)</td></tr><tr class="evenRow"><td align="left">Amount</td><td align="left">decimal</td><td align="left">Financial amount</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Text description of item</td></tr><tr class="evenRow"><td align="left">UserTag1</td><td align="left">string</td><td align="left">Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes)</td></tr><tr class="oddRow"><td align="left">UserTag2</td><td align="left">string</td><td align="left">Optional additional information stored in the database but not exposed through the Rezlynx UI (e.g. for support purposes)</td></tr></tbody></table><h4>Returned data</h4><ul><li>None</li></ul>
pmsped_PostZReadSoapIn
<pmsped_PostZRead xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>74e9307d-628a-42ae-b166-87f98875ecfe</SessionID>
<PaymentsList>
<Payments>
<ZReadPayment>
<PayTypeCode>CASH</PayTypeCode>
<Amount>16</Amount>
</ZReadPayment>
<ZReadPayment>
<PayTypeCode>VISA</PayTypeCode>
<Amount>4</Amount>
</ZReadPayment>
<ZReadPayment>
<PayTypeCode>MC</PayTypeCode>
<Amount>2</Amount>
</ZReadPayment>
</Payments>
</PaymentsList>
<SalesList>
<Sales>
<ZReadSale>
<AnalysisCode>FOOD</AnalysisCode>
<Amount>12</Amount>
<Description>Food Sales</Description>
</ZReadSale>
<ZReadSale>
<AnalysisCode>BARDRINK</AnalysisCode>
<Amount>10</Amount>
<Description>Bar Drinks Sales</Description>
</ZReadSale>
</Sales>
</SalesList>
</pmsped_PostZRead>
pmsped_PostZReadSoapOut
<pmsped_PostZReadResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsped_PostZReadResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsped_PostZReadResult>
</pmsped_PostZReadResponse>
<p>Check room availability at given sites over given stay dates.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">Sites</td><td align="left">(object)</td><td align="left">Set of all sites for which availability required</td></tr><tr class="oddRow"><td align="left">> string</td><td align="left">string</td><td align="left">Site ID</td></tr><tr class="evenRow"><td align="left">ArrivalDate</td><td align="left">dateTime</td><td align="left">Arrival date</td></tr><tr class="oddRow"><td align="left">Nights</td><td align="left">int</td><td align="left">Number of nights of stay</td></tr><tr class="evenRow"><td align="left">PAXConfigurations</td><td align="left">(object)</td><td align="left">Set of all persons requirements</td></tr><tr class="oddRow"><td align="left">> cPAXConfiguration</td><td align="left">(object)</td><td align="left">Set of persons requirements</td></tr><tr class="evenRow"><td align="left">>> Rooms</td><td align="left">int</td><td align="left">Number of rooms required</td></tr><tr class="oddRow"><td align="left">>> RoomTypeGroup</td><td align="left">string</td><td align="left">Room type group, if applicable</td></tr><tr class="evenRow"><td align="left">>> Adults</td><td align="left">int</td><td align="left">Number of adults staying</td></tr><tr class="oddRow"><td align="left">>> Children</td><td align="left">int</td><td align="left">Number of children staying</td></tr><tr class="evenRow"><td align="left">PromotionalCode</td><td align="left">string</td><td align="left">Promotional code, if applicable</td></tr></tbody></table><h2 class="">Returned data (per-site availability)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SiteID</td><td align="left">string</td><td align="left">Site ID</td></tr><tr class="evenRow"><td align="left">Available</td><td align="left">boolean</td><td align="left">Available Yes/No</td></tr><tr class="oddRow"><td align="left">Rate</td><td align="left">decimal</td><td align="left">Room rate</td></tr></tbody></table>
pmsavl_CheckAvailabilitySoapIn
<pmsavl_CheckAvailability xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>9a129b49-75ff-4721-ac28-ba042c74c532</SessionID>
<Sites>
<string>TESTSITE1</string>
<string>TESTSITE2</string>
</Sites>
<ArrivalDate>2018-09-11T09:55:20.3011068+01:00</ArrivalDate>
<Nights>1</Nights>
<PAXConfigurations>
<cPAXConfiguration>
<Rooms>1</Rooms>
<RoomTypeGroup />
<Adults>1</Adults>
<Children>0</Children>
</cPAXConfiguration>
</PAXConfigurations>
<PromotionalCode />
<Availability />
</pmsavl_CheckAvailability>
pmsavl_CheckAvailabilitySoapOut
<pmsavl_CheckAvailabilityResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsavl_CheckAvailabilityResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsavl_CheckAvailabilityResult>
<Nights>1</Nights>
<Availability>
<Availability>
<Site>
<SiteID>TESTSITE1</SiteID>
<Available>false</Available>
<Rate>0</Rate>
</Site>
<Site>
<SiteID>TESTSITE2</SiteID>
<Available>false</Available>
<Rate>0</Rate>
</Site>
</Availability>
</Availability>
</pmsavl_CheckAvailabilityResponse>
<p>Get the detailed availability for the given stay details for the best available room rate.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">SiteID</td><td align="left">string</td><td align="left">Site ID</td></tr><tr class="oddRow"><td align="left">ArrivalDate</td><td align="left">dateTime</td><td align="left">Arrival date</td></tr><tr class="evenRow"><td align="left">Nights</td><td align="left">int</td><td align="left">Number of nights</td></tr><tr class="oddRow"><td align="left">PAXConfigurations</td><td align="left">(object)</td><td align="left">Set of all persons requirements</td></tr><tr class="evenRow"><td align="left">> cPAXConfiguration</td><td align="left">(object)</td><td align="left">Set of persons requirements</td></tr><tr class="oddRow"><td align="left">>> Rooms</td><td align="left">int</td><td align="left">Number of rooms required</td></tr><tr class="evenRow"><td align="left">>> RoomTypeGroup</td><td align="left">string</td><td align="left">Room type group, if applicable</td></tr><tr class="oddRow"><td align="left">>> Adults</td><td align="left">int</td><td align="left">Number of adults</td></tr><tr class="evenRow"><td align="left">>> Children</td><td align="left">int</td><td align="left">Number of children</td></tr><tr class="oddRow"><td align="left">PromotionalCode</td><td align="left">string</td><td align="left">Promotional code, if applicable</td></tr></tbody></table><h2 class="">Returned data (detailed availability)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">PAXConfigurations</td><td align="left">(object)</td><td align="left">Rates matching set of all persons requirements</td></tr><tr class="evenRow"><td align="left">> PAXConfiguration</td><td align="left">(object)</td><td align="left">Rates matching set of persons requirements</td></tr><tr class="oddRow"><td align="left">>> Rates</td><td align="left">(object)</td><td align="left">Rates</td></tr></tbody></table>
pmsavl_GetDetailedCheapestRateAvailabilitySoapIn
<pmsavl_GetDetailedCheapestRateAvailability xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>1dc990af-9e7d-4445-a2cf-59540412b5c8</SessionID>
<SiteID>TESTSITE1</SiteID>
<ArrivalDate>2018-09-11T09:55:20.3011068+01:00</ArrivalDate>
<Nights>1</Nights>
<PAXConfigurations>
<cPAXConfiguration>
<Rooms>1</Rooms>
<RoomTypeGroup />
<Adults>1</Adults>
<Children>0</Children>
</cPAXConfiguration>
<cPAXConfiguration>
<Rooms>1</Rooms>
<RoomTypeGroup />
<Adults>1</Adults>
<Children>0</Children>
</cPAXConfiguration>
</PAXConfigurations>
<PromotionalCode />
</pmsavl_GetDetailedCheapestRateAvailability>
pmsavl_GetDetailedCheapestRateAvailabilitySoapOut
<pmsavl_GetDetailedCheapestRateAvailabilityResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsavl_GetDetailedCheapestRateAvailabilityResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsavl_GetDetailedCheapestRateAvailabilityResult>
<Nights>1</Nights>
<DetailedAvailability>
<PaxConfigurations>
<PaxConfiguration>
<Rooms>1</Rooms>
<RoomTypeGroup />
<Adults>1</Adults>
<Children>0</Children>
<Rates />
</PaxConfiguration>
</PaxConfigurations>
</DetailedAvailability>
</pmsavl_GetDetailedCheapestRateAvailabilityResponse>
<p>Get a list of configured up-sell product items (e.g. Flowers, Champagne, Breakfast) for the given sites.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">Sites</td><td align="left">(object)</td><td align="left">Set of Site IDs</td></tr><tr class="oddRow"><td align="left">> string</td><td align="left">string</td><td align="left">Site ID</td></tr><tr class="evenRow"><td align="left">PackageCode</td><td align="left">string</td><td align="left">Optional package code</td></tr></tbody></table><h2 class="">Returned data (products)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">ProductCode</td><td align="left">string</td><td align="left">Product code</td></tr><tr class="evenRow"><td align="left">ChargeMode</td><td align="left">(see below)</td><td align="left">Charge mode, i.e. basis on which upsell charged</td></tr><tr class="oddRow"><td align="left">ValueEach</td><td align="left">decimal</td><td align="left">Upsell price</td></tr><tr class="evenRow"><td align="left">ProductType</td><td align="left">(see below)</td><td align="left">Product type</td></tr></tbody></table><p><strong>ChargeMode</strong> can be one of the following:</p><ul><li>"PerRoom"</li><li>"PerPerson"</li><li>"PerAdult"</li><li>"PerChild"</li><li>"PerInfant"</li><li>"SingleCharge"</li><li>"DailyPerRoom"</li><li>"DailyPerDelegate"</li><li>"HourlyPerRoom"</li><li>"HourlyPerDelegate"</li><li>"FunctionSingleCharge"</li></ul><p><strong>ProductType</strong> can be one of the following:</p><ul><li>"Normal"</li><li>"NewsPaper"</li><li>"CheckInOffer"</li><li>"ReservationOffer"</li><li>"ReservationAndCheckInOffer"</li><li>"InventoryItem"</li><li>"Function"</li><li>"FunctionCheckInOffer"</li><li>"Activity"</li></ul>
pmscfg_GetProductUpSellListSoapIn
<pmscfg_GetProductUpSellList xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>f04c05bb-3b06-4669-be34-b166462880c3</SessionID>
<Sites>
<string>TEST112</string>
<string>TEST112A</string>
</Sites>
<PackageCode />
</pmscfg_GetProductUpSellList>
pmscfg_GetProductUpSellListSoapOut
<pmscfg_GetProductUpSellListResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscfg_GetProductUpSellListResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmscfg_GetProductUpSellListResult>
<SiteProducts>
<Sites>
<Site>
<SiteID>TEST112</SiteID>
<Products>
<Product>
<ProductCode>FLOWERS</ProductCode>
<ChargeMode>PerRoom</ChargeMode>
<ValueEach>30.00</ValueEach>
<ProductType>Normal</ProductType>
</Product>
<Product>
<ProductCode>BFAST_UPSELL</ProductCode>
<ChargeMode>PerAdult</ChargeMode>
<ValueEach>7.50</ValueEach>
<ProductType>Normal</ProductType>
</Product>
</Products>
</Site>
<Site>
<SiteID>TEST112A</SiteID>
<Products>
<Product>
<ProductCode>FLOWERS</ProductCode>
<ChargeMode>PerRoom</ChargeMode>
<ValueEach>30.00</ValueEach>
<ProductType>Normal</ProductType>
</Product>
<Product>
<ProductCode>CHAMPAGNE</ProductCode>
<ChargeMode>PerRoom</ChargeMode>
<ValueEach>40.00</ValueEach>
<ProductType>Normal</ProductType>
</Product>
</Products>
</Site>
</Sites>
</SiteProducts>
</pmscfg_GetProductUpSellListResponse>
<p>Retrieve a list of available upsell items for the given stay dates.</p><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionID</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">RatePlanCode</td><td align="left">string</td><td align="left">Rate plan code</td></tr><tr class="oddRow"><td align="left">ArrivalDateTime</td><td align="left">dateTime</td><td align="left">Arrival date</td></tr><tr class="evenRow"><td align="left">DepartureDateTime</td><td align="left">dateTime</td><td align="left">Departure date</td></tr></tbody></table><h2 class="">Returned data (product)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">ProductCode</td><td align="left">string</td><td align="left">Product code</td></tr><tr class="evenRow"><td align="left">ProductGroupCode</td><td align="left">string</td><td align="left">Product group code</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Product description</td></tr><tr class="evenRow"><td align="left">SalesAnalysisCode</td><td align="left">string</td><td align="left">Sales analysis code</td></tr><tr class="oddRow"><td align="left">ProductChargeMode</td><td align="left">(see below)</td><td align="left">Product charge mode (basis on which product is charged, e.g. per adult or per room)</td></tr><tr class="evenRow"><td align="left">ProductPostingFrequency</td><td align="left">(see below)</td><td align="left">Product posting frequency (when product charge should be posted)</td></tr><tr class="oddRow"><td align="left">ProductUpsellSource</td><td align="left">(see below)</td><td align="left">Product upsell source (e.g. general or rate-specific)</td></tr><tr class="evenRow"><td align="left">ValueEach</td><td align="left">decimal</td><td align="left">Product value</td></tr><tr class="oddRow"><td align="left">RFlag</td><td align="left">int</td><td align="left">Internal flag to indicate if marked for deletion</td></tr></tbody></table><p><strong>ProductChargeMode</strong> can be one of the following:</p><ul><li>PerRoom</li><li>PerPerson</li><li>PerAdult</li><li>PerChild</li><li>PerInfant</li><li>SingleCharge</li><li>DailyPerRoom</li><li>DailyPerDelegate</li><li>HourlyPerRoom</li><li>HourlyPerDelegate</li><li>FunctionSingleCharge</li><li>Unknown</li></ul><p><strong>ProductPostingFrequency</strong> can be one of the following:</p><ul><li>EveryBlock</li><li>OnArrivalOnly</li><li>OnDepartureOnly</li><li>OnArrivalAndDeparture</li><li>EveryBlockExcludeArrival</li><li>EveryBlockExcludeDeparture</li><li>EveryBlockExcludeArrivalAndDeparture</li><li>Unknown</li></ul><p><strong>ProductUpsellSource</strong> can be one of the following:</p><ul><li>None</li><li>GeneralUpSell</li><li>RateSpecificUpSell</li></ul>
pmsprd_GetProductUpSellListSoapIn
<pmsprd_GetProductUpSellList xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>4e198586-f1fd-4387-aee5-fd3944e81b18</SessionID>
<RatePlanCode>string</RatePlanCode>
<ArrivalDateTime>dateTime</ArrivalDateTime>
<DepartureDateTime>dateTime</DepartureDateTime>
<ProductList>
</ProductList>
</pmsprd_GetProductUpSellList>
pmsprd_GetProductUpSellListSoapOut
<pmsprd_GetProductUpSellListResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprd_GetProductUpSellListResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprd_GetProductUpSellListResult>
<ProductList>
<ProductCodes>
<ProductItem>
<ProductCode>BFAST_UPSELL</ProductCode>
<ProductGroupCode>UPSELLS</ProductGroupCode>
<Description>Breakfast</Description>
<SalesAnalysisCode>BREAKFAST</SalesAnalysisCode>
<ProductChargeMode>PerAdult</ProductChargeMode>
<ProductPostingFrequency>EveryBlockExcludeDeparture</ProductPostingFrequency>
<ProductUpsellSource>GeneralUpSell</ProductUpsellSource>
<ValueEach>7.5000</ValueEach>
<RFlag>0</RFlag>
</ProductItem>
<ProductItem>
<ProductCode>CHAMPAGNE</ProductCode>
<ProductGroupCode>UPSELLS</ProductGroupCode>
<Description>Bottle of Champagne</Description>
<SalesAnalysisCode>BAR</SalesAnalysisCode>
<ProductChargeMode>PerRoom</ProductChargeMode>
<ProductPostingFrequency>OnArrivalOnly</ProductPostingFrequency>
<ProductUpsellSource>GeneralUpSell</ProductUpsellSource>
<ValueEach>40.0000</ValueEach>
<RFlag>0</RFlag>
</ProductItem>
<ProductItem>
<ProductCode>COT</ProductCode>
<ProductGroupCode>BEDS</ProductGroupCode>
<Description>Baby Cot</Description>
<SalesAnalysisCode>BED</SalesAnalysisCode>
<ProductChargeMode>PerRoom</ProductChargeMode>
<ProductPostingFrequency>EveryBlockExcludeDeparture</ProductPostingFrequency>
<ProductUpsellSource>GeneralUpSell</ProductUpsellSource>
<ValueEach>0</ValueEach>
<RFlag>0</RFlag>
</ProductItem>
<ProductItem>
<ProductCode>DINNER_UPSEL</ProductCode>
<ProductGroupCode>UPSELLS</ProductGroupCode>
<Description>Dinner</Description>
<SalesAnalysisCode>DINNER</SalesAnalysisCode>
<ProductChargeMode>PerAdult</ProductChargeMode>
<ProductPostingFrequency>EveryBlockExcludeDeparture</ProductPostingFrequency>
<ProductUpsellSource>GeneralUpSell</ProductUpsellSource>
<ValueEach>25.0000</ValueEach>
<RFlag>0</RFlag>
</ProductItem>
<ProductItem>
<ProductCode>FLOWERS</ProductCode>
<ProductGroupCode>UPSELLS</ProductGroupCode>
<Description>Bunch Seasonal Flowers</Description>
<SalesAnalysisCode>SUNDRIES</SalesAnalysisCode>
<ProductChargeMode>PerRoom</ProductChargeMode>
<ProductPostingFrequency>OnArrivalOnly</ProductPostingFrequency>
<ProductUpsellSource>GeneralUpSell</ProductUpsellSource>
<ValueEach>30.0000</ValueEach>
<RFlag>0</RFlag>
</ProductItem>
<ProductItem>
<ProductCode>ROOM_UPGRADE</ProductCode>
<ProductGroupCode>UPSELLS</ProductGroupCode>
<Description>Room Upgrade</Description>
<SalesAnalysisCode>ACCOM</SalesAnalysisCode>
<ProductChargeMode>SingleCharge</ProductChargeMode>
<ProductPostingFrequency>OnArrivalOnly</ProductPostingFrequency>
<ProductUpsellSource>GeneralUpSell</ProductUpsellSource>
<ValueEach>15.0000</ValueEach>
<RFlag>0</RFlag>
</ProductItem>
</ProductCodes>
</ProductList>
</pmsprd_GetProductUpSellListResponse>
This method is used to post charges to a resident guest folio. The charges can consist of one or more individual items, which can optionally be grouped under a header.</p><table><tbody><tr class="evenRow"><td align="left"><strong>Resident guest folio</strong> The charges can be posted against a room reference (room name or number), against a telephone extension number associated a room, or against a reservation number. If posting against a room reference or telephone extension, the system will actually post to the primary guest reservation which is resident in the room. In the vast majority of cases, there would only be one resident reservation associated with a room, but it is technically possible to have more than one. It is generally better to post to a reservation reference to be absolutely clear on this point. Furthermore, if <FolioID> is supplied, it is possible to post to an individual guest folio within a multi-guest reservation, e.g. if splitting a bill between room guests. If no <FolioID> is supplied, the system will post to the primary guest folio in a multi-guest reservation (which will have a Folio ID of '1').</td></tr></tbody></table><table><tbody><tr class="evenRow"><td align="left"><strong>Grouped under a header</strong> If the <Header> element is excluded, then the items will not be grouped together and each line item will appear on the guest bill as a separate item. However, if the <Header> element is included, the items will be grouped together on the guest bill using the description supplied in the header and the value equal to the total of the individual values. This option is preferred by many hoteliers. Grouping items together like this also makes it easier to view in posting reports and on-screen bills. In all cases the individual items are stored for reporting and financial analysis.</td></tr></tbody></table><table><tbody><tr class="evenRow"><td align="left"><strong>Sales analysis codes</strong> Each charge must be posted with a corresponding sales analysis code used to identify the type of charge, e.g. telephone, bar, spa, and so on. The codes in use for a site are configurable and therefore can be different from site to site. The list of codes in use can be obtained using pmscfg_AnalList.</td></tr></tbody></table><table><tbody><tr class="evenRow"><td align="left"><strong>Tax codes</strong> VAT (Value Added Tax) is calculated by the Rezlynx PMS according to the sales analysis code and is therefore not referenced specifically in the posting method. All values used in the posting method should be gross values.</td></tr></tbody></table>
<h4>Parameters</h4>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionId</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">PostingMethod</td><td align="left">"PostingMethod_RoomID", "PostingMethod_Booking_RoomRef" or "PostingMethod_TelExtNo"</td><td align="left">Posting method (room, booking reference or telephone extension)</td></tr><tr class="oddRow"><td align="left">PostingParameter</td><td align="left">string</td><td>This is the value of the parameter defined by PostingMethod, e.g. if using PostingMethod_RoomID then PostingParameter would be the room name or number, e.g. "200"</td></tr><tr class="evenRow"><td align="left">FolioID</td><td align="left">int</td><td align="left">Folio ID, if the bill is split by multiple folios</td></tr><tr class="oddRow"><td align="left">Header</td><td align="left">(Header, see below)</td><td align="left">Posting header</td></tr><tr class="evenRow"><td align="left">Transactions</td><td align="left">(Financial transactions, see below)</td><td align="left">List of financial transactions</td></tr></tbody></table>
<h4>Parameters (Header)</h4>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AnalysisCode</td><td align="left">string</td><td align="left">Sales analysis code</td></tr><tr class="evenRow"><td align="left">Description</td><td align="left">string</td><td align="left">Description</td></tr><tr class="oddRow"><td align="left">Quantity</td><td align="left">int</td><td align="left">Quantity</td></tr><tr class="evenRow"><td align="left">ExternalInvoiceNo</td><td align="left">string</td><td align="left">Optional: if posted transactions are already invoiced in an external system, e.g. POS, the document number of that operation can be passed as a parameter</td></tr></tbody></table>
<h4>Parameters (Financial Transaction)</h4>
<table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AnalysisCode</td><td align="left">string</td><td align="left">Sales analysis code</td></tr><tr class="evenRow"><td align="left">Description</td><td align="left">string</td><td align="left">Description</td></tr><tr class="oddRow"><td align="left">Quantity</td><td align="left">int</td><td align="left">Quantity</td></tr><tr class="evenRow"><td align="left">GrossTotal</td><td align="left">decimal</td><td align="left">Gross total value</td></tr><tr class="oddRow"><td align="left">ShiftNo</td><td align="left">int</td><td align="left">Shift number (or '-1' if not applicable)</td></tr></tbody></table>
<h4>Returned data</h4>
None
pmschg_PostToRoomSoapIn
<pmschg_PostToRoom xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionID>d9de5589-5781-45bd-a5bd-a385f6d19bce</SessionID>
<PostingMethod>PostingMethod_RoomID</PostingMethod>
<PostingParameter>002</PostingParameter>
<FolioID>-1</FolioID>
<Header>
<AnalysisCode>FOOD</AnalysisCode>
<Description>Crystal Room – Beverage – Order No. 12345</Description>
<Quantity>1</Quantity>
<ExternalInvoiceNo>INV001</ExternalInvoiceNo>
</Header>
<Transactions>
<FinancialTransaction>
<AnalysisCode>FOOD</AnalysisCode>
<Description>Dinner</Description>
<Quantity>1</Quantity>
<GrossTotal>35.50</GrossTotal>
<ShiftNo>-1</ShiftNo>
</FinancialTransaction>
<FinancialTransaction>
<AnalysisCode>BARDRINK</AnalysisCode>
<Description>Bar Drinks</Description>
<Quantity>1</Quantity>
<GrossTotal>12.75</GrossTotal>
<ShiftNo>-1</ShiftNo>
</FinancialTransaction>
</Transactions>
</pmschg_PostToRoom>
pmschg_PostToRoomSoapOut
<pmschg_PostToRoomResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmschg_PostToRoomResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmschg_PostToRoomResult>
</pmschg_PostToRoomResponse>
Updates an attribute (custom field) on a profile, e.g. if there is a custom field set up on a profile for 'car registration', then you can use this method to update the car registration on the guest's profile.
<h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">SessionId</td><td align="left">string</td><td align="left">Session ID, obtained at log-in</td></tr><tr class="evenRow"><td align="left">ProfileRef</td><td align="left">string</td><td align="left">Profile reference</td></tr><tr class="oddRow"><td align="left">AttributeCode</td><td align="left">string</td><td align="left">Attribute code</td></tr><tr class="evenRow"><td align="left">NewValue</td><td align="left">string</td><td align="left">New attribute value</td></tr></tbody></table><h2 class="">Returned data</h2><ul><li>None</li></ul>
pmsprf_UpdateProfileAttributeSoapIn
<pmsprf_UpdateProfileAttribute xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionId>e3acd937-568a-4276-8552-7a064207fc7c</SessionId>
<ProfileRef>PF000012</ProfileRef>
<AttributeCode>CAR_REG</AttributeCode>
<NewValue>WN56 KHU</NewValue>
</pmsprf_UpdateProfileAttribute>
pmsprf_UpdateProfileAttributeSoapOut
<pmsprf_UpdateProfileAttributeResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_UpdateProfileAttributeResult>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprf_UpdateProfileAttributeResult>
</pmsprf_UpdateProfileAttributeResponse>
<p>Allocate an existing CIM payment or credit note to one or more invoices. You can specify the amount to be allocated to each invoice. The Central Invoicing Module must be installed for the given site.</p><table><tbody><tr class="evenRow"><td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="https://developers.guestline.com/doc/Common-to-all-API-methods">Common to all API methods</a>.</td></tr></tbody></table><h2 class="">Parameters (transaction)</h2><p>The transaction parameters define the payment or credit note to be allocated. These values can be obtained from <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#cim_GetUnallocatedCredits">cim_GetUnallocatedCredits</a>.</p><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AccountRef</td><td align="left">string</td><td align="left">CIM account reference</td></tr><tr class="evenRow"><td align="left">Status</td><td align="left">(see below)</td><td align="left">Payment or credit status</td></tr><tr class="oddRow"><td align="left">TimeStamp</td><td align="left">dateTime</td><td align="left">Date of payment or credit</td></tr><tr class="evenRow"><td align="left">DocumentRef</td><td align="left">string</td><td align="left">Payment or credit document reference</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Payment or credit description</td></tr><tr class="evenRow"><td align="left">GrossValue</td><td align="left">decimal</td><td align="left">Gross value of transaction</td></tr><tr class="oddRow"><td align="left">Balance</td><td align="left">decimal</td><td align="left">Balance remaining on account</td></tr><tr class="evenRow"><td align="left">SiteID</td><td align="left">string</td><td align="left">Site ID</td></tr><tr class="oddRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking reference, if applicable</td></tr><tr class="evenRow"><td align="left">PaymentDue</td><td align="left">dateTime</td><td align="left">Payment due date</td></tr><tr class="oddRow"><td align="left">SequenceNo</td><td align="left">int</td><td align="left">Transaction sequence number</td></tr><tr class="evenRow"><td align="left">Id</td><td align="left">int</td><td align="left">Payment or credit ID</td></tr></tbody></table><p><strong>Status</strong> can be one of the following:</p><ul><li>"Unknown"</li><li>"PendingIssue"</li><li>"DebitUnPaid"</li><li>"DebitPartPaid"</li><li>"DebitFullyPaid"</li><li>"CreditPartUsed"</li><li>"CreditFullyUsed"</li><li>"CreditUnused"</li></ul><h2 class="">Parameters (invoices)</h2><p>The invoices parameters define for each invoice the invoice reference and the amount to be allocated to the invoice.</p><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AllocateInvoiceDetails</td><td align="left">(object)</td><td align="left">Details of invoice</td></tr><tr class="evenRow"><td align="left">>ExtensionData</td><td align="left">(object)</td><td align="left">Not used</td></tr><tr class="oddRow"><td align="left">>DocumentRef</td><td align="left">string</td><td align="left">Invoice document reference</td></tr><tr class="evenRow"><td align="left">>Value</td><td align="left">decimal</td><td align="left">Value to be allocated to this invoice</td></tr></tbody></table><h2 class="">Returned data</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AllocatePaymentResponse</td><td align="left">"Success" or "InvalidMatchOrPartialMatch... ValueAndOrInsufficientFunds"</td><td align="left">Success or failure response</td></tr></tbody></table>
cim_AllocateExistingPaymentSoapIn
<cim_AllocateExistingPayment xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<transaction>
<AccountRef>CIM00001</AccountRef>
<Status>PendingIssue</Status>
<TimeStamp>2018-03-29T12:30:14.6042212+01:00</TimeStamp>
<DocumentRef>string</DocumentRef>
<Description>string</Description>
<GrossValue>120.00</GrossValue>
<Balance>20000.00</Balance>
<SiteID>TEST111</SiteID>
<BookRef>string</BookRef>
<PaymentDue>2018-03-29T12:30:14.6042212+01:00</PaymentDue>
<SequenceNo>456</SequenceNo>
<Id>99</Id>
</transaction>
<invoices>
<AllocateInvoiceDetails>
<ExtensionData />
<DocumentRef>8787</DocumentRef>
<Value>10.00</Value>
</AllocateInvoiceDetails>
<AllocateInvoiceDetails>
<ExtensionData />
<DocumentRef>30400</DocumentRef>
<Value>90.00</Value>
</AllocateInvoiceDetails>
</invoices>
</cim_AllocateExistingPayment>
cim_AllocateExistingPaymentSoapOut
<cim_AllocateExistingPaymentResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_AllocateExistingPaymentResult>
<AllocatePaymentResponse>Success</AllocatePaymentResponse>
<FaultResponse>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</FaultResponse>
</cim_AllocateExistingPaymentResult>
</cim_AllocateExistingPaymentResponse>
<p>For the specified CIM account, get the list of credit notes and payments not allocated to invoices. The Central Invoicing Module must be installed for the given site.</p><table><tbody><tr class="evenRow"><td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td></tr></tbody></table><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">accountRef</td><td align="left">string</td><td align="left">CIM account reference</td></tr></tbody></table><h2 class="">Returned data (CIM transaction)</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AccountRef</td><td align="left">string</td><td align="left">CIM account reference</td></tr><tr class="evenRow"><td align="left">Status</td><td align="left">(see below)</td><td align="left">Payment or credit status</td></tr><tr class="oddRow"><td align="left">TimeStamp</td><td align="left">dateTime</td><td align="left">Date</td></tr><tr class="evenRow"><td align="left">DocumentRef</td><td align="left">string</td><td align="left">Payment or credit document reference</td></tr><tr class="oddRow"><td align="left">Description</td><td align="left">string</td><td align="left">Transaction description</td></tr><tr class="evenRow"><td align="left">GrossValue</td><td align="left">decimal</td><td align="left">Gross amount</td></tr><tr class="oddRow"><td align="left">Balance</td><td align="left">decimal</td><td align="left">Balance remaining</td></tr><tr class="evenRow"><td align="left">SiteID</td><td align="left">string</td><td align="left">Site ID</td></tr><tr class="oddRow"><td align="left">BookRef</td><td align="left">string</td><td align="left">Booking reference, if applicable</td></tr><tr class="evenRow"><td align="left">PaymentDue</td><td align="left">dateTime</td><td align="left">Payment due date</td></tr><tr class="oddRow"><td align="left">SequenceNo</td><td align="left">int</td><td align="left">Transaction sequence number</td></tr><tr class="evenRow"><td align="left">Id</td><td align="left">int</td><td align="left">Payment or credit ID</td></tr></tbody></table><p><strong>Status</strong> can be one of the following:</p><ul><li>"Unknown"</li><li>"PendingIssue"</li><li>"DebitUnPaid"</li><li>"DebitPartPaid"</li><li>"DebitFullyPaid"</li><li>"CreditPartUsed"</li><li>"CreditFullyUsed"</li><li>"CreditUnused"</li></ul>
cim_GetUnallocatedCreditsSoapIn
<cim_GetUnallocatedCredits xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<accountRef>string</accountRef>
</cim_GetUnallocatedCredits>
cim_GetUnallocatedCreditsSoapOut
<cim_GetUnallocatedCreditsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_GetUnallocatedCreditsResult>
<CIMTransaction>
<AccountRef>string</AccountRef>
<Status>PendingIssue</Status>
<TimeStamp>dateTime</TimeStamp>
<DocumentRef>string</DocumentRef>
<Description>string</Description>
<GrossValue>decimal</GrossValue>
<Balance>decimal</Balance>
<SiteID>string</SiteID>
<BookRef>string</BookRef>
<PaymentDue>dateTime</PaymentDue>
<SequenceNo>int</SequenceNo>
<Id>int</Id>
</CIMTransaction>
<CIMTransaction>
<AccountRef>string</AccountRef>
<Status>PendingIssue</Status>
<TimeStamp>dateTime</TimeStamp>
<DocumentRef>string</DocumentRef>
<Description>string</Description>
<GrossValue>decimal</GrossValue>
<Balance>decimal</Balance>
<SiteID>string</SiteID>
<BookRef>string</BookRef>
<PaymentDue>dateTime</PaymentDue>
<SequenceNo>int</SequenceNo>
<Id>int</Id>
</CIMTransaction>
</cim_GetUnallocatedCreditsResult>
</cim_GetUnallocatedCreditsResponse>
<p>Retrieve the list of payable invoices for the given CIM account. The Central Invoicing Module must be installed for the given site.</p><table><tbody><tr class="evenRow"><td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td></tr></tbody></table><h2 class="">Parameters</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">accountRef</td><td align="left">string</td><td align="left">CIM account reference</td></tr></tbody></table><h2 class="">Returned data</h2><table><tbody><tr class="evenRow"><th align="left">Name</th><th align="left">Type</th><th align="left">Description</th></tr><tr class="oddRow"><td align="left">AccountRef</td><td align="left">string</td><td align="left">CIM account reference</td></tr><tr class="evenRow"><td align="left">DocumentRef</td><td align="left">string</td><td align="left">Invoice document reference</td></tr><tr class="oddRow"><td align="left">GrossValue</td><td align="left">decimal</td><td align="left">Invoice gross value</td></tr><tr class="evenRow"><td align="left">NettTotal</td><td align="left">decimal</td><td align="left">Invoice nett value</td></tr><tr class="oddRow"><td align="left">BalanceRemaining</td><td align="left">decimal</td><td align="left">Invoice balance remaining</td></tr></tbody></table>
cim_RetrievePayableInvoicesSoapIn
<cim_RetrievePayableInvoices xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<accountRef>776736</accountRef>
</cim_RetrievePayableInvoices>
cim_RetrievePayableInvoicesSoapOut
<cim_RetrievePayableInvoicesResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<cim_RetrievePayableInvoicesResult>
<CIMInvoice>
<AccountRef>776736</AccountRef>
<DocumentRef>INV0083</DocumentRef>
<GrossValue>2000.00</GrossValue>
<NettTotal>1750.00</NettTotal>
<BalanceRemaining>10000.00</BalanceRemaining>
</CIMInvoice>
<CIMInvoice>
<AccountRef>776736</AccountRef>
<DocumentRef>INV0084</DocumentRef>
<GrossValue>25.00</GrossValue>
<NettTotal>18.57</NettTotal>
<BalanceRemaining>11075.00</BalanceRemaining>
</CIMInvoice>
</cim_RetrievePayableInvoicesResult>
</cim_RetrievePayableInvoicesResponse>
<p>This method fetches financial export data from the <a class="tc-tiddlylink tc-tiddlylink-resolves" href="#CIM">CIM</a> system, covering a specified time period.</p>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">sessionId</td>
<td align="left">string</td>
<td align="left">Session ID, obtained at login</td>
</tr>
<tr class="evenRow">
<td align="left">beforeTimestamp</td>
<td align="left">dateTime</td>
<td align="left">Date-time equal to or before which data is required</td>
</tr>
<tr class="oddRow">
<td align="left">afterTimestamp</td>
<td align="left">dateTime</td>
<td align="left">Date-time equal to or after which data is required</td>
</tr>
<tr class="evenRow">
<td align="left">useLessThanToDate</td>
<td align="left">Boolean</td>
<td align="left">Provides an option to return only the data that is less than the before timestamp which is required for financial export for LSE</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>A set of financial transactions</li>
</ul>
<h2 class="">Returned data (financial transaction)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">TransactionType</td>
<td align="left">string</td>
<td align="left">Transaction type (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">AccountNumber</td>
<td align="left">string</td>
<td align="left">CIM account number</td>
</tr>
<tr class="oddRow">
<td align="left">AccountType</td>
<td align="left">int</td>
<td align="left">CIM account type</td>
</tr>
<tr class="evenRow">
<td align="left">TransactionReference</td>
<td align="left">string</td>
<td align="left">Transaction reference</td>
</tr>
<tr class="oddRow">
<td align="left">UniqueReferenceNumber</td>
<td align="left">string</td>
<td align="left">Unique reference number</td>
</tr>
<tr class="evenRow">
<td align="left">SecondReference</td>
<td align="left">string</td>
<td align="left">Supplementary reference number, if applicable</td>
</tr>
<tr class="oddRow">
<td align="left">Description</td>
<td align="left">string</td>
<td align="left">Transaction description</td>
</tr>
<tr class="evenRow">
<td align="left">DueDate</td>
<td align="left">dateTime</td>
<td align="left">Due date</td>
</tr>
<tr class="oddRow">
<td align="left">ForDate</td>
<td align="left">dateTime</td>
<td align="left">For date</td>
</tr>
<tr class="evenRow">
<td align="left">TransactionDate</td>
<td align="left">dateTime</td>
<td align="left">Transaction date</td>
</tr>
<tr class="oddRow">
<td align="left">GrossValue</td>
<td align="left">decimal</td>
<td align="left">Gross value</td>
</tr>
<tr class="evenRow">
<td align="left">NettValue</td>
<td align="left">decimal</td>
<td align="left">Nett value</td>
</tr>
<tr class="oddRow">
<td align="left">TaxValue</td>
<td align="left">decimal</td>
<td align="left">Tax value</td>
</tr>
<tr class="evenRow">
<td align="left">NominalCode</td>
<td align="left">string</td>
<td align="left">Nominal code</td>
</tr>
<tr class="oddRow">
<td align="left">SaleCode</td>
<td align="left">string</td>
<td align="left">Sales code</td>
</tr>
<tr class="evenRow">
<td align="left">PayCode</td>
<td align="left">string</td>
<td align="left">Payment code</td>
</tr>
<tr class="oddRow">
<td align="left">TaxCode</td>
<td align="left">string</td>
<td align="left">Tax code</td>
</tr>
<tr class="evenRow">
<td align="left">SiteId</td>
<td align="left">string</td>
<td align="left">Applicable site ID</td>
</tr>
<tr class="oddRow">
<td align="left">PeriodId</td>
<td align="left">int</td>
<td align="left">Applicable period ID</td>
</tr>
<tr class="evenRow">
<td align="left">PeriodFromDate</td>
<td align="left">dateTime</td>
<td align="left">Period 'from' date</td>
</tr>
<tr class="oddRow">
<td align="left">PeriodToDate</td>
<td align="left">dateTime</td>
<td align="left">Period 'to' date</td>
</tr>
<tr class="evenRow">
<td align="left">ModifiedDate</td>
<td align="left">dateTime</td>
<td align="left">Modified date</td>
</tr>
<tr class="oddRow">
<td align="left">ModifiedKey</td>
<td align="left">int</td>
<td align="left">Modified key</td>
</tr>
</tbody>
</table>
<p><strong>Transaction type</strong> is one of the following:</p>
<ul>
<li>"Payment"</li>
<li>"Invoice"</li>
<li>"CreditNote"</li>
<li>"Proforma"</li>
</ul>
cim_FinancialExportReportV2SoapIn
<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>
cim_FinancialExportReportV2SoapOut
<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>
<p>This method retrieves a guest profile.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Profile requestor authentication</strong> Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them.</td>
</tr>
</tbody>
</table>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">ProfileRequestor</td>
<td align="left">(object)</td>
<td align="center"></td>
</tr>
<tr class="evenRow">
<td align="left">> ProfileUniqueId</td>
<td align="left">string</td>
<td align="left">Unique profile ID, must be either a profile reference, unique email address or loyalty ID</td>
</tr>
<tr class="oddRow">
<td align="left">> ProfileUniqueIdAuthenticatorValue</td>
<td align="left">string</td>
<td align="left">The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below</td>
</tr>
<tr class="evenRow">
<td align="left">> AuthenticationMethod</td>
<td align="left">"PD"</td>
<td align="left">"PD" stands for "Person Details" and should always be set to this</td>
</tr>
<tr class="oddRow">
<td align="left">> AuthenticationCode</td>
<td align="left">string</td>
<td align="left">The method of second line authentication to be used i.e. "Forename", "Surname" or "PostCode"</td>
</tr>
<tr class="evenRow">
<td align="left">> AuthenticationValue</td>
<td align="left">string</td>
<td align="left">The authentication value, e.g. if the method is "Surname" and the profile is under the name of "Jones" then the value will be "Jones", if the method is "PostCode" then the value will be "SY26LG"</td>
</tr>
<tr class="oddRow">
<td align="left">Filters</td>
<td align="left">"Checked Out", "Resident" or "Future"</td>
<td align="left">Optional filter to filter results according to the reservation status</td>
</tr>
<tr class="evenRow">
<td align="left">ProfileSearchMode</td>
<td align="left">"Contact", "Guest" or "Both"</td>
<td align="left">Used to indicate whether searching for a reservation contact, reservation guest or both</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data (profile)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">ProfileRef</td>
<td align="left">string</td>
<td align="left">Profile reference</td>
</tr>
<tr class="evenRow">
<td align="left">Salutation</td>
<td align="left">string</td>
<td align="left">Title</td>
</tr>
<tr class="oddRow">
<td align="left">Forename</td>
<td align="left">string</td>
<td align="left">Forename</td>
</tr>
<tr class="evenRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Surname</td>
</tr>
<tr class="oddRow">
<td align="left">EMailAddress</td>
<td align="left">string</td>
<td align="left">E-mail address</td>
</tr>
<tr class="evenRow">
<td align="left">Gender</td>
<td align="left">string</td>
<td align="left">Gender</td>
</tr>
<tr class="oddRow">
<td align="left">Street</td>
<td align="left">string</td>
<td align="left">Address street</td>
</tr>
<tr class="evenRow">
<td align="left">Area</td>
<td align="left">string</td>
<td align="left">Address area</td>
</tr>
<tr class="oddRow">
<td align="left">Town</td>
<td align="left">string</td>
<td align="left">Address town or city</td>
</tr>
<tr class="evenRow">
<td align="left">County</td>
<td align="left">string</td>
<td align="left">Address county or state</td>
</tr>
<tr class="oddRow">
<td align="left">PostCode</td>
<td align="left">string</td>
<td align="left">Address postcode or zip code</td>
</tr>
<tr class="evenRow">
<td align="left">Country</td>
<td align="left">string</td>
<td align="left">Address country</td>
</tr>
<tr class="oddRow">
<td align="left">TelephoneNo</td>
<td align="left">string</td>
<td align="left">Telephone number</td>
</tr>
<tr class="evenRow">
<td align="left">FaxNo</td>
<td align="left">string</td>
<td align="left">Fax number</td>
</tr>
<tr class="oddRow">
<td align="left">MobileNo</td>
<td align="left">string</td>
<td align="left">Mobile telephone number</td>
</tr>
<tr class="evenRow">
<td align="left">Nationality</td>
<td align="left">string</td>
<td align="left">Nationality</td>
</tr>
<tr class="oddRow">
<td align="left">Language</td>
<td align="left">string</td>
<td align="left">Language</td>
</tr>
<tr class="evenRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference, if applicable</td>
</tr>
<tr class="oddRow">
<td align="left">Vip</td>
<td align="left">int</td>
<td align="left">Integer VIP level (e.g. 1,2,3...)</td>
</tr>
<tr class="evenRow">
<td align="left">DateOfBirth</td>
<td align="left">dateTime</td>
<td align="left">Date of birth</td>
</tr>
<tr class="oddRow">
<td align="left">StudentID</td>
<td align="left">string</td>
<td align="left">Student ID, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">TypeOfPerson</td>
<td align="left">"Adult", "Child" or "Infant"</td>
<td align="left">Adult status</td>
</tr>
<tr class="oddRow">
<td align="left">PassportNumber</td>
<td align="left">string</td>
<td align="left">Passport number</td>
</tr>
<tr class="evenRow">
<td align="left">PreferredRoomType</td>
<td align="left">string</td>
<td align="left">Preferred room type</td>
</tr>
<tr class="oddRow">
<td align="left">ExcludeFromMailings</td>
<td align="left">Boolean</td>
<td align="left">Indicates if person chose to be excluded from general marketing mailings</td>
</tr>
<tr class="evenRow">
<td align="left">Smoker</td>
<td align="left">int</td>
<td align="left">Smoker or not</td>
</tr>
<tr class="oddRow">
<td align="left">BlackListed</td>
<td align="left">int</td>
<td align="left">Blacklisted or not</td>
</tr>
<tr class="evenRow">
<td align="left">LoyaltyID</td>
<td align="left">string</td>
<td align="left">Loyalty ID</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileType</td>
<td align="left">"Private", "Agents", "Corporate", "TourGroup" or "TourSeries"</td>
<td align="left">Profile type</td>
</tr>
<tr class="evenRow">
<td align="left">ExcludeFromThirdPartyMailings</td>
<td align="left">Boolean</td>
<td align="left">Indicates if person chose to be excluded from third-party mailings</td>
</tr>
<tr class="oddRow">
<td align="left">Suffix</td>
<td align="left">string</td>
<td align="left">Name suffix</td>
</tr>
<tr class="evenRow">
<td align="left">MiddleName</td>
<td align="left">string</td>
<td align="left">Middle name</td>
</tr>
<tr class="oddRow">
<td align="left">AddressLine1</td>
<td align="left">string</td>
<td align="left">Address line 1</td>
</tr>
<tr class="evenRow">
<td align="left">AddressLine2</td>
<td align="left">string</td>
<td align="left">Address line 2</td>
</tr>
<tr class="oddRow">
<td align="left">State</td>
<td align="left">string</td>
<td align="left">Address state</td>
</tr>
<tr class="evenRow">
<td align="left">PublicNotes</td>
<td align="left">string</td>
<td align="left">Notes (public)</td>
</tr>
<tr class="oddRow">
<td align="left">PrivateNotes</td>
<td align="left">string</td>
<td align="left">Notes (private)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes1</td>
<td align="left">string</td>
<td align="left">Notes (custom 1)</td>
</tr>
<tr class="oddRow">
<td align="left">CustomNotes2</td>
<td align="left">string</td>
<td align="left">Notes (custom 2)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes3</td>
<td align="left">string</td>
<td align="left">Notes (custom 3)</td>
</tr>
</tbody>
</table>
pmsprf_GetProfileSummaryV3SoapIn
<pmsprf_GetProfileSummaryV3 xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<ProfileRequestor>
<ProfileUniqueId>PF000024</ProfileUniqueId>
<ProfileUniqueIdAuthenticatorValue />
<AuthenticationMethod>PD</AuthenticationMethod>
<AuthenticationCode>Surname</AuthenticationCode>
<AuthenticationValue>Valli</AuthenticationValue>
</ProfileRequestor>
</pmsprf_GetProfileSummaryV3>
pmsprf_GetProfileSummaryV3SoapOut
<pmsprf_GetProfileSummaryV3Response xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_GetProfileSummaryV3Result>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprf_GetProfileSummaryV3Result>
<Profile>
<ProfileRef>PF000024</ProfileRef>
<Salutation>Mr</Salutation>
<Forename>Zen</Forename>
<Surname>Valli</Surname>
<EMailAddress>zunaid.valli@guestline.com</EMailAddress>
<Gender>U</Gender>
<Street>Guestline House Shrewsbury Business Park</Street>
<Area>Sitka Drive</Area>
<Town>Shrewsbury</Town>
<County>Shropshire</County>
<PostCode>SY2 6LG</PostCode>
<Country>United Kingdom</Country>
<TelephoneNo>0123456789</TelephoneNo>
<FaxNo />
<MobileNo />
<Nationality>British</Nationality>
<Language>English</Language>
<CompanyRef />
<Vip>0</Vip>
<DateOfBirth>1754-01-01T00:00:00</DateOfBirth>
<StudentID />
<TypeOfPerson>Adult</TypeOfPerson>
<PassportNumber />
<PreferredRoomType />
<ExcludeFromMailings>false</ExcludeFromMailings>
<Smoker>0</Smoker>
<BlackListed>0</BlackListed>
<LoyaltyID />
<ProfileType>Private</ProfileType>
<ExcludeFromThirdPartyMailings>true</ExcludeFromThirdPartyMailings>
<Suffix />
<MiddleName />
<AddressLine1 />
<AddressLine2 />
<State />
<PublicNotes />
<PrivateNotes />
<CustomNotes1>Gluten</CustomNotes1>
<CustomNotes2>No Duvet</CustomNotes2>
<CustomNotes3 />
</Profile>
</pmsprf_GetProfileSummaryV3Response>
<p>This method retrieves a guest profile, including custom attributes. It is based on <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/docs/services/f093d4f7933f4a31bed5130e623e314e/operations/pmsprf-getprofilesummaryv3?">pmsprf_GetProfileSummaryV3</a> but with the addition of custom attributes in the response object.</p>
<p>(note however that this method uses SessionID like <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/docs/services/f093d4f7933f4a31bed5130e623e314e/operations/5b6bfd0223b4741394498433?">pmsprf_GetProfileSummaryV2</a> and <u>not</u> SOAP header authentication like <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/docs/services/f093d4f7933f4a31bed5130e623e314e/operations/pmsprf-getprofilesummaryv3?">pmsprf_GetProfileSummaryV3</a>)</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Profile requestor authentication</strong> Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them.</td>
</tr>
</tbody>
</table>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SessionID</td>
<td align="left">string</td>
<td align="left">Session ID, obtained at log-in</td>
</tr>
<tr class="evenRow">
<td align="left">ProfileRequestor</td>
<td align="left">(object)</td>
<td align="center"></td>
</tr>
<tr class="oddRow">
<td align="left">> ProfileUniqueId</td>
<td align="left">string</td>
<td align="left">Unique profile ID, must be either a profile reference, unique email address or loyalty ID</td>
</tr>
<tr class="evenRow">
<td align="left">> ProfileUniqueIdAuthenticatorValue</td>
<td align="left">string</td>
<td align="left">The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below</td>
</tr>
<tr class="oddRow">
<td align="left">> AuthenticationMethod</td>
<td align="left">"PD"</td>
<td align="left">"PD" stands for "Person Details" and should always be set to this</td>
</tr>
<tr class="evenRow">
<td align="left">> AuthenticationCode</td>
<td align="left">string</td>
<td align="left">The method of second line authentication to be used i.e. "Forename", "Surname" or "PostCode"</td>
</tr>
<tr class="oddRow">
<td align="left">> AuthenticationValue</td>
<td align="left">string</td>
<td align="left">The authentication value, e.g. if the method is "Surname" and the profile is under the name of "Jones" then the value will be "Jones", if the method is "PostCode" then the value will be "SY26LG"</td>
</tr>
<tr class="evenRow">
<td align="left">Filters</td>
<td align="left">"Checked Out", "Resident" or "Future"</td>
<td align="left">Optional filter to filter results according to the reservation status</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileSearchMode</td>
<td align="left">"Contact", "Guest" or "Both"</td>
<td align="left">Used to indicate whether searching for a reservation contact, reservation guest or both</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data (profile)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">ProfileRef</td>
<td align="left">string</td>
<td align="left">Profile reference</td>
</tr>
<tr class="evenRow">
<td align="left">Salutation</td>
<td align="left">string</td>
<td align="left">Title</td>
</tr>
<tr class="oddRow">
<td align="left">Forename</td>
<td align="left">string</td>
<td align="left">Forename</td>
</tr>
<tr class="evenRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Surname</td>
</tr>
<tr class="oddRow">
<td align="left">EMailAddress</td>
<td align="left">string</td>
<td align="left">E-mail address</td>
</tr>
<tr class="evenRow">
<td align="left">Gender</td>
<td align="left">string</td>
<td align="left">Gender</td>
</tr>
<tr class="oddRow">
<td align="left">Street</td>
<td align="left">string</td>
<td align="left">Address street</td>
</tr>
<tr class="evenRow">
<td align="left">Area</td>
<td align="left">string</td>
<td align="left">Address area</td>
</tr>
<tr class="oddRow">
<td align="left">Town</td>
<td align="left">string</td>
<td align="left">Address town or city</td>
</tr>
<tr class="evenRow">
<td align="left">County</td>
<td align="left">string</td>
<td align="left">Address county or state</td>
</tr>
<tr class="oddRow">
<td align="left">PostCode</td>
<td align="left">string</td>
<td align="left">Address postcode or zip code</td>
</tr>
<tr class="evenRow">
<td align="left">Country</td>
<td align="left">string</td>
<td align="left">Address country</td>
</tr>
<tr class="oddRow">
<td align="left">TelephoneNo</td>
<td align="left">string</td>
<td align="left">Telephone number</td>
</tr>
<tr class="evenRow">
<td align="left">FaxNo</td>
<td align="left">string</td>
<td align="left">Fax number</td>
</tr>
<tr class="oddRow">
<td align="left">MobileNo</td>
<td align="left">string</td>
<td align="left">Mobile telephone number</td>
</tr>
<tr class="evenRow">
<td align="left">Nationality</td>
<td align="left">string</td>
<td align="left">Nationality</td>
</tr>
<tr class="oddRow">
<td align="left">Language</td>
<td align="left">string</td>
<td align="left">Language</td>
</tr>
<tr class="evenRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference, if applicable</td>
</tr>
<tr class="oddRow">
<td align="left">Vip</td>
<td align="left">int</td>
<td align="left">Integer VIP level (e.g. 1,2,3...)</td>
</tr>
<tr class="evenRow">
<td align="left">DateOfBirth</td>
<td align="left">dateTime</td>
<td align="left">Date of birth</td>
</tr>
<tr class="oddRow">
<td align="left">StudentID</td>
<td align="left">string</td>
<td align="left">Student ID, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">TypeOfPerson</td>
<td align="left">"Adult", "Child" or "Infant"</td>
<td align="left">Adult status</td>
</tr>
<tr class="oddRow">
<td align="left">PassportNumber</td>
<td align="left">string</td>
<td align="left">Passport number</td>
</tr>
<tr class="evenRow">
<td align="left">PreferredRoomType</td>
<td align="left">string</td>
<td align="left">Preferred room type</td>
</tr>
<tr class="oddRow">
<td align="left">ExcludeFromMailings</td>
<td align="left">Boolean</td>
<td align="left">Indicates if person chose to be excluded from general marketing mailings</td>
</tr>
<tr class="evenRow">
<td align="left">Smoker</td>
<td align="left">int</td>
<td align="left">Smoker or not</td>
</tr>
<tr class="oddRow">
<td align="left">BlackListed</td>
<td align="left">int</td>
<td align="left">Blacklisted or not</td>
</tr>
<tr class="evenRow">
<td align="left">LoyaltyID</td>
<td align="left">string</td>
<td align="left">Loyalty ID</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileType</td>
<td align="left">"Private", "Agents", "Corporate", "TourGroup" or "TourSeries"</td>
<td align="left">Profile type</td>
</tr>
<tr class="evenRow">
<td align="left">ExcludeFromThirdPartyMailings</td>
<td align="left">Boolean</td>
<td align="left">Indicates if person chose to be excluded from third-party mailings</td>
</tr>
<tr class="oddRow">
<td align="left">Suffix</td>
<td align="left">string</td>
<td align="left">Name suffix</td>
</tr>
<tr class="evenRow">
<td align="left">MiddleName</td>
<td align="left">string</td>
<td align="left">Middle name</td>
</tr>
<tr class="oddRow">
<td align="left">AddressLine1</td>
<td align="left">string</td>
<td align="left">Address line 1</td>
</tr>
<tr class="evenRow">
<td align="left">AddressLine2</td>
<td align="left">string</td>
<td align="left">Address line 2</td>
</tr>
<tr class="oddRow">
<td align="left">State</td>
<td align="left">string</td>
<td align="left">Address state</td>
</tr>
<tr class="evenRow">
<td align="left">PublicNotes</td>
<td align="left">string</td>
<td align="left">Notes (public)</td>
</tr>
<tr class="oddRow">
<td align="left">PrivateNotes</td>
<td align="left">string</td>
<td align="left">Notes (private)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes1</td>
<td align="left">string</td>
<td align="left">Notes (custom 1)</td>
</tr>
<tr class="oddRow">
<td align="left">CustomNotes2</td>
<td align="left">string</td>
<td align="left">Notes (custom 2)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes3</td>
<td align="left">string</td>
<td align="left">Notes (custom 3)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data (custom attribute)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">AttributeCode</td>
<td align="left">string</td>
<td align="left">Attribute field type (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">Value</td>
<td align="left">string</td>
<td align="left">(please ignore this field)</td>
</tr>
<tr class="oddRow">
<td align="left">Param1</td>
<td align="left">string</td>
<td align="left">Parameter #1, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">Param2</td>
<td align="left">string</td>
<td align="left">Parameter #2, if applicable</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileAttributeCode</td>
<td align="left">string</td>
<td align="left">Name of this custom attribute</td>
</tr>
<tr class="evenRow">
<td align="left">ProfileAttributeDescription</td>
<td align="left">string</td>
<td>Description or label for this custom attribute</td>
</tr>
<tr class="oddRow">
<td align="left">ProfileAttributeValue</td>
<td align="left">string</td>
<td align="left">Value of this custom attribute</td>
</tr>
</tbody>
</table>
<p><strong>Attribute field type</strong> can be one of the following:</p>
<ul>
<li>"SMALL" (a small text box)</li>
<li>"LARGE" (a large text box)</li>
<li>"DATE" (a date)</li>
<li>"NUMBER" (an integer number)</li>
<li>"YES_NO" (a yes/no flag)</li>
<li>"LIST" (a list-box)</li>
</ul>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note</strong> some care is needed with the custom attribute values, as they depend on the attribute field type. For example, values for field type "YES_NO" are '1' for 'Yes' and '0' for 'No'.</td>
</tr>
</tbody>
</table>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note</strong> in the case of attributes of field type "LIST", Param2 contains the list options, e.g. "[],[1],[2],[3]" indicates possible values for the attribute are <blank>, '1', '2' or '3'.</td>
</tr>
</tbody>
</table>
pmsprf_GetProfileSummaryWithAttributesSoapIn
<pmsprf_GetProfileSummaryWithAttributes xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<SessionId>a6a70a2d-1ac0-4da0-815a-98cd825a822e</SessionId>
<ProfileRequestor>
<ProfileUniqueId>PF00000003</ProfileUniqueId>
<ProfileUniqueIdAuthenticatorValue />
<AuthenticationMethod>PD</AuthenticationMethod>
<AuthenticationCode>Surname</AuthenticationCode>
<AuthenticationValue>Alibone</AuthenticationValue>
</ProfileRequestor>
</pmsprf_GetProfileSummaryWithAttributes>
pmsprf_GetProfileSummaryWithAttributesSoapOut
<pmsprf_GetProfileSummaryWithAttributesResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_GetProfileSummaryV2Result>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprf_GetProfileSummaryV2Result>
<Profile>
<ProfileRef>PF00000003</ProfileRef>
<Salutation>Mr</Salutation>
<Forename>Lee</Forename>
<Surname>Alibone</Surname>
<EMailAddress>lee.alibone@guestline.com</EMailAddress>
<Gender>M</Gender>
<Street>Guestline House Shrewsbury Business Park</Street>
<Area>Sitka Drive</Area>
<Town>Shrewsbury</Town>
<County>Shropshire</County>
<PostCode>SY2 6LG</PostCode>
<Country>United Kingdom</Country>
<TelephoneNo>0123456789</TelephoneNo>
<FaxNo />
<MobileNo />
<Nationality>British</Nationality>
<Language>English</Language>
<CompanyRef />
<Vip>0</Vip>
<DateOfBirth>1754-01-01T00:00:00</DateOfBirth>
<StudentID />
<TypeOfPerson>Adult</TypeOfPerson>
<PassportNumber />
<PreferredRoomType />
<ExcludeFromMailings>false</ExcludeFromMailings>
<Smoker>0</Smoker>
<BlackListed>0</BlackListed>
<LoyaltyID />
<ProfileType>Private</ProfileType>
<ExcludeFromThirdPartyMailings>true</ExcludeFromThirdPartyMailings>
<Suffix />
<MiddleName />
<AddressLine1 />
<AddressLine2 />
<State />
<PublicNotes />
<PrivateNotes />
<CustomNotes1>Gluten</CustomNotes1>
<CustomNotes2>No Duvet</CustomNotes2>
<CustomNotes3 />
<colProfileAttributes>
<ProfileCustomAttributes>
<AttributeCode>SMALL</AttributeCode>
<Value>Small text</Value>
<Param1 />
<Param2 />
<ProfileAttributeCode>SMALL</ProfileAttributeCode>
<ProfileAttributeDescription>Small</ProfileAttributeDescription>
<ProfileAttributeValue>Small text</ProfileAttributeValue>
</ProfileCustomAttributes>
<ProfileCustomAttributes>
<AttributeCode>LARGE</AttributeCode>
<Value />
<Param1 />
<Param2 />
<ProfileAttributeCode>LARGE</ProfileAttributeCode>
<ProfileAttributeDescription>Large</ProfileAttributeDescription>
<ProfileAttributeValue />
</ProfileCustomAttributes>
<ProfileCustomAttributes>
<AttributeCode>DATE</AttributeCode>
<Value />
<Param1 />
<Param2 />
<ProfileAttributeCode>DATE</ProfileAttributeCode>
<ProfileAttributeDescription>Date</ProfileAttributeDescription>
<ProfileAttributeValue />
</ProfileCustomAttributes>
<ProfileCustomAttributes>
<AttributeCode>NUMBER</AttributeCode>
<Value>99999</Value>
<Param1 />
<Param2 />
<ProfileAttributeCode>NUMBER</ProfileAttributeCode>
<ProfileAttributeDescription>Number</ProfileAttributeDescription>
<ProfileAttributeValue>99999</ProfileAttributeValue>
</ProfileCustomAttributes>
<ProfileCustomAttributes>
<AttributeCode>YES_NO</AttributeCode>
<Value>1</Value>
<Param1 />
<Param2 />
<ProfileAttributeCode>YES_NO</ProfileAttributeCode>
<ProfileAttributeDescription>Yes / No</ProfileAttributeDescription>
<ProfileAttributeValue>1</ProfileAttributeValue>
</ProfileCustomAttributes>
<ProfileCustomAttributes>
<AttributeCode>LIST</AttributeCode>
<Value>3</Value>
<Param1 />
<Param2>[],[1],[2],[3]</Param2>
<ProfileAttributeCode>LIST</ProfileAttributeCode>
<ProfileAttributeDescription>List</ProfileAttributeDescription>
<ProfileAttributeValue>3</ProfileAttributeValue>
</ProfileCustomAttributes>
</colProfileAttributes>
</Profile>
</pmsprf_GetProfileSummaryWithAttributesResponse>
<p>This is used to amend profile details directly in the PMS.</p>
<table>
<tbody>
<tr class="evenRow">
<td><strong>Updating individual fields</strong> Setting a field value will overwrite the current value with the new value; fields which are blank in the request message will <u>not</u> cause any change in the field value, these will <u>not</u> be overwritten; to clear the contents of a field, set the field value to '*' in the request message.</td>
</tr>
</tbody>
</table>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Profile requestor authentication</strong> Since profiles contain personal information, there is an additional requirement around access (two factor authentication); the client using this method must supply either a password set up against the profile, or else supply some information already known from the profile, such as guest surname - see below. A single API account will only support one of these two methods, you cannot mix them.</td>
</tr>
</tbody>
</table>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2 class="">Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">ProfileRequestor</td>
<td align="left">(object)</td>
<td align="center"></td>
</tr>
<tr class="evenRow">
<td align="left">> ProfileUniqueId</td>
<td align="left">string</td>
<td align="left">Unique profile ID, must be either a profile reference, unique email address or loyalty ID</td>
</tr>
<tr class="oddRow">
<td align="left">> ProfileUniqueIdAuthenticatorValue</td>
<td align="left">string</td>
<td align="left">The password that is associated with this profile; if you know the password then you don’t need to send any of the other values below, otherwise leave this blank and send through all the second factor authentication values below</td>
</tr>
<tr class="evenRow">
<td align="left">> AuthenticationMethod</td>
<td align="left">"PD"</td>
<td align="left">"PD" stands for "Person Details" and should always be set to this</td>
</tr>
<tr class="oddRow">
<td align="left">> AuthenticationCode</td>
<td align="left">string</td>
<td align="left">The method of second line authentication to be used i.e. "Forename", "Surname" or "PostCode"</td>
</tr>
<tr class="evenRow">
<td align="left">> AuthenticationValue</td>
<td align="left">string</td>
<td align="left">The authentication value, e.g. if the method is "Surname" and the profile is under the name of "Jones" then the value will be "Jones", if the method is "PostCode" then the value will be "SY26LG"</td>
</tr>
<tr class="oddRow">
<td align="left">StreetAddress</td>
<td align="left">string</td>
<td align="left">Address street</td>
</tr>
<tr class="evenRow">
<td align="left">AreaAddress</td>
<td align="left">string</td>
<td align="left">Address area</td>
</tr>
<tr class="oddRow">
<td align="left">Town</td>
<td align="left">string</td>
<td align="left">Address town or city</td>
</tr>
<tr class="evenRow">
<td align="left">County</td>
<td align="left">string</td>
<td align="left">Address county or state</td>
</tr>
<tr class="oddRow">
<td align="left">Country</td>
<td align="left">string</td>
<td align="left">Address country</td>
</tr>
<tr class="evenRow">
<td align="left">Postcode</td>
<td align="left">string</td>
<td align="left">Address postcode or zip code</td>
</tr>
<tr class="oddRow">
<td align="left">TelNumber</td>
<td align="left">string</td>
<td align="left">Telephone number</td>
</tr>
<tr class="evenRow">
<td align="left">FaxNumber</td>
<td align="left">string</td>
<td align="left">Fax number</td>
</tr>
<tr class="oddRow">
<td align="left">MobileNo</td>
<td align="left">string</td>
<td align="left">Mobile telephone number</td>
</tr>
<tr class="evenRow">
<td align="left">Email</td>
<td align="left">string</td>
<td align="left">E-mail address</td>
</tr>
<tr class="oddRow">
<td align="left">ExcludeFromMailings</td>
<td align="left">Boolean</td>
<td align="left">Indicates if person chose to be excluded from general marketing mailings</td>
</tr>
<tr class="evenRow">
<td align="left">Password</td>
<td align="left">string</td>
<td align="left">Password to secure access to the profile</td>
</tr>
<tr class="oddRow">
<td align="left">CompanyRef</td>
<td align="left">string</td>
<td align="left">Company reference</td>
</tr>
<tr class="evenRow">
<td align="left">Salutation</td>
<td align="left">string</td>
<td align="left">Title e.g. "Mr" or "Ms"</td>
</tr>
<tr class="oddRow">
<td align="left">Forename</td>
<td align="left">string</td>
<td align="left">Forename</td>
</tr>
<tr class="evenRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Surname</td>
</tr>
<tr class="oddRow">
<td align="left">Greeting</td>
<td align="left">string</td>
<td align="left">Preferred form of address</td>
</tr>
<tr class="evenRow">
<td align="left">Vip</td>
<td align="left">int</td>
<td align="left">Integer VIP level</td>
</tr>
<tr class="oddRow">
<td align="left">BlackListed</td>
<td align="left">int</td>
<td align="left">Blacklisted or not</td>
</tr>
<tr class="evenRow">
<td align="left">TypeOfPerson</td>
<td align="left">int</td>
<td align="left">Code to indicate adult, child or infant status</td>
</tr>
<tr class="oddRow">
<td align="left">Nationality</td>
<td align="left">string</td>
<td align="left">Nationality</td>
</tr>
<tr class="evenRow">
<td align="left">Language</td>
<td align="left">string</td>
<td align="left">Language</td>
</tr>
<tr class="oddRow">
<td align="left">DOB</td>
<td align="left">dateTime</td>
<td align="left">Date of birth</td>
</tr>
<tr class="evenRow">
<td align="left">ProfileType</td>
<td align="left">int</td>
<td align="left">Code to indicate profile type</td>
</tr>
<tr class="oddRow">
<td align="left">Smoker</td>
<td align="left">int</td>
<td align="left">Smoker or not</td>
</tr>
<tr class="evenRow">
<td align="left">LoyaltyID</td>
<td align="left">string</td>
<td align="left">Loyalty ID</td>
</tr>
<tr class="oddRow">
<td align="left">StudentID</td>
<td align="left">string</td>
<td align="left">Student ID, if applicable</td>
</tr>
<tr class="evenRow">
<td align="left">Gender</td>
<td align="left">string</td>
<td align="left">Gender</td>
</tr>
<tr class="oddRow">
<td align="left">PassportNumber</td>
<td align="left">string</td>
<td align="left">Passport number</td>
</tr>
<tr class="evenRow">
<td align="left">PreferredRoomType</td>
<td align="left">string</td>
<td align="left">Preferred room type</td>
</tr>
<tr class="oddRow">
<td align="left">ExcludeFromThirdPartyMailings</td>
<td align="left">Boolean</td>
<td align="left">Indicates if person chose to be excluded from third-party mailings</td>
</tr>
<tr class="evenRow">
<td align="left">PublicNotes</td>
<td align="left">string</td>
<td align="left">Notes (public)</td>
</tr>
<tr class="oddRow">
<td align="left">PrivateNotes</td>
<td align="left">string</td>
<td align="left">Notes (private)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes1</td>
<td align="left">string</td>
<td align="left">Notes (custom 1)</td>
</tr>
<tr class="oddRow">
<td align="left">CustomNotes2</td>
<td align="left">string</td>
<td align="left">Notes (custom 2)</td>
</tr>
<tr class="evenRow">
<td align="left">CustomNotes3</td>
<td align="left">string</td>
<td align="left">Notes (custom 3)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>None</li>
</ul>
pmsprf_UpdateProfileSummaryV3SoapIn
<pmsprf_UpdateProfileSummaryV3 xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<ProfileRequestor>
<ProfileUniqueId>PV00067</ProfileUniqueId>
<ProfileUniqueIdAuthenticatorValue />
<AuthenticationMethod>PD</AuthenticationMethod>
<AuthenticationCode>Surname</AuthenticationCode>
<AuthenticationValue>McCormick</AuthenticationValue>
</ProfileRequestor>
<StreetAddress />
<AreaAddress />
<Town>Shrewsbury1</Town>
<County />
<Country />
<Postcode />
<TelNumber />
<FaxNumber />
<MobileNo />
<Email />
<ExcludeFromMailings>false</ExcludeFromMailings>
<Password />
<CompanyRef />
<Salutation />
<Forename />
<Surname />
<Greeting />
<VIP>0</VIP>
<Blacklisted>0</Blacklisted>
<TypeOfPerson>0</TypeOfPerson>
<Nationality />
<Language />
<DOB>2017-10-17T16:46:45.757975+01:00</DOB>
<Smoker>0</Smoker>
<ProfileType>-1</ProfileType>
<LoyaltyID />
<StudentID />
<Gender />
<PassportNumber />
<PreferredRoomType />
<ExcludeFromThirdPartyMailings>false</ExcludeFromThirdPartyMailings>
<PublicNotes />
<PrivateNotes />
<CustomNotes1 />
<CustomNotes2 />
<CustomNotes3 />
</pmsprf_UpdateProfileSummaryV3>
pmsprf_UpdateProfileSummaryV3SoapOut
<pmsprf_UpdateProfileSummaryV3Response xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsprf_UpdateProfileSummaryV3Result>
<ExceptionCode>0</ExceptionCode>
<ExceptionDescription>No error</ExceptionDescription>
</pmsprf_UpdateProfileSummaryV3Result>
</pmsprf_UpdateProfileSummaryV3Response>
<p>This is a lightweight version of the BookingSearch method and it is used to retrieve information for a certain reservation.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">bookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="evenRow">
<td align="left">roomPickID</td>
<td align="left">int</td>
<td align="left">Integer indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>Search results consisting of a single reservation</li>
</ul>
<h2 class="">Returned data (Reservation)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">RoomId</td>
<td align="left">string</td>
<td align="left">Room ID (room number or name)</td>
</tr>
<tr class="evenRow">
<td align="left">BookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="oddRow">
<td align="left">RoomPickID</td>
<td align="left">int</td>
<td align="left">Integer indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
<tr class="evenRow">
<td align="left">BookingType</td>
<td align="left">string</td>
<td align="left">Booking or reservation type (see below)</td>
</tr>
<tr class="oddRow">
<td align="left">BookingStatus</td>
<td align="left">int</td>
<td align="left">Integer indicating the corresponding BookingStatus Id in Rezlynx</td>
</tr>
<tr class="evenRow">
<td align="left">RoomTypeCode</td>
<td align="left">string</td>
<td align="left">Room type code</td>
</tr>
<tr class="oddRow">
<td align="left">Arrival</td>
<td align="left">dateTime</td>
<td align="left">Guest planned arrival date (reservation start)</td>
</tr>
<tr class="evenRow">
<td align="left">Departure</td>
<td align="left">dateTime</td>
<td align="left">Guest planned departure date (reservation finish)</td>
</tr>
<tr class="oddRow">
<td align="left">Creation</td>
<td align="left">dateTime</td>
<td align="left">Reservation creation date</td>
</tr>
<tr class="evenRow">
<td align="left">GroupAllotmentRef</td>
<td align="left">string</td>
<td align="left">Group Allotment reference</td>
</tr>
<tr class="evenRow">
<td align="left">MultiRoomReference</td>
<td align="left">string</td>
<td align="left">Free text description field used as a heading for multi-room reservations</td>
</tr>
<tr class="oddRow">
<td align="left">Contact</td>
<td>(object)</td>
<td>Contact person details. If there is a profile linked to the booking, we only return ProfileRef code else we return Salutation, Forename, Surname and Name.</a></td>
</tr>
<tr class="evenRow">
<td align="left">Company</td>
<td align="left">string</td>
<td align="left">Reference code for company through which reservation made, if applicable.</td>
</tr>
<tr class="oddRow">
<td align="left">Agent</td>
<td>string</td>
<td align="left">Reference code for agent through which reservation made, if applicable.</td>
</tr>
<tr class="evenRow">
<td align="left">Source</td>
<td align="left">string</td>
<td>Reference code for reservation source, if applicable</td>
</tr>
<tr class="oddRow">
<td align="left">Ledger</td>
<td align="left">string</td>
<td align="left">Reference code for ledger, if applicable.</td>
</tr>
<tr class="evenRow">
<td align="left">PostsAllowed</td>
<td align="left">string</td>
<td align="left">Indicates any posting restrictions for the reservation: either "All" (all postings
allowed), "None" (no postings allowed) or "CallsOnly" (only phone postings allowed)</td>
</tr>
<tr class="oddRow">
<td align="left">BookRefRoomPickID</td>
<td align="left">string</td>
<td align="left">Long-form booking reference, including Room Pick ID, e.g. "BK000034/1"</td>
</tr>
<tr class="evenRow">
<td align="left">AlarmCall</td>
<td align="left">string</td>
<td align="left">Alarm call time, if set</td>
</tr>
<tr class="oddRow">
<td align="left">MovieAccess</td>
<td align="left">string</td>
<td align="left"><a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/movie-access">Movie Access</a>
code, if used</td>
</tr>
<tr class="evenRow">
<td align="left">FunctionBookingDescription</td>
<td align="left">string</td>
<td>Description if function room reservation</td>
</tr>
<tr class="oddRow">
<td align="left">AllowRoomMoves</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if room moves are allowed</td>
</tr>
<tr class="evenRow">
<td align="left">MarketSegment</td>
<td align="left">string</td>
<td align="left">Market segment, for marketing purposes</td>
</tr>
<tr class="oddRow">
<td align="left">TotalCostNett</td>
<td align="left">decimal</td>
<td align="left">Total cost of the booking (nett of tax)</td>
</tr>
<tr class="evenRow">
<td align="left">TotalCostGross</td>
<td align="left">decimal</td>
<td align="left">Total cost of the booking (gross, including tax)</td>
</tr>
<tr class="oddRow">
<td align="left">LastEdited</td>
<td align="left">dateTime</td>
<td align="left">Date-time the reservation was last edited or changed (not including changes made at a room
block, group or multi-room level)</td>
</tr>
<tr class="evenRow">
<td align="left">GDSRef</td>
<td align="left">string</td>
<td align="left">GDS reference, if booking came via an external GDS</td>
</tr>
<tr class="oddRow">
<td align="left">CRSRef1</td>
<td align="left">string</td>
<td align="left">Rezlynx CRS reference</td>
</tr>
<tr class="evenRow">
<td align="left">CRSRef2</td>
<td align="left">string</td>
<td align="left">External CRS reference, if reservation came via an external CRS</td>
</tr>
<tr class="oddRow">
<td align="left">SystemSource</td>
<td align="left">string</td>
<td align="left">System origin of this reservation (see below)</td>
</tr>
<tr class="evenRow">
<td align="left">DistributionChannelId</td>
<td align="left">int</td>
<td align="left">Distribution Channel ID, if the reservation came via a distribution channel</td>
</tr>
<tr class="oddRow">
<td align="left">PreCheckIn</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if pre-checked-in or not (if applicable)</td>
</tr>
<tr class="evenRow">
<td align="left">RezlynxCRS</td>
<td align="left">string</td>
<td align="left">Rezlynx CRS reference</td>
</tr>
</tbody>
</table>
<p><strong>Booking type</strong> must be one of the following:</p>
<ul>
<li>"Bedroom" = normal bedroom reservation</li>
<li>"Function" = function room reservation</li>
<li>"Nra" = non-resident account, i.e. not linked to a room</li>
<li>"Master" = master booking <code>!new in 1.500!</code></li>
</ul>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note</strong> Master bookings are dummy room reservations, similar to an NRA but
linked to a group or multi-room reservation. Both master bookings and NRAs can be useful for managing
accounts.</td>
</tr>
</tbody>
</table>
<p><strong>SystemSource</strong> must be one of the following:</p>
<ul>
<li>"Unknown"</li>
<li>"Rezlynx"</li>
<li>"PublicPortal"</li>
<li>"AgentPortal"</li>
<li>"CorporatePortal"</li>
<li>"Roomlynx"</li>
<li>"CRS"</li>
<li>"BWCRS"</li>
<li>"WebService"</li>
<li>"CentralInvoicing"</li>
<li>"SalesAndCatering"</li>
</ul>
pmsbkg_GetReservationSoapIn
<pmsbkg_GetReservation xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK0000006273</bookRef>
<roomPickId>1</roomPickId>
</pmsbkg_GetReservation>
pmsbkg_GetReservationSoapOut
<pmsbkg_GetReservationResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_GetReservationResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
<Reservation>
<BookRef>BK06165</BookRef>
<RoomPickId>1</RoomPickId>
<BookingType>BedRoom</BookingType>
<BookingStatus>1</BookingStatus>
<RoomTypeCode>DOUBLE</RoomTypeCode>
<Arrival>2019-05-03T00:00:00</Arrival>
<Departure>2019-05-04T00:00:00</Departure>
<Creation>2019-05-03T08:14:23</Creation>
<Contact>
<ProfileRef>PF00899</ProfileRef>
</Contact>
<PostsAllowed>All</PostsAllowed>
<BookRefRoomPickID>BK06165/1</BookRefRoomPickID>
<MovieAccess>Children</MovieAccess>
<AllowRoomMoves>true</AllowRoomMoves>
<MarketSegment>MARKETSEGMEN</MarketSegment>
<TotalCostNett>83.3300</TotalCostNett>
<TotalCostGross>100.0000</TotalCostGross>
<LastEdited>2019-05-03T08:14:23</LastEdited>
<SystemSource>Rezlynx</SystemSource>
<DistributionChannelId>1</DistributionChannelId>
<PreCheckIn>false</PreCheckIn>
</Reservation>
</pmsbkg_GetReservationResult>
</pmsbkg_GetReservationResponse>
<p>This methods can be used to get transactions for single reservation with pre-arrival status.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">bookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="evenRow">
<td align="left">roomPickID</td>
<td align="left">int</td>
<td align="left">Integer indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>Search results consisting of a set of reservation transactions</li>
</ul>
<h2 class="">Returned data (Transactions)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">EntryTypeName</td>
<td align="left">string</td>
<td align="left">Name of the transaction category</td>
</tr>
<tr class="evenRow">
<td align="left">FolioId</td>
<td align="left">int</td>
<td align="left">Integer indicating which guest of a multi-folio reservation this is (1,2,3,...)</td>
</tr>
<tr class="oddRow">
<td align="left">ForDate</td>
<td align="left">dateTime</td>
<td align="left">Item date-time stamp</td>
</tr>
<tr class="evenRow">
<td align="left">AnalysisCode</td>
<td align="left">string</td>
<td align="left">Name of the analysis code, e.g. "BARFOOD"</td>
</tr>
<tr class="oddRow">
<td align="left">RatePlanCode</td>
<td align="left">string</td>
<td align="left">Rate plan code</td>
</tr>
<tr class="evenRow">
<td align="left">NettTotal</td>
<td align="left">decimal</td>
<td align="left">Total cost of the item (nett of tax)</td>
</tr>
<tr class="oddRow">
<td align="left">GrossTotal</td>
<td align="left">decimal</td>
<td align="left">Total cost of the item (gross, including tax)</td>
</tr>
</tbody>
</table>
<p><strong>EntryTypeName</strong> must be one of the following:</p>
<ul>
<li>RateAdultAccomodation</li>
<li>RateChildSharingAccomodation</li>
<li>RateChildOwnAccomodation</li>
<li>Upsell</li>
<li>ProductRuleUpsell</li>
<li>RateInclusiveUpsell</li>
<li>RateSupplement</li>
<li>CityTaxSurcharge</li>
</ul>
pmsbkg_GetReservationTransactionsSoapIn
<pmsbkg_GetReservation xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK0000006273</bookRef>
<roomPickId>1</roomPickId>
</pmsbkg_GetReservation>
pmsbkg_GetReservationTransactionsSoapOut
<pmsbkg_GetReservationTransactionsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_GetReservationTransactionsResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
<Transactions>
<ReservationTransaction>
<EntryTypeName>RateInclusiveUpsell</EntryTypeName>
<FolioId>1</FolioId>
<ForDate>2019-09-16T00:00:00</ForDate>
<AnalysisCode>ROTAX2</AnalysisCode>
<RatePlanCode>BAR_BB</RatePlanCode>
<NettTotal>0.8400</NettTotal>
<GrossTotal>2.0000</GrossTotal>
</ReservationTransaction>
<ReservationTransaction>
<EntryTypeName>RateInclusiveUpsell</EntryTypeName>
<FolioId>1</FolioId>
<ForDate>2019-09-16T00:00:00</ForDate>
<AnalysisCode>DINNER</AnalysisCode>
<RatePlanCode>BAR_BB</RatePlanCode>
<NettTotal>5.0000</NettTotal>
<GrossTotal>5.0000</GrossTotal>
</ReservationTransaction>
<ReservationTransaction>
<EntryTypeName>RateAdultAccomodation</EntryTypeName>
<FolioId>1</FolioId>
<ForDate>2019-09-16T00:00:00</ForDate>
<AnalysisCode>20TAX</AnalysisCode>
<RatePlanCode>BAR_BB</RatePlanCode>
<NettTotal>8333.3300</NettTotal>
<GrossTotal>10000.0000</GrossTotal>
</ReservationTransaction>
<ReservationTransaction>
<EntryTypeName>RateAdultAccomodation</EntryTypeName>
<FolioId>1</FolioId>
<ForDate>2019-09-17T00:00:00</ForDate>
<AnalysisCode>0TAX</AnalysisCode>
<RatePlanCode>BAR_BB</RatePlanCode>
<NettTotal>10000.0000</NettTotal>
<GrossTotal>10000.0000</GrossTotal>
</ReservationTransaction>
<ReservationTransaction>
<EntryTypeName>RateInclusiveUpsell</EntryTypeName>
<FolioId>1</FolioId>
<ForDate>2019-09-17T00:00:00</ForDate>
<AnalysisCode>ROTAX2</AnalysisCode>
<RatePlanCode>BAR_BB</RatePlanCode>
<NettTotal>0.8400</NettTotal>
<GrossTotal>2.0000</GrossTotal>
</ReservationTransaction>
<ReservationTransaction>
<EntryTypeName>RateInclusiveUpsell</EntryTypeName>
<FolioId>1</FolioId>
<ForDate>2019-09-17T00:00:00</ForDate>
<AnalysisCode>DINNER</AnalysisCode>
<RatePlanCode>BAR_BB</RatePlanCode>
<NettTotal>5.0000</NettTotal>
<GrossTotal>5.0000</GrossTotal>
</ReservationTransaction>
<ReservationTransaction>
<EntryTypeName>RateInclusiveUpsell</EntryTypeName>
<FolioId>1</FolioId>
<ForDate>2019-09-18T00:00:00</ForDate>
<AnalysisCode>ROTAX2</AnalysisCode>
<RatePlanCode>BAR_BB</RatePlanCode>
<NettTotal>0.8400</NettTotal>
<GrossTotal>2.0000</GrossTotal>
</ReservationTransaction>
<ReservationTransaction>
<EntryTypeName>RateInclusiveUpsell</EntryTypeName>
<FolioId>1</FolioId>
<ForDate>2019-09-18T00:00:00</ForDate>
<AnalysisCode>DINNER</AnalysisCode>
<RatePlanCode>BAR_BB</RatePlanCode>
<NettTotal>5.0000</NettTotal>
<GrossTotal>5.0000</GrossTotal>
</ReservationTransaction>
<ReservationTransaction>
<EntryTypeName>RateAdultAccomodation</EntryTypeName>
<FolioId>1</FolioId>
<ForDate>2019-09-18T00:00:00</ForDate>
<AnalysisCode>0TAX</AnalysisCode>
<RatePlanCode>BAR_BB</RatePlanCode>
<NettTotal>10000.0000</NettTotal>
<GrossTotal>10000.0000</GrossTotal>
</ReservationTransaction>
</Transactions>
</pmsbkg_GetReservationTransactionsResult>
</pmsbkg_GetReservationTransactionsResponse>
<p>This method retrieves the product rules added to a booking, that are NOT part of the rate plan used.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">bookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="evenRow">
<td align="left">roomPickID</td>
<td align="left">int</td>
<td align="left">Integer indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data collection of (ReservationProductRule)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">ReservationProductRules</td>
<td align="left">object</td>
<td align="left">Object representing results collection</td>
</tr>
<tr class="evenRow">
<td align="left">ReservationProductRule</td>
<td align="left">object</td>
<td align="left">Object representing one reservation's product rule</td>
</tr>
<tr class="oddRow">
<td align="left"> > Id</td>
<td align="left">int</td>
<td align="left">Id of this specific reservation's product rule</td>
</tr>
<tr class="evenRow">
<td align="left"> > ProductRuleCode</td>
<td align="left">string</td>
<td align="left">Product rule code</td>
</tr>
<tr class="oddRow">
<td align="left"> > Quantity</td>
<td align="left">int</td>
<td align="left">Quantity</td>
</tr>
<tr class="evenRow">
<td align="left"> > Value</td>
<td align="left">decimal</td>
<td align="left">Net value</td>
</tr>
</tbody>
</table>
pmsbkg_GetReservationProductRulesSoapIn
<pmsbkg_GetReservationProductRules xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK0000006298</bookRef>
<roomPickId>1</roomPickId>
</pmsbkg_GetReservationProductRules>
pmsbkg_GetReservationProductRulesSoapOut
<pmsbkg_GetReservationProductRulesResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_GetReservationProductRulesResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
<ReservationProductRules>
<ReservationProductRule>
<Id>1280</Id>
<ProductRuleCode>BFAST</ProductRuleCode>
<Quantity>1</Quantity>
<Value>12.0000</Value>
</ReservationProductRule>
<ReservationProductRule>
<Id>1281</Id>
<ProductRuleCode>EASTER</ProductRuleCode>
<Quantity>2</Quantity>
<Value>15.0000</Value>
</ReservationProductRule>
</ReservationProductRules>
</pmsbkg_GetReservationProductRulesResult>
</pmsbkg_GetReservationProductRulesResponse>
<p>This method retrieves the products added to a booking, that are NOT part of the rate plan used.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">bookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="evenRow">
<td align="left">roomPickID</td>
<td align="left">int</td>
<td align="left">Integer indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data collection of (ReservationProduct)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">Id</td>
<td align="left">int</td>
<td align="left">Id of this specific reservation's product</td>
</tr>
<tr class="evenRow">
<td align="left">ProductCode</td>
<td align="left">string</td>
<td align="left">Product code</td>
</tr>
<tr class="oddRow">
<td align="left">Quantity</td>
<td align="left">int</td>
<td align="left">Quantity, for Custom PostingMode it will be set to 0</td>
</tr>
<tr class="evenRow">
<td align="left">Value</td>
<td align="left">decimal</td>
<td align="left">Net value, for Custom PostingMode it will be set to 0</td>
</tr>
<tr class="oddRow">
<td align="left">ChargeMode</td>
<td align="left">string</td>
<td align="left">Product charge mode (basis on which product is charged, e.g. per adult or per room)</td>
</tr>
<tr class="evenRow">
<td align="left">PostingMode</td>
<td align="left">object</td>
<td align="left">Object that aggregates the PostingMode selected in Rezlynx for that specific Product</td>
</tr>
<tr class="oddRow">
<td align="left"> > Simple</td>
<td align="left">object</td>
<td align="left">If the Product for the Reservation is created using Simple mode, it will be represented by this object</td>
</tr>
<tr class="evenRow">
<td align="left"> >> DayOfArrival</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the day of arrival</td>
</tr>
<tr class="oddRow">
<td align="left"> >> ResidentDays</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the resident days</td>
</tr>
<tr class="evenRow">
<td align="left"> >> DayOfCheckout</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the day of checkout</td>
</tr>
<tr class="oddRow">
<td align="left"> >> Custom</td>
<td align="left">object</td>
<td align="left">If the Product for the Reservation is created using Custom mode, it will be represented by this object</td>
</tr>
<tr class="evenRow">
<td align="left"> >> PostingItems</td>
<td align="left">object</td>
<td align="left">Collection of posting details</td>
</tr>
<tr class="oddRow">
<td align="left"> >>> PostingItem</td>
<td align="left">object</td>
<td align="left">Each combination of date, quantity and value will be represented by this object</td>
</tr>
<tr class="evenRow">
<td align="left"> >>>> ForDate</td>
<td align="left">dateTime</td>
<td align="left">Date used for this specific quantity and value combination</td>
</tr>
<tr class="oddRow">
<td align="left"> >>>> Quantity</td>
<td align="left">int</td>
<td align="left">Quantity</td>
</tr>
<tr class="evenRow">
<td align="left"> >>>> Value</td>
<td align="left">decimal</td>
<td align="left">Net value</td>
</tr>
<tr class="oddRow">
<td align="left"> > Rhythm</td>
<td align="left">object</td>
<td align="left">If the Product for the Reservation is created using Rhythm mode, it will be represented by this object</td>
</tr>
<tr class="evenRow">
<td align="left"> >> Night1</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the first night</td>
</tr>
<tr class="oddRow">
<td align="left"> >> Night2</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the second night</td>
</tr>
<tr class="evenRow">
<td align="left"> >> Night3</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the third night</td>
</tr>
<tr class="oddRow">
<td align="left"> >> Night4</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the fourth night</td>
</tr>
<tr class="evenRow">
<td align="left"> >> Night5</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the fifth night</td>
</tr>
<tr class="oddRow">
<td align="left"> >> Night6</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the sixth night</td>
</tr>
<tr class="evenRow">
<td align="left"> >> Night7</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the seventh night</td>
</tr>
<tr class="oddRow">
<td align="left"> >> Night8</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the eighth night</td>
</tr>
<tr class="evenRow">
<td align="left"> >> Night9</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the ninth night</td>
</tr>
<tr class="oddRow">
<td align="left"> >> Night10</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the tenth night</td>
</tr>
<tr class="evenRow">
<td align="left"> >> Night11</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the eleventh night</td>
</tr>
<tr class="oddRow">
<td align="left"> >> Night12</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the twelfth night</td>
</tr>
<tr class="evenRow">
<td align="left"> >> Night13</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the thirteenth night</td>
</tr>
<tr class="oddRow">
<td align="left"> >> Night14</td>
<td align="left">boolean</td>
<td align="left">Flag to indicate if Product is sold for the fourteenth night</td>
</tr>
</tbody>
</table>
<p><strong>ChargeMode</strong> must be one of the following:</p>
<ul>
<li>"PerRoom"</li>
<li>"PerPerson"</li>
<li>"PerAdult"</li>
<li>"PerChild"</li>
<li>"PerInfant"</li>
<li>"SingleCharge"</li>
<li>"DailyPerRoom"</li>
<li>"DailyPerDelegate"</li>
<li>"HourlyPerRoom"</li>
<li>"HourlyPerDelegate"</li>
<li>"FunctionSingleCharge"</li>
</ul>
pmsbkg_GetReservationProductsSoapIn
<pmsbkg_GetReservationProducts xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK0000006313</bookRef>
<roomPickId>1</roomPickId>
</pmsbkg_GetReservationProducts>
pmsbkg_GetReservationProductsSoapOut
<pmsbkg_GetReservationProductsResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_GetReservationProductsResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
<ReservationProducts>
<ReservationProduct>
<Id>5071</Id>
<ProductCode>CHIO</ProductCode>
<Quantity>2</Quantity>
<Value>3.2000</Value>
<ChargeMode>PerRoom</ChargeMode>
<PostingMode>
<Simple>
<DayOfArrival>true</DayOfArrival>
<ResidentDays>true</ResidentDays>
<DayOfCheckout>false</DayOfCheckout>
</Simple>
</PostingMode>
</ReservationProduct>
<ReservationProduct>
<Id>5072</Id>
<ProductCode>COKE</ProductCode>
<Quantity>1</Quantity>
<Value>2.0000</Value>
<ChargeMode>PerRoom</ChargeMode>
<PostingMode>
<Rhythm>
<Night1>true</Night1>
<Night2>false</Night2>
<Night3>false</Night3>
<Night4>false</Night4>
<Night5>false</Night5>
<Night6>false</Night6>
<Night7>false</Night7>
<Night8>false</Night8>
<Night9>false</Night9>
<Night10>false</Night10>
<Night11>false</Night11>
<Night12>false</Night12>
<Night13>false</Night13>
<Night14>false</Night14>
</Rhythm>
</PostingMode>
</ReservationProduct>
<ReservationProduct>
<Id>5073</Id>
<ProductCode>LAPTE</ProductCode>
<Quantity>0</Quantity>
<Value>0</Value>
<ChargeMode>PerRoom</ChargeMode>
<PostingMode>
<Custom>
<PostingItems>
<PostingItem>
<ForDate>2019-09-24T00:00:00</ForDate>
<Quantity>1</Quantity>
<Value>15.0000</Value>
</PostingItem>
<PostingItem>
<ForDate>2019-09-25T00:00:00</ForDate>
<Quantity>1</Quantity>
<Value>15.0000</Value>
</PostingItem>
</PostingItems>
</Custom>
</PostingMode>
</ReservationProduct>
</ReservationProducts>
</pmsbkg_GetReservationProductsResult>
</pmsbkg_GetReservationProductsResponse>
This method provides the ability to remove a product from a reservation, if the reservation has a PreArrival status.
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">bookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="evenRow">
<td align="left">roomPickID</td>
<td align="left">int</td>
<td align="left">Number indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
<tr class="oddRow">
<td align="left">reservationProductId</td>
<td align="left">int</td>
<td align="left">Number indicating which product id you want to remove from the reservation</td>
</tr>
<tr class="evenRow">
<td align="left">forDate</td>
<td align="left">dateTime</td>
<td align="left">Optional: Will remove custom product on given date</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>None</li>
</ul>
pmsbkg_RemoveReservationProductSoapIn
<pmsbkg_RemoveReservationProduct xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK0000006313</bookRef>
<roomPickId>1</roomPickId>
<reservationProductId>602</reservationProductId>
<forDate>2019-01-31T00:00:14.6042212+01:00</forDate>
</pmsbkg_RemoveReservationProduct>
pmsbkg_RemoveReservationProductSoapOut
<pmsbkg_RemoveReservationProductResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_RemoveReservationProductResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
</pmsbkg_RemoveReservationProductResult>
</pmsbkg_RemoveReservationProductResponse>
This method provides the ability to remove a product rule from a reservation, if the reservation has a PreArrival status.
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">bookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="evenRow">
<td align="left">roomPickID</td>
<td align="left">int</td>
<td align="left">Number indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
<tr class="oddRow">
<td align="left">reservationProductRuleId</td>
<td align="left">int</td>
<td align="left">Number indicating which product rule id you want to remove from the reservation</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>None</li>
</ul>
pmsbkg_RemoveReservationProductRuleSoapIn
<pmsbkg_RemoveReservationProductRule xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK0000006313</bookRef>
<roomPickId>1</roomPickId>
<reservationProductRuleId>602</reservationProductRuleId>
</pmsbkg_RemoveReservationProduct>
pmsbkg_RemoveReservationProductRuleSoapOut
<pmsbkg_RemoveReservationProductRuleResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_RemoveReservationProductRuleResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
</pmsbkg_RemoveReservationProductRuleResult>
</pmsbkg_RemoveReservationProductRuleResponse>
<p>This method can be used to get the booking lines of a reservation.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">bookRef</td>
<td align="left">string</td>
<td align="left">Booking or reservation reference</td>
</tr>
<tr class="evenRow">
<td align="left">roomPickID</td>
<td align="left">int</td>
<td align="left">Integer indicating which of a multi-room reservation this is (1,2,3,...)</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>Search results consisting of a set of reservation booking lines</li>
</ul>
<h2 class="">Returned data (Booking Lines)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">Id</td>
<td align="left">int</td>
<td align="left">Unique identifier of the booking line</td>
</tr>
<tr class="evenRow">
<td align="left">Date</td>
<td align="left">dateTime</td>
<td align="left">Date of the booking line</td>
</tr>
<tr class="oddRow">
<td align="left">Adults</td>
<td align="left">int</td>
<td align="left">Number of adults on the booking day</td>
</tr>
<tr class="evenRow">
<td align="left">Children</td>
<td align="left">int</td>
<td align="left">Number of children on the booking day</td>
</tr>
<tr class="oddRow">
<td align="left">Infants</td>
<td align="left">int</td>
<td align="left">Number of infants on the booking day</td>
</tr>
<tr class="evenRow">
<td align="left">RatePlan</td>
<td align="left">string</td>
<td align="left">Rate plan code used on the given booking day</td>
</tr>
<tr class="oddRow">
<td align="left">MarketSegment</td>
<td align="left">string</td>
<td align="left">Market segment code used on the given booking day</td>
</tr>
<tr class="evenRow">
<td align="left">RoomType</td>
<td align="left">string</td>
<td align="left">Room type code used on the given booking day</td>
</tr>
<tr class="oddRow">
<td align="left">RoomId</td>
<td align="left">string</td>
<td align="left">Room number used on the given booking day</td>
</tr>
<tr class="evenRow">
<td align="left">Nett</td>
<td align="left">decimal</td>
<td align="left">Total cost of the item (nett of tax)</td>
</tr>
<tr class="oddRow">
<td align="left">Gross</td>
<td align="left">decimal</td>
<td align="left">Total cost of the item (gross, including tax)</td>
</tr>
<tr class="evenRow">
<td align="left">DayLet</td>
<td align="left">bool</td>
<td align="left">Flag that indicates the booking checked in and out on the same day</td>
</tr>
</tbody>
</table>
pmsbkg_GetReservationBookingLinesSoapIn
<pmsbkg_GetReservationBookingLines xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<bookRef>BK0000006273</bookRef>
<roomPickId>1</roomPickId>
</pmsbkg_GetReservationBookingLines>
pmsbkg_GetReservationBookingLinesSoapOut
<pmsbkg_GetReservationBookingLinesResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmsbkg_GetReservationBookingLinesResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
<BookingLine>
<Id>15771</Id>
<Date>2019-10-08T00:00:00</Date>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
<RatePlan>UNTOLD</RatePlan>
<MarketSegment>CORPORATE</MarketSegment>
<RoomType>DOUBLE</RoomType>
<RoomId>100</RoomId>
<Nett>83.3300</Nett>
<Gross>100.0000</Gross>
<DayLet>false</DayLet>
</BookingLine>
<BookingLine>
<Id>15772</Id>
<Date>2019-10-09T00:00:00</Date>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
<RatePlan>UNTOLD</RatePlan>
<MarketSegment>CORPORATE</MarketSegment>
<RoomType>DOUBLE</RoomType>
<RoomId>100</RoomId>
<Nett>95.0000</Nett>
<Gross>100.0000</Gross>
<DayLet>false</DayLet>
</BookingLine>
<BookingLine>
<Id>15773</Id>
<Date>2019-10-10T00:00:00</Date>
<Adults>2</Adults>
<Children>0</Children>
<Infants>0</Infants>
<RatePlan>ELECTRIC</RatePlan>
<MarketSegment>TOUR</MarketSegment>
<RoomType>TWIN</RoomType>
<RoomId>200</RoomId>
<Nett>246.2800</Nett>
<Gross>255.0000</Gross>
<DayLet>false</DayLet>
</BookingLine>
</BookingLines>
</pmsbkg_GetReservationBookingLinesResult>
</pmsbkg_GetReservationBookingLinesResponse>
<p>Create an enquiry in the PMS for a conference/event.</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters (EventEnquiryWeb)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">StartDate</td>
<td align="left">date</td>
<td align="left">Start Date</td>
</tr>
<tr class="evenRow">
<td align="left">EndDate</td>
<td align="left">date</td>
<td align="left">End Date</td>
</tr>
<tr class="oddRow">
<td align="left">Title</td>
<td align="left">string</td>
<td align="left">Delegate title</td>
</tr>
<tr class="evenRow">
<td align="left">Forname</td>
<td align="left">string</td>
<td align="left">Delegate forname</td>
</tr>
<tr class="oddRow">
<td align="left">Surname</td>
<td align="left">string</td>
<td align="left">Delegate surname</td>
</tr>
<tr class="evenRow">
<td align="left">Telephone</td>
<td align="left">string</td>
<td align="left">Delegate phone number</td>
</tr>
<tr class="oddRow">
<td align="left">Mobile</td>
<td align="left">string</td>
<td align="left">Delegate mobile phone number</td>
</tr>
<tr class="evenRow">
<td align="left">Email</td>
<td align="left">string</td>
<td align="left">Delegate email</td>
</tr>
<tr class="oddRow">
<td align="left">Delegates</td>
<td align="left">int</td>
<td align="left">Number of delegates</td>
</tr>
<tr class="evenRow">
<td align="left">EventName</td>
<td align="left">string</td>
<td align="left">Event name/td>
</tr>
<tr class="oddRow">
<td align="left">EnquiryNotes</td>
<td align="left">string</td>
<td align="left">Enquiry Notes</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">Reference</td>
<td align="left">string</td>
<td align="left">The reference of newly created enquiry. Indicates if the process was successful or not</td>
</tr>
</tbody>
</table>
cnbenq_CreateWebEnquirySoapIn
<cnbenq_CreateWebEnquiry xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<EventEnquiryWeb>
<StartDate>2018-07-11T00:00:00</StartDate>
<EndDate>2018-07-13T00:00:00</EndDate>
<Title>Ms</Title>
<Forename>Joe</Forename>
<Surename>Hart</Surename>
<Telephone />
<Mobile />
<Email />
<Delegates>30</Delegates>
<EventName>Wedding</EventName>
<EnquiryNotes />
</EventEnquiryWeb>
</cnbenq_CreateWebEnquiry>
cnbenq_CreateWebEnquirySoapOut
<cnbenq_CreateWebEnquiryResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<EventEnquiryWebResponse>Reference</EventEnquiryWebResponse>
</cnbenq_CreateWebEnquiryResponse>
<p>This method can be used to get the attribute configuration for companies, enquiries, profiles, reservation and rooms</p>
<table>
<tbody>
<tr class="evenRow">
<td align="left"><strong>Note!</strong> This API method uses SOAP header authentication, it does <u>not</u> use a Session ID obtained from LogIn method like most PMS methods. See <a class="tc-tiddlylink tc-tiddlylink-resolves" href="/doc/Common-to-all-API-methods">Common to all API methods</a>.</td>
</tr>
</tbody>
</table>
<h2>Parameters</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">systemArea</td>
<td align="left">string</td>
<td align="left">Optional. We can filter the data on the server, passing a comma separated list of system areas (ex. profiles,company). When left blank it will return all the data</td>
</tr>
</tbody>
</table>
<h2 class="">Returned data</h2>
<ul>
<li>Search results consisting of a set of attribute configuration objects</li>
</ul>
<h2 class="">Returned data collection of (AttributeConfiguration)</h2>
<table>
<tbody>
<tr class="evenRow">
<th align="left">Name</th>
<th align="left">Type</th>
<th align="left">Description</th>
</tr>
<tr class="oddRow">
<td align="left">SystemArea</td>
<td align="left">string</td>
<td align="left">Origin of the system area (Company, Profile, Enquiry, Reservation or Room)</td>
</tr>
<tr class="evenRow">
<td align="left">Code</td>
<td align="left">string</td>
<td align="left">Attribute code</td>
</tr>
<tr class="oddRow">
<td align="left">Description</td>
<td align="left">string</td>
<td align="left">Attribute description</td>
</tr>
<tr class="evenRow">
<td align="left">FieldType</td>
<td align="left">string</td>
<td align="left">Type of the field (SmallText, LargeText, Number, Date, YesNo or List)</td>
</tr>
<tr class="oddRow">
<td align="left">DefaultValue</td>
<td align="left">string</td>
<td align="left">Default value for this attribute</td>
</tr>
<tr class="evenRow">
<td align="left">ListOptions</td>
<td align="left">object</td>
<td align="left">Only for type List. Represents a set of ListOption objects</td>
</tr>
<tr class="oddRow">
<td align="left"> > ListOption</td>
<td align="left">object</td>
<td align="left">Only for type List. Represents a specific ListOption object</td>
</tr>
<tr class="evenRow">
<td align="left"> >> Value</td>
<td align="left">string</td>
<td align="left">Only for type List. Represents a text set for this ListOption object</td>
</tr>
</tbody>
</table>
pmscfg_GetAttributeConfigurationSoapIn
<pmscfg_GetAttributeConfiguration xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<systemArea>profile,company</systemArea>
</pmscfg_GetAttributeConfiguration>
pmscfg_GetAttributeConfigurationSoapOut
<pmscfg_GetAttributeConfigurationResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19">
<pmscfg_GetAttributeConfigurationResult>
<ResponseCode>0</ResponseCode>
<ResponseDescription>No error</ResponseDescription>
<AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Company</SystemArea>
<Code>DATE</Code>
<Description>Date</Description>
<FieldType>Date</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Company</SystemArea>
<Code>LARGE</Code>
<Description>Large</Description>
<FieldType>LargeText</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Company</SystemArea>
<Code>LIST</Code>
<Description>List</Description>
<FieldType>List</FieldType>
<DefaultValue />
<ListOptions>
<ListOption>
<Value />
</ListOption>
<ListOption>
<Value>1</Value>
</ListOption>
<ListOption>
<Value>2</Value>
</ListOption>
<ListOption>
<Value>3</Value>
</ListOption>
</ListOptions>
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Company</SystemArea>
<Code>NUMBER</Code>
<Description>Number</Description>
<FieldType>Number</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Company</SystemArea>
<Code>SMALL</Code>
<Description>Small</Description>
<FieldType>SmallText</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Company</SystemArea>
<Code>YES_NO</Code>
<Description>Yes / No</Description>
<FieldType>YesNo</FieldType>
<DefaultValue>Yes</DefaultValue>
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Profile</SystemArea>
<Code>SMALL</Code>
<Description>Small</Description>
<FieldType>SmallText</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Profile</SystemArea>
<Code>LARGE</Code>
<Description>Large</Description>
<FieldType>LargeText</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Profile</SystemArea>
<Code>DATE</Code>
<Description>Date</Description>
<FieldType>Date</FieldType>
<DefaultValue>01/01/0001</DefaultValue>
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Profile</SystemArea>
<Code>NUMBER</Code>
<Description>Number</Description>
<FieldType>Number</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Profile</SystemArea>
<Code>YES_NO</Code>
<Description>Yes / No</Description>
<FieldType>YesNo</FieldType>
<DefaultValue>Yes</DefaultValue>
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Profile</SystemArea>
<Code>LIST</Code>
<Description>List</Description>
<FieldType>List</FieldType>
<DefaultValue />
<ListOptions>
<ListOption>
<Value />
</ListOption>
<ListOption>
<Value>1</Value>
</ListOption>
<ListOption>
<Value>2</Value>
</ListOption>
<ListOption>
<Value>3</Value>
</ListOption>
</ListOptions>
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Reservation</SystemArea>
<Code>DATE</Code>
<Description>Date</Description>
<FieldType>Date</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Reservation</SystemArea>
<Code>LARGE</Code>
<Description>Large</Description>
<FieldType>LargeText</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Reservation</SystemArea>
<Code>LIST</Code>
<Description>List</Description>
<FieldType>List</FieldType>
<DefaultValue />
<ListOptions>
<ListOption>
<Value />
</ListOption>
<ListOption>
<Value>1</Value>
</ListOption>
<ListOption>
<Value>2</Value>
</ListOption>
<ListOption>
<Value>3</Value>
</ListOption>
</ListOptions>
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Reservation</SystemArea>
<Code>NUMBER</Code>
<Description>Number</Description>
<FieldType>Number</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Reservation</SystemArea>
<Code>SMALL</Code>
<Description>Small</Description>
<FieldType>SmallText</FieldType>
<DefaultValue />
</AttributeConfiguration>
<AttributeConfiguration>
<SystemArea>Reservation</SystemArea>
<Code>YES_NO</Code>
<Description>Yes / No</Description>
<FieldType>YesNo</FieldType>
<DefaultValue>Yes</DefaultValue>
</AttributeConfiguration>
</AttributeConfiguration>
</pmscfg_GetAttributeConfigurationResult>
</pmscfg_GetAttributeConfigurationResponse>