Referência

Referência

Todas as operações da API de integração, por área, com parâmetros, campos, permissões e exemplos reais.

A API de integração tem 902 operações, numa lista fechada: o que não está aqui não se alcança com uma chave. A mesma lista gera o ficheiro OpenAPI (para gerar um cliente na sua linguagem) e é a que o servidor aplica.

#Empresa e estabelecimentos

Quem é a empresa e quais são os seus estabelecimentos. É por aqui que se confirma que a chave está ligada à empresa certa.

GET /api/empresaOs dados da própria empresa: identificação fiscal, morada, contactos, contas bancárias e o estado da chave de assinatura.
GET /api/lojasOs estabelecimentos da empresa.
POST /api/lojasCria um estabelecimento.
PUT /api/lojas/{id}Altera um estabelecimento.
GET /api/pesquisaA pesquisa global: um texto procura em clientes, documentos, artigos e fornecedores.
GET /api/empresa/configuracao-geralA configuração geral da empresa (por agora, as cópias a imprimir por omissão).
PUT /api/empresa/configuracao-geralAltera a configuração geral da empresa.
GET /api/empresa/politica-vendasA política de vendas da empresa.
PUT /api/empresa/politica-vendasAltera a política de vendas da empresa.
GET /api/empresa/configuracao-fiscal-comprasA configuração fiscal das compras: as respostas da empresa que condicionam o seu tratamento.
GET /api/empresa/configuracao-fiscal-compras/historicoO histórico das alterações às respostas fiscais das compras.
GET /api/empresa/logotipoO logotipo da empresa.

#Catálogos

Os valores de referência que os outros pedidos usam: tipos de documento, métodos de pagamento, impostos, unidades, categorias. Quase nunca mudam: guarde-os localmente e actualize-os de vez em quando.

GET /api/catalogosTodos os catálogos fiscais numa só chamada: tipos de documento, métodos de pagamento, impostos, retenções, motivos de isenção, províncias e municípios.
GET /api/impostosAs taxas de imposto (IVA) que um artigo pode ter.
GET /api/moedasAs moedas registadas na empresa.
GET /api/metodos-pagamentoOs métodos de pagamento (numerário, Multicaixa, transferência…). O id é o que se envia nos pagamentos.
GET /api/documentos/tiposOs tipos de documento que a empresa pode emitir. O id de cada um é o tipoDocumentoId dos pedidos de emissão.
GET /api/documentos/seriesAs séries de numeração de cada tipo de documento, por estabelecimento.
GET /api/produtos/catalogos/{tipo}As listas de apoio do cadastro de artigos: categorias, unidades, marcas, modelos, fabricantes e tamanhos.
GET /api/condicoes-pagamentoAs condições de pagamento da empresa: o prazo para pagar uma factura a crédito.
POST /api/condicoes-pagamentoCria uma condição de pagamento.
PUT /api/condicoes-pagamento/{id}Altera uma condição de pagamento.
GET /api/taxas-retencaoAs taxas de retenção na fonte que um artigo ou um cliente pode ter.
GET /api/motivos-isencao-ivaOs motivos de isenção de IVA (os códigos legais) que um artigo isento tem de indicar.
GET /api/provinciasAs províncias de Angola.
GET /api/municipiosOs municípios de Angola.

#Clientes

A ficha dos clientes e a sua conta corrente. Um cliente «Especial» tem conta corrente, desconto e limite de crédito; um cliente que não escolher é o «Consumidor Final».

GET /api/clientesLista os clientes, por ordem alfabética.
GET /api/clientes/{id}A ficha completa de um cliente.
GET /api/clientes/{id}/extractoO extracto da conta corrente de um cliente: cada débito (factura a crédito) e crédito (recibo, nota de crédito), com o documento e o saldo depois do movimento.
GET /api/clientes/{id}/resumoO resumo de compras de um cliente: o total comprado, o número de documentos e o que está em dívida.
POST /api/clientesCria um cliente.
PUT /api/clientes/{id}Actualiza a ficha de um cliente.
DELETE /api/clientes/{id}Elimina um cliente da lista.
GET /api/clientes/{id}/extracto/pdfO extracto de conta de um cliente em PDF.
POST /api/clientes/{id}/extracto/enviarEnvia o extracto de conta ao cliente por e-mail.
POST /api/clientes/{id}/movimentosRegista um movimento manual na conta corrente de um cliente (um ajuste ou um acerto).

#Avenças

A facturação recorrente: um cliente, um valor e uma periodicidade. O sistema emite a factura de cada ciclo; nunca cobra sozinho.

GET /api/avencasLista as avenças (facturação recorrente).
POST /api/avencasCria uma avença.
GET /api/avencas/{id}/historicoO histórico de uma avença: as facturas que já gerou.
POST /api/avencas/{id}/pausarPausa uma avença: deixa de emitir até ser retomada.
POST /api/avencas/{id}/retomarRetoma uma avença pausada.
POST /api/avencas/{id}/cancelarCancela uma avença: não volta a emitir. As facturas já emitidas mantêm-se.
POST /api/avencas/gerar-pendentesEmite agora todas as facturas das avenças que estão por emitir.

#Fornecedores

Os fornecedores a quem a empresa compra: a ficha e o número de contribuinte que as compras e o mapa de fornecedores usam.

GET /api/fornecedoresLista os fornecedores.
GET /api/fornecedores/{id}A ficha de um fornecedor.
POST /api/fornecedoresCria um fornecedor.
PUT /api/fornecedores/{id}Actualiza a ficha de um fornecedor.
DELETE /api/fornecedores/{id}Elimina um fornecedor da lista.

#Artigos

Produtos e serviços: o cadastro, os níveis de preço, o imposto e a pesquisa para venda com o saldo de stock.

GET /api/produtosLista os artigos (produtos e serviços) com os preços e o custo.
GET /api/produtos/{id}O cadastro completo de um artigo.
GET /api/produtos/{id}/historico-custosO histórico do custo de um artigo: o custo unitário, desde quando vigora e de onde veio (compra ou actualização).
GET /api/produtos/pesquisa-vendaA pesquisa de artigos para vender: preços de todos os níveis, imposto e o saldo de stock no armazém.
GET /api/produtos/mais-vendidos-pdvOs identificadores dos artigos que mais saem: o separador «Mais vendidos» do ponto de venda.
GET /api/produtos/grupos-variacaoOs grupos de variação: artigos que são variações um do outro (tamanho, cor).
POST /api/produtosCria um artigo.
PUT /api/produtos/{id}Actualiza o cadastro de um artigo.
POST /api/produtos/{id}/activarVolta a activar um artigo desactivado.
POST /api/produtos/{id}/desactivarDesactiva um artigo: deixa de poder ser vendido, mas o histórico fica.
GET /api/produtos/sincronizacao-vendaO catálogo completo de artigos para venda, para guardar numa cópia local (sincronização de um ponto de venda ou de uma loja online).
PUT /api/produtos/{id}/composicaoDefine a composição de um conjunto (kit): os artigos e as quantidades que o formam.
POST /api/produtos/grupos-variacaoCria um grupo de variações («Camisola Polo»).
PUT /api/produtos/grupos-variacao/{id}Renomeia um grupo de variações.
DELETE /api/produtos/grupos-variacao/{id}Elimina um grupo de variações.
PUT /api/produtos/{id}/variacaoDefine o grupo e a variação («M · Azul») de um artigo.
POST /api/produtos/{id}/variacoesCria uma variação de um artigo, por cópia.
POST /api/produtos/{id}/variacoes/em-serieCria todas as variações de uma vez (tamanhos × cores).
PUT /api/produtos/{id}/unidades-vendaDefine as unidades de venda de um artigo (caixa, dúzia, unidade…).
POST /api/produtos/catalogos/{tipo}Cria um item de um catálogo de apoio dos artigos.
PUT /api/produtos/catalogos/{tipo}/{id}Altera um item de um catálogo de apoio dos artigos.
POST /api/produtos/catalogos/{tipo}/{id}/activarActiva um item de um catálogo de apoio.
POST /api/produtos/catalogos/{tipo}/{id}/desactivarDesactiva um item de um catálogo de apoio.

#Stock e armazéns

Armazéns, saldos, lotes e movimentos. Uma venda baixa o stock sozinha; aqui está o que se faz por fora de uma venda: compras (entradas) e saídas manuais.

GET /api/estoque/armazensOs armazéns, cada um com o estabelecimento a que pertence.
GET /api/estoque/armazens/{id}Um armazém.
GET /api/estoque/saldosOs saldos de stock, por artigo, armazém e lote.
GET /api/estoque/saldos/baixo-estoqueOs artigos abaixo do stock mínimo definido no cadastro.
GET /api/estoque/saldos/por-produtosO saldo de vários artigos de uma vez, num armazém.
GET /api/estoque/saldos/historico/{produtoId}Os movimentos de stock de um artigo (entradas, saídas, transferências), do mais recente para o mais antigo, com o saldo depois de cada um.
GET /api/estoque/lotesOs lotes (com validade) de um ou de todos os artigos.
GET /api/estoque/lotes/{id}Um lote.
GET /api/estoque/entradasAs compras (entradas de stock) registadas.
GET /api/estoque/entradas/{id}Uma compra, com as linhas, os custos e os pagamentos.
POST /api/estoque/entradasRegista uma compra a um fornecedor: dá entrada no stock e cria a conta a pagar.
GET /api/estoque/saidas-manuaisAs saídas manuais de stock (quebras, ofertas, consumo interno).
GET /api/estoque/saidas-manuais/{id}Uma saída manual.
POST /api/estoque/saidas-manuaisRegista uma saída de stock que não é uma venda, com o motivo.
POST /api/estoque/armazensCria um armazém num estabelecimento.
PUT /api/estoque/armazens/{id}Altera um armazém.
POST /api/estoque/armazens/{id}/predefinirFaz deste armazém o predefinido do estabelecimento (o que as vendas usam quando não se indica outro).
DELETE /api/estoque/armazens/{id}Elimina um armazém.
POST /api/estoque/lotesCria um lote (descrição e validade).
PUT /api/estoque/lotes/{id}Altera um lote.
DELETE /api/estoque/lotes/{id}Elimina um lote.
POST /api/estoque/saldos/retirarRetira stock de um artigo, sempre o mais antigo primeiro (FIFO).
POST /api/estoque/entradas-manuaisDá entrada de stock sem fornecedor nem factura (stock inicial, ajuste positivo de inventário).
POST /api/estoque/entradas/{id}/anexoAnexa à entrada de stock a imagem ou o PDF do documento do fornecedor.
GET /api/estoque/entradas/{id}/anexoDescarrega o anexo de uma entrada de stock.
DELETE /api/estoque/entradas/{id}/anexoRemove o anexo de uma entrada de stock.
POST /api/estoque/transferenciasTransfere stock de um armazém para outro.
GET /api/estoque/transferencias/recentesAs transferências mais recentes.
GET /api/estoque/transferencias/produtosPesquisa de artigos com stock no armazém de origem, para preparar uma transferência.
GET /api/estoque/transferencias/disponibilidadeO stock disponível no armazém de origem para uma lista de artigos.
GET /api/estoque/transferencias/estoque-no-destinoO stock que uma lista de artigos já tem no armazém de destino.
GET /api/estoque/transferencias/pendentesAs transferências à espera de confirmação.
POST /api/estoque/transferencias/{id}/confirmarConfirma uma transferência: o stock passa para o destino.
POST /api/estoque/transferencias/{id}/rejeitarRejeita uma transferência (com um motivo, opcional): o stock fica na origem.
GET /api/estoque/transferencias/{id}Uma transferência de stock, com as linhas.
GET /api/estoque/transferenciasLista as transferências de stock.
POST /api/estoque/reservas-stockCria um pedido de reserva de stock a um cliente, por um prazo.
GET /api/estoque/reservas-stock/activosOs pedidos de reserva de stock activos.
GET /api/estoque/reservas-stock/activos/resumoOs totais de todas as reservas de stock activas.
GET /api/estoque/reservas-stock/cliente/{clienteId}As reservas de stock activas de um cliente.
GET /api/estoque/reservas-stock/historicoO histórico dos pedidos de reserva de stock.
GET /api/estoque/reservas-stock/produtosPesquisa de artigos para reservar, com o stock de um armazém.
GET /api/estoque/reservas-stock/disponibilidadeO stock disponível para reservar, de uma lista de artigos num armazém.
POST /api/estoque/reservas-stock/{id}/linhas/{linhaId}/confirmarConfirma uma linha de um pedido de reserva: o stock fica reservado.
POST /api/estoque/reservas-stock/{id}/prorrogarProrroga o prazo de um pedido de reserva de stock.
POST /api/estoque/reservas-stock/{id}/cancelarCancela um pedido de reserva de stock (com um motivo, opcional): o stock volta a ficar livre.
GET /api/estoque/reservas/disponibilidadeOnde um artigo tem stock disponível, em toda a empresa.
GET /api/estoque/reservasLista as reservas de stock entre estabelecimentos.
POST /api/estoque/reservasPede stock a outro estabelecimento (uma reserva entre estabelecimentos).
POST /api/estoque/reservas/{id}/confirmarO estabelecimento de origem confirma uma reserva de stock.
POST /api/estoque/reservas/{id}/recusarO estabelecimento de origem recusa uma reserva de stock (com um motivo, opcional).
GET /api/estoque/guias-transferenciaAs guias de transferência interna: o documento interno que acompanha cada transferência.
POST /api/estoque/guias-transferencia/{id}/confirmar-recepcaoConfirma a recepção da mercadoria de uma guia de transferência interna.

#Encomendas a fornecedores

A reposição de stock: a sugestão do que está abaixo do mínimo e as notas de encomenda, uma por fornecedor.

