# LodgingData

A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.

The lodging (hotel) detail a stay-related transaction carries, for merchants transacting under a
lodging industry.

## Fields
- `checkInDate` (string(date)): The date the guest checked in, or is expected to. (nullable)
- `checkOutDate` (string(date)): The date the guest checked out, or is expected to. (nullable)
- `nights` (integer(int32)): How many nights the stay covers. Conditional: When Nights is not null. Range: 1 to 99. (nullable)
- `folioNumber` (string): The property's own reference for the guest's bill. (nullable, max length 22)
- `saleCode` ([LodgingSaleCode](https://devportal.demo.winkpg.io/docs/api/models/LodgingSaleCode.md)): What kind of lodging charge this is. Conditional: When SaleCode is not null. (nullable)
  Values:
  - `Sale`: An ordinary stay, settled against the guest's folio.
  - `NoShow`: A guaranteed reservation the guest did not arrive for, charged under the property's no-show policy.
  - `Deposit`: An advance deposit taken against a future stay.
  - `DelayedCharge`: A charge added after the guest checked out, for something attributable to the stay (a bar tab posted late, a room found damaged).
  - `ExpressService`: Express checkout: the folio is settled without the guest presenting the card again.
  - `AssuredReservation`: A reservation the property guaranteed to hold, which is what makes a later NoShow chargeable.
- `chargeDescriptor` ([LodgingChargeDescriptor](https://devportal.demo.winkpg.io/docs/api/models/LodgingChargeDescriptor.md)): Which part of the property the charge arose in. Conditional: When ChargeDescriptor is not null. (nullable)
  Values:
  - `Lodging`: A room charge. The ordinary case.
  - `Restaurant`: A restaurant charge.
  - `GiftShop`: A gift-shop charge.
  - `HealthClub`: A health-club or spa charge.
  - `HairSalon`: A hair-salon charge.
  - `ConventionFees`: A convention or meeting-room fee.
  - `TennisClub`: A tennis-club charge.
  - `GolfShop`: A golf-shop charge.
- `extraCharges` ([LodgingExtraCharges](https://devportal.demo.winkpg.io/docs/api/models/LodgingExtraCharges.md)): The ancillary items the folio included beyond the room. Conditional: When ExtraCharges is not null. Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names. (nullable)
  Values:
  - `None`: Room charges only. An explicit statement, not an absent one.
  - `Restaurant`: Restaurant charges.
  - `GiftShop`: Gift-shop charges.
  - `MiniBar`: Mini-bar charges.
  - `Telephone`: Telephone charges.
  - `Laundry`: Laundry charges.
  - `Other`: Charges that fit none of the named categories.
- `extraChargeAmount` (number(double)): How much of the amount is accounted for by `extraCharges`. Conditional: When ExtraChargeAmount is not null. Must be > 0. (nullable)
- `preferredCustomer` (boolean): Whether the guest is enrolled in the property's loyalty programme. (nullable)

## See also

- [All documentation](https://devportal.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.