Alojamento
Mapa de reservas, quartos, folios e limpezas.
O mapa é o ecrã principal: quartos em linhas, dias em colunas, e a reserva faz-se a arrastar. O folio é a conta da estadia, e recebe as diárias e o que o hóspede consumir noutros módulos, incluindo a mesa do restaurante.
O que a licença destranca
Este módulo exige a funcionalidade hoteleiro na licença. Sem ela, as rotas dele respondem 403 e o menu não o mostra.
Precisa de: armazem, comercial. Sem eles, este módulo não faz o que promete.
Aproveita: restaurante, rh. Sem eles funciona, e faz menos.
É o módulo principal de: Hotéis e alojamento local.
O que se consegue ver a acontecer
- Uma reserva cria-se a arrastar sobre os dias livres de um quarto
- O check-in abre o folio, e o check-out fecha-o e emite a fatura
- Um consumo do restaurante pode ir para o folio do quarto
- O quarto passa a sujo no check-out, e volta a livre quando a limpeza o marca
Os 58 endpoints
Saem da árvore de rotas montada, que é a mesma que serve os pedidos. A referência completa, com corpos e respostas, está em /api.
| Método | Caminho | O que faz |
|---|---|---|
GET |
/api/v1/hoteleiro/configuracao |
As decisões deste hotel |
PUT |
/api/v1/hoteleiro/configuracao |
Grava as decisões deste hotel |
GET |
/api/v1/hoteleiro/disponibilidade |
O mapa de ocupação, por quarto e por dia |
GET |
/api/v1/hoteleiro/folios/:id |
A conta corrente de um quarto |
POST |
/api/v1/hoteleiro/folios/:id/itens |
Lança um consumo na conta do quarto |
GET |
/api/v1/hoteleiro/folios/:id/pdf |
A conta do quarto em papel |
DELETE |
/api/v1/hoteleiro/folios/itens/:id |
Tira uma linha da conta |
GET |
/api/v1/hoteleiro/hospedes |
Procura hóspedes |
POST |
/api/v1/hoteleiro/hospedes |
Regista um hóspede |
GET |
/api/v1/hoteleiro/hospedes/:id |
Mostra um hóspede |
PUT |
/api/v1/hoteleiro/hospedes/:id |
Atualiza um hóspede |
GET |
/api/v1/hoteleiro/hospedes/:id/historico |
As estadias de alguém, da mais recente para trás |
GET |
/api/v1/hoteleiro/limpezas |
As tarefas de limpeza |
POST |
/api/v1/hoteleiro/limpezas |
Cria uma tarefa de limpeza à mão |
GET |
/api/v1/hoteleiro/limpezas/:id |
Mostra uma tarefa |
POST |
/api/v1/hoteleiro/limpezas/:id/atribuir |
Dá a tarefa a alguém |
POST |
/api/v1/hoteleiro/limpezas/:id/concluir |
A limpeza está feita |
POST |
/api/v1/hoteleiro/limpezas/:id/iniciar |
A camareira começou |
POST |
/api/v1/hoteleiro/limpezas/:id/inspecionar |
A governanta deu por boa, e o quarto volta à venda |
POST |
/api/v1/hoteleiro/limpezas/:id/reprovar |
A limpeza volta para trás, com o motivo |
POST |
/api/v1/hoteleiro/limpezas/gerar |
Gera as tarefas de um dia |
GET |
/api/v1/hoteleiro/politicas |
As políticas de cancelamento |
POST |
/api/v1/hoteleiro/politicas |
Cria uma política de cancelamento |
DELETE |
/api/v1/hoteleiro/politicas/:id |
Apaga uma política |
PUT |
/api/v1/hoteleiro/politicas/:id |
Atualiza uma política |
GET |
/api/v1/hoteleiro/quartos |
Os quartos do hotel |
POST |
/api/v1/hoteleiro/quartos |
Cria um quarto |
DELETE |
/api/v1/hoteleiro/quartos/:id |
Apaga um quarto |
GET |
/api/v1/hoteleiro/quartos/:id |
Mostra um quarto, com a categoria |
PUT |
/api/v1/hoteleiro/quartos/:id |
Atualiza um quarto |
PUT |
/api/v1/hoteleiro/quartos/:id/estado |
Muda o estado de um quarto |
GET |
/api/v1/hoteleiro/relatorios/canais |
Reservas e receita por canal de origem |
GET |
/api/v1/hoteleiro/relatorios/ocupacao |
Taxa de ocupação por dia e por tipo de quarto |
GET |
/api/v1/hoteleiro/relatorios/previsao-ocupacao |
O que já está reservado para a frente |
GET |
/api/v1/hoteleiro/relatorios/receita |
Receita de alojamento contra receita de extras |
GET |
/api/v1/hoteleiro/relatorios/revpar |
RevPAR, diária média e ocupação, na mesma tabela |
GET |
/api/v1/hoteleiro/reservas |
Lista as reservas |
POST |
/api/v1/hoteleiro/reservas |
Abre uma reserva, com os preços congelados noite a noite |
GET |
/api/v1/hoteleiro/reservas/:id |
Mostra uma reserva, com os quartos, as noites e as contas |
POST |
/api/v1/hoteleiro/reservas/:id/cancelar |
Cancela a reserva e aplica a política |
POST |
/api/v1/hoteleiro/reservas/:id/check-in |
Dá entrada ao hóspede e abre a conta do quarto |
POST |
/api/v1/hoteleiro/reservas/:id/check-out |
Fecha as contas, emite as faturas e liberta os quartos |
POST |
/api/v1/hoteleiro/reservas/:id/confirmar |
Dá a reserva por garantida |
PUT |
/api/v1/hoteleiro/reservas/:id/datas |
Muda as datas e recalcula as noites |
POST |
/api/v1/hoteleiro/reservas/:id/deposito |
Recebe um adiantamento e emite o documento |
GET |
/api/v1/hoteleiro/reservas/:id/folios |
As contas de uma reserva |
GET |
/api/v1/hoteleiro/reservas/:id/simular-cancelamento |
Quanto se retém se cancelar agora |
GET |
/api/v1/hoteleiro/reservas/:id/simular-datas |
Quanto custaria mudar as datas |
POST |
/api/v1/hoteleiro/reservas/grupo |
Abre uma reserva de grupo, com uma reserva por quarto |
GET |
/api/v1/hoteleiro/tarifas |
Os planos tarifários |
POST |
/api/v1/hoteleiro/tarifas |
Cria um plano tarifário |
DELETE |
/api/v1/hoteleiro/tarifas/:id |
Apaga um plano tarifário |
PUT |
/api/v1/hoteleiro/tarifas/:id |
Atualiza um plano tarifário |
GET |
/api/v1/hoteleiro/tarifas/simular |
O preço de uma estadia, noite a noite |
GET |
/api/v1/hoteleiro/tipos-quarto |
As categorias de alojamento |
POST |
/api/v1/hoteleiro/tipos-quarto |
Cria uma categoria de alojamento |
GET |
/api/v1/hoteleiro/tipos-quarto/:id |
Mostra uma categoria |
PUT |
/api/v1/hoteleiro/tipos-quarto/:id |
Atualiza uma categoria |
Esta página é gerada a partir do código do módulo, com make docs-modulos. O que aqui está muda no mesmo commit em que o módulo muda.