Introdução
Autenticação
Resposta e erros
SDKs e plugins
Países
Isenções IVA
Changelog
Vendas
Recibos
Clientes
Clientes - Contas em aberto
Artigos
Artigos - Stock
Artigos - Movimentos stock
Agenda - Marcações
Agenda - Indisponibilidades
Administração
Administração - Armazéns
Administração - Categorias
Administração - Colaboradores
Administração - Condições de pagamento
Administração - Formas de pagamento
Administração - Modos de expedição
Administração - Moedas
Administração - Preços
Administração - Séries
Administração - Taxas de IVA
Administração - Tipos de documento
Administração - Veículos
Administração - Unidades
Subscrição - Locais
Agenda - Indisponibilidades
—Este endpoint visa gerir as indisponibilidades na agenda.
Endpoints
POST /bookings/unavailables/create |
POST /bookings/unavailables/:id/update |
POST /bookings/unavailables/:id/delete |
Agenda - Indisponibilidades - Criar
reason
string
required
Razão da indisponibilidade. Deve ser enviado um dos seguintes valores: Doença
, Férias
, Almoço
, Folga
, Outro
.
location
mixed
Local da marcação. Pode ser enviado o ID ou nome do local. No caso de não preenchimento será assumido o local pré-definido.
employee
mixed
Colaborador a quem está atribuída a marcação. Pode ser enviado o ID ou o email.
observations
string
Observações da indisponibilidade
dates
json array
required
Lista de datas que constam na indisponibilidade. Serão geradas tantas indisponibilidades quanto o nº de elementos / datas
start_at
datetime
required
Data de início da marcação, no formato ano-mes-dia horas:minutos
end_at
datetime
required
Data de fim da marcação, no formato ano-mes-dia horas:minutos
Request POST /bookings/unavailables/create
{
"reason": ..
"location": ..
"employee": ..
"observations": ..
"dates":
[
{
"start_at": ..
"end_at": ..
}
],
}
Response 200
{
"status": true,
"data":
{
[
"id": ..
"start_at": ..
"end_at": ..
"reason": ..
"observations": ..
"employee": [],
"location": [],
],
[
"id": ..
"start_at": ..
"end_at": ..
"reason": ..
"observations": ..
"employee": [],
"location": [],
],
},
}
Possíveis erros
- Não tem permissões para executar esta operação
- Não preencheu todos os campos obrigatórios
- A data início ou fim não contêm um formato válido (ano-mês-dia horas:minutos)
- A data / hora fim não pode ser inferior à data início
- As datas não aparentam estar no formato adequado