GET /api/estoque/encomendas/sugestaoA sugestão de encomenda: os artigos abaixo do stock mínimo, com o fornecedor habitual e a quantidade que repõe o dobro do mínimo.
POST /api/estoque/encomendas/notasCria as notas de encomenda (uma por fornecedor) a partir dos artigos escolhidos.
GET /api/estoque/encomendas/notasLista as notas de encomenda.
GET /api/estoque/encomendas/notas/{id}Uma nota de encomenda, com as linhas.
POST /api/estoque/encomendas/notas/{id}/recebidaMarca uma nota de encomenda como recebida.
POST /api/estoque/encomendas/notas/{id}/cancelarCancela uma nota de encomenda, com o motivo.

#Promoções

As promoções: criar, aprovar, pausar, terminar, simular o que acontece a uma venda e ver o que renderam e custaram.

GET /api/promocoesLista as promoções.
GET /api/promocoes/relatorioO que as promoções renderam e custaram num período, com o período anterior ao lado, por operador e por caixa, e os alertas.
GET /api/promocoes/pdvA descarga das promoções para um ponto de venda.
GET /api/promocoes/{id}Uma promoção, com as regras.
POST /api/promocoesCria uma promoção (fica em rascunho).
PUT /api/promocoes/{id}Altera uma promoção em rascunho.
POST /api/promocoes/{id}/aprovarAprova uma promoção: passa a valer.
POST /api/promocoes/{id}/pausarPausa uma promoção (com um motivo, opcional).
POST /api/promocoes/{id}/retomarRetoma uma promoção pausada.
POST /api/promocoes/{id}/reabrirReabre uma promoção como rascunho, para a poder alterar.
POST /api/promocoes/{id}/terminarTermina uma promoção (com um motivo, opcional).
POST /api/promocoes/{id}/duplicarDuplica uma promoção, como rascunho.
POST /api/promocoes/simularSimula o que as promoções fazem a uma venda: as linhas, os descontos e o total, sem emitir nada.

#Documentos

Emitir e consultar facturas, facturas/recibo, pró-formas, orçamentos, notas de crédito, recibos e guias. Um documento emitido nunca se altera nem se apaga: corrige-se com uma nota de crédito.

GET /api/documentosLista os documentos emitidos, do mais recente para o mais antigo.
GET /api/documentos/pendentesAs facturas a crédito de um cliente que ainda têm valor por liquidar, da mais antiga para a mais recente.
GET /api/documentos/{id}Um documento emitido, com as linhas, os pagamentos e (nos recibos) as liquidações.
GET /api/documentos/{id}/impressaoO modelo de impressão do documento: os dados da empresa e do cliente, as linhas, o resumo de impostos e as frases legais, prontos a desenhar.
GET /api/documentos/{id}/pdfO PDF A4 do documento, igual ao que a aplicação imprime.
GET /api/documentos/{id}/enviosO histórico de envios do documento por e-mail: para quem, quando e com que resultado.
POST /api/documentosEmite um documento: factura, factura/recibo, pró-forma, orçamento ou guia.
POST /api/documentos/pre-calculoCalcula, sem emitir nada, o total que a emissão deste mesmo pedido cobraria.
POST /api/documentos/notas-creditoEmite uma nota de crédito sobre uma factura ou factura/recibo: devolução ou correcção, total ou parcial.
POST /api/documentos/recibosEmite um recibo: o cliente liquida, total ou parcialmente, uma ou várias facturas a crédito de uma só vez.
POST /api/documentos/{id}/enviar-emailEnvia o documento por e-mail ao destinatário indicado.
POST /api/documentos/rascunhosGuarda um rascunho de documento.
PUT /api/documentos/rascunhos/{id}Actualiza um rascunho de documento.
GET /api/documentos/rascunhosLista os rascunhos de documento.
GET /api/documentos/rascunhos/{id}Um rascunho de documento, com as linhas.
DELETE /api/documentos/rascunhos/{id}Elimina um rascunho.
POST /api/documentos/rascunhos/{id}/emitirEmite o documento que o rascunho descreve: passa a ter número e assinatura.
POST /api/documentos/recibos/{id}/anularAnula um recibo, com o motivo.
POST /api/documentos/{id}/enviar-lembrete-pagamentoEnvia ao cliente, por e-mail, um lembrete de pagamento de uma factura a crédito por receber.
POST /api/documentos/{id}/impressoesRegista que o documento vai ser impresso e diz se é o «Original» ou uma reimpressão («2.ª via, em conformidade com a original»).

#Financeiro

Quem deve à empresa e a quem a empresa deve: contas a receber, contas a pagar, despesas e pagamentos.

GET /api/financeiro/contas-a-receberAs facturas a crédito por receber, com o vencimento, o que já foi recebido e o escalão de atraso.
GET /api/financeiro/contas-a-receber/resumoO resumo do que há por receber: total em aberto, vencido e a vencer, por escalão.
GET /api/financeiro/contas-a-pagarAs contas a pagar: compras a fornecedores e despesas.
GET /api/financeiro/contas-a-pagar/resumoO resumo do que há por pagar: total em aberto, vencido e a vencer em 7 dias.
GET /api/financeiro/contas-a-pagar/{id}Uma conta a pagar com todos os pagamentos e estornos.
POST /api/financeiro/contas-a-pagar/despesasLança uma despesa (renda, electricidade, serviços): cria uma conta a pagar, paga ou por pagar.
POST /api/financeiro/contas-a-pagar/{id}/pagamentosRegista um pagamento, parcial ou total, de uma conta a pagar.
GET /api/financeiro/categoriasAs categorias financeiras (de despesa e de receita), para classificar uma despesa.
GET /api/financeiro/centros-custoOs centros de custo da empresa, para imputar as despesas.
POST /api/financeiro/contas-a-pagar/{id}/notas-creditoRegista uma nota de crédito do fornecedor sobre uma conta a pagar: abate o que falta pagar.
GET /api/financeiro/contas-a-pagar/despesas/resumo-mesO resumo das despesas do mês corrente: total lançado, já pago e por pagar.
POST /api/financeiro/contas-a-pagar/{id}/anularAnula uma despesa que ainda não tem pagamentos.
POST /api/financeiro/contas-a-pagar/{id}/pagamentos/{pagamentoId}/estornarEstorna um pagamento a um fornecedor: a dívida reabre.
GET /api/financeiro/despesas-recorrentesAs despesas recorrentes (renda, seguros, rendas de equipamento…).
GET /api/financeiro/despesas-recorrentes/resumoO resumo das despesas recorrentes: quantas, quanto por mês e quantas estão pendentes de lançar.
GET /api/financeiro/despesas-recorrentes/{id}A ficha de uma despesa recorrente, com as despesas que já gerou.
POST /api/financeiro/despesas-recorrentesCria uma despesa recorrente.
PUT /api/financeiro/despesas-recorrentes/{id}Altera uma despesa recorrente; vale para os ciclos seguintes.
POST /api/financeiro/despesas-recorrentes/{id}/pausarPausa uma despesa recorrente: deixa de lançar até ser retomada.
POST /api/financeiro/despesas-recorrentes/{id}/retomarRetoma uma despesa recorrente pausada.
POST /api/financeiro/despesas-recorrentes/{id}/cancelarCancela uma despesa recorrente: não volta a lançar. As despesas já lançadas mantêm-se.
POST /api/financeiro/despesas-recorrentes/lancar-pendentesLança agora todas as despesas recorrentes que estão por lançar.
GET /api/financeiro/mapa-fornecedoresO Mapa de Fornecedores de um mês, para a declaração à AGT: a pré-visualização.
GET /api/financeiro/mapa-fornecedores/excelO Mapa de Fornecedores de um mês no modelo Excel da AGT.
POST /api/financeiro/categoriasCria uma categoria financeira (de receita ou de despesa).
PUT /api/financeiro/categorias/{id}Renomeia uma categoria financeira.
PUT /api/financeiro/categorias/{id}/actividadeDefine a actividade do fluxo de caixa a que uma categoria pertence.
PUT /api/financeiro/categorias/{id}/valores-fiscaisDefine a natureza fiscal da compra por omissão de uma categoria de despesa.
PUT /api/financeiro/categorias/{id}/activaActiva ou desactiva uma categoria financeira.
POST /api/financeiro/centros-custoCria um centro de custo.
PUT /api/financeiro/centros-custo/{id}Renomeia um centro de custo.
PUT /api/financeiro/centros-custo/{id}/activoActiva ou desactiva um centro de custo.
GET /api/financeiro/creditos-fornecedorOs créditos a favor da empresa junto dos fornecedores (o que sobra de uma nota de crédito sobre uma factura já paga).
GET /api/financeiro/creditos-fornecedor/{id}Um crédito de fornecedor, com as utilizações que já teve.
POST /api/financeiro/creditos-fornecedor/{id}/compensarUsa um crédito para abater outra conta a pagar do mesmo fornecedor.
POST /api/financeiro/creditos-fornecedor/{id}/reembolsarRecebe um crédito em dinheiro: o fornecedor devolve o valor à empresa.
POST /api/financeiro/creditos-fornecedor/utilizacoes/{utilizacaoId}/desfazerDesfaz uma utilização de um crédito (uma compensação ou um reembolso), com o motivo.

#Tesouraria

Onde está o dinheiro: as contas da empresa (caixas e bancos), os lançamentos, as transferências entre contas, as receitas avulsas, o fluxo de caixa, a conciliação bancária e o fecho de período. O extracto das contas só se acrescenta; erros corrigem-se com estornos.

GET /api/financeiro/contasAs contas financeiras da empresa (caixas e bancos) com o saldo calculado.
GET /api/financeiro/contas/{id}/extractoO extracto de uma conta: os movimentos por ordem, com os totais do período.
POST /api/financeiro/contasCria uma conta bancária.
PUT /api/financeiro/contas/{id}Altera o nome, o banco, o número da conta e o IBAN de uma conta bancária.
PUT /api/financeiro/contas/{id}/saldo-inicialDefine o saldo inicial de uma conta e a data a partir da qual os movimentos contam.
PUT /api/financeiro/contas/{id}/activaActiva ou desactiva uma conta.
POST /api/financeiro/contas/{id}/por-omissaoFaz desta conta bancária a conta por omissão (a que recebe os pagamentos que não são em numerário).
GET /api/financeiro/lancamentosOs lançamentos de todas as contas, por categoria e centro de custo.
POST /api/financeiro/transferenciasTransfere dinheiro de uma conta para outra (por exemplo, depositar numerário no banco).
POST /api/financeiro/transferencias/{id}/estornarEstorna uma transferência: devolve o dinheiro à conta de origem, com o motivo.
POST /api/financeiro/receitasRegista uma receita avulsa (dinheiro que entra e não vem de um documento: um juro, um subsídio, um reembolso).
POST /api/financeiro/receitas/{id}/estornarEstorna uma receita avulsa, com o motivo.
GET /api/financeiro/fluxo-caixa/realizadoO fluxo de caixa realizado: o que de facto entrou e saiu num período, por categoria.
GET /api/financeiro/fluxo-caixa/realizado/csvO mesmo fluxo de caixa realizado, num ficheiro CSV (para abrir no Excel).
GET /api/financeiro/fluxo-caixa/previstoA projecção do saldo nos próximos dias, com o que está para receber e para pagar.
GET /api/financeiro/fluxo-caixa/indicadoresOs indicadores de tesouraria de um período: prazos médios de recebimento e de pagamento, retenção…
GET /api/financeiro/conciliacao/{contaId}O estado da conciliação bancária de uma conta: até quando está conciliada, o saldo conciliado, o saldo no sistema e a trilha das conciliações.
GET /api/financeiro/conciliacao/{contaId}/movimentosOs movimentos de uma conta bancária que ainda não estão conciliados, até ao dia do extracto do banco (inclusive).
POST /api/financeiro/conciliacao/{contaId}Concilia uma conta: marca como conferidos os movimentos que batem com o extracto do banco.
POST /api/financeiro/conciliacao/desfazer/{id}Desfaz a conciliação mais recente de uma conta: os movimentos voltam a ficar por conciliar.
GET /api/financeiro/periodosOs períodos financeiros: até quando a contabilidade está fechada.
POST /api/financeiro/periodos/fecharFecha um mês: depois de fechado, nada se lança nem se estorna nesse mês.
POST /api/financeiro/periodos/reabrirReabre um mês fechado, com o motivo.

#Caixa

As sessões de caixa (turnos de operador) e os terminais, só para consulta. Abrir, fechar e movimentar o caixa fazem-se no balcão, pelo próprio operador: um documento emitido por chave de API não precisa de caixa aberto.

GET /api/caixa/meuA sessão de caixa aberta de quem a chave representa (o titular), ou nenhuma.
GET /api/caixa/historicoAs sessões de caixa já fechadas, das mais recentes para as mais antigas.
GET /api/caixa/abertosOs caixas abertos neste momento na empresa, com o operador e o saldo de cada um.
GET /api/caixa/documentosOs documentos emitidos na sessão de caixa aberta, para conferir o turno.
GET /api/caixa/terminaisOs terminais de caixa (os postos físicos de venda) da empresa.
GET /api/caixa/terminais/{id}A ficha de um terminal de caixa.

#Recursos humanos

Os trabalhadores e tudo o que lhes diz respeito: estrutura, fichas, férias e assiduidade, ponto, remunerações e folha, cessações, processos disciplinares, contencioso, higiene e segurança, activos, avaliações, acordos colectivos e canal de denúncias. São dados sensíveis: uma chave só alcança esta área se o dono da empresa lhe der, ao criá-la, acesso reforçado, com consentimento registado, endereços de rede e validade curta. Cada pedido fica registado e o dono vê-o. Ver Dados sensíveis. A identidade de quem denuncia e a importação em massa de trabalhadores não se fazem por chave.

