bookings

Modified on: Thu, 5 Sep, 2024 at 3:52 PM

Print

Here you can find all details about the booking as well as the references to the other tables it is connected with.

Fields

Field nameTypeDescription/Notes
idINTEGERUnique identifier of the booking across the entire Clock PMS+ ecosystem*
account_idINTEGERIdentification of the account owning the . Reference to accounts table*
numberSTRINGUser defined number of the booking. Please note the numbers are not unique and may be duplicated. The number may contain prefix and suffix*
arrivalDATEArrival date (YYYY-MM-DD)*
arrival_timeSTRINGArrival time as specified by the staff or OTA. Please note the the format depends on the user input and hence is not necessarily structured as time
transfer_arrivalSTRINGFlight or other traveling information
early_arrivalBOOLEANtrue/false*
departureDATEDeparture date (YYYY-MM-DD)*
departure_timeSTRINGDeparture time as specified by the staff or OTA. Please note the the format depends on the user input and hence is not necessarily structured as time
transfer_departureSTRINGFlight or other traveling information
late_departureBOOLEANtrue/false*
created_atTIMESTAMPTime when the booking is created in (Date and time in UTC)*
updated_atTIMESTAMPTime when the booking is updated for the last time (Date and time in UTC)*
user_createdSTRINGName of the Clock PMS+ user created the booking*
user_updatedSTRINGName of the Clock PMS+ user updated the booking*
statusSTRINGBooking status can be: 'expected', 'checked_in', 'checked_out', 'canceled' or 'no_show'. Bookings having the last two statuses ('canceled' or 'no_show') are considered not to be valid bookings. Such bookings are not calculated into availability.*
status_changed_atTIMESTAMPDatetime of the last status change (Date and time in UTC)*
adultsINTEGERNumber of adults for price calculation. Optional
childrenINTEGERNumber of children for price calculation. Optional
children_agesSTRINGChildren ages for price calculation. Optional
company_idINTEGERUnique ID of the company if the booking is associated one. Reference to Companies table
company_nameSTRINGName of the company
company_branchSTRINGIdentifier of the branch of the selected company (London, New York,... East, west, etc)
agent_idINTEGERUnique ID of the agent if the booking is associated one. Reference to Companies table
agent_nameSTRINGAgent name
agent_branchSTRINGIdentifier of the branch of the selected agent (London, New York,... East, west, etc)
event_idINTEGERUnique ID of the event if the booking is associated one. Reference to the Events table
event_nameSTRINGEvent name
block_idINTEGERID of the room block if the booking is associated with one. Reference to the Blocks table
block_nameSTRINGName of the block
reference_numberSTRINGReference to external number of the booking (OTA, CRS, etc)
reference_dateDATEThe date for the reference (YYYY-MM-DD)
is_guaranteedBOOLEANtrue/false*
guarantee_policy_idINTEGERIdentifier of the guarantee policy associated with the booking
guarantee_policy_nameSTRINGName of the guarantee policy
rate_idINTEGERIdentifier of the rate if used
rate_nameSTRINGName of the rate
manual_pricesSTRINGManual price of the booking. If the prices are different for the dates they will separated with comma
manual_currencySTRINGISO 4217 currency codes
restaurantSTRINGWhich restaurant the guests will use for the meals included in the package
mealsSTRINGMeals included in the package
room_type_idINTEGERUnique ID room type
room_type_nameSTRINGName of the room type
report_segment_idINTEGERRelation to report_segments table which is holding the segmentation information for the booking*
accept_charge_transfersBOOLEANtrue/false specifies if the booking may accept additional charges for Clock POS or other system*
commission_value_centsINTEGERCalculated commission for the booking
commission_currencySTRINGISO 4217 currency codes
commission_payment_dateDATEWhen the commission was paid (YYYY-MM-DD)
commission_checkedBOOLEANtrue/false*
commission_notesSTRINGNotes for the commission
commission_recipientSTRINGIf not empty the possible values are 'agent' or 'company'
city_tax_modeSTRING
  • If the city ax mode is selected the possible values are 'no_city_tax' meaning no city tax will be calculated
  • 'city_tax_add' meaning the city tax is added on top of the rate price as a separate charge
  • 'city_tax_included_modificator' meaning the ax is included in and will be posted with a separate charge
  • 'city_tax_included_charge' meaning the included in the rate price and will not be posted separately
citytax_adultsINTEGERNumber of adults to be used for city tax calculation
citytax_childrenINTEGERNumber of children to be used for city tax calculation
notesSTRINGBooking notes
housekeeping_notesSTRINGHousekeeping notes
meals_notesSTRINGMeal notes
client_requestsSTRINGClient requests
guest_profile_idINTEGERMain guest profile id. reference to guests table*
contact_person_id
INTEGER
Booking's contact person id. reference to guests table*
room_charges_grossINTEGERGROSS value of all Room charges (revenue_group=rooms) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
room_charges_netINTEGERNET value of all Room charges (revenue_group=rooms) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
fb_grossINTEGERGROSS value of all F&B charges (revenue_group=f&b) associated with the booking regardless if they are paid ord who will pay for them (booker another booker or company)
fb_netINTEGERNET value of all F&B charges (revenue_group=f&b) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
extra_grossINTEGERGROSS value of all Extra charges (revenue_group=extra) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
extra_netINTEGERNET value of all Extra charges (revenue_group=extra) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
other_grossINTEGERGROSS value of all Other charges (revenue_group=other) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
other_netINTEGERNET value of all Other charges (revenue_group=other) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
tax_grossINTEGERGROSS value of all Tax charges (revenue_group=tax) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
tax_netINTEGERNET value of all Tax charges (revenue_group=tax) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
packages_grossINTEGERGROSS value of all Package charges (revenue_group=package) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
packages_netINTEGERNET value of all Package charges (revenue_group=package) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
deposit_grossINTEGERGROSS value of all Deposit charges (revenue_group=deposit) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
deposit_netINTEGERNET value of all Deposit charges (revenue_group=deposit) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
surcharge_grossINTEGERGROSS value of all Surcharge charges (revenue_group=surcharge) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
surcharge_netINTEGERGROSS value of all Surcharge charges (revenue_group=surcharge) associated with the booking regardless if they are paid or who will pay for them (booker another booker or company)
total_valueINTEGERTotal amount of all charges in folios payable by the booking. Please note it may be different than the summary of all above charges value because some of those may be transferred to companies or other booking's folios
currencySTRINGISO 4217 currency codes
* Field will have value for every record

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.

On this page