GET v2/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.

Request Formats

application/json, text/json

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

application/xml, text/xml

Sample:
System.Xml.XmlDocument

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PMSChargeToRoomResponseDto
Name Type Description 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:
System.Xml.XmlDocument