GET /api/rh/funcionariosLista os trabalhadores da empresa.
GET /api/rh/departamentosLista os departamentos.
POST /api/rh/departamentosCria um departamento.
PUT /api/rh/departamentos/{id}Altera um departamento.
PUT /api/rh/departamentos/{id}/activoActiva ou desactiva um departamento.
GET /api/rh/cargosLista os cargos.
POST /api/rh/cargosCria um cargo.
PUT /api/rh/cargos/{id}Altera um cargo.
PUT /api/rh/cargos/{id}/activoActiva ou desactiva um cargo.
GET /api/rh/funcionarios/resumoO resumo dos trabalhadores: quantos há, por estado.
GET /api/rh/funcionarios/alertas-documentosOs alertas sobre documentos dos trabalhadores (por exemplo, os que estão a expirar).
GET /api/rh/funcionarios/{id}A ficha de um trabalhador.
POST /api/rh/funcionariosCria um trabalhador (a ficha).
PUT /api/rh/funcionarios/{id}Altera a ficha de um trabalhador.
POST /api/rh/funcionarios/{id}/contratosRegista um contrato do trabalhador.
PUT /api/rh/funcionarios/{id}/contas-bancariasDefine as contas bancárias do trabalhador (onde recebe o salário).
PUT /api/rh/funcionarios/{id}/dependentesDefine os dependentes do trabalhador.
PUT /api/rh/funcionarios/{id}/estadoMuda o estado do trabalhador (activo, suspenso, de licença…).
GET /api/rh/funcionarios/{id}/situacoesO histórico de suspensões e licenças da ficha: motivo, início, retorno previsto e regresso.
POST /api/rh/funcionarios/{id}/cessarCessa a relação de trabalho de um trabalhador.
GET /api/rh/funcionarios/{id}/componentesOs componentes remuneratórios de um trabalhador (salário base, subsídios…).
POST /api/rh/funcionarios/{id}/componentesAcrescenta um componente remuneratório a um trabalhador.
GET /api/rh/funcionarios/{id}/habilitacoesAs habilitações académicas e a formação profissional da ficha.
PUT /api/rh/funcionarios/{id}/habilitacoesDefine as habilitações académicas e a formação profissional da ficha.
GET /api/rh/funcionarios/{id}/situacao-fiscalA situação fiscal e contributiva da ficha (isento de IRT, não sujeito à Segurança Social…), com a fonte legal e o histórico.
POST /api/rh/funcionarios/{id}/situacao-fiscalRegista uma situação fiscal ou contributiva na ficha.
GET /api/rh/funcionarios/{id}/recibosOs recibos de vencimento de um trabalhador.
POST /api/rh/componentes/{id}/encerrarEncerra um componente remuneratório: deixa de contar a partir da data indicada.
GET /api/rh/remuneracoes/trabalhadoresOs trabalhadores para escolher nos ecrãs de remunerações (só nomes, sem salários).
GET /api/rh/configuracaoA configuração de recursos humanos da empresa: as respostas às perguntas que condicionam os cálculos.
GET /api/rh/configuracao/historicoO histórico das alterações à configuração de recursos humanos.
POST /api/rh/configuracao/aceitar-padroesAceita de uma vez todas as respostas padrão (e as por confirmar), com o nome de quem as validou.
PUT /api/rh/configuracao/{pergunta}Define a resposta a uma pergunta da configuração de recursos humanos.
GET /api/rh/calendarioO calendário de recursos humanos: os feriados da empresa.
POST /api/rh/calendario/feriadosRegista um feriado ou uma tolerância no calendário da empresa.
GET /api/rh/calendario/feriados-nacionaisOs feriados nacionais da lei (e as pontes) propostos para um ano.
POST /api/rh/calendario/feriados-nacionaisCarrega os feriados nacionais propostos no calendário da empresa.
PUT /api/rh/calendario/feriados/{id}Altera um feriado do calendário da empresa.
DELETE /api/rh/calendario/feriados/{id}Remove um feriado do calendário da empresa.
GET /api/rh/parametros-legaisOs parâmetros legais em vigor que os cálculos de recursos humanos usam (só leitura).
GET /api/rh/ausenciasLista as ausências dos trabalhadores.
POST /api/rh/ausenciasRegista uma ausência.
POST /api/rh/ausencias/{id}/aprovarAprova uma ausência.
POST /api/rh/ausencias/{id}/rejeitarRejeita uma ausência.
POST /api/rh/ausencias/{id}/anularAnula uma ausência.
GET /api/rh/ferias/saldosOs saldos de férias dos trabalhadores.
GET /api/rh/ferias/funcionarios/{funcionarioId}As férias de um trabalhador: direitos, saldo e marcações.
POST /api/rh/ferias/direitosRegista um movimento do direito a férias de um trabalhador num ano (o direito do ano, dias por acordo ou um ajuste).
GET /api/rh/ferias/marcacoesLista as marcações de férias.
POST /api/rh/ferias/marcacoesMarca férias de um trabalhador.
POST /api/rh/ferias/marcacoes/{id}/aprovarAprova uma marcação de férias.
POST /api/rh/ferias/marcacoes/{id}/rejeitarRejeita uma marcação de férias.
POST /api/rh/ferias/marcacoes/{id}/anularAnula uma marcação de férias.
GET /api/rh/trabalho-suplementarLista o trabalho suplementar (horas extra).
GET /api/rh/trabalho-suplementar/resumoO resumo do trabalho suplementar.
POST /api/rh/trabalho-suplementarRegista trabalho suplementar de um trabalhador.
POST /api/rh/trabalho-suplementar/{id}/aprovarAprova trabalho suplementar.
POST /api/rh/trabalho-suplementar/{id}/rejeitarRejeita trabalho suplementar.
POST /api/rh/trabalho-suplementar/{id}/anularAnula trabalho suplementar.
GET /api/rh/assiduidade/trabalhadoresOs trabalhadores para escolher nos ecrãs de assiduidade (só nomes).
GET /api/rh/assiduidade/calendarioO calendário de assiduidade: as ausências, as férias e os feriados de um período.
GET /api/rh/ponto/equipamentosOs equipamentos de ponto (relógios) da empresa.
POST /api/rh/ponto/equipamentosRegista um equipamento de ponto.
PUT /api/rh/ponto/equipamentos/{id}Altera um equipamento de ponto.
GET /api/rh/ponto/codigosOs códigos dos trabalhadores nos equipamentos de ponto.
PUT /api/rh/ponto/codigos/{funcionarioId}Define o código de um trabalhador nos equipamentos de ponto.
GET /api/rh/ponto/marcacoesAs marcações de ponto de um período.
POST /api/rh/ponto/marcacoesRegista à mão uma marcação de ponto (esquecimento do trabalhador, equipamento avariado).
POST /api/rh/ponto/importacoes/pre-visualizarPré-visualiza a importação de um ficheiro extraído de um equipamento de ponto: não grava nada.
POST /api/rh/ponto/importacoesImporta um ficheiro extraído de um equipamento de ponto: acrescenta as marcações novas.
GET /api/rh/ponto/folha/{funcionarioId}A folha de ponto de um trabalhador num período.
GET /api/rh/rubricasAs rubricas de remuneração e de desconto.
GET /api/rh/rubricas/para-lancamentoAs rubricas que se podem usar num lançamento variável.
POST /api/rh/rubricasCria uma rubrica.
PUT /api/rh/rubricas/{id}Altera uma rubrica.
PUT /api/rh/rubricas/{id}/activaActiva ou desactiva uma rubrica.
GET /api/rh/subsidios-extraordinariosA proposta dos subsídios de férias e de Natal de um mês.
POST /api/rh/subsidios-extraordinarios/gerarGera os lançamentos dos subsídios de férias e de Natal de um mês, por aprovar.
GET /api/rh/lancamentosLista os lançamentos variáveis (prémios, comissões, faltas descontadas…).
POST /api/rh/lancamentosRegista um lançamento variável.
POST /api/rh/lancamentos/{id}/aprovarAprova um lançamento variável.
POST /api/rh/lancamentos/{id}/rejeitarRejeita um lançamento variável.
POST /api/rh/lancamentos/{id}/anularAnula um lançamento variável.
GET /api/rh/descontosLista os descontos programados (empréstimos, adiantamentos…).
GET /api/rh/descontos/{id}Um desconto programado, com os movimentos e os eventos.
POST /api/rh/descontosCria um desconto programado.
POST /api/rh/descontos/{id}/aprovarAprova um desconto programado.
POST /api/rh/descontos/{id}/rejeitarRejeita um desconto programado.
POST /api/rh/descontos/{id}/anularAnula um desconto programado.
POST /api/rh/descontos/{id}/movimentosRegista um movimento manual no saldo de um desconto aprovado: um abatimento (o trabalhador pagou por outra via) ou um estorno.
POST /api/rh/descontos/{id}/eventosSuspende ou retoma um desconto aprovado a partir de um mês (por exemplo, por ordem do tribunal).
GET /api/rh/diuturnidades/rubricasAs rubricas que se podem usar nas diuturnidades.
GET /api/rh/diuturnidades/regrasAs regras de diuturnidades da empresa.
GET /api/rh/diuturnidadesAs diuturnidades dos trabalhadores.
POST /api/rh/diuturnidades/regrasCria uma regra de diuturnidades.
POST /api/rh/diuturnidades/regras/{id}/anularAnula uma regra de diuturnidades.
POST /api/rh/diuturnidades/aplicarAplica as regras de diuturnidades aos trabalhadores.
GET /api/rh/folhasLista as folhas de salários.
GET /api/rh/folhas/{id}Uma folha de salários, com os recibos.
GET /api/rh/folhas/{id}/recibos/{reciboId}Um recibo de vencimento de uma folha.
GET /api/rh/folhas/{id}/pdfA folha inteira em PDF.
GET /api/rh/folhas/{id}/recibos/{reciboId}/pdfUm recibo de vencimento em PDF.
GET /api/rh/folhas/{id}/mapa-pagamentoO mapa de pagamento de uma folha aprovada: quanto pagar a cada trabalhador.
GET /api/rh/folhas/{id}/mapa-pagamento/csvO mapa de pagamento de uma folha aprovada, em CSV.
GET /api/rh/folhas/{id}/mapa-retencoesO mapa de retenções de uma folha aprovada: o IRT e a Segurança Social retidos.
GET /api/rh/folhas/{id}/mapa-retencoes/csvO mapa de retenções de uma folha aprovada, em CSV.
GET /api/rh/folhas/{id}/mapa-remuneracoes-agtO Mapa de Remunerações da AGT de uma folha aprovada: a pré-visualização, com avisos.
GET /api/rh/folhas/{id}/mapa-remuneracoes-agt/xlsxO Mapa de Remunerações da AGT de uma folha aprovada, no modelo Excel oficial.
GET /api/rh/folhas/trabalhadoresOs trabalhadores que a folha de um mês pode incluir (só nomes, sem salários).
POST /api/rh/folhasCalcula a folha de salários de um mês: um recibo por trabalhador com relação laboral nesse mês.
DELETE /api/rh/folhas/{id}Descarta uma folha em rascunho.
POST /api/rh/folhas/{id}/aprovarAprova uma folha de salários.
POST /api/rh/folhas/{id}/anularAnula uma folha de salários aprovada, com o motivo.
GET /api/rh/cessacoes/trabalhadoresOs trabalhadores para escolher nos ecrãs de cessação.
GET /api/rh/cessacoesLista as cessações e os acertos de contas.
GET /api/rh/cessacoes/{id}Uma cessação, com o acerto de contas.
POST /api/rh/cessacoesInicia o processo de cessação de um trabalhador e calcula as sugestões do acerto de contas.
PUT /api/rh/cessacoes/{id}/linhasDefine as linhas do acerto de contas de uma cessação em rascunho.
DELETE /api/rh/cessacoes/{id}Descarta uma cessação em rascunho.
POST /api/rh/cessacoes/{id}/aprovarAprova uma cessação e o seu acerto de contas.
GET /api/rh/disciplinar/trabalhadoresOs trabalhadores para escolher nos ecrãs disciplinares.
GET /api/rh/disciplinarLista os processos disciplinares.
GET /api/rh/disciplinar/alertasOs alertas dos processos disciplinares (prazos a vencer).
GET /api/rh/disciplinar/{id}Um processo disciplinar, com as fases.
POST /api/rh/disciplinarAbre um processo disciplinar.
POST /api/rh/disciplinar/{id}/fasesRegista uma fase de um processo disciplinar.
POST /api/rh/disciplinar/{id}/sancaoAplica uma sanção disciplinar.
POST /api/rh/disciplinar/{id}/arquivarArquiva um processo disciplinar.
GET /api/rh/contencioso/trabalhadoresOs trabalhadores para escolher nos ecrãs de contencioso.
GET /api/rh/contenciosoLista os litígios laborais.
GET /api/rh/contencioso/resumoO resumo dos litígios laborais e das provisões.
GET /api/rh/contencioso/{id}Um litígio laboral, com os eventos e as provisões.
POST /api/rh/contenciosoAbre um litígio laboral.
POST /api/rh/contencioso/{id}/eventosRegista um evento num litígio laboral.
POST /api/rh/contencioso/{id}/riscoClassifica o risco de um litígio laboral.
PUT /api/rh/contencioso/{id}/numero-processoDefine o número do processo judicial de um litígio.
POST /api/rh/contencioso/{id}/encerrarEncerra um litígio laboral.
POST /api/rh/contencioso/{id}/contaRegista uma conta (um custo ou um recebimento) num litígio laboral.
POST /api/rh/contencioso/{id}/provisoesPropõe uma provisão para um litígio laboral.
POST /api/rh/contencioso/provisoes/{provisaoId}/confirmarConfirma uma provisão proposta.
POST /api/rh/contencioso/provisoes/{provisaoId}/rejeitarRejeita uma provisão proposta.
GET /api/rh/hst/trabalhadoresOs trabalhadores para escolher nos ecrãs de higiene, segurança e saúde.
GET /api/rh/hst/alertasOs alertas de higiene, segurança e saúde (por exemplo, exames por renovar).
GET /api/rh/hst/examesLista os exames médicos dos trabalhadores.
POST /api/rh/hst/examesRegista um exame médico.
POST /api/rh/hst/exames/{id}/anularAnula um exame médico registado.
GET /api/rh/hst/acidentesLista os acidentes de trabalho.
GET /api/rh/hst/acidentes/{id}Um acidente de trabalho, com as actualizações.
POST /api/rh/hst/acidentesRegista um acidente de trabalho.
POST /api/rh/hst/acidentes/{id}/actualizacoesRegista uma actualização num acidente de trabalho.
GET /api/rh/activos/trabalhadoresOs trabalhadores para escolher nos ecrãs de activos.
GET /api/rh/activos/alertasOs alertas dos activos entregues (por exemplo, devoluções em atraso).
GET /api/rh/activosLista os activos entregues aos trabalhadores (EPI, equipamentos).
POST /api/rh/activosRegista a entrega de um activo a um trabalhador.
POST /api/rh/activos/{id}/devolverRegista a devolução de um activo.
POST /api/rh/activos/{id}/anularAnula o registo de um activo entregue.
GET /api/rh/avaliacoes/trabalhadoresOs trabalhadores para escolher nos ecrãs de avaliações.
GET /api/rh/avaliacoes/resumoO resumo das avaliações de desempenho.
GET /api/rh/avaliacoes/pendentesOs trabalhadores com avaliação de desempenho pendente.
GET /api/rh/avaliacoesLista as avaliações de desempenho.
GET /api/rh/avaliacoes/{id}Uma avaliação de desempenho.
POST /api/rh/avaliacoesAbre uma avaliação de desempenho.
PUT /api/rh/avaliacoes/{id}Actualiza uma avaliação de desempenho em curso.
POST /api/rh/avaliacoes/{id}/concluirConclui uma avaliação de desempenho.
POST /api/rh/avaliacoes/{id}/anularAnula uma avaliação de desempenho.
GET /api/rh/acordos/trabalhadoresOs trabalhadores para escolher nos ecrãs de acordos colectivos.
GET /api/rh/acordosLista os acordos colectivos de trabalho.
GET /api/rh/acordos/{id}Um acordo colectivo, com os parâmetros, as categorias e as adesões.
POST /api/rh/acordosRegista um acordo colectivo de trabalho.
PUT /api/rh/acordos/{id}Actualiza um acordo colectivo.
POST /api/rh/acordos/{id}/terminarTermina um acordo colectivo.
POST /api/rh/acordos/{id}/parametrosAcrescenta um parâmetro a um acordo colectivo.
POST /api/rh/acordos/{id}/parametros/{parametroId}/anularAnula um parâmetro de um acordo colectivo.
POST /api/rh/acordos/{id}/parametros/{parametroId}/confirmarConfirma um parâmetro de um acordo colectivo.
POST /api/rh/acordos/{id}/categoriasAcrescenta uma categoria profissional a um acordo colectivo.
POST /api/rh/acordos/{id}/categorias/{categoriaId}/anularAnula uma categoria de um acordo colectivo.
POST /api/rh/acordos/{id}/adesoesRegista a adesão de um trabalhador a um acordo colectivo.
POST /api/rh/acordos/adesoes/{adesaoId}/encerrarEncerra a adesão de um trabalhador a um acordo colectivo.
GET /api/rh/auditoria/acessosA auditoria de acessos a dados sensíveis de recursos humanos feitos dentro do Mucanda: quem consultou o quê e quando.
GET /api/rh/denuncias/resumoO resumo das denúncias recebidas no canal de denúncias.
GET /api/rh/denunciasLista as denúncias recebidas no canal de denúncias.
GET /api/rh/denuncias/{id}Uma denúncia, com as respostas e as notas de tratamento.
POST /api/rh/denuncias/{id}/responderResponde ao autor de uma denúncia, pelo canal.
POST /api/rh/denuncias/{id}/notasRegista uma nota interna no tratamento de uma denúncia.
POST /api/rh/denuncias/{id}/concluirConclui o tratamento de uma denúncia.
POST /api/rh/denuncias/{id}/arquivarArquiva uma denúncia.

