RESERVATION DEPOSITIN WITH FORECAST ADD V003

Service Reference Name: S_RESERVATION_DEPOSITIN_WITH_FORECAST_ADD_V003

General

Post deposit as total amount on the reservation. Packages on the reservation will be posted on the reservation account and settled. Deposit invoice will be created. For group reservations the packages are posted on every reservation account. The payment will be posted on the master reservation account.

Prerequisites: All following registry keys are set

  • Registry key: 1747;c=reservation,v=procFactLstOnCheckIn
  • Registry key: 1748;c=reservation,v=procLstTypesOnCheckIn
  • Registry key: 846035;c=crossbow,v=allowPrepaymentInvoicing

Input

  • RESERVATION-CENTRALID: CentralID of the reservation. Optional, but one out of RESERVATION-CENTRALID or RESERVATION-OBJID needs to be sent to find the reservation.

  • RESERVATION-OBJID: ObjID of the reservation. Optional, but one out of RESERVATION-CENTRALID or RESERVATION-OBJID needs to be sent to find the reservation.

  • transactionID. Mandatory. The transaction ID of the payment.

  • typeofpayment. Mandatory. Payment type for the payment.

  • paymentAmount. Optional. Amount of the payment. Payment with amount = 0 is allowed in cases of changes on packages/services and in respect to that may also changes on vat amounts.

  • currency. Optional for reservations in local currency, mandatory for reservations in foreign currency. Local currency is used, if empty.

  • approvalNumber. Mandatory. Approval number for the deposit in processing.

  • processingDate. Mandatory. Date of the deposit in processing.

  • serviceProvider. Optional. The service provider used for the payment.

  • paymentDescription. Optional. Field for further description of the payment.

  • emailForDepositInvoice. Optional. Email address for deposit invoice.

  • paymentinstructions: The payment instruction to route the posting, combo box key ("VO"). Key = Value: 0 = own acount; 1 = group acount; 3 = oderer acount

  • cardNumber. Optional. Number of the credit card.

  • cardValidUntil. Optional. Credit card valid until date.

Output

  • ACCOUNT-OBJID: ObjID of the RESERVATION-ACCOUNT on to the deposit was posted. For group reservations every reservation account is listed.
  • DepositInvoice
  • INVOICE-OBJID: ObjID of the deposit invoice.
  • invoiceNo: Invoice no of the deposit invoice.
  • invoiceNoSet: Invoice set of the deposit invoice.
  • amount: Amount of the deposit invoice.
  • currrencyAmount: Amount of the deposit invoice in foreign currency.
  • currency: Currency of the deposit invoice.
  • DepositCredit (appears from the second prepayment -- is the cancellation of the previous prepayment invoice)
  • INVOICE-OBJID: ObjID of the deposit invoice.
  • invoiceNo: Invoice no of the deposit invoice.
  • invoiceNoSet: Invoice set of the deposit invoice.
  • amount: Amount of the deposit invoice.
  • currrencyAmount: Amount of the deposit invoice in foreign currency.
  • currency: Currency of the deposit invoice.

Direction

SIHOT.PMS ← IF Partner

Message

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soapenv:Header />
  <soapenv:Body>
    <S_RESERVATION_DEPOSITIN_WITH_FORECAST_ADD_V003Request xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
      <Authentication>
        <SecurityID>string</SecurityID>
      </Authentication>
      <Reservation><!--Optional--><RESERVATION-CENTRALID>Base: string Pattern: ([0-9])*</RESERVATION-CENTRALID><!--Optional--><RESERVATION-OBJID>Base: string Pattern: ([0-9])*</RESERVATION-OBJID>
        <DepositInWithForecast>
          <transactionid>string</transactionid>
          <typeofpayment>string</typeofpayment><!--Optional--><paymentamount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</paymentamount><!--Optional--><currency>string</currency><!--Optional--><approvalnumber>string</approvalnumber><!--Optional--><processingdate>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</processingdate><!--Optional--><serviceprovider>string</serviceprovider><!--Optional--><paymentdescription>string</paymentdescription><!--Optional--><emailfordepositinvoice>string</emailfordepositinvoice>
          <paymentinstructions>string</paymentinstructions><!--Optional--><cardnumber>string</cardnumber><!--Optional--><cardvaliduntil>Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})|</cardvaliduntil>
        </DepositInWithForecast>
      </Reservation>
    </S_RESERVATION_DEPOSITIN_WITH_FORECAST_ADD_V003Request>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Message

