GET hotels/{hotelId}/transactions?key={key}&date={date}

Gets all Transactions created on a specific Date for the hotel specified.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
hotelId

Hotel-Id => checked against the calling applications permissions

string

Required

key

API - Key identifying the caller

string

Required

date

Day for which to retrieve transactions, Format YYYY-MM-DD

date

Required

Body Parameters

None.

Response Information

Resource Description

List of Transactions

Collection of Transaction
NameDescriptionTypeAdditional information
AmountNoTax

Net amount spend (excluding taxes)

decimal number

None.

AmountTax

Amount of tax spend

decimal number

None.

Details

Description of the transaction details

string

None.

FolioTranNumber

A unique numerical identifier for the transaction posted to the guest folio

integer

None.

GuestId

Unique ID of the Guest

string

None.

HotelId

Unique Hotel - Id

string

None.

ReservationId

Id of the reservation this transaction is mapped to

integer

None.

SpendCode

Transaction Code as defined in the roomkey - backend

string

None.

TransactionDateTime

Date and time the transaction was started

date

None.

TransactionId

Transaction Id - unique per reservation

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "AmountNoTax": 1.0,
    "AmountTax": 2.0,
    "Details": "sample string 3",
    "FolioTranNumber": 4,
    "GuestId": "sample string 5",
    "HotelId": "sample string 6",
    "ReservationId": 7,
    "SpendCode": "sample string 8",
    "TransactionDateTime": "2022-10-05T23:39:40.5597595-07:00",
    "TransactionId": 10
  },
  {
    "AmountNoTax": 1.0,
    "AmountTax": 2.0,
    "Details": "sample string 3",
    "FolioTranNumber": 4,
    "GuestId": "sample string 5",
    "HotelId": "sample string 6",
    "ReservationId": 7,
    "SpendCode": "sample string 8",
    "TransactionDateTime": "2022-10-05T23:39:40.5597595-07:00",
    "TransactionId": 10
  }
]

application/xml, text/xml

Sample:
<ArrayOfTransaction xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models">
  <Transaction>
    <AmountNoTax>1</AmountNoTax>
    <AmountTax>2</AmountTax>
    <Details>sample string 3</Details>
    <FolioTranNumber>4</FolioTranNumber>
    <GuestId>sample string 5</GuestId>
    <HotelId>sample string 6</HotelId>
    <ReservationId>7</ReservationId>
    <SpendCode>sample string 8</SpendCode>
    <TransactionDateTime>2022-10-05T23:39:40.5597595-07:00</TransactionDateTime>
    <TransactionId>10</TransactionId>
  </Transaction>
  <Transaction>
    <AmountNoTax>1</AmountNoTax>
    <AmountTax>2</AmountTax>
    <Details>sample string 3</Details>
    <FolioTranNumber>4</FolioTranNumber>
    <GuestId>sample string 5</GuestId>
    <HotelId>sample string 6</HotelId>
    <ReservationId>7</ReservationId>
    <SpendCode>sample string 8</SpendCode>
    <TransactionDateTime>2022-10-05T23:39:40.5597595-07:00</TransactionDateTime>
    <TransactionId>10</TransactionId>
  </Transaction>
</ArrayOfTransaction>