#Eventos

Tudo o que acontece na empresa (um documento emitido, a validação da AGT, um pagamento) fica registado como um evento. Os webhooks enviam-nos na hora; aqui lêem-se, para recuperar avisos perdidos ou sincronizar sem webhooks.

GET /api/eventosOs eventos dos últimos 30 dias (documento emitido, validação ou recusa da AGT, anulação, pagamento, cliente criado), do mais recente para o mais antigo.

#Relatórios

Os números do negócio por período. Os relatórios são pesados: a empresa só pode ter dois a correr ao mesmo tempo (ver Limites).

GET /api/relatorios/mapas/{codigo}Um mapa de gestão (o código diz qual) de um período.
GET /api/relatorios/caixas/{id}/resumoO resumo de uma sessão de caixa.
GET /api/visao-360A Visão 360° do negócio: vendas, dinheiro, dívidas, stock e impostos num só pedido.
GET /api/relatorios/clientes/rankingOs melhores clientes do período, por valor vendido.
GET /api/relatorios/documentosOs documentos emitidos num período, com totais, por tipo, cliente, utilizador, estabelecimento e estado.
GET /api/relatorios/ivaO resumo do IVA do período: base e imposto por taxa.
GET /api/relatorios/pagamentosOs pagamentos recebidos no período, por método.
GET /api/relatorios/pendentesAs facturas pendentes de pagamento, com o escalão de atraso.
GET /api/relatorios/produtos-vendidosOs artigos vendidos no período, com quantidade, valor, custo e lucro.
GET /api/relatorios/produtos/classificacao-abcA classificação ABC dos artigos pelo valor vendido.
GET /api/relatorios/produtos/rankingOs artigos mais (ou menos) vendidos do período.
GET /api/relatorios/produtos/{produtoId}/ultimas-vendasAs últimas vendas de um artigo.
GET /api/relatorios/resumo-facturacaoA facturação de hoje, da semana, do mês e do ano (descontadas as notas de crédito).
GET /api/relatorios/vendas-mensaisAs vendas de cada mês de um ano, por artigo.

#Ficheiros fiscais

Os ficheiros que a empresa entrega à administração fiscal (SAF-T de facturação, de compras e de inventário) e a prova de integridade da cadeia de assinaturas.

GET /api/saftO ficheiro SAF-T(AO) de facturação de um estabelecimento, num período.
GET /api/saft/cadeia-assinaturasReverifica a cadeia de assinaturas de um tipo de documento: a prova de que nenhum documento foi alterado, retirado ou inserido.
GET /api/saft/comprasO SAF-T(AO) de aquisição de bens e serviços (compras) de um mês.
GET /api/saft/compras/resumoA pré-visualização do SAF-T de compras de um mês: totais, fornecedores e avisos.
GET /api/saft/inventarioO ficheiro de inventário (existências a 31 de Dezembro) de um exercício.
GET /api/saft/inventario/resumoA pré-visualização do inventário de um exercício: linhas, valor total e avisos.

#Conformidade e facturação electrónica

O que a lei pede à empresa: a verificação da integridade das assinaturas, o dever de reporte das vendas a grosso e o estado da comunicação dos documentos à AGT (facturação electrónica). A adesão e as séries da facturação electrónica configuram-se só no ecrã, por uma pessoa.

GET /api/conformidade/integridadeO estado da integridade das assinaturas da empresa: se a emissão está suspensa e porquê.
POST /api/conformidade/integridade/verificarVerifica agora a integridade das assinaturas.
GET /api/conformidade/dever-de-reporteO dever de reporte das vendas a grosso a pessoas singulares de valor elevado: o que há por reportar (DP 71/25, art. 15.º).
POST /api/conformidade/dever-de-reporte/{documentoId}/reportadaMarca um documento como já reportado.
GET /api/facturacao-electronica/estadoO estado da facturação electrónica da empresa.
GET /api/facturacao-electronica/documentosOs documentos e o estado da sua comunicação à AGT.
GET /api/facturacao-electronica/documentos/{documentoId}O estado da comunicação de um documento à AGT.
POST /api/facturacao-electronica/comunicarPede a comunicação imediata dos documentos pendentes à AGT (sem esperar pelo robô).

#Produção

Fichas técnicas (receitas), ordens de produção, centros de trabalho, custo industrial e rastreabilidade por lote. Concluir uma ordem baixa a matéria do stock e dá entrada do produto acabado ao custo apurado, tudo numa só transacção; uma ordem concluída nunca se edita: desfaz-se com um estorno, num documento próprio.

GET /api/producao/centrosOs centros de trabalho (máquinas, linhas ou postos) com a capacidade e o custo por hora.
POST /api/producao/centrosCria um centro de trabalho: código, nome, custo por hora, horas por dia, postos e eficiência.
PUT /api/producao/centros/{id}Altera os dados de um centro de trabalho.
PUT /api/producao/centros/{id}/activoActiva ou desactiva um centro de trabalho.
GET /api/producao/fichasAs fichas técnicas (receitas) com o artigo que produzem, a versão e o estado.
POST /api/producao/fichasCria uma ficha técnica em rascunho: o artigo que produz, o rendimento, as linhas de matéria e, se houver, as operações e as outras saídas.
GET /api/producao/fichas/{id}Uma ficha técnica completa: linhas, operações, saídas e o critério de reparto do custo.
PUT /api/producao/fichas/{id}Altera uma ficha em rascunho.
POST /api/producao/fichas/{id}/activarActiva uma ficha técnica: passa a ser a que vale para o artigo.
POST /api/producao/fichas/{id}/nova-versaoCria uma nova versão, em rascunho, a partir de uma ficha existente.
GET /api/producao/fichas/{id}/simulacaoSimula quanto custa produzir uma quantidade, ao custo médio de hoje dos insumos, sem escrever nada.
GET /api/producao/fichas/{id}/arvoreA árvore de uma produção multinível: o que se precisa de cada insumo, o que o stock do armazém cobre e o que falta (a produzir ou a comprar).
GET /api/producao/ordensAs ordens de produção com o estado e as quantidades.
POST /api/producao/ordensCria uma ordem de produção, em rascunho, a partir de uma ficha técnica e de uma quantidade-alvo.
GET /api/producao/ordens/{id}Uma ordem de produção completa: necessidades, consumos, saídas, custos e variações.
POST /api/producao/ordens/{id}/planearPassa a ordem de rascunho a planeada: fotografa as necessidades de matéria (a partir da versão da ficha) e a política de stock negativo.
POST /api/producao/ordens/{id}/iniciarPassa a ordem de planeada a em execução.
POST /api/producao/ordens/{id}/concluirConclui a ordem: baixa a matéria (por lote, FIFO), apura o custo industrial e dá entrada do produto acabado ao custo apurado.
POST /api/producao/ordens/{id}/cancelarCancela uma ordem em rascunho ou planeada, com motivo.
POST /api/producao/ordens/{id}/estornarEstorna uma ordem concluída, num documento próprio: o acabado sai do stock e os insumos voltam ao lote de onde saíram, ao custo a que saíram.
POST /api/producao/ordens/{id}/custosRegista um custo (mão-de-obra, energia, máquina, gastos gerais ou outro) numa ordem.
GET /api/producao/painelO painel da produção: ordens em rascunho, planeadas, em execução, concluídas no mês e atrasadas, e as que estão em curso.
GET /api/producao/relatoriosO relatório da produção: por artigo, o que se produziu face ao planeado, o custo por unidade e as variações; e, mês a mês, a quantidade e o custo por unidade.
GET /api/producao/relatorios/custos-por-centroOs custos operacionais (mão-de-obra, energia, máquina…) imputados às ordens, por centro de trabalho e por tipo, no período em que foram registados.
GET /api/producao/rastreabilidade/lotes/{loteId}A rastreabilidade de um lote: de onde veio e para onde foi.

#Planeamento da produção

O que produzir e quando: parâmetros de planeamento por artigo, procura, plano de necessidades com sugestões de produzir e de comprar, carga dos centros de trabalho e calendário. Correr um plano não altera stock, ordens nem encomendas: só firmar as sugestões cria ordens de produção e notas de encomenda.

GET /api/producao/planeamento/parametrosOs parâmetros de planeamento de cada artigo: política, prazo de entrega, lote mínimo, múltiplo e stock de segurança.
PUT /api/producao/planeamento/parametros/{produtoId}Define os parâmetros de planeamento de um artigo.
DELETE /api/producao/planeamento/parametros/{produtoId}Remove os parâmetros de planeamento de um artigo.
GET /api/producao/planeamento/procuraAs linhas de procura registadas para o planeamento.
POST /api/producao/planeamento/procuraRegista linhas de procura.
POST /api/producao/planeamento/procura/{id}/cancelarCancela uma linha de procura.
GET /api/producao/planeamento/qualidadeA qualidade dos dados do planeamento: o que corrigir antes de correr o plano.
GET /api/producao/planeamento/cargaA carga dos centros de trabalho para as próximas semanas, face à capacidade de cada centro.
GET /api/producao/planeamento/planosOs planos de necessidades já corridos.
GET /api/producao/planeamento/planos/{id}Um plano de necessidades com as sugestões de produzir e de comprar.
POST /api/producao/planeamento/planosCorre o plano de necessidades para um armazém e um horizonte em semanas.
POST /api/producao/planeamento/planos/{id}/firmarFirma sugestões do plano: cada sugestão de produzir cria uma ordem de produção e cada uma de comprar cria uma nota de encomenda.
POST /api/producao/planeamento/planos/{id}/ignorarMarca sugestões do plano como ignoradas.
GET /api/producao/planeamento/calendarioO calendário do planeamento: os dias úteis da semana e os dias de encerramento.
PUT /api/producao/planeamento/calendario/dias-uteisDefine os dias úteis da semana.
POST /api/producao/planeamento/calendario/encerramentosAcrescenta um dia de encerramento ao calendário.
DELETE /api/producao/planeamento/calendario/encerramentos/{id}Remove um dia de encerramento do calendário.

