Tipo de recurso bookingAppointment

Namespace: microsoft.graph

Importante

As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor de versão.

Representa um compromisso do cliente para um bookingService, executado por um conjunto de membros da equipe, fornecido por um Microsoft Bookings negócios.

Observação

Se você criar um aplicativo personalizado usando permissões de aplicativo, deverá seguir a validação de regras de negócios.

Métodos

Método	Tipo de retorno	Descrição
Listar compromissos	coleção bookingAppointment	Obtenha uma lista de objetos bookingAppointment no bookingbusiness especificado.
Criar bookingAppointment	bookingAppointment	Crie um novo bookingAppointment para o bookingbusiness especificado.
Obter bookingAppointment	bookingAppointment	Leia as propriedades e as relações do objeto bookingAppointment .
Atualizar	Nenhum(a)	Atualize um objeto bookingAppointment .
Excluir	Nenhuma	Exclua um objeto bookingAppointment .
Cancel	Nenhuma	Cancele um objeto bookingAppointment .

Propriedades

Propriedade	Tipo	Descrição
additionalInformation	Cadeia de Caracteres	Informações adicionais que são enviadas ao cliente quando um compromisso é confirmado.
anonymousJoinWebUrl	Cadeia de Caracteres	URL da reunião para ingressar anonimamente.
customerEmailAddress	Cadeia de Caracteres	O endereço SMTP do bookingCustomer que está reservando o compromisso.
customerId	Cadeia de Caracteres	A ID do bookingCustomer para este compromisso. Se nenhuma ID for especificada quando um compromisso for criado, um novo objeto bookingCustomer será criado. Depois de definido, você deve considerar a customerId imutável.
customerLocation	location	Representa informações de localização para o bookingCustomer que está reservando o compromisso.
Customername	Cadeia de Caracteres	O nome do cliente.
customerNotes	Cadeia de Caracteres	Observações do cliente associadas a este compromisso. Você só pode obter o valor ao ler este bookingAppointment por sua ID. Você só pode definir essa propriedade ao criar inicialmente um compromisso com um novo cliente. Depois desse ponto, o valor é calculado do cliente representado por customerId.
customerPhone	Cadeia de Caracteres	O número de telefone do cliente.
Clientes	coleção bookingCustomerInformation	Ele lista as propriedades do cliente para um compromisso. Um compromisso conterá uma lista de informações do cliente e cada unidade indicará as propriedades de um cliente que faz parte desse compromisso. Opcional.
customerTimeZone	Cadeia de Caracteres	O fuso horário do cliente. Para obter uma lista de valores possíveis, consulte dateTimeTimeZone.
duração	Duration	O comprimento do compromisso, indicado no formato ISO8601 .
end	dateTimeTimeZone	A data, a hora e o fuso horário em que o compromisso termina.
filledAttendeesCount	Int32	O número atual de clientes no compromisso.
id	Cadeia de caracteres	A ID do bookingAppointment. Somente leitura.
invoiceAmount	Duplo	O valor cobrado na fatura.
invoiceDate	dateTimeTimeZone	A data, a hora e o fuso horário da fatura para este compromisso.
invoiceId	Cadeia de Caracteres	A ID da fatura.
invoiceStatus	string	O status da fatura. Os possíveis valores são: draft, reviewing, open, canceled, paid, corrective.
invoiceUrl	Cadeia de Caracteres	A URL da fatura em Microsoft Bookings.
isLocationOnline	Boolean	True indica que o compromisso será mantido online. O valor padrão é falso.
joinWebUrl	Cadeia de Caracteres	A URL da reunião online para o compromisso.
maximumAttendeesCount	Int32	O número máximo de clientes permitidos em um compromisso. Se maximumAttendeesCount do serviço for maior que 1, passe as IDs de cliente válidas ao criar ou atualizar um compromisso. Para criar um cliente, use a operação Criar bookingCustomer .
optOutOfCustomerEmail	Boolean	True indica que o bookingCustomer para este compromisso não deseja receber uma confirmação para este compromisso.
Postbuffer	Duration	A quantidade de tempo a ser reservado após o término do compromisso, para limpeza, como exemplo. O valor é expresso no formato ISO8601 .
Prebuffer	Duration	A quantidade de tempo a ser reservado antes do início do compromisso, para preparação, como exemplo. O valor é expresso no formato ISO8601 .
Preço	Duplo	O preço normal de um compromisso para o bookingService especificado.
priceType	bookingPriceType	Uma configuração para fornecer flexibilidade para a estrutura de preços dos serviços. Os valores possíveis são: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet, unknownFutureValue.
Lembretes	coleção bookingReminder	A coleção de lembretes de clientes enviados para este compromisso. O valor dessa propriedade está disponível somente ao ler este bookingAppointment por sua ID.
selfServiceAppointmentId	Cadeia de Caracteres	Uma ID de acompanhamento adicional para o compromisso, se o compromisso tiver sido criado diretamente pelo cliente na página de agendamento, em vez de um membro da equipe em nome do cliente.
serviceId	Cadeia de caracteres	A ID do bookingService associado a este compromisso.
serviceLocation	location	O local onde o serviço é entregue.
serviceName	Cadeia de Caracteres	O nome do bookingService associado a este compromisso. Essa propriedade é opcional ao criar um novo compromisso. Se não for especificado, ele será calculado do serviço associado ao compromisso pela propriedade serviceId .
serviceNotes	Cadeia de Caracteres	Anotações de um bookingStaffMember. O valor dessa propriedade está disponível somente ao ler este bookingAppointment por sua ID.
smsNotificationsEnabled	Boolean	True indica SMS notificações serão enviadas aos clientes para o compromisso. O valor padrão é falso.
staffMemberIds	Coleção de cadeias de caracteres	A ID de cada bookingStaffMember agendado neste compromisso.
iniciar	dateTimeTimeZone	A data, a hora e o fuso horário em que o compromisso começa.

Relações

Nenhum

Representação JSON

Veja a seguir uma representação JSON do recurso.

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