POST hotels/{hotelId}/transactions/roomcharges?key={key}

Posts room related charges to the RoomKey Backend

Request Information

URI Parameters

Name	Description	Type	Additional information
hotelId	Hotel Id	string	Required
key	API - Key identifying the caller	string	Required

Body Parameters

Collection of RoomCharge

Name	Type	Additional information
RoomNumber	string	None.
Terminal	string	None.
NumberOfGuests	integer	None.
GuestName	string	None.
CostCentre	string	None.
CheckNumber	string	None.
GrossAmount	decimal number	None.
TipAmount	decimal number	None.
ServiceCharge	decimal number	None.
Tax1	decimal number	None.
Tax2	decimal number	None.
Tax3	decimal number	None.
Tax4	decimal number	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "RoomNumber": "sample string 1",
    "Terminal": "sample string 2",
    "NumberOfGuests": 3,
    "GuestName": "sample string 4",
    "CostCentre": "sample string 5",
    "CheckNumber": "sample string 6",
    "GrossAmount": 7.0,
    "TipAmount": 8.0,
    "ServiceCharge": 9.0,
    "Tax1": 10.0,
    "Tax2": 11.0,
    "Tax3": 12.0,
    "Tax4": 13.0
  },
  {
    "RoomNumber": "sample string 1",
    "Terminal": "sample string 2",
    "NumberOfGuests": 3,
    "GuestName": "sample string 4",
    "CostCentre": "sample string 5",
    "CheckNumber": "sample string 6",
    "GrossAmount": 7.0,
    "TipAmount": 8.0,
    "ServiceCharge": 9.0,
    "Tax1": 10.0,
    "Tax2": 11.0,
    "Tax3": 12.0,
    "Tax4": 13.0
  }
]

application/xml, text/xml

Sample:

<ArrayOfRoomCharge xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <RoomCharge>
    <CheckNumber>sample string 6</CheckNumber>
    <CostCentre>sample string 5</CostCentre>
    <GrossAmount>7</GrossAmount>
    <GuestName>sample string 4</GuestName>
    <NumberOfGuests>3</NumberOfGuests>
    <RoomNumber>sample string 1</RoomNumber>
    <ServiceCharge>9</ServiceCharge>
    <Tax1>10</Tax1>
    <Tax2>11</Tax2>
    <Tax3>12</Tax3>
    <Tax4>13</Tax4>
    <Terminal>sample string 2</Terminal>
    <TipAmount>8</TipAmount>
  </RoomCharge>
  <RoomCharge>
    <CheckNumber>sample string 6</CheckNumber>
    <CostCentre>sample string 5</CostCentre>
    <GrossAmount>7</GrossAmount>
    <GuestName>sample string 4</GuestName>
    <NumberOfGuests>3</NumberOfGuests>
    <RoomNumber>sample string 1</RoomNumber>
    <ServiceCharge>9</ServiceCharge>
    <Tax1>10</Tax1>
    <Tax2>11</Tax2>
    <Tax3>12</Tax3>
    <Tax4>13</Tax4>
    <Terminal>sample string 2</Terminal>
    <TipAmount>8</TipAmount>
  </RoomCharge>
</ArrayOfRoomCharge>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

true if charge was posted, false otherwise

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>