#Qualidade da produção

Planos de inspecção, inspecções por lote, quarentena, não conformidades com acções correctivas, instrumentos de medição e certificado de qualidade. Um lote em quarentena fica num armazém à parte até a qualidade o libertar.

GET /api/producao/qualidade/planosOs planos de inspecção: o artigo, o momento da inspecção e os pontos de controlo.
GET /api/producao/qualidade/planos/{id}Um plano de inspecção com os pontos de controlo.
POST /api/producao/qualidade/planosCria um plano de inspecção para um artigo, num momento (Recepcao, EmProcesso ou Final), com os pontos de controlo.
PUT /api/producao/qualidade/planos/{id}Altera os pontos de controlo, a observação e a exigência de libertação de um plano (esta só vale num plano Final).
POST /api/producao/qualidade/planos/{id}/desactivarDesactiva um plano de inspecção.
GET /api/producao/qualidade/inspeccoesAs inspecções registadas, com o resultado.
GET /api/producao/qualidade/inspeccoes/{id}Uma inspecção com as medições e o resultado.
POST /api/producao/qualidade/inspeccoesRegista uma inspecção a um plano, com as medições.
GET /api/producao/qualidade/por-inspeccionarO que falta inspeccionar: lotes (ou, nos artigos sem lote, entradas e ordens) com um plano activo e ainda nenhuma inspecção desse momento.
GET /api/producao/qualidade/lotesOs lotes de um artigo que se podem inspeccionar.
GET /api/producao/qualidade/quarentena/armazensOs armazéns, com a indicação de quais são de quarentena.
POST /api/producao/qualidade/quarentena/armazensCria o armazém «Quarentena» de um estabelecimento, já marcado como tal.
PUT /api/producao/qualidade/quarentena/armazens/{id}Designa um armazém como o de quarentena do seu estabelecimento (um só por estabelecimento), ou retira-lhe a marca.
GET /api/producao/qualidade/quarentena/lotesO que a qualidade tem de decidir ou de mover: os lotes em quarentena e os lotes que reprovaram e ainda estão fora dela.
POST /api/producao/qualidade/quarentena/lotes/{loteId}/colocarPõe um lote (ou parte dele) em quarentena: transfere-o do armazém onde está para o de quarentena do mesmo estabelecimento.
POST /api/producao/qualidade/quarentena/lotes/{loteId}/libertarLiberta um lote da quarentena: só com a última inspecção do lote aprovada, transfere a quantidade para o armazém de destino.
GET /api/producao/qualidade/quarentena/movimentosOs movimentos de qualidade (entradas e saídas de quarentena).
GET /api/producao/qualidade/nao-conformidadesAs não conformidades, abertas e fechadas.
GET /api/producao/qualidade/nao-conformidades/{id}Uma não conformidade com a causa, as acções correctivas e a decisão.
POST /api/producao/qualidade/nao-conformidadesAbre uma não conformidade à mão.
PUT /api/producao/qualidade/nao-conformidades/{id}/causaRegista (ou altera) a causa de uma não conformidade.
POST /api/producao/qualidade/nao-conformidades/{id}/accoesAcrescenta uma acção correctiva, com o responsável e o prazo.
POST /api/producao/qualidade/nao-conformidades/{id}/accoes/{accaoId}/concluirDá uma acção correctiva por concluída.
POST /api/producao/qualidade/nao-conformidades/{id}/accoes/{accaoId}/cancelarCancela uma acção correctiva.
POST /api/producao/qualidade/nao-conformidades/{id}/decisaoDecide uma não conformidade e cumpre a decisão no stock, tudo ou nada.
GET /api/producao/qualidade/instrumentosOs instrumentos de medição e a validade da calibração de cada um.
POST /api/producao/qualidade/instrumentosRegista um instrumento de medição: código, nome e, se houver, a validade da calibração.
PUT /api/producao/qualidade/instrumentos/{id}Altera o nome, a validade da calibração e a observação de um instrumento, ou desactiva-o.
GET /api/producao/qualidade/certificado/{loteId}O certificado de qualidade de um lote.
GET /api/producao/qualidade/indicadoresOs números simples da qualidade num período, com a definição de cada um.

#Estética e beleza

A camada de negócio do salão sobre a agenda das Marcações: o catálogo de serviços de beleza com as suas exigências de segurança, a configuração, a próxima visita (rebook), o material esterilizado (kits) e os relatórios de higiene e de indicadores. O serviço, o tempo e o preço continuam a ser das Marcações. As fichas dos clientes e o que lhes diz respeito estão na área «Fichas de beleza».

GET /api/beleza/modelosOs modelos de serviço de beleza de partida.
GET /api/beleza/servicosOs serviços da agenda com os atributos de beleza.
PUT /api/beleza/servicos/{servicoId}Define (ou redefine) os atributos de beleza de um serviço da agenda.
POST /api/beleza/servicos/de-modeloCria o serviço da agenda a partir de um modelo de partida e liga-o a um artigo do tipo Serviço que a empresa já tem.
GET /api/beleza/configuracaoA configuração da beleza: segmentos, avisos do ciclo, janela do briefing e validade da esterilização.
PUT /api/beleza/configuracaoDefine a configuração da beleza.
GET /api/beleza/rebooksAs próximas visitas propostas aos clientes (rebooks).
POST /api/beleza/marcacoes/{marcacaoId}/rebookPropõe a próxima visita de um serviço feito: na data do ciclo do serviço (ou na que se disser), com o profissional que o fez.
POST /api/beleza/rebooks/{id}/aceitarO cliente aceita a próxima visita: cria a marcação na hora indicada.
POST /api/beleza/rebooks/{id}/recusarO cliente recusa a próxima visita proposta.
GET /api/beleza/kitsOs kits de material (esterilizado, em uso, sujo, em esterilização).
POST /api/beleza/kitsCria um kit de material.
PUT /api/beleza/kits/{id}Altera um kit de material.
POST /api/beleza/kits/lerLê o código de um kit para começar um serviço: se está esterilizado e dentro da validade passa a «em uso»; senão a leitura fica recusada e registada.
POST /api/beleza/kits/{id}/sujoMarca um kit como sujo.
POST /api/beleza/kits/{id}/esterilizacao/iniciarInicia a esterilização de um kit.
POST /api/beleza/kits/{id}/esterilizacao/concluirConclui a esterilização de um kit, com o lote, o aparelho e a validade.
GET /api/beleza/higiene/relatorioO relatório de higiene de um período.
GET /api/beleza/indicadoresOs indicadores da beleza de um período.

#Fichas de beleza (dados sensíveis)

A ficha técnica viva de cada cliente (perfis de cabelo, pele, unhas e pestanas, condições de saúde e alergias), os testes de sensibilidade, os registos técnicos (fórmulas, receitas, técnicas), os consentimentos para fotografias, as fotografias, e o que se verifica e regista em cada atendimento. São dados pessoais, em parte de saúde: a chave só os alcança se o dono da empresa lhe deu, ao criá-la, acesso reforçado com um consentimento que cubra as fichas de beleza (versão 2 ou posterior), com endereços de rede e validade curta, e cada pedido fica registado. Ver Dados sensíveis.

GET /api/beleza/clientes/{clienteId}/fichaA ficha técnica de um cliente: perfis, preferências, condições, testes, consentimentos, ciclos, registos técnicos e fotografias.
PUT /api/beleza/clientes/{clienteId}/fichaDefine a ficha técnica de um cliente: os perfis de cabelo, pele, unhas e pestanas, as preferências, a data da última química e as notas da equipa.
POST /api/beleza/clientes/{clienteId}/condicoesRegista uma condição (gravidez, alergia…) na ficha do cliente.
POST /api/beleza/condicoes/{id}/removerRemove uma condição da ficha, com motivo.
POST /api/beleza/clientes/{clienteId}/testesAplica um teste de sensibilidade: fica pendente até alguém registar o resultado depois do tempo de leitura.
POST /api/beleza/testes/{id}/resultadoRegista o resultado de um teste de sensibilidade.
POST /api/beleza/testes/{id}/anularAnula um teste, com motivo.
GET /api/beleza/clientes/{clienteId}/registosOs registos técnicos de um cliente (fórmulas, receitas, técnicas).
POST /api/beleza/clientes/{clienteId}/registosCria um registo técnico na ficha do cliente.
POST /api/beleza/registos/{id}/repetirCria um registo técnico novo a partir de um existente (repetir a mesma fórmula ou receita).
POST /api/beleza/clientes/{clienteId}/consentimentosRegista o consentimento do cliente para fotografias, para uma finalidade e uma versão do texto.
POST /api/beleza/consentimentos/{id}/revogarRevoga um consentimento do cliente.
POST /api/beleza/clientes/{clienteId}/fotosAnexa uma fotografia à ficha de um cliente.
GET /api/beleza/fotos/{id}Descarrega uma fotografia de um cliente.
GET /api/beleza/clientes/{clienteId}/acessosQuem consultou a ficha de um cliente e quando.
GET /api/beleza/marcacoes/{marcacaoId}/verificacaoO que a ficha do cliente tem a dizer sobre os serviços de uma marcação, numa fase do atendimento (avisos e bloqueios).
POST /api/beleza/verificar-pedidoAntes de marcar: o que a ficha do cliente tem a dizer sobre os serviços que se vão marcar (só avisos).
GET /api/beleza/marcacoes/{marcacaoId}/cartaoO cartão do atendimento: o cliente, as condições, as preferências, os consentimentos, a verificação de segurança, os serviços, os kits usados e as próximas visitas.
POST /api/beleza/marcacoes/{marcacaoId}/respostasRegista a resposta do cliente a uma pergunta do questionário de segurança (sim ou não) numa marcação.
POST /api/beleza/marcacoes/{marcacaoId}/dosesRegista uma dose de produto usada num atendimento.

#Hospedarias e hotéis

A propriedade, os tipos de quarto e os quartos, os planos tarifários com tarifas por dia e restrições de venda, as reservas com depósito e prazo, a recepção (chegadas, partidas, check-in e check-out), o folio e a sua facturação, o housekeeping, a manutenção, os bloqueios de quartos, o night audit e os indicadores hoteleiros. A facturação do folio emite um documento fiscal do núcleo, pelo fluxo de sempre. As fichas dos hóspedes e os seus ocupantes estão na área «Hóspedes».

