bookingBusiness resource type

Namespace: microsoft.graph

Represents a business in Microsoft Bookings. This is the top level object in the Microsoft Bookings API. It contains business information and related business objects such as appointments, customers, services, and staff members.

Methods

Method	Return Type	Description
List	bookingBusiness collection	Get a collection of bookingBusiness objects in the tenant.
Create	bookingBusiness	Create a new Microsoft Bookings business.
Get	bookingBusiness	Read properties and relationships of a bookingBusiness object.
Update	bookingBusiness	Update the properties of a bookingBusiness object.
Delete	None	Delete a bookingBusiness object.
Create bookingAppointment	bookingAppointment	Create a new bookingAppointment by posting to the appointments collection.
List appointments	bookingAppointment collection	Get a bookingAppointment object collection.
Create bookingCustomer	bookingCustomer	Create a new bookingCustomer by posting to the customers collection.
List customers	bookingCustomer collection	Get a bookingCustomer object collection.
Create bookingService	bookingService	Create a new bookingService by posting to the services collection.
List services	bookingService collection	Get a bookingService object collection.
Create bookingStaffMember	bookingStaffMember	Create a new bookingStaffMember by posting to the staffMembers collection.
List staffMembers	bookingStaffMember collection	Get a bookingStaffMember object collection.
List customQuestions	bookingCustomQuestion collection	Get the bookingCustomQuestion resources from the customQuestions navigation property.
Create bookingCustomQuestion	bookingCustomQuestion	Create a new bookingCustomQuestion object.
List calendarView	bookingAppointment collection	Get the collection of bookingAppointment objects that occurs in the specified date range.
Publish	None	Make the scheduling page of this business available to external customers. Set the isPublished property to true, and publicUrl property to the URL of the scheduling page.
Unpublish	None	Make the scheduling page of this business not available to external customers. Set the isPublished property to false, and the publicUrl property to null.
Get staff availability	staffAvailabilityItem collection	Get the availability information of staff members of a Microsoft Bookings calendar.

Properties

Property	Type	Description
address	physicalAddress	The street address of the business. The address property, together with phone and webSiteUrl, appear in the footer of a business scheduling page. The attribute type of physicalAddress is not supported in v1.0. Internally we map the addresses to the type others.
bookingPageSettings	bookingPageSettings	Settings for the published booking page.
businessHours	bookingWorkHours collection	The hours of operation for the business.
businessType	String	The type of business.
createdDateTime	DateTimeOffset	The date, time, and time zone when the booking business was created. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
defaultCurrencyIso	String	The code for the currency that the business operates in on Microsoft Bookings.
displayName	String	The name of the business, which interfaces with customers. This name appears at the top of the business scheduling page.
email	String	The email address for the business.
id	String	A unique programmatic identifier for the business. Read-only.
isPublished	Boolean	The scheduling page has been made available to external customers. Use the publish and unpublish actions to set this property. Read-only.
languageTag	String	The language of the self-service booking page.
lastUpdatedDateTime	DateTimeOffset	The date, time, and time zone when the booking business was last updated. The timestamp type represents date and time information using ISO 8601 format and is always in UTC. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z.
phone	String	The telephone number for the business. The phone property, together with address and webSiteUrl, appear in the footer of a business scheduling page.
publicUrl	String	The URL for the scheduling page, which is set after you publish or unpublish the page. Read-only.
schedulingPolicy	bookingSchedulingPolicy	Specifies how bookings can be created for this business.
webSiteUrl	String	The URL of the business web site. The webSiteUrl property, together with address, phone, appear in the footer of a business scheduling page.

Relationships

Relationship	Type	Description
appointments	bookingAppointment collection	All the appointments of this business. Read-only. Nullable.
calendarView	bookingAppointment collection	The set of appointments of this business in a specified date range. Read-only. Nullable.
customers	bookingCustomer collection	All the customers of this business. Read-only. Nullable.
customQuestions	bookingCustomQuestion collection	All the custom questions of this business. Read-only. Nullable.
services	bookingService collection	All the services offered by this business. Read-only. Nullable.
staffMembers	bookingStaffMember collection	All the staff members that provide services in this business. Read-only. Nullable.

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.bookingBusiness",
  "address": {"@odata.type": "microsoft.graph.physicalAddress"},
  "bookingPageSettings": {"@odata.type": "microsoft.graph.bookingPageSettings"},
  "businessHours": [{"@odata.type": "microsoft.graph.bookingWorkHours"}],
  "businessType": "String",
  "createdDateTime": "String (timestamp)",
  "defaultCurrencyIso": "String",
  "displayName": "String",
  "email": "String",
  "id": "String (identifier)",
  "isPublished": "Boolean",
  "languageTag": "String",
  "lastUpdatedDateTime": "String (timestamp)",
  "phone": "String",
  "publicUrl": "String",
  "schedulingPolicy": {"@odata.type": "microsoft.graph.bookingSchedulingPolicy"},
  "webSiteUrl": "String"
}