bookingAppointment resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a customer appointment for a bookingService, performed by a set of staff members, provided by a Microsoft Bookings business.

Methods

Method	Return Type	Description
List	bookingAppointment collection	Get a list of bookingAppointment objects in the specified bookingbusiness.
Create	bookingAppointment	Create a new bookingAppointment for the specified bookingbusiness.
Get	bookingAppointment	Read the properties and relationships of bookingAppointment object.
Update	bookingAppointment	Update a bookingAppointment object.
Delete	None	Delete a bookingAppointment object.
Cancel appointment	None	Cancel a bookingAppointment object.

Properties

Property	Type	Description
additionalInformation	String	Additional information that is sent to the customer when an appointment is confirmed.
anonymousJoinWebUrl	String	The URL of the meeting to join anonymously.
appointmentLabel	String	The user can stamp a custom label on the appointment.
createdDateTime	DateTimeOffset	The date, time, and timezone when the appointment was created.
customerEmailAddress	String	The SMTP address of the bookingCustomer who is booking the appointment.
customerId	String	The ID of the bookingCustomer for this appointment. If no ID is specified when an appointment is created, then a new bookingCustomer object is created. Once set, you should consider the customerId immutable.
customerLocation	location	Represents location information for the bookingCustomer who is booking the appointment.
customerName	String	The customer's name.
customerNotes	String	Notes from the customer associated with this appointment. You can get the value only when you read this bookingAppointment by its ID. You can set this property only when you initially create an appointment with a new customer.
customerPhone	String	The customer's phone number.
customers	bookingCustomerInformation collection	A collection of the customer properties for an appointment. An appointment will contain a list of customer information and each unit will indicate the properties of a customer who is part of that appointment. Optional.
customerTimeZone	String	The time zone of the customer. For a list of possible values, see dateTimeTimeZone.
duration	Duration	The length of the appointment, denoted in ISO8601 format.
end	dateTimeTimeZone	The date, time, and time zone that the appointment ends.
filledAttendeesCount	Int32	The current number of customers in the appointment.
id	String	The ID of the bookingAppointment. Read-only.
invoiceAmount	Double	The billed amount on the invoice.
invoiceDate	dateTimeTimeZone	The date, time, and time zone of the invoice for this appointment.
invoiceId	String	The ID of the invoice.
invoiceStatus	string	The status of the invoice. Possible values are: draft, reviewing, open, canceled, paid, corrective.
invoiceUrl	String	The URL of the invoice in Microsoft Bookings.
isCustomerAllowedToManageBooking	Boolean	Indicates that the customer can manage bookings created by the staff. The default value is false.
isLocationOnline	Boolean	Indicates that the appointment is held online. The default value is false.
joinWebUrl	String	The URL of the online meeting for the appointment.
lastUpdatedDateTime	DateTimeOffset	The date, time and timezone when the booking business was last updated.
maximumAttendeesCount	Int32	The maximum number of customers allowed in an appointment. If maximumAttendeesCount of the service is greater than 1, pass valid customer IDs while creating or updating an appointment. To create a customer, use the Create bookingCustomer operation.
optOutOfCustomerEmail	Boolean	True indicates that the bookingCustomer for this appointment does not wish to receive a confirmation for this appointment.
postBuffer	Duration	The amount of time to reserve after the appointment ends, for cleaning up, as an example. The value is expressed in ISO8601 format.
preBuffer	Duration	The amount of time to reserve before the appointment begins, for preparation, as an example. The value is expressed in ISO8601 format.
price	Double	The regular price for an appointment for the specified bookingService.
priceType	bookingPriceType	A setting to provide flexibility for the pricing structure of services. Possible values are: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet, unknownFutureValue.
reminders	bookingReminder collection	The collection of customer reminders sent for this appointment. The value of this property is available only when reading this bookingAppointment by its ID.
selfServiceAppointmentId	String	Another tracking ID for the appointment, if the appointment was created directly by the customer on the scheduling page, as opposed to by a staff member on behalf of customer.
serviceId	String	The ID of the bookingService associated with this appointment.
serviceLocation	location	The location where the service is delivered.
serviceName	String	The name of the bookingService associated with this appointment. This property is optional when creating a new appointment. If not specified, it is computed from the service associated with the appointment by the serviceId property.
serviceNotes	String	Notes from a bookingStaffMember. The value of this property is available only when reading this bookingAppointment by its ID.
smsNotificationsEnabled	Boolean	True indicates SMS notifications will be sent to the customers for the appointment. Default value is false.
staffMemberIds	String collection	The ID of each bookingStaffMember who is scheduled in this appointment.
start	dateTimeTimeZone	The date, time, and time zone that the appointment begins.

Relationships

None

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.bookingAppointment",
  "id": "String (identifier)",
  "createdDateTime": "String (timestamp)",
  "lastUpdatedDateTime": "String (timestamp)",
  "selfServiceAppointmentId": "String",
  "additionalInformation": "String",
  "appointmentLabel": "String",
  "isLocationOnline": "Boolean",
  "joinWebUrl": "String",
  "smsNotificationsEnabled": "Boolean",
  "customerId": "String",
  "customerName": "String",
  "customerEmailAddress": "String",
  "customerPhone": "String",
  "customerLocation": {
    "@odata.type": "microsoft.graph.location"
  },
  "customerTimeZone": "String",
  "customerNotes": "String",
  "serviceId": "String",
  "serviceName": "String",
  "start": {
    "@odata.type": "microsoft.graph.dateTimeTimeZone"
  },
  "end": {
    "@odata.type": "microsoft.graph.dateTimeTimeZone"
  },
  "duration": "String (duration)",
  "preBuffer": "String (duration)",
  "postBuffer": "String (duration)",
  "serviceLocation": {
    "@odata.type": "microsoft.graph.location"
  },
  "priceType": "String",
  "price": "Double",
  "serviceNotes": "String",
  "reminders": [
    {
      "@odata.type": "microsoft.graph.bookingReminder"
    }
  ],
  "optOutOfCustomerEmail": "Boolean",
  "anonymousJoinWebUrl": "String",
  "customers": [
    {
      "@odata.type": "microsoft.graph.bookingCustomerInformation"
    }
  ],
  "maximumAttendeesCount": "Int32",
  "filledAttendeesCount": "Int32",
  "staffMemberIds": [
    "String"
  ],
  "invoiceAmount": "Double",
  "invoiceDate": {
    "@odata.type": "microsoft.graph.dateTimeTimeZone"
  },
  "invoiceId": "String",
  "invoiceStatus": "String",
  "invoiceUrl": "String",
  "isCustomerAllowedToManageBooking": "Boolean",
}