GET /api/hospedagem/propriedadesAs propriedades da empresa, com as horas de check-in e check-out, o prazo do depósito, a hora do night audit, a data do hotel e os créditos de limpeza.
POST /api/hospedagem/propriedadesCria uma propriedade.
PUT /api/hospedagem/propriedades/{id}Altera uma propriedade.
GET /api/hospedagem/tipos-de-quartoOs tipos de quarto, com a lotação e o artigo de alojamento.
POST /api/hospedagem/tipos-de-quartoCria um tipo de quarto.
PUT /api/hospedagem/tipos-de-quarto/{id}Altera um tipo de quarto.
GET /api/hospedagem/quartosOs quartos, com o tipo e o estado.
POST /api/hospedagem/quartosCria um quarto de um tipo.
PUT /api/hospedagem/quartos/{id}Altera um quarto.
GET /api/hospedagem/planosOs planos tarifários (o que a tarifa inclui, a política de cancelamento e a garantia exigida).
POST /api/hospedagem/planosCria um plano tarifário.
PUT /api/hospedagem/planos/{id}Altera um plano tarifário.
GET /api/hospedagem/tarifasAs tarifas de um plano num intervalo de datas.
PUT /api/hospedagem/tarifas/baseDefine o preço base de um tipo de quarto num plano.
PUT /api/hospedagem/tarifas/diasDefine o preço de uma noite (sem IVA) num intervalo de datas, para um tipo (ou todos os activos), opcionalmente só em certos dias da semana (0 = domingo).
POST /api/hospedagem/tarifas/dias/removerTira o preço especial de um intervalo: os dias voltam ao preço base do plano.
GET /api/hospedagem/restricoesAs restrições de venda (estadia mínima e máxima, fechado a chegadas, a partidas ou à venda).
POST /api/hospedagem/restricoesCria uma restrição de venda num intervalo de datas, para um plano e/ou um tipo de quarto.
PUT /api/hospedagem/restricoes/{id}Altera uma restrição de venda.
DELETE /api/hospedagem/restricoes/{id}Remove uma restrição de venda.
GET /api/hospedagem/extrasOs extras do catálogo (consumos e serviços lançáveis no folio).
POST /api/hospedagem/extrasCria um extra, ligado a um artigo do catálogo.
PUT /api/hospedagem/extras/{id}Altera um extra.
GET /api/hospedagem/taxasAs taxas de alojamento configuradas pela propriedade.
POST /api/hospedagem/taxasCria uma taxa de alojamento, ligada a um artigo.
PUT /api/hospedagem/taxas/{id}Altera uma taxa de alojamento.
GET /api/hospedagem/calendarioO calendário da propriedade num intervalo de datas, por tipo de quarto.
GET /api/hospedagem/orcamentoO orçamento de uma estadia antes de a vender: há vaga em todas as noites, que restrições a impedem, o preço de cada noite, o total e o IVA e o total com IVA.
GET /api/hospedagem/reservasA lista de reservas de uma propriedade, por data de chegada.
POST /api/hospedagem/reservasCria uma reserva.
GET /api/hospedagem/chegadasAs chegadas de um dia (por omissão, a data do hotel): reservas pedidas ou confirmadas que chegam, por hora prevista.
GET /api/hospedagem/partidasAs partidas de um dia (por omissão, a data do hotel): hóspedes em casa cuja partida é nesse dia.
GET /api/hospedagem/em-casaOs hóspedes em casa agora.
GET /api/hospedagem/mapaO mapa de quartos: cada quarto com o estado de limpeza, quem lá está (ou chega ou parte hoje) e o motivo de estar fora de serviço.
POST /api/hospedagem/reservas/{id}/confirmarConfirma uma reserva pedida, com a garantia indicada.
POST /api/hospedagem/reservas/{id}/cancelarCancela uma reserva, com motivo.
PUT /api/hospedagem/reservas/{id}/dadosAltera os dados de uma reserva: a empresa, o plano, o segmento, a hora prevista de chegada, as notas, os pedidos especiais, o VIP e as rotas de facturação.
POST /api/hospedagem/reservas/{id}/estadiasAcrescenta um troço (estadia) a uma reserva.
PUT /api/hospedagem/reservas/{id}/estadias/{estadiaId}Altera um troço de uma reserva pedida ou confirmada (datas, tipo, ocupantes, quarto).
DELETE /api/hospedagem/reservas/{id}/estadias/{estadiaId}Retira um troço de uma reserva.
PUT /api/hospedagem/reservas/{id}/estadias/{estadiaId}/quartoAtribui (ou muda) o quarto físico de um troço, sempre do mesmo tipo.
POST /api/hospedagem/reservas/{id}/depositos/pedirPede um depósito por referência à reserva.
POST /api/hospedagem/reservas/{id}/depositos/registarRegista um depósito já recebido (dinheiro, TPA, transferência confirmada).
POST /api/hospedagem/depositos/{id}/pagoMarca um depósito pedido como pago, com o método de pagamento e a referência.
POST /api/hospedagem/depositos/{id}/devolverDevolve um depósito pago (por exemplo, um cancelamento sem penalização).
POST /api/hospedagem/reservas/{id}/check-inO hóspede chegou: atribui os quartos que faltam (do tipo reservado, limpos e sem avaria), muda a reserva para «em casa» e abre o folio com a rota e o limite de crédito.
POST /api/hospedagem/reservas/{id}/pre-check-inRegista que o hóspede já tratou do pré-check-in (dados e documento entregues antes de chegar): à chegada só se atribui o quarto e se assina.
POST /api/hospedagem/reservas/{id}/check-outO hóspede saiu: lança as noites que faltam, liberta as noites seguintes (saída antecipada), deixa o quarto sujo com a limpeza de partida no plano e fecha o folio se nada falta facturar.
POST /api/hospedagem/reservas/{id}/estadias/{estadiaId}/estenderEstende a estadia de um hóspede em casa até uma nova partida.
POST /api/hospedagem/reservas/{id}/estadias/{estadiaId}/trocar-quartoTroca de quarto de um hóspede em casa (avaria, pedido, upgrade).
GET /api/hospedagem/reservas/{id}/folioO folio de uma reserva: os lançamentos, as janelas de facturação, as facturações e os depósitos pagos.
POST /api/hospedagem/reservas/{id}/folio/lancamentosLança um consumo ou um extra no folio: de um extra do catálogo (a quantidade sai da regra do extra) ou de um artigo à escolha.
POST /api/hospedagem/reservas/{id}/folio/taxasAplica ao folio as taxas de alojamento configuradas pela propriedade, calculadas pelas suas bases.
POST /api/hospedagem/reservas/{id}/folio/lancamentos/{lancamentoId}/estornarCorrige o folio estornando (total ou em parte) um lançamento, com motivo.
PUT /api/hospedagem/reservas/{id}/folio/limiteDefine o limite de crédito do folio (o que o hóspede pode dever, sem IVA, antes de a recepção ser avisada).
GET /api/hospedagem/reservas/{id}/folio/facturacaoO que se facturaria agora numa janela do folio: o total com IVA que o núcleo emitiria, os depósitos que se abateriam e se pode facturar.
POST /api/hospedagem/reservas/{id}/folio/facturarFactura uma janela do folio: um documento pelo comando do «Novo documento».
GET /api/hospedagem/housekeeping/planoO plano de limpezas do dia.
POST /api/hospedagem/housekeeping/plano/gerarGera o plano do dia a partir das reservas (partidas, estadias, preparações) e ordena-o: quem chega manda.
POST /api/hospedagem/housekeeping/plano/distribuirReparte as limpezas por fazer do dia pelas camareiras escolhidas: sempre para a que tem menos créditos.
PUT /api/hospedagem/housekeeping/tarefas/{id}/camareiraAtribui uma limpeza a uma camareira (ou retira a atribuição).
POST /api/hospedagem/housekeeping/tarefas/{id}/iniciarInicia uma limpeza.
POST /api/hospedagem/housekeeping/tarefas/{id}/concluirConclui uma limpeza.
POST /api/hospedagem/housekeeping/tarefas/{id}/nao-incomodarO hóspede pediu para não ser incomodado: a limpeza fica adiada e o quarto marcado, até a camareira voltar a tentar.
POST /api/hospedagem/housekeeping/tarefas/{id}/inspeccionarA governanta aprova (o quarto fica inspeccionado e pronto a vender) ou reprova com motivo (o quarto volta a sujo e a camareira refaz).
POST /api/hospedagem/housekeeping/minibarLança o consumo do minibar de um quarto ao folio do hóspede que lá está.
GET /api/hospedagem/manutencao/ticketsOs pedidos de manutenção.
POST /api/hospedagem/manutencao/ticketsAbre um pedido de manutenção (por exemplo, uma avaria vista pela camareira).
PUT /api/hospedagem/manutencao/tickets/{id}/tecnicoAtribui um pedido de manutenção a um técnico (ou retira a atribuição).
POST /api/hospedagem/manutencao/tickets/{id}/iniciarInicia um pedido de manutenção.
POST /api/hospedagem/manutencao/tickets/{id}/resolverResolve o pedido, dizendo o que se fez.
POST /api/hospedagem/manutencao/tickets/{id}/cancelarCancela um pedido de manutenção, com motivo.
PUT /api/hospedagem/manutencao/tickets/{id}/prioridadeMuda a prioridade de um pedido de manutenção.
GET /api/hospedagem/bloqueiosOs bloqueios de quartos (fora de serviço ou fora de venda).
POST /api/hospedagem/bloqueiosTira um quarto da venda entre duas datas.
POST /api/hospedagem/bloqueios/{id}/encerrarEncerra um bloqueio: o quarto volta a vender a partir de hoje (ou do primeiro dia do bloqueio, se ainda não começou).
GET /api/hospedagem/night-auditO estado do night audit: a data do hotel, se o fecho do dia é devido e os últimos fechos.
POST /api/hospedagem/night-audit/fecharFecha o dia da data do hotel à mão (o gerente).
GET /api/hospedagem/indicadoresOs indicadores hoteleiros de um período: ocupação, ADR, RevPAR e TRevPAR, mais o movimento (reservas, cancelamentos, no-shows, chegadas, partidas).

#Hóspedes (dados sensíveis)

As fichas dos hóspedes (documento de identificação, nacionalidade, data de nascimento, morada, preferências, lista negra), os ocupantes das reservas e o detalhe de uma reserva, que os inclui. São dados pessoais sensíveis: a chave só os alcança se o dono da empresa lhe deu, ao criá-la, acesso reforçado com um consentimento que cubra os hóspedes (versão 2 ou posterior), com endereços de rede e validade curta, e cada pedido fica registado. Ver Dados sensíveis.

GET /api/hospedagem/reservas/{id}Uma reserva completa: estadias, depósitos, ocupantes, movimentos e política.
POST /api/hospedagem/reservas/{id}/ocupantesAcrescenta um ocupante (hóspede acompanhante) a uma reserva, com o documento de identificação.
DELETE /api/hospedagem/ocupantes/{id}Remove um ocupante de uma reserva.
GET /api/hospedagem/fichas/{clienteId}A ficha de um hóspede sem o documento: se é VIP, se está na lista negra e como se reconhece o documento.
POST /api/hospedagem/fichas/{clienteId}/abrirAbre a ficha completa de um hóspede, com o número do documento.
PUT /api/hospedagem/fichas/{clienteId}Guarda a ficha de um hóspede: documento, nacionalidade, data de nascimento, morada, profissão, preferências, VIP e lista negra.
GET /api/hospedagem/fichas/{clienteId}/acessosQuem abriu a ficha de um hóspede e quando.

#Oficinas mecânicas

A oficina de viaturas e motorizadas: a ficha da viatura com livro de quilómetros, documentos com validade e plano de manutenção; o catálogo de operações com tempos padrão; a ordem de reparação (recepção, diagnóstico, inspecção, orçamento por trabalhos, decisão do cliente, execução, qualidade e entrega), o pátio, as garantias e os lembretes. A entrega cobra com um documento fiscal do núcleo, pelo fluxo de sempre.

GET /api/oficina/definicoesAs definições da oficina: os tipos de oficina, o diagnóstico, a validade do orçamento, os avisos do pátio, as taxas e o termo de entrada.
PUT /api/oficina/definicoesDefine as definições da oficina.
GET /api/oficina/modelosO catálogo de modelos de partida: as operações e os pontos de inspecção que se podem carregar para a empresa.
POST /api/oficina/catalogo/carregar-partidaAcrescenta ao catálogo da empresa as operações e os pontos de inspecção de partida dos tipos de oficina indicados (por omissão, os da configuração), saltando os que já existem.
GET /api/oficina/operacoesAs operações do catálogo da oficina, com os tempos padrão e as garantias.
POST /api/oficina/operacoesCria uma operação do catálogo.
PUT /api/oficina/operacoes/{id}Altera uma operação do catálogo.
POST /api/oficina/operacoes/de-modeloCria uma operação a partir de um modelo de partida (chave), ligada ao artigo de serviço indicado.
PUT /api/oficina/operacoes/{id}/activaActiva ou desactiva uma operação.
GET /api/oficina/pontosOs pontos de inspecção do catálogo.
POST /api/oficina/pontosCria um ponto de inspecção.
PUT /api/oficina/pontos/{id}Altera um ponto de inspecção.
PUT /api/oficina/pontos/{id}/activoActiva ou desactiva um ponto de inspecção.
GET /api/oficina/boxesOs boxes (postos de trabalho) da oficina.
POST /api/oficina/boxesCria um box.
PUT /api/oficina/boxes/{id}Altera um box.
GET /api/oficina/zonasAs zonas do pátio.
POST /api/oficina/zonasCria uma zona do pátio.
PUT /api/oficina/zonas/{id}Altera uma zona do pátio.
GET /api/oficina/viaturasAs viaturas registadas.
GET /api/oficina/viaturas/{id}Uma viatura completa: dados, proprietário e donos anteriores, quilómetros, documentos e plano de manutenção.
POST /api/oficina/viaturasRegista uma viatura.
PUT /api/oficina/viaturas/{id}Altera a matrícula, o VIN e os dados de uma viatura.
POST /api/oficina/viaturas/{id}/transferirTransfere a viatura para outro proprietário (outro cliente da empresa).
PUT /api/oficina/viaturas/{id}/activaActiva ou desactiva uma viatura.
POST /api/oficina/viaturas/{id}/kmRegista a quilometragem lida (pelo condutor ou pela recepção).
GET /api/oficina/viaturas/{id}/livroO livro da viatura: as entradas do historial, o que está por fazer, as garantias e os registos de quilómetros.
GET /api/oficina/viaturas/{id}/garantiasAs garantias activas da viatura.
POST /api/oficina/viaturas/{id}/documentosAcrescenta um documento da viatura (seguro, inspecção, selo…), com a referência e a validade.
PUT /api/oficina/viaturas/{id}/documentos/{documentoId}Altera um documento da viatura.
DELETE /api/oficina/viaturas/{id}/documentos/{documentoId}Remove um documento da viatura.
POST /api/oficina/viaturas/{id}/planoAcrescenta um item ao plano de manutenção da viatura, com os intervalos em quilómetros e em meses.
PUT /api/oficina/viaturas/{id}/plano/{itemId}Altera um item do plano de manutenção.
DELETE /api/oficina/viaturas/{id}/plano/{itemId}Remove um item do plano de manutenção.
GET /api/oficina/lembretesA lista accionável de lembretes: documentos a expirar ou expirados e revisões a breve ou em atraso, de todas as viaturas activas.
GET /api/oficina/ordensAs ordens de reparação.
GET /api/oficina/ordens/{id}Uma ordem de reparação completa: recepção, inspecção, trabalhos, orçamento, fotografias e entrega.
GET /api/oficina/quadroO quadro da oficina: as ordens por fase.
GET /api/oficina/patioO pátio: onde está cada viatura, há quantos dias e porquê.
POST /api/oficina/ordensRecebe uma viatura: abre a ordem de reparação com a quilometragem de entrada, o combustível, os objectos, o pedido do cliente e os danos.
POST /api/oficina/ordens/{id}/termoRegista a aceitação do termo de entrada pelo cliente (aceitePor).
POST /api/oficina/ordens/{id}/patioMove a viatura no pátio (zona, lugar e código da chave).
POST /api/oficina/ordens/{id}/prazoDefine (ou retira) o prazo prometido da ordem.
POST /api/oficina/ordens/{id}/diagnosticoRegista o diagnóstico: o texto, o tempo gasto e os códigos OBD.
POST /api/oficina/ordens/{id}/inspeccaoRegista o resultado de um ponto de inspecção, com a cor, a medição e a nota.
POST /api/oficina/ordens/{id}/trabalhosPropõe um trabalho na ordem.
POST /api/oficina/ordens/{id}/trabalhos/de-operacaoPropõe um trabalho a partir de uma operação do catálogo.
PUT /api/oficina/ordens/{id}/trabalhos/{trabalhoId}Altera um trabalho proposto.
DELETE /api/oficina/ordens/{id}/trabalhos/{trabalhoId}Remove um trabalho proposto.
POST /api/oficina/ordens/{id}/orcamentoEnvia o orçamento ao cliente: uma versão nova com todos os trabalhos por aprovar.
POST /api/oficina/ordens/{id}/trabalhos/{trabalhoId}/decisaoRegista a decisão do cliente sobre um trabalho, dada ao balcão, ao telefone ou presencialmente.
POST /api/oficina/ordens/{id}/trabalhos/{trabalhoId}/peca-em-faltaMarca (ou desmarca) um trabalho como à espera de peça, com a data prevista.
POST /api/oficina/ordens/{id}/trabalhos/{trabalhoId}/atribuirAtribui um trabalho a um mecânico e/ou a um box.
POST /api/oficina/ordens/{id}/trabalhos/{trabalhoId}/iniciarInicia a execução de um trabalho (num box, se indicado).
POST /api/oficina/ordens/{id}/trabalhos/{trabalhoId}/pausarPausa a execução de um trabalho, com motivo.
POST /api/oficina/ordens/{id}/trabalhos/{trabalhoId}/terminarTermina a execução de um trabalho.
POST /api/oficina/ordens/{id}/trabalhos/{trabalhoId}/linhas/{linhaId}/aplicarAplica (consome do stock) uma quantidade de uma peça de um trabalho.
POST /api/oficina/ordens/{id}/qualidade/aprovarAprova a qualidade da ordem, com o test-drive (quilómetros) e uma nota.
POST /api/oficina/ordens/{id}/qualidade/reprovarReprova a qualidade da ordem: os trabalhos indicados voltam à execução, com motivo.
GET /api/oficina/ordens/{id}/entrega/preparacaoO que se cobraria agora pela ordem, calculado pelo mesmo caminho que a emissão (promoções, retenções e arredondamento incluídos).
POST /api/oficina/ordens/{id}/entregaEntrega a viatura: emite um documento pelo mesmo comando do «Novo documento», grava a entrega e emite as garantias.
POST /api/oficina/ordens/{id}/cancelarCancela uma ordem, com motivo.
POST /api/oficina/ordens/{id}/responsabilidadeDefine a responsabilidade da garantia numa ordem aberta ao abrigo de uma garantia.
POST /api/oficina/garantias/{garantiaId}/reclamarAbre uma ordem de reparação ao abrigo de uma garantia.
POST /api/oficina/ordens/{id}/fotosAnexa uma fotografia a uma ordem (ou a um trabalho ou inspecção).
GET /api/oficina/fotos/{id}Descarrega uma fotografia de uma ordem.
GET /api/oficina/indicadoresOs indicadores da oficina num período.

