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 - Marcações
—Este endpoint visa gerir as marcações na agenda.
POST /bookings/create |
POST /bookings/:id/update |
POST /bookings/:id/update/time |
POST /bookings/:id/delete |
POST /bookings/:id/invoice/create |
POST /bookings/check_availability |
POST /bookings/summary |
POST /bookings/find |
Agenda - Marcações - Criar
ID do cliente
Contribuinte do cliente. No caso de não preenchimento será assumido o valor 999999990.
Data de início da marcação, no formato ano-mes-dia horas:minutos
Data de fim da marcação, no formato ano-mes-dia horas:minutos
Se deve ignorar validações da hora da marcação, como por exemplo a data seleccionada já se encontrar ocupada
Descrição da marcação. Se preenchido irá sobrepor-se ao nome do cliente na agenda.
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.
Colaborador a quem está atribuída a marcação. Pode ser enviado o ID ou o email.
Forma de pagamento. Pode ser enviado o ID ou o descritivo, exemplo: Numerário, Transferência bancária, etc.
Estado da marcação. Deve ser enviado um dos seguintes valores: Pendente ou Confirmado.
Determina se a marcação se encontra paga
Observações da marcação
Lista de artigos que constam na marcação.
ID ou referência do artigo
Preço unitário
Quantidade
Desconto percentual
Request POST /bookings/create
{
"customer": ..
"vat_number": ..
"start_at": ..
"end_at": ..
"ignore_validations": ..
"description": ..
"location": ..
"employee": ..
"payment_method": ..
"status": ..
"paid": ..
"observations": ..
"items":
[
{
"id": ..
"price": ..
"quantity": ..
"discount": ..
}
],
}Response 200
{
"status": true,
"data":
{
"id": ..
"number": ..
"description": ..
"sale_id": ..
"location_id": ..
"customer_id": ..
"customer_vat_number": ..
"employee_id": ..
"payment_method_id": ..
"start_at": ..
"end_at": ..
"ignore_validations": ..
"gross_total": ..
"total_discount": ..
"net_total": ..
"total_vat": ..
"grand_total": ..
"sms_alert_sent": ..
"email_alert_sent": ..
"email_invoice_sent": ..
"paid": ..
"paid_at": ..
"status": ..
"observations": ..
"created_by": ..
"updated_at": ..
"created_at": ..
"sale": [],
"customer": [],
"location": [],
"employee": [],
"paymentmethod": [],
"items": [],
"createdby": [],
}
}Sugerimos que teste e valide a resposta completa numa plataforma de testes de API como por exemplo Postman ou Insomnia.
- 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 início não pode ser inferior à data actual
- A data início e fim não se encontra dentro do horário da agenda configurado
- A data / hora fim não pode ser inferior à data início
- O estado introduzido não existe
- Seleccione pelo menos um artigo
- A marcação tem o limite máximo de 20 artigos
- O cliente não existe
- O cliente não se encontra activo
- A data da marcação encontra-se ocupada
- Um ou mais artigos mal preenchidos, na linha: X
- O artigo não existe
- Não preencheu todos os campos obrigatórios nos artigos
- Não preencheu correctamente o preço unitário (formato aceite: 0,00000 ou 0.00000)
- Não preencheu correctamente a quantidade (formato aceite: 0,00000 ou 0.00000)
- Não preencheu correctamente o desconto (formato aceite: 0,00 ou 0.00)
- O total não pode ser negativo ou igual a zero