GET v{version}/OnlineOrders/PMSChargeToRoom

Request Information

URI Parameters

Name	Type	Description	Additional information
version	string		None.

Body Parameters

PMSChargeToRoomApiModel

Name	Type	Description	Additional information
SiteID	integer		Required
TableNumber	integer	Required if - Optionally send the Table number to find the TransactionID. Note if multiple Transactions are open at a table this will error.
TransactionID	integer	Required if - Optionally send The TransactionID to find the specific transaction. This is available in the TablePaymentRequest Endpoint.

Name

Type

Description

Additional information

SiteID

integer

Required

TableNumber

integer

Required if - Optionally send the Table number to find the TransactionID. Note if multiple Transactions are open at a table this will error.

TransactionID

integer

Required if - Optionally send The TransactionID to find the specific transaction. This is available in the TablePaymentRequest Endpoint.

Request Formats

application/json, text/json

Sample:

{
  "SiteID": 1,
  "TableNumber": 1,
  "TransactionID": 1
}

application/xml, text/xml

Sample:

<PMSChargeToRoomApiModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.OnlineOrdersV2.ApiModels">
  <SiteID>1</SiteID>
  <TableNumber>1</TableNumber>
  <TransactionID>1</TransactionID>
</PMSChargeToRoomApiModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PMSChargeToRoomResponseDto

Name	Type	Additional information
IsSuccess	boolean	None.
ErrorMsg	string	None.
AmountPosted	decimal number	None.
ItemCodes	Dictionary of integer [key] and string [value]	None.
TenderCodes	Dictionary of integer [key] and string [value]	None.
Reference	string	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "ErrorMsg": "sample string 2",
  "AmountPosted": 3.0,
  "ItemCodes": {
    "1": "sample string 2",
    "3": "sample string 4"
  },
  "TenderCodes": {
    "1": "sample string 2",
    "3": "sample string 4"
  },
  "Reference": "sample string 4"
}

application/xml, text/xml

Sample:

<PMSChargeToRoomResponseDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.API.Core.Models.SignalR.Dtos">
  <AmountPosted>3</AmountPosted>
  <ErrorMsg>sample string 2</ErrorMsg>
  <IsSuccess>true</IsSuccess>
  <ItemCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfintstring>
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfintstring>
  </ItemCodes>
  <Reference>sample string 4</Reference>
  <TenderCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfintstring>
    <d2p1:KeyValueOfintstring>
      <d2p1:Key>3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfintstring>
  </TenderCodes>
</PMSChargeToRoomResponseDto>