#Lavandaria

A lavandaria de serviço: o catálogo (categorias, tipos de roupa, serviços, urgências, máquinas), as ordens de serviço com peças e etiquetas, o prazo prometido, a produção por fases (triagem, lavagem, secagem, acabamento, qualidade, pronta) com lotes em máquinas, os incidentes, as mensagens aos clientes e o levantamento, que emite um documento fiscal do núcleo pelo fluxo de sempre. Na recepção não se factura nada.

GET /api/lavandaria/categoriasAs categorias de roupa (com o peso médio de cada peça).
POST /api/lavandaria/categoriasCria uma categoria de roupa.
PUT /api/lavandaria/categorias/{id}Altera uma categoria de roupa.
GET /api/lavandaria/tipos-de-roupaOs tipos de roupa.
POST /api/lavandaria/tipos-de-roupaCria um tipo de roupa.
PUT /api/lavandaria/tipos-de-roupa/{id}Altera um tipo de roupa.
GET /api/lavandaria/servicosOs serviços de lavandaria, com as fases por que passam e os preços.
POST /api/lavandaria/servicosCria um serviço de lavandaria, ligado a um artigo do catálogo.
PUT /api/lavandaria/servicos/{id}Altera um serviço de lavandaria.
GET /api/lavandaria/urgenciasOs níveis de urgência (prazo mais curto, com acréscimo).
POST /api/lavandaria/urgenciasCria um nível de urgência: o nome, as horas de prazo e o acréscimo percentual.
PUT /api/lavandaria/urgencias/{id}Altera um nível de urgência.
GET /api/lavandaria/maquinasAs máquinas da lavandaria, com a capacidade e o estado.
POST /api/lavandaria/maquinasCria uma máquina.
PUT /api/lavandaria/maquinas/{id}Altera uma máquina.
POST /api/lavandaria/maquinas/{id}/avariaDeclara a avaria de uma máquina: a máquina sai do planeamento e, se tinha um lote em ciclo, o lote pára e as peças voltam à fila para outra máquina.
POST /api/lavandaria/maquinas/{id}/manutencaoPõe uma máquina em manutenção.
POST /api/lavandaria/maquinas/{id}/servicoRepõe uma máquina em serviço.
GET /api/lavandaria/configuracaoA configuração da lavandaria: prefixo das ordens, horário, folga de produção, tolerância de peso e política de abandono.
PUT /api/lavandaria/configuracaoDefine a configuração da lavandaria.
GET /api/lavandaria/ordensAs ordens de serviço do estabelecimento.
POST /api/lavandaria/ordensRecebe a roupa: cria a ordem de serviço com os itens, os preços (gravados no item, já com a urgência) e o prazo prometido.
GET /api/lavandaria/ordens/{id}Uma ordem de serviço completa, com as peças e o seu percurso.
POST /api/lavandaria/ordens/{id}/cancelarCancela uma ordem, com motivo.
GET /api/lavandaria/ordens/{id}/levantamento/preparacaoO que se cobraria agora por estas peças, calculado pelo mesmo caminho que a emissão (IVA, retenções, promoções e arredondamento incluídos).
POST /api/lavandaria/ordens/{id}/levantamentoO levantamento: o cliente leva as peças que estão prontas (todas ou só algumas) e paga.
POST /api/lavandaria/ordens/{id}/abandonarMarca uma ordem pronta e não levantada como abandonada, com o destino dado à roupa.
GET /api/lavandaria/prazoQuando ficaria pronta uma encomenda assim, antes de a gravar.
GET /api/lavandaria/pecas/{codigo}Procura uma peça pela etiqueta: onde está, em que ordem e o que lhe aconteceu.
POST /api/lavandaria/pecas/avancarFaz avançar a peça para a fase seguinte da sua rota.
POST /api/lavandaria/pecas/qualidade/aprovarAprova a qualidade e arruma a peça: fica pronta, com a posição onde está (prateleira, cabide, cacifo).
POST /api/lavandaria/pecas/qualidade/reprovarReprova a peça na qualidade.
PUT /api/lavandaria/pecas/{itemId}/peso-de-saidaRegista o peso da roupa à saída e diz se a diferença para a entrada passa a tolerância.
PUT /api/lavandaria/pecas/{itemId}/peso-de-entradaCorrige o peso de entrada de um saco pesado mal, antes de entrar em produção.
POST /api/lavandaria/pecas/{itemId}/fotosAnexa uma fotografia a uma peça.
GET /api/lavandaria/fotos/{id}Descarrega uma fotografia de uma peça.
GET /api/lavandaria/quadroO quadro de produção: uma coluna por fase (triagem, lavagem, secagem, acabamento, qualidade, pronta) com as peças que lá estão, as atrasadas primeiro.
GET /api/lavandaria/lotes/filaAs peças à espera de entrar num lote, numa fase.
GET /api/lavandaria/lotes/sugestaoPropõe lotes para as máquinas livres do tipo certo.
GET /api/lavandaria/lotesOs lotes em máquinas.
POST /api/lavandaria/lotesFecha um lote: a máquina entra em ciclo e as peças passam à fase do lote.
POST /api/lavandaria/lotes/{id}/terminarTermina o ciclo: a máquina fica livre e as peças avançam para a fase seguinte da sua rota.
POST /api/lavandaria/lotes/{id}/pararPára um lote em ciclo sem avaria (por exemplo, uma peça posta por engano): as peças voltam à fila e a máquina fica livre.
GET /api/lavandaria/incidentesOs incidentes (peça perdida, trocada, danificada…).
POST /api/lavandaria/incidentesAbre um incidente numa ordem ou numa peça.
POST /api/lavandaria/incidentes/{id}/resolverResolve um incidente: reprocessar, reparar, indemnizar ou sem razão.
GET /api/lavandaria/notificacoesAs mensagens da lavandaria aos clientes, com o canal, o texto e o resultado.
POST /api/lavandaria/notificacoes/{id}/enviadaMarca uma mensagem como enviada (o balcão abriu a ligação de WhatsApp e enviou-a).
GET /api/lavandaria/painelO painel do gerente: a produção do dia, o prazo cumprido, o dinheiro parado em roupa por levantar, a não-qualidade e as máquinas.

#Marcações

A agenda de profissionais, cadeiras, salas e equipamentos: serviços com depósito e tempos de preparação, horários e excepções, marcações com o seu ciclo de vida (pedida, confirmada, chegou, em atendimento, concluída, paga), fila de espera, lista de espera com ofertas de vaga, comissões e as mensagens aos clientes. A conta de uma marcação concluída fecha-se com um documento fiscal do núcleo, pelo fluxo de sempre.

GET /api/marcacoes/profissionaisOs profissionais da agenda.
POST /api/marcacoes/profissionaisCria um profissional da agenda.
PUT /api/marcacoes/profissionais/{id}Altera a ficha de um profissional.
PUT /api/marcacoes/profissionais/{id}/activoActiva ou desactiva um profissional.
GET /api/marcacoes/recursosOs recursos da agenda (cadeiras, salas, equipamentos).
POST /api/marcacoes/recursosCria um recurso da agenda.
PUT /api/marcacoes/recursos/{id}Altera o nome, o tipo e o estado de um recurso.
GET /api/marcacoes/servicosOs serviços que se podem marcar.
POST /api/marcacoes/servicosCria um serviço marcável, ligado a um artigo do catálogo.
PUT /api/marcacoes/servicos/{id}Altera um serviço marcável.
GET /api/marcacoes/horariosO horário semanal de um estabelecimento, de um profissional ou de um recurso.
PUT /api/marcacoes/horariosDefine o horário semanal de um alvo, por janelas.
GET /api/marcacoes/excepcoesAs excepções aos horários (feriados, férias, folgas, pausas, dias de horário especial…).
POST /api/marcacoes/excepcoesCria uma excepção ao horário: um bloqueio num intervalo, ou um dia de horário especial.
DELETE /api/marcacoes/excepcoes/{id}Elimina uma excepção ao horário.
GET /api/marcacoes/configuracaoA configuração da agenda: perfil de negócio, granularidade, tolerância de falta e overbooking.
PUT /api/marcacoes/configuracaoDefine a configuração da agenda.
GET /api/marcacoes/disponibilidadeAs horas possíveis para um serviço.
GET /api/marcacoes/agendaAs marcações de um período, na agenda.
GET /api/marcacoes/ocupacaoA ocupação das agendas, por profissional e por dia.
GET /api/marcacoes/{id}Uma marcação completa.
POST /api/marcacoesCria uma marcação para um cliente, com um ou mais serviços.
POST /api/marcacoes/{id}/aprovarAprova uma marcação pedida.
POST /api/marcacoes/{id}/depositoRegista o depósito recebido de uma marcação.
POST /api/marcacoes/{id}/reconfirmarReconfirma uma marcação (o cliente confirmou que vem).
PUT /api/marcacoes/{id}/notaMuda (ou retira) a nota de uma marcação.
GET /api/marcacoes/clientes/{clienteId}/historicoO que a agenda sabe de um cliente: marcações, visitas feitas, faltas, desmarcações, total pago, última visita, próxima marcação e as marcações mais recentes.
POST /api/marcacoes/{id}/chegouRegista a chegada do cliente.
POST /api/marcacoes/{id}/iniciarInicia o atendimento.
POST /api/marcacoes/{id}/pausarPausa o atendimento (uma pausa de processamento: o profissional fica livre, o recurso não).
POST /api/marcacoes/{id}/retomarRetoma o atendimento pausado.
POST /api/marcacoes/{id}/concluirConclui o atendimento.
POST /api/marcacoes/{id}/cancelarCancela uma marcação, com motivo.
POST /api/marcacoes/{id}/faltouMarca a falta do cliente.
POST /api/marcacoes/{id}/servicosAcrescenta um serviço a meio do atendimento.
POST /api/marcacoes/{id}/reagendarMuda uma marcação para outras horas: cria a nova, que herda o depósito e a nota, e deixa a antiga como «Reagendada», ligada à nova.
POST /api/marcacoes/{id}/contaFecha a conta de uma marcação concluída: os serviços feitos mais os produtos vendidos no fim, num só documento fiscal.
GET /api/marcacoes/comissoesAs comissões dos profissionais num período.
GET /api/marcacoes/filaA fila de espera: os clientes à espera de serem chamados para uma marcação imediata.
POST /api/marcacoes/filaPõe um cliente na fila, para um serviço e, se quiser, com um profissional preferido.
POST /api/marcacoes/fila/{id}/chamarChama o cliente: cria a marcação imediata (agora, com o profissional livre) em estado «Chegou».
POST /api/marcacoes/fila/{id}/desistirRegista que o cliente desistiu da fila.
GET /api/marcacoes/lista-de-esperaOs pedidos da lista de espera (clientes que querem uma vaga num período).
POST /api/marcacoes/lista-de-esperaAcrescenta um pedido à lista de espera: o cliente, o serviço, o período e, se quiser, as horas.
POST /api/marcacoes/lista-de-espera/{id}/cancelarCancela um pedido da lista de espera.
POST /api/marcacoes/ofertas/{id}/aceitarO cliente aceita a vaga oferecida: cria a marcação nessa hora (se ainda estiver livre) e satisfaz o pedido.
POST /api/marcacoes/ofertas/{id}/recusarO cliente recusa a vaga oferecida.
GET /api/marcacoes/notificacoesAs mensagens da agenda aos clientes, com o canal, o texto e o resultado.
POST /api/marcacoes/notificacoes/{id}/enviadaMarca uma mensagem como enviada (a recepção abriu a ligação de WhatsApp e enviou-a).
POST /api/marcacoes/seriesCria uma marcação e as suas repetições (semanal, de 15 em 15 dias ou de 4 em 4 semanas).
POST /api/marcacoes/series/{serieId}/cancelarCancela as marcações de uma repetição que ainda estão por cumprir.

