GET hotels/{hotelId}/statistics/receipts?key={key}&date={date}
Gets all Receipts for the hotel specified on a date
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
hotelId |
Hotel Id |
string |
Required |
key |
API - Key identifying the caller |
string |
Required |
date |
Date for which to retrieve the receipts, Format: MM-DD-YYYY |
date |
Required |
Body Parameters
None.
Response Information
Resource Description
List of Receipts
Collection of ReceiptName | Description | Type | Additional information |
---|---|---|---|
arrival_date |
Arrival Date |
date |
None. |
booker_account_code |
Wholesaler Code |
string |
None. |
booker_account_name |
Wholesaler Account Name |
string |
None. |
booker_account_type |
Corporate Code if Guest is Corporate otherwise empty (string) |
string |
None. |
booker_name |
Booker Name |
string |
None. |
client_type_code |
Client Type code |
string |
None. |
country_of_nationality |
Guest Country of Nationality |
string |
None. |
country_of_residence |
Guest Country of Residence (Main Address) |
string |
None. |
credit_card_auth_code |
Credit card autorization code |
string |
None. |
credit_card_number |
Credit Card Number |
string |
None. |
daily_rate_plan_name |
Rate Plan Name |
string |
None. |
date_booked |
Date the reservation was created |
date |
None. |
departure_date |
Departure Date |
date |
None. |
folio_tran_number |
A unique numerical identifier for the transaction posted to the guest folio |
integer |
None. |
guest_first_name |
Guest First Name |
string |
None. |
guest_last_name |
Guest Last Name |
string |
None. |
guest_name |
Guest full name. |
string |
None. |
guest_title |
Guest Title |
string |
None. |
IsTransfer |
Marks the receipt as transfered (tranNumber / reservation) |
boolean |
None. |
journal_entry_amount |
Journal entry amount |
decimal number |
None. |
journal_entry_credit |
Journal credit account |
string |
None. |
journal_entry_debit |
Journal debit account |
string |
None. |
loyalty_card_number |
Loyalty Card Number |
string |
None. |
payment_date |
Payment Date |
date |
None. |
property_name |
Property Name |
string |
None. |
rate_plan_MKTSeg |
Market Segment of the Rate Plan |
string |
None. |
reservation_id |
reservation ID |
string |
None. |
room_type |
Room Type |
string |
None. |
source_of_business |
Source of Business Name |
string |
None. |
source_of_business_code |
Source of Business Code |
string |
None. |
transaction_amount |
Transaction Amount |
decimal number |
None. |
transaction_code |
Transaction Code |
string |
None. |
transaction_comment |
Transaction comment typed in by staff |
string |
None. |
transaction_date |
Date the transaction was made. |
date |
None. |
transaction_gl_account_code_credit |
Credit account number for this transaction code |
string |
None. |
transaction_gl_account_code_debit |
Debit account number for this transaction code |
string |
None. |
user |
User |
string |
None. |
Response Formats
application/json, text/json
[ { "arrival_date": "2024-12-12T14:42:56.8100592-08:00", "booker_account_code": "sample string 2", "booker_account_name": "sample string 3", "booker_account_type": "sample string 4", "booker_name": "sample string 5", "client_type_code": "sample string 6", "country_of_nationality": "sample string 7", "country_of_residence": "sample string 8", "credit_card_auth_code": "sample string 9", "credit_card_number": "sample string 10", "daily_rate_plan_name": "sample string 11", "date_booked": "2024-12-12T14:42:56.8100592-08:00", "departure_date": "2024-12-12T14:42:56.8100592-08:00", "folio_tran_number": 1, "guest_first_name": "sample string 14", "guest_last_name": "sample string 15", "guest_name": "sample string 16", "guest_title": "sample string 17", "IsTransfer": true, "journal_entry_amount": 19.0, "journal_entry_credit": "sample string 20", "journal_entry_debit": "sample string 21", "loyalty_card_number": "sample string 22", "payment_date": "2024-12-12T14:42:56.8100592-08:00", "property_name": "sample string 24", "rate_plan_MKTSeg": "sample string 25", "reservation_id": "sample string 26", "room_type": "sample string 27", "source_of_business": "sample string 28", "source_of_business_code": "sample string 29", "transaction_amount": 30.0, "transaction_code": "sample string 31", "transaction_comment": "sample string 32", "transaction_date": "2024-12-12T14:42:56.8100592-08:00", "transaction_gl_account_code_credit": "sample string 34", "transaction_gl_account_code_debit": "sample string 35", "user": "sample string 36" }, { "arrival_date": "2024-12-12T14:42:56.8100592-08:00", "booker_account_code": "sample string 2", "booker_account_name": "sample string 3", "booker_account_type": "sample string 4", "booker_name": "sample string 5", "client_type_code": "sample string 6", "country_of_nationality": "sample string 7", "country_of_residence": "sample string 8", "credit_card_auth_code": "sample string 9", "credit_card_number": "sample string 10", "daily_rate_plan_name": "sample string 11", "date_booked": "2024-12-12T14:42:56.8100592-08:00", "departure_date": "2024-12-12T14:42:56.8100592-08:00", "folio_tran_number": 1, "guest_first_name": "sample string 14", "guest_last_name": "sample string 15", "guest_name": "sample string 16", "guest_title": "sample string 17", "IsTransfer": true, "journal_entry_amount": 19.0, "journal_entry_credit": "sample string 20", "journal_entry_debit": "sample string 21", "loyalty_card_number": "sample string 22", "payment_date": "2024-12-12T14:42:56.8100592-08:00", "property_name": "sample string 24", "rate_plan_MKTSeg": "sample string 25", "reservation_id": "sample string 26", "room_type": "sample string 27", "source_of_business": "sample string 28", "source_of_business_code": "sample string 29", "transaction_amount": 30.0, "transaction_code": "sample string 31", "transaction_comment": "sample string 32", "transaction_date": "2024-12-12T14:42:56.8100592-08:00", "transaction_gl_account_code_credit": "sample string 34", "transaction_gl_account_code_debit": "sample string 35", "user": "sample string 36" } ]
application/xml, text/xml
<ArrayOfReceipt xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RoomKeyAPI.Models"> <Receipt> <IsTransfer>true</IsTransfer> <arrival_date>2024-12-12T14:42:56.8100592-08:00</arrival_date> <booker_account_code>sample string 2</booker_account_code> <booker_account_name>sample string 3</booker_account_name> <booker_account_type>sample string 4</booker_account_type> <booker_name>sample string 5</booker_name> <client_type_code>sample string 6</client_type_code> <country_of_nationality>sample string 7</country_of_nationality> <country_of_residence>sample string 8</country_of_residence> <credit_card_auth_code>sample string 9</credit_card_auth_code> <credit_card_number>sample string 10</credit_card_number> <daily_rate_plan_name>sample string 11</daily_rate_plan_name> <date_booked>2024-12-12T14:42:56.8100592-08:00</date_booked> <departure_date>2024-12-12T14:42:56.8100592-08:00</departure_date> <folio_tran_number>1</folio_tran_number> <guest_first_name>sample string 14</guest_first_name> <guest_last_name>sample string 15</guest_last_name> <guest_name>sample string 16</guest_name> <guest_title>sample string 17</guest_title> <journal_entry_amount>19</journal_entry_amount> <journal_entry_credit>sample string 20</journal_entry_credit> <journal_entry_debit>sample string 21</journal_entry_debit> <loyalty_card_number>sample string 22</loyalty_card_number> <payment_date>2024-12-12T14:42:56.8100592-08:00</payment_date> <property_name>sample string 24</property_name> <rate_plan_MKTSeg>sample string 25</rate_plan_MKTSeg> <reservation_id>sample string 26</reservation_id> <room_type>sample string 27</room_type> <source_of_business>sample string 28</source_of_business> <source_of_business_code>sample string 29</source_of_business_code> <transaction_amount>30</transaction_amount> <transaction_code>sample string 31</transaction_code> <transaction_comment>sample string 32</transaction_comment> <transaction_date>2024-12-12T14:42:56.8100592-08:00</transaction_date> <transaction_gl_account_code_credit>sample string 34</transaction_gl_account_code_credit> <transaction_gl_account_code_debit>sample string 35</transaction_gl_account_code_debit> <user>sample string 36</user> </Receipt> <Receipt> <IsTransfer>true</IsTransfer> <arrival_date>2024-12-12T14:42:56.8100592-08:00</arrival_date> <booker_account_code>sample string 2</booker_account_code> <booker_account_name>sample string 3</booker_account_name> <booker_account_type>sample string 4</booker_account_type> <booker_name>sample string 5</booker_name> <client_type_code>sample string 6</client_type_code> <country_of_nationality>sample string 7</country_of_nationality> <country_of_residence>sample string 8</country_of_residence> <credit_card_auth_code>sample string 9</credit_card_auth_code> <credit_card_number>sample string 10</credit_card_number> <daily_rate_plan_name>sample string 11</daily_rate_plan_name> <date_booked>2024-12-12T14:42:56.8100592-08:00</date_booked> <departure_date>2024-12-12T14:42:56.8100592-08:00</departure_date> <folio_tran_number>1</folio_tran_number> <guest_first_name>sample string 14</guest_first_name> <guest_last_name>sample string 15</guest_last_name> <guest_name>sample string 16</guest_name> <guest_title>sample string 17</guest_title> <journal_entry_amount>19</journal_entry_amount> <journal_entry_credit>sample string 20</journal_entry_credit> <journal_entry_debit>sample string 21</journal_entry_debit> <loyalty_card_number>sample string 22</loyalty_card_number> <payment_date>2024-12-12T14:42:56.8100592-08:00</payment_date> <property_name>sample string 24</property_name> <rate_plan_MKTSeg>sample string 25</rate_plan_MKTSeg> <reservation_id>sample string 26</reservation_id> <room_type>sample string 27</room_type> <source_of_business>sample string 28</source_of_business> <source_of_business_code>sample string 29</source_of_business_code> <transaction_amount>30</transaction_amount> <transaction_code>sample string 31</transaction_code> <transaction_comment>sample string 32</transaction_comment> <transaction_date>2024-12-12T14:42:56.8100592-08:00</transaction_date> <transaction_gl_account_code_credit>sample string 34</transaction_gl_account_code_credit> <transaction_gl_account_code_debit>sample string 35</transaction_gl_account_code_debit> <user>sample string 36</user> </Receipt> </ArrayOfReceipt>