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.
Values
Values:
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.
Fields
| Field | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
checkInDate
required |
string (date) | The date the guest checked in, or is expected to.
nullable
Values:
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.
| ||||||||||||||||
checkOutDate
required |
string (date) | The date the guest checked out, or is expected to.
nullable
Values:
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.
| ||||||||||||||||
nights
required |
integer (int32) | How many nights the stay covers.
Conditional: When Nights is not null. Range: 1 to 99.
nullable
Values:
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.
| ||||||||||||||||
folioNumber
required |
string | The property's own reference for the guest's bill.
nullablemax length 22
Values:
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.
| ||||||||||||||||
saleCode
required |
LodgingSaleCode LodgingSaleCode | What kind of lodging charge this is.
Conditional: When SaleCode is not null.
nullable
Values:
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.
| ||||||||||||||||
chargeDescriptor
required |
LodgingChargeDescriptor LodgingChargeDescriptor | Which part of the property the charge arose in.
Conditional: When ChargeDescriptor is not null.
nullable
Values:
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.
| ||||||||||||||||
extraCharges
required |
LodgingExtraCharges LodgingExtraCharges | 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:
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.
| ||||||||||||||||
extraChargeAmount
required |
number (double) | How much of the amount is accounted for by `extraCharges`.
Conditional: When ExtraChargeAmount is not null. Must be > 0.
nullable
Values:
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.
| ||||||||||||||||
preferredCustomer
required |
boolean | Whether the guest is enrolled in the property's loyalty programme.
nullable
Values:
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.
|
This model has no documented fields.