#Contratos

Contratos de cliente e de fornecedor: partes, valores, prazo, renovação, versões e adendas, aprovação e assinatura, documentos anexos e o plano de facturação periódico, que emite as facturas dos períodos. Os estados de um contrato são: Rascunho, EmAprovacao, Aprovado, Assinado, Activo, Suspenso, EmRenovacao, Expirado, Rescindido e Encerrado. Quem submete um contrato não o aprova; a equipa do contrato e a alçada de aprovação não se gerem pela API.

GET /api/contratosOs contratos com o número, o título, a contraparte, o estado, os valores e a próxima emissão.
GET /api/contratos/{id}Um contrato completo: termos, versões, plano de facturação, execuções, acertos, documentos, registo de eventos e equipa.
GET /api/contratos/pendentes-de-facturacaoOs períodos de facturação pendentes de cada contrato: o período, a data de emissão, o valor-base e os períodos em atraso.
GET /api/contratos/acertosOs acertos dos contratos: a diferença entre o que se facturou e o que era esperado num período.
GET /api/contratos/configuracaoA configuração dos contratos da empresa: a alçada anual do gestor, acima da qual só a direcção aprova.
POST /api/contratosCria um contrato em rascunho, com o sentido (cliente ou fornecedor), o tipo, a parte, os termos e, se houver, o plano de facturação.
PUT /api/contratos/{id}Altera o título, o objecto, a data de início, o responsável, os termos e o plano de um contrato ainda em rascunho.
POST /api/contratos/{id}/submeterSubmete um rascunho a aprovação.
POST /api/contratos/{id}/devolverDevolve a rascunho um contrato que está em aprovação.
POST /api/contratos/{id}/aprovarAprova o contrato: atribui-lhe o número (por exemplo, CT 2026/0042) e congela a versão inicial.
POST /api/contratos/{id}/assinaturaRegista a assinatura do contrato, com a data e os signatários.
POST /api/contratos/{id}/dispensar-assinaturaDispensa a assinatura (por exemplo, uma aceitação por e-mail, que se anexa), com motivo.
POST /api/contratos/{id}/activarActiva o contrato assinado: a versão inicial passa a vigorar e o plano de facturação começa a contar.
POST /api/contratos/{id}/suspenderSuspende um contrato activo (ou em renovação), com motivo.
POST /api/contratos/{id}/reactivarReactiva um contrato suspenso: volta a activo.
POST /api/contratos/{id}/renovarRenova à mão: mais N meses, com os mesmos termos ou outros.
POST /api/contratos/{id}/rescindirRescinde o contrato, com o motivo, a data de efeito e, se houver, a penalidade.
POST /api/contratos/{id}/encerrarEncerra o contrato terminado, depois dos acertos: o plano já facturou tudo e não há acertos por tratar.
POST /api/contratos/{id}/adendasPropõe uma adenda: uma versão nova dos termos, com a data de efeito e o motivo.
POST /api/contratos/{id}/versoes/{numero}/aprovarAprova uma adenda (ou a revisão de preço que o sistema propôs).
POST /api/contratos/{id}/versoes/{numero}/recusarRecusa uma versão proposta, com motivo.
POST /api/contratos/acertos/{id}/resolverDá um acerto por resolvido, com a referência de como se resolveu.
POST /api/contratos/acertos/{id}/dispensarDispensa um acerto, com motivo.
POST /api/contratos/{id}/documentosAnexa um documento a um contrato (ou a uma das suas versões).
GET /api/contratos/{id}/documentos/{documentoId}Descarrega um documento anexado a um contrato.
GET /api/contratos/modelosOs modelos de contrato.
POST /api/contratos/modelosCria um modelo de contrato.
PUT /api/contratos/modelos/{id}Altera um modelo de contrato.
POST /api/contratos/gerar-facturasEmite os períodos pendentes dos contratos dos estabelecimentos da chave.

#Restauração

A sala e as mesas, os postos de preparação (cozinha, bar), o menu, as fichas técnicas dos pratos, as comandas com o seu ciclo (lançar, enviar à cozinha, servir, pedir a conta, cobrar) e os relatórios. A conta cobra-se com um documento fiscal do núcleo (factura/recibo ou factura), pelo fluxo de sempre. Cancelar um item já enviado exige a permissão própria: o pedido de autorização a um supervisor, por PIN, faz-se ao balcão e não está na API.

GET /api/restauracao/salaA planta da sala: as zonas e as mesas, com a posição e a forma de cada uma.
POST /api/restauracao/sala/zonasCria uma zona da sala.
PUT /api/restauracao/sala/zonas/{id}Altera o nome e a ordem de uma zona.
PUT /api/restauracao/sala/zonas/{id}/activaActiva ou desactiva uma zona.
POST /api/restauracao/sala/mesasCria uma mesa numa zona, com o número, a capacidade, a forma e a posição na planta.
PUT /api/restauracao/sala/mesas/{id}Altera a zona, o número, a capacidade, a forma e a posição de uma mesa.
PUT /api/restauracao/sala/mesas/{id}/activaActiva ou desactiva uma mesa.
POST /api/restauracao/sala/mesas/{id}/limparLimpa uma mesa que fechou: volta a poder ser ocupada.
GET /api/restauracao/postosOs postos de preparação (cozinha, bar…) onde chegam os talões.
POST /api/restauracao/postosCria um posto de preparação.
PUT /api/restauracao/postos/{id}Altera o nome, a ordem e o passo «em preparação» de um posto.
PUT /api/restauracao/postos/{id}/activoActiva ou desactiva um posto de preparação.
GET /api/restauracao/postos/{postoId}/taloesOs talões de um posto (o ecrã da cozinha): o que há por preparar e, se pedir, o histórico.
POST /api/restauracao/taloes/{talaoId}/prontoMarca o talão inteiro como pronto: tudo o que faltava preparar fica pronto.
GET /api/restauracao/menuO menu que o garçom vê: os artigos de venda activos, com o preço de tabela e o posto de cada um.
PUT /api/restauracao/produtos/{produtoId}/configDefine, para um artigo, o posto onde se prepara, o nome curto e o tempo-alvo de preparação (postoId, nomeCurto, tempoAlvoMinutos).
PUT /api/restauracao/produtos/{produtoId}/esgotadoMarca ou repõe um artigo como esgotado: a cozinha marca-o quando acaba, e o garçom deixa de o poder lançar em qualquer terminal.
PUT /api/restauracao/produtos/{produtoId}/quantidade-do-diaDefine quantas doses de um artigo se vendem hoje (ou tira o limite, com quantidade nula).
PUT /api/restauracao/produtos/{produtoId}/gruposDefine, de uma vez, os grupos de opções que um artigo oferece, pela ordem dada.
GET /api/restauracao/grupos-opcoesOs grupos de opções que um artigo pode oferecer, com as opções de cada um.
POST /api/restauracao/grupos-opcoesCria um grupo de opções, com o mínimo e o máximo que se podem escolher e as opções.
PUT /api/restauracao/grupos-opcoes/{id}Altera um grupo de opções (nome, mínimo, máximo, ordem, estado e opções).
GET /api/restauracao/fichasAs fichas técnicas dos pratos e das preparações.
GET /api/restauracao/fichas/{produtoId}A ficha técnica de um prato ou de uma preparação, com os ingredientes.
PUT /api/restauracao/fichas/{produtoId}Cria ou substitui a ficha técnica de um prato ou de uma preparação.
GET /api/restauracao/ingredientesOs artigos que se podem pôr numa ficha: os activos que controlam stock e as preparações já definidas.
GET /api/restauracao/preparacoes/candidatosOs artigos que podem passar a preparações: activos, de produto, sem stock próprio e que ainda não têm ficha.
POST /api/restauracao/comandasAbre uma comanda numa mesa.
GET /api/restauracao/comandas/{id}Uma comanda com os itens e o estado da conta.
GET /api/restauracao/mesas/{mesaId}/comandaA comanda aberta de uma mesa, ou nada se a mesa está livre.
POST /api/restauracao/comandas/{id}/itensLança um artigo na comanda.
PUT /api/restauracao/itens/{itemId}Altera a quantidade, a observação, o lugar ou a fase de um item.
DELETE /api/restauracao/itens/{itemId}Remove um item pendente da comanda (que ainda não foi enviado).
POST /api/restauracao/comandas/{id}/enviarEnvia a comanda: um talão por posto com os itens pendentes das fases já pedidas.
POST /api/restauracao/itens/{itemId}/servirMarca um item como servido.
POST /api/restauracao/itens/{itemId}/iniciarMarca o início da preparação de um item.
POST /api/restauracao/itens/{itemId}/prontoMarca um item como pronto.
POST /api/restauracao/itens/{itemId}/desfazer-prontoDesfaz o «pronto» nos 30 segundos seguintes (um toque enganado no ecrã).
POST /api/restauracao/itens/{itemId}/cancelarCancela um item já enviado, com um motivo estruturado.
POST /api/restauracao/itens/{itemId}/pedir-cancelamentoO posto (a cozinha, o bar) pede que um item já enviado seja cancelado: não o cancela, avisa o supervisor, que o vê na comanda e decide.
POST /api/restauracao/itens/{itemId}/dispensar-pedido-cancelamentoQuem tem a comanda (o garçom ou o supervisor) dispensa o pedido de cancelamento da cozinha: o item fica como estava.
POST /api/restauracao/comandas/{id}/anularAnula uma comanda.
POST /api/restauracao/comandas/{id}/transferirPassa a comanda inteira para outra mesa.
POST /api/restauracao/comandas/{id}/juntar-mesasJunta mesas livres à comanda (um grupo grande que ocupa duas ou três mesas): continua a haver uma só conta.
POST /api/restauracao/comandas/{id}/separar-mesaSepara uma mesa que estava junta: fica livre e a comanda continua com as outras.
POST /api/restauracao/comandas/{id}/trocar-garcomReatribui a mesa a outro garçom do mesmo estabelecimento.
POST /api/restauracao/comandas/{id}/mover-itensPassa itens (todos da mesma comanda) para outra comanda aberta do mesmo estabelecimento.
GET /api/restauracao/comandas/{id}/pre-contaA pré-conta, sem mexer na mesa: o que falta cobrar.
POST /api/restauracao/comandas/{id}/pedir-contaO cliente pede a conta: a mesa passa a «à espera de conta» e devolve-se a pré-conta.
POST /api/restauracao/comandas/{id}/reabrir-contaReabre a conta: o cliente afinal pede mais, ou a conta foi pedida por engano, e a mesa volta a «ocupada».
POST /api/restauracao/comandas/{id}/consulta-de-mesaEmite a Consulta de Mesa com tudo o que falta cobrar na comanda e passa a mesa a «conta pedida».
GET /api/restauracao/comandas/{id}/consultas-de-mesaAs consultas de mesa já emitidas para uma comanda, da mais recente para a mais antiga.
POST /api/restauracao/comandas/{id}/cobrarCobra uma parte da conta (ou toda) com um documento fiscal do núcleo: factura/recibo («FR», paga no acto) ou factura («FT», a crédito a um cliente especial).
GET /api/restauracao/relatorioO relatório da restauração de um período.
GET /api/restauracao/engenharia-do-menuA engenharia do menu de um período.
GET /api/restauracao/reposicaoA reposição de ingredientes: o que repor, com base no consumo recente.
GET /api/restauracao/auditoriaO registo de auditoria da sala, pesquisável por operador, mesa, tipo de acção e período.
GET /api/restauracao/reservasAs reservas de mesa de um dia, por hora.
GET /api/restauracao/reservas/{id}Uma reserva de mesa.
POST /api/restauracao/reservasCria uma reserva de mesa.
PUT /api/restauracao/reservas/{id}Altera uma reserva que ainda espera o cliente (mesa, hora, duração, pessoas, telefone e nota).
POST /api/restauracao/reservas/{id}/chegouRegista a chegada do cliente.
POST /api/restauracao/reservas/{id}/sentarRegista que o cliente se sentou (a reserva cumpriu-se e a mesa fica livre da reserva).
POST /api/restauracao/reservas/{id}/faltouRegista que o cliente não veio.
POST /api/restauracao/reservas/{id}/cancelarCancela uma reserva e liberta a mesa.