QuickBooks: Create a charge — response body — context lodging
Create a charge: response body, field context / lodging. Complete fields and constraints for contract 2026-10-20.
API reference · Contract 2026-10-20
SDK schema: Create a charge — response body — context lodging
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: allowed |
chargeType | string | Optional | Indicates the specific lodging or non-lodging service charged to the customer. Valid values: ConventionFees GiftShop Golf HealthClub Hotel Restaurant Salon Tennis |
checkInDate | string | Optional | The date of actual or anticipated check-in, depending on the transaction type. The check-in date can’t be later than the check-out date. The date format is dates is CCCC-MM-DD where: CCCC : The four-digit year MM : The two digit month DD : The Two digit day For example: June 5, 2019 is represented as 2019-06-05 . |
checkOutDate | string | Optional | The date of actual or anticipated check-out, depending on the transaction type. The check-out date must always be later than the check-in date. The date format is dates is CCCC-MM-DD where: CCCC : The four-digit year MM : The two digit month DD : The Two digit day For example: June 5, 2019 is represented as 2019-06-05 . |
extraCharges | array | Optional | Indicates if the current charge contains one or more additional charges. This field is only relevant for lodging apps. It indicates the types of extra charges billed to the customer. They usually apply after a customer checks out. Valid values: GiftShop Laundry Minibar Restaurant Telephone Other |
extraCharges[] | string | Each item | |
folioID | string | Optional | The unique ID that identifies the bill for a particular guest’s stay. This value can be assigned by a hotel or automatically by lodging apps. |
lengthOfStay | JSON | Optional | The anticipated, actual, or icremental length of stay, depending on the transaction type. Decimal string |
lengthOfStay (anyOf 1) | JSON | Alternative | |
lengthOfStay (anyOf 1) (anyOf 1) | number | Alternative | |
lengthOfStay (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
lengthOfStay (anyOf 2) | string | Alternative | |
roomRate | JSON | Optional | The nightly rate for the room. This field is only relevant for lodging apps. It should represent the nightly rate for the room as quoted at the time of reservation, including the taxes. If the reservation spans multiple days, provide the average rate for those days. Decimal string |
roomRate (anyOf 1) | JSON | Alternative | |
roomRate (anyOf 1) (anyOf 1) | number | Alternative | |
roomRate (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
roomRate (anyOf 2) | string | Alternative | |
specialProgram | string | Optional | Indicates if the current charge is a normal room charge, an advance deposit, and so forth. This field is only relevant for lodging apps. It indicates the reason for the charge. Valid values: AdvanceDeposit AssuredReservation DelayedCharge ExpressService NormalCharge NoShowCharge |
totalAuthAmount | JSON | Optional | The total amount authorized by the card issuer for the current credit card and the current FolioID . It refers to the total amount authorized for the particular card and folio and includes tax and other applicable charges. Apps are responsible for keeping a running total of authorizations and submitting the correct amount in this field. Decimal string |
totalAuthAmount (anyOf 1) | JSON | Alternative | |
totalAuthAmount (anyOf 1) (anyOf 1) | number | Alternative | |
totalAuthAmount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
totalAuthAmount (anyOf 2) | string | Alternative |