Name Type
S_RESERVATION_DEPOSITIN_WITH_FORECAST_ADD_V003Request
TransactionID string
Authentication Node
SecurityID string
Reservation Node
RESERVATION-CENTRALID Base: string Pattern: ([0-9])*
RESERVATION-OBJID Base: string Pattern: ([0-9])*
DepositInWithForecast Node
transactionid string
typeofpayment string
paymentamount Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9])
currency string
approvalnumber string
processingdate Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})
serviceprovider string
paymentdescription string
emailfordepositinvoice string
paymentinstructions string
cardnumber string
cardvaliduntil Base: string Pattern: ([0-9]{4})-([0-9]{2})-([0-9]{2})

Response

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:envgen="http://soapenvelopegenerator.eduardocastro.info/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soapenv:Header />
  <soapenv:Body>
    <S_RESERVATION_DEPOSITIN_WITH_FORECAST_ADD_V003Response xmlns="http://www.gubse.com/IFS/SihotServices01.xsd"><!--Optional--><TransactionID>string</TransactionID>
      <Result>
        <Success>Base: string Pattern: true or false</Success><!--Optional--><ErrorMsg>string</ErrorMsg><!--Optional--><MSG-LIST><!--Optional--><MSG-ENTRY><!--Optional--><MSG-LEVEL>Base: string Pattern: ERROR or WARNING or INFO</MSG-LEVEL><!--Optional--><MSG-CLASS>string</MSG-CLASS><!--Optional--><MSG-NO>Base: string Pattern: ([0-9])*</MSG-NO><!--Optional--><MSG-TEXT>string</MSG-TEXT><!--Optional--><MSG-ENTRY-PARAM-LIST><!--Optional--><PARAM><!--Optional--><INDEX>Base: string Pattern: ([0-9])*</INDEX><!--Optional--><VALUE>string</VALUE>
              </PARAM>
            </MSG-ENTRY-PARAM-LIST><!--Optional--><MSG-COMMENT>string</MSG-COMMENT><!--Optional--><MSG-SUPRESSED>string</MSG-SUPRESSED>
          </MSG-ENTRY>
        </MSG-LIST>
      </Result><!--Optional--><Output><!--Optional--><Deposit>
          <ResAccounts><!--Optional--><DepositAccount>
              <ACCOUNT-OBJID>Base: string Pattern: ([0-9])*</ACCOUNT-OBJID>
            </DepositAccount>
          </ResAccounts><!--Optional--><DepositInvoice>
            <INVOICE-OBJID>Base: string Pattern: ([0-9])*</INVOICE-OBJID>
            <invoiceno>Base: string Pattern: ([0-9])*</invoiceno>
            <invoicenoset>Base: string minLength: 0 maxLength: 2</invoicenoset>
            <amount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</amount>
            <currencyAmount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</currencyAmount>
            <currency>string</currency>
          </DepositInvoice><!--Optional--><DepositCredit>
            <INVOICE-OBJID>Base: string Pattern: ([0-9])*</INVOICE-OBJID>
            <invoiceno>Base: string Pattern: ([0-9])*</invoiceno>
            <invoicenoset>Base: string minLength: 0 maxLength: 2</invoicenoset>
            <amount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</amount>
            <currencyAmount>Base: string Pattern: ([-+]){0,1}([0-9])*\.{0,1}([0-9])*</currencyAmount>
            <currency>string</currency>
          </DepositCredit>
        </Deposit>
      </Output>
    </S_RESERVATION_DEPOSITIN_WITH_FORECAST_ADD_V003Response>
  </soapenv:Body>
</soapenv:Envelope>

Attributes Response

Name Type
S_RESERVATION_DEPOSITIN_WITH_FORECAST_ADD_V003Response
TransactionID string
Result Node
Success Base: string Pattern: true or false
ErrorMsg string
MSG-LIST Node
MSG-ENTRY Node
MSG-LEVEL Base: string Pattern: ERROR or WARNING or INFO
MSG-CLASS string
MSG-NO Base: string Pattern: ([0-9])*
MSG-TEXT string
MSG-ENTRY-PARAM-LIST Node
PARAM Node
INDEX Base: string Pattern: ([0-9])*
VALUE string
MSG-COMMENT string
MSG-SUPRESSED string
Output Node
Deposit Node
ResAccounts Node
DepositAccount Node
ACCOUNT-OBJID Base: string Pattern: ([0-9])*
DepositInvoice Node
INVOICE-OBJID Base: string Pattern: ([0-9])*
invoiceno Base: string Pattern: ([0-9])*
invoicenoset Base: string minLength: 0 maxLength: 2
amount Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9])
currencyAmount Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9])
currency string
DepositCredit Node
INVOICE-OBJID Base: string Pattern: ([0-9])*
invoiceno Base: string Pattern: ([0-9])*
invoicenoset Base: string minLength: 0 maxLength: 2
amount Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9])
currencyAmount Base: string Pattern: ([-+]){0,1}([0-9]).{0,1}([0-9])
currency string