RezLynx Web Service Router
Click here for a complete list of operations.
pmsdoc_GetDocumentDetail
pmsdoc_GetDocumentDetail
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /rlxsoap.asmx HTTP/1.1 Host: rlxsoap.eu.guestline.app Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://tempuri.org/RLXSOAP19/RLXSOAP19/pmsdoc_GetDocumentDetail" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <pmsdoc_GetDocumentDetail xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19"> <SessionID>string</SessionID> <DocumentRef>string</DocumentRef> <DocumentDetail> <DocumentSummary> <BookRefRoomRef>string</BookRefRoomRef> <FolioId>int</FolioId> <FolioSplitId>int</FolioSplitId> <DocumentRef>string</DocumentRef> <DocumentType>FolioBill_CombinedFolios or FolioBill_IndividualFolio or DepositInvoice or LedgerInvoice or LedgerCreditNote or LedgerCreditPayment or PostCashNote or CurrencyExchangeReceipt</DocumentType> <DocumentTimestamp>dateTime</DocumentTimestamp> <Forename>string</Forename> <Surname>string</Surname> <LedgerRef>string</LedgerRef> <LedgerName>string</LedgerName> <GrossTotal>decimal</GrossTotal> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <ArrivalDate>dateTime</ArrivalDate> <DepartureDate>dateTime</DepartureDate> <AddressSource>Profile or Company or FreeType</AddressSource> <AddressRef>string</AddressRef> </DocumentSummary> <HeaderDetails> <Title>string</Title> <Forename>string</Forename> <Surname>string</Surname> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <County>string</County> <Country>string</Country> <Postcode>string</Postcode> </HeaderDetails> <TransactionLines> <FinancialDocumentDetailTransaction> <ItemType>int</ItemType> <EntryType>int</EntryType> <Status>int</Status> <AnalCode>string</AnalCode> <BookRef>string</BookRef> <Comments>string</Comments> <ConversionId>int</ConversionId> <ConvertedGrossTotal>decimal</ConvertedGrossTotal> <Description>string</Description> <EndDate>dateTime</EndDate> <FinTransactionParam1>int</FinTransactionParam1> <FinTransactionParam2>string</FinTransactionParam2> <ForDate>dateTime</ForDate> <GrossPerUnit>decimal</GrossPerUnit> <GrossTotal>decimal</GrossTotal> <IndexOfDate>int</IndexOfDate> <IsFolioCharge>boolean</IsFolioCharge> <NettPerUnit>decimal</NettPerUnit> <NettTotal>decimal</NettTotal> <NoOfNights>int</NoOfNights> <OrderIndex>int</OrderIndex> <PackageCode>string</PackageCode> <PaymentCode>string</PaymentCode> <Quantity>decimal</Quantity> <RoomPickId>int</RoomPickId> <SourceTransId>int</SourceTransId> <StartDate>dateTime</StartDate> <TaxReference>string</TaxReference> <TaxTotal>decimal</TaxTotal> <Timestamp>dateTime</Timestamp> <TransactionWasCategAs>int</TransactionWasCategAs> <TransactionWasGroupedBy>int</TransactionWasGroupedBy> <TransId>int</TransId> <TaxSequence>string</TaxSequence> <NettSequence>decimal</NettSequence> </FinancialDocumentDetailTransaction> <FinancialDocumentDetailTransaction> <ItemType>int</ItemType> <EntryType>int</EntryType> <Status>int</Status> <AnalCode>string</AnalCode> <BookRef>string</BookRef> <Comments>string</Comments> <ConversionId>int</ConversionId> <ConvertedGrossTotal>decimal</ConvertedGrossTotal> <Description>string</Description> <EndDate>dateTime</EndDate> <FinTransactionParam1>int</FinTransactionParam1> <FinTransactionParam2>string</FinTransactionParam2> <ForDate>dateTime</ForDate> <GrossPerUnit>decimal</GrossPerUnit> <GrossTotal>decimal</GrossTotal> <IndexOfDate>int</IndexOfDate> <IsFolioCharge>boolean</IsFolioCharge> <NettPerUnit>decimal</NettPerUnit> <NettTotal>decimal</NettTotal> <NoOfNights>int</NoOfNights> <OrderIndex>int</OrderIndex> <PackageCode>string</PackageCode> <PaymentCode>string</PaymentCode> <Quantity>decimal</Quantity> <RoomPickId>int</RoomPickId> <SourceTransId>int</SourceTransId> <StartDate>dateTime</StartDate> <TaxReference>string</TaxReference> <TaxTotal>decimal</TaxTotal> <Timestamp>dateTime</Timestamp> <TransactionWasCategAs>int</TransactionWasCategAs> <TransactionWasGroupedBy>int</TransactionWasGroupedBy> <TransId>int</TransId> <TaxSequence>string</TaxSequence> <NettSequence>decimal</NettSequence> </FinancialDocumentDetailTransaction> </TransactionLines> <Footer> <FinancialDocumentDetailTaxLine> <TaxRule>string</TaxRule> <Description>string</Description> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <GrossTotal>decimal</GrossTotal> </FinancialDocumentDetailTaxLine> <FinancialDocumentDetailTaxLine> <TaxRule>string</TaxRule> <Description>string</Description> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <GrossTotal>decimal</GrossTotal> </FinancialDocumentDetailTaxLine> </Footer> </DocumentDetail> </pmsdoc_GetDocumentDetail> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <pmsdoc_GetDocumentDetailResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19"> <pmsdoc_GetDocumentDetailResult> <ExceptionCode>int</ExceptionCode> <ExceptionDescription>string</ExceptionDescription> </pmsdoc_GetDocumentDetailResult> <DocumentDetail> <DocumentSummary> <BookRefRoomRef>string</BookRefRoomRef> <FolioId>int</FolioId> <FolioSplitId>int</FolioSplitId> <DocumentRef>string</DocumentRef> <DocumentType>FolioBill_CombinedFolios or FolioBill_IndividualFolio or DepositInvoice or LedgerInvoice or LedgerCreditNote or LedgerCreditPayment or PostCashNote or CurrencyExchangeReceipt</DocumentType> <DocumentTimestamp>dateTime</DocumentTimestamp> <Forename>string</Forename> <Surname>string</Surname> <LedgerRef>string</LedgerRef> <LedgerName>string</LedgerName> <GrossTotal>decimal</GrossTotal> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <ArrivalDate>dateTime</ArrivalDate> <DepartureDate>dateTime</DepartureDate> <AddressSource>Profile or Company or FreeType</AddressSource> <AddressRef>string</AddressRef> </DocumentSummary> <HeaderDetails> <Title>string</Title> <Forename>string</Forename> <Surname>string</Surname> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <County>string</County> <Country>string</Country> <Postcode>string</Postcode> </HeaderDetails> <TransactionLines> <FinancialDocumentDetailTransaction> <ItemType>int</ItemType> <EntryType>int</EntryType> <Status>int</Status> <AnalCode>string</AnalCode> <BookRef>string</BookRef> <Comments>string</Comments> <ConversionId>int</ConversionId> <ConvertedGrossTotal>decimal</ConvertedGrossTotal> <Description>string</Description> <EndDate>dateTime</EndDate> <FinTransactionParam1>int</FinTransactionParam1> <FinTransactionParam2>string</FinTransactionParam2> <ForDate>dateTime</ForDate> <GrossPerUnit>decimal</GrossPerUnit> <GrossTotal>decimal</GrossTotal> <IndexOfDate>int</IndexOfDate> <IsFolioCharge>boolean</IsFolioCharge> <NettPerUnit>decimal</NettPerUnit> <NettTotal>decimal</NettTotal> <NoOfNights>int</NoOfNights> <OrderIndex>int</OrderIndex> <PackageCode>string</PackageCode> <PaymentCode>string</PaymentCode> <Quantity>decimal</Quantity> <RoomPickId>int</RoomPickId> <SourceTransId>int</SourceTransId> <StartDate>dateTime</StartDate> <TaxReference>string</TaxReference> <TaxTotal>decimal</TaxTotal> <Timestamp>dateTime</Timestamp> <TransactionWasCategAs>int</TransactionWasCategAs> <TransactionWasGroupedBy>int</TransactionWasGroupedBy> <TransId>int</TransId> <TaxSequence>string</TaxSequence> <NettSequence>decimal</NettSequence> </FinancialDocumentDetailTransaction> <FinancialDocumentDetailTransaction> <ItemType>int</ItemType> <EntryType>int</EntryType> <Status>int</Status> <AnalCode>string</AnalCode> <BookRef>string</BookRef> <Comments>string</Comments> <ConversionId>int</ConversionId> <ConvertedGrossTotal>decimal</ConvertedGrossTotal> <Description>string</Description> <EndDate>dateTime</EndDate> <FinTransactionParam1>int</FinTransactionParam1> <FinTransactionParam2>string</FinTransactionParam2> <ForDate>dateTime</ForDate> <GrossPerUnit>decimal</GrossPerUnit> <GrossTotal>decimal</GrossTotal> <IndexOfDate>int</IndexOfDate> <IsFolioCharge>boolean</IsFolioCharge> <NettPerUnit>decimal</NettPerUnit> <NettTotal>decimal</NettTotal> <NoOfNights>int</NoOfNights> <OrderIndex>int</OrderIndex> <PackageCode>string</PackageCode> <PaymentCode>string</PaymentCode> <Quantity>decimal</Quantity> <RoomPickId>int</RoomPickId> <SourceTransId>int</SourceTransId> <StartDate>dateTime</StartDate> <TaxReference>string</TaxReference> <TaxTotal>decimal</TaxTotal> <Timestamp>dateTime</Timestamp> <TransactionWasCategAs>int</TransactionWasCategAs> <TransactionWasGroupedBy>int</TransactionWasGroupedBy> <TransId>int</TransId> <TaxSequence>string</TaxSequence> <NettSequence>decimal</NettSequence> </FinancialDocumentDetailTransaction> </TransactionLines> <Footer> <FinancialDocumentDetailTaxLine> <TaxRule>string</TaxRule> <Description>string</Description> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <GrossTotal>decimal</GrossTotal> </FinancialDocumentDetailTaxLine> <FinancialDocumentDetailTaxLine> <TaxRule>string</TaxRule> <Description>string</Description> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <GrossTotal>decimal</GrossTotal> </FinancialDocumentDetailTaxLine> </Footer> </DocumentDetail> </pmsdoc_GetDocumentDetailResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /rlxsoap.asmx HTTP/1.1 Host: rlxsoap.eu.guestline.app Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <pmsdoc_GetDocumentDetail xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19"> <SessionID>string</SessionID> <DocumentRef>string</DocumentRef> <DocumentDetail> <DocumentSummary> <BookRefRoomRef>string</BookRefRoomRef> <FolioId>int</FolioId> <FolioSplitId>int</FolioSplitId> <DocumentRef>string</DocumentRef> <DocumentType>FolioBill_CombinedFolios or FolioBill_IndividualFolio or DepositInvoice or LedgerInvoice or LedgerCreditNote or LedgerCreditPayment or PostCashNote or CurrencyExchangeReceipt</DocumentType> <DocumentTimestamp>dateTime</DocumentTimestamp> <Forename>string</Forename> <Surname>string</Surname> <LedgerRef>string</LedgerRef> <LedgerName>string</LedgerName> <GrossTotal>decimal</GrossTotal> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <ArrivalDate>dateTime</ArrivalDate> <DepartureDate>dateTime</DepartureDate> <AddressSource>Profile or Company or FreeType</AddressSource> <AddressRef>string</AddressRef> </DocumentSummary> <HeaderDetails> <Title>string</Title> <Forename>string</Forename> <Surname>string</Surname> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <County>string</County> <Country>string</Country> <Postcode>string</Postcode> </HeaderDetails> <TransactionLines> <FinancialDocumentDetailTransaction> <ItemType>int</ItemType> <EntryType>int</EntryType> <Status>int</Status> <AnalCode>string</AnalCode> <BookRef>string</BookRef> <Comments>string</Comments> <ConversionId>int</ConversionId> <ConvertedGrossTotal>decimal</ConvertedGrossTotal> <Description>string</Description> <EndDate>dateTime</EndDate> <FinTransactionParam1>int</FinTransactionParam1> <FinTransactionParam2>string</FinTransactionParam2> <ForDate>dateTime</ForDate> <GrossPerUnit>decimal</GrossPerUnit> <GrossTotal>decimal</GrossTotal> <IndexOfDate>int</IndexOfDate> <IsFolioCharge>boolean</IsFolioCharge> <NettPerUnit>decimal</NettPerUnit> <NettTotal>decimal</NettTotal> <NoOfNights>int</NoOfNights> <OrderIndex>int</OrderIndex> <PackageCode>string</PackageCode> <PaymentCode>string</PaymentCode> <Quantity>decimal</Quantity> <RoomPickId>int</RoomPickId> <SourceTransId>int</SourceTransId> <StartDate>dateTime</StartDate> <TaxReference>string</TaxReference> <TaxTotal>decimal</TaxTotal> <Timestamp>dateTime</Timestamp> <TransactionWasCategAs>int</TransactionWasCategAs> <TransactionWasGroupedBy>int</TransactionWasGroupedBy> <TransId>int</TransId> <TaxSequence>string</TaxSequence> <NettSequence>decimal</NettSequence> </FinancialDocumentDetailTransaction> <FinancialDocumentDetailTransaction> <ItemType>int</ItemType> <EntryType>int</EntryType> <Status>int</Status> <AnalCode>string</AnalCode> <BookRef>string</BookRef> <Comments>string</Comments> <ConversionId>int</ConversionId> <ConvertedGrossTotal>decimal</ConvertedGrossTotal> <Description>string</Description> <EndDate>dateTime</EndDate> <FinTransactionParam1>int</FinTransactionParam1> <FinTransactionParam2>string</FinTransactionParam2> <ForDate>dateTime</ForDate> <GrossPerUnit>decimal</GrossPerUnit> <GrossTotal>decimal</GrossTotal> <IndexOfDate>int</IndexOfDate> <IsFolioCharge>boolean</IsFolioCharge> <NettPerUnit>decimal</NettPerUnit> <NettTotal>decimal</NettTotal> <NoOfNights>int</NoOfNights> <OrderIndex>int</OrderIndex> <PackageCode>string</PackageCode> <PaymentCode>string</PaymentCode> <Quantity>decimal</Quantity> <RoomPickId>int</RoomPickId> <SourceTransId>int</SourceTransId> <StartDate>dateTime</StartDate> <TaxReference>string</TaxReference> <TaxTotal>decimal</TaxTotal> <Timestamp>dateTime</Timestamp> <TransactionWasCategAs>int</TransactionWasCategAs> <TransactionWasGroupedBy>int</TransactionWasGroupedBy> <TransId>int</TransId> <TaxSequence>string</TaxSequence> <NettSequence>decimal</NettSequence> </FinancialDocumentDetailTransaction> </TransactionLines> <Footer> <FinancialDocumentDetailTaxLine> <TaxRule>string</TaxRule> <Description>string</Description> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <GrossTotal>decimal</GrossTotal> </FinancialDocumentDetailTaxLine> <FinancialDocumentDetailTaxLine> <TaxRule>string</TaxRule> <Description>string</Description> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <GrossTotal>decimal</GrossTotal> </FinancialDocumentDetailTaxLine> </Footer> </DocumentDetail> </pmsdoc_GetDocumentDetail> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <pmsdoc_GetDocumentDetailResponse xmlns="http://tempuri.org/RLXSOAP19/RLXSOAP19"> <pmsdoc_GetDocumentDetailResult> <ExceptionCode>int</ExceptionCode> <ExceptionDescription>string</ExceptionDescription> </pmsdoc_GetDocumentDetailResult> <DocumentDetail> <DocumentSummary> <BookRefRoomRef>string</BookRefRoomRef> <FolioId>int</FolioId> <FolioSplitId>int</FolioSplitId> <DocumentRef>string</DocumentRef> <DocumentType>FolioBill_CombinedFolios or FolioBill_IndividualFolio or DepositInvoice or LedgerInvoice or LedgerCreditNote or LedgerCreditPayment or PostCashNote or CurrencyExchangeReceipt</DocumentType> <DocumentTimestamp>dateTime</DocumentTimestamp> <Forename>string</Forename> <Surname>string</Surname> <LedgerRef>string</LedgerRef> <LedgerName>string</LedgerName> <GrossTotal>decimal</GrossTotal> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <ArrivalDate>dateTime</ArrivalDate> <DepartureDate>dateTime</DepartureDate> <AddressSource>Profile or Company or FreeType</AddressSource> <AddressRef>string</AddressRef> </DocumentSummary> <HeaderDetails> <Title>string</Title> <Forename>string</Forename> <Surname>string</Surname> <Address1>string</Address1> <Address2>string</Address2> <City>string</City> <County>string</County> <Country>string</Country> <Postcode>string</Postcode> </HeaderDetails> <TransactionLines> <FinancialDocumentDetailTransaction> <ItemType>int</ItemType> <EntryType>int</EntryType> <Status>int</Status> <AnalCode>string</AnalCode> <BookRef>string</BookRef> <Comments>string</Comments> <ConversionId>int</ConversionId> <ConvertedGrossTotal>decimal</ConvertedGrossTotal> <Description>string</Description> <EndDate>dateTime</EndDate> <FinTransactionParam1>int</FinTransactionParam1> <FinTransactionParam2>string</FinTransactionParam2> <ForDate>dateTime</ForDate> <GrossPerUnit>decimal</GrossPerUnit> <GrossTotal>decimal</GrossTotal> <IndexOfDate>int</IndexOfDate> <IsFolioCharge>boolean</IsFolioCharge> <NettPerUnit>decimal</NettPerUnit> <NettTotal>decimal</NettTotal> <NoOfNights>int</NoOfNights> <OrderIndex>int</OrderIndex> <PackageCode>string</PackageCode> <PaymentCode>string</PaymentCode> <Quantity>decimal</Quantity> <RoomPickId>int</RoomPickId> <SourceTransId>int</SourceTransId> <StartDate>dateTime</StartDate> <TaxReference>string</TaxReference> <TaxTotal>decimal</TaxTotal> <Timestamp>dateTime</Timestamp> <TransactionWasCategAs>int</TransactionWasCategAs> <TransactionWasGroupedBy>int</TransactionWasGroupedBy> <TransId>int</TransId> <TaxSequence>string</TaxSequence> <NettSequence>decimal</NettSequence> </FinancialDocumentDetailTransaction> <FinancialDocumentDetailTransaction> <ItemType>int</ItemType> <EntryType>int</EntryType> <Status>int</Status> <AnalCode>string</AnalCode> <BookRef>string</BookRef> <Comments>string</Comments> <ConversionId>int</ConversionId> <ConvertedGrossTotal>decimal</ConvertedGrossTotal> <Description>string</Description> <EndDate>dateTime</EndDate> <FinTransactionParam1>int</FinTransactionParam1> <FinTransactionParam2>string</FinTransactionParam2> <ForDate>dateTime</ForDate> <GrossPerUnit>decimal</GrossPerUnit> <GrossTotal>decimal</GrossTotal> <IndexOfDate>int</IndexOfDate> <IsFolioCharge>boolean</IsFolioCharge> <NettPerUnit>decimal</NettPerUnit> <NettTotal>decimal</NettTotal> <NoOfNights>int</NoOfNights> <OrderIndex>int</OrderIndex> <PackageCode>string</PackageCode> <PaymentCode>string</PaymentCode> <Quantity>decimal</Quantity> <RoomPickId>int</RoomPickId> <SourceTransId>int</SourceTransId> <StartDate>dateTime</StartDate> <TaxReference>string</TaxReference> <TaxTotal>decimal</TaxTotal> <Timestamp>dateTime</Timestamp> <TransactionWasCategAs>int</TransactionWasCategAs> <TransactionWasGroupedBy>int</TransactionWasGroupedBy> <TransId>int</TransId> <TaxSequence>string</TaxSequence> <NettSequence>decimal</NettSequence> </FinancialDocumentDetailTransaction> </TransactionLines> <Footer> <FinancialDocumentDetailTaxLine> <TaxRule>string</TaxRule> <Description>string</Description> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <GrossTotal>decimal</GrossTotal> </FinancialDocumentDetailTaxLine> <FinancialDocumentDetailTaxLine> <TaxRule>string</TaxRule> <Description>string</Description> <NettTotal>decimal</NettTotal> <TaxTotal>decimal</TaxTotal> <GrossTotal>decimal</GrossTotal> </FinancialDocumentDetailTaxLine> </Footer> </DocumentDetail> </pmsdoc_GetDocumentDetailResponse> </soap12:Body> </soap12:Envelope>