Adueladocumentação

Restaurante

Salão, comandas, ecrã de cozinha e fichas técnicas.

A ficha técnica é o que faz o economato descer sozinho: diz o que sai do armazém quando se vende um prato. Sem fichas vende-se na mesma, e ao fim do mês ninguém sabe onde foi parar o azeite.

O que a licença destranca

Este módulo exige a funcionalidade restaurante 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: hoteleiro, rh. Sem eles funciona, e faz menos.

É o módulo principal de: Restaurantes e bares.

O que se consegue ver a acontecer

  • O mapa do salão mostra as mesas como elas estão na sala
  • Um pedido enviado aparece no ecrã da cozinha, por ordem de chegada
  • Fechar a conta desce os ingredientes pelo que as fichas técnicas dizem
  • Uma conta pode dividir-se por pessoa

Os 49 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/restaurante/configuracao As decisões desta casa
PUT /api/v1/restaurante/configuracao Grava as decisões desta casa
GET /api/v1/restaurante/contas-por-pagar As contas que ficaram em dívida
POST /api/v1/restaurante/contas/:id/dividir Reparte a conta
POST /api/v1/restaurante/contas/:id/fechar Fecha a conta e emite o que houver a emitir
GET /api/v1/restaurante/contas/:id/pre-conta A conta para o cliente conferir, em ESC/POS
GET /api/v1/restaurante/estacoes Os postos de produção
POST /api/v1/restaurante/estacoes Cria um posto
PUT /api/v1/restaurante/estacoes/:id Muda um posto
POST /api/v1/restaurante/estacoes/:id/produtos Manda uma lista de pratos para esta estação
GET /api/v1/restaurante/eventos Fluxo de eventos do salão (SSE)
GET /api/v1/restaurante/fichas As receitas da casa
POST /api/v1/restaurante/fichas Grava a receita de um prato
GET /api/v1/restaurante/fichas/:id Uma receita com os ingredientes
PUT /api/v1/restaurante/fichas/:id Grava a receita de um prato
GET /api/v1/restaurante/fichas/:id/custo O custo de uma dose, decomposto
POST /api/v1/restaurante/fichas/:id/recalcular Reapura e grava o custo da dose
GET /api/v1/restaurante/folios As contas de quarto onde se pode debitar
DELETE /api/v1/restaurante/itens/:id Apaga um prato que ainda não foi para a cozinha
PUT /api/v1/restaurante/itens/:id/estado Faz o prato andar no seu ciclo
PUT /api/v1/restaurante/itens/:id/pronto Marca um prato pronto
GET /api/v1/restaurante/kds A fila de uma estação
GET /api/v1/restaurante/mesas O mapa de salão
POST /api/v1/restaurante/mesas Põe uma mesa na sala
GET /api/v1/restaurante/mesas/:id Uma mesa
PUT /api/v1/restaurante/mesas/:id Muda uma mesa
PUT /api/v1/restaurante/mesas/:id/estado Muda a mesa de estado
POST /api/v1/restaurante/mesas/:id/separar Desencosta as mesas desta
POST /api/v1/restaurante/mesas/:id/unir Encosta mesas a esta
GET /api/v1/restaurante/pedidos As comandas
POST /api/v1/restaurante/pedidos Abre uma comanda, ou acrescenta à que a mesa já tem
GET /api/v1/restaurante/pedidos/:id Uma comanda com os pratos
POST /api/v1/restaurante/pedidos/:id/cancelar Cancela a comanda inteira
GET /api/v1/restaurante/pedidos/:id/conta A conta de uma comanda, criando-a se ainda não existir
POST /api/v1/restaurante/pedidos/:id/enviar-cozinha Manda os pratos pendentes para os postos
POST /api/v1/restaurante/pedidos/:id/itens Acrescenta pratos a uma comanda
GET /api/v1/restaurante/pratos-sem-ficha O que se vendeu sem descontar nada do armazém
GET /api/v1/restaurante/relatorios/cancelamentos O que se anulou, por motivo e por empregado
GET /api/v1/restaurante/relatorios/consumo-ingredientes Teórico pela ficha contra real do armazém
GET /api/v1/restaurante/relatorios/ocupacao-mesas Rotação por mesa e por hora do dia
GET /api/v1/restaurante/relatorios/pratos-mais-vendidos Quantidade, receita e margem por prato
GET /api/v1/restaurante/relatorios/tempo-preparacao Quanto a cozinha demora, por estação
GET /api/v1/restaurante/roteamento Que prato vai para que estação
GET /api/v1/restaurante/salas Os espaços da casa
POST /api/v1/restaurante/salas Cria um espaço
PUT /api/v1/restaurante/salas/:id Muda um espaço
GET /api/v1/restaurante/taloes A fila de impressão
GET /api/v1/restaurante/taloes/:id/bytes O talão em ESC/POS
POST /api/v1/restaurante/taloes/:id/reimprimir Volta a mandar um talão à impressora

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.