Comercial e faturação

Clientes, vendas, o ponto de venda, e a fatura que a AGT aceita.

É o módulo que todos os negócios usam, e o que carrega a obrigação legal. As séries são numeradas sem buracos, os documentos são assinados, e o SAF-T (AO) exporta-se do próprio ecrã. Uma venda confirmada não se edita: anula-se, com nota de crédito, porque é assim que a lei quer e é assim que uma inspeção consegue seguir o rasto.

O que a licença destranca#

Este módulo exige a funcionalidade comercial na licença. Sem ela, as rotas dele respondem 403 e o menu não o mostra.

Precisa de: armazem. Sem eles, este módulo não faz o que promete.

Aproveita: contabilidade, tesouraria. Sem eles funciona, e faz menos.

Não se instala sem: armazem. É a ordem de arranque, e não a lista comercial.

É o módulo principal de: Todos os negócios.

O que se consegue ver a acontecer#

• Uma venda ao balcão fecha-se pelo teclado, sem tocar no rato
• A fatura-recibo sai numerada, assinada, e com o NIF do cliente quando ele o dá
• Um cliente com limite de crédito é travado quando o ultrapassa
• O preço sai da tabela do cliente, da do grupo dele, ou da ficha do produto
• O turno de caixa abre e fecha com a contagem do dinheiro
• O SAF-T do mês exporta-se num clique

Os 92 endpoints#

Saem da árvore de rotas montada, que é a mesma que serve os pedidos. A referência completa, com corpos e respostas, está em /api.

Método	Caminho	O que faz
GET	/api/v1/comercial/avencas	Lista as vendas recorrentes
POST	/api/v1/comercial/avencas	Cria uma venda que se repete
GET	/api/v1/comercial/avencas/:id	Mostra uma avença com as linhas
POST	/api/v1/comercial/avencas/:id/desligar	Pára a emissão sem apagar o histórico
POST	/api/v1/comercial/avencas/:id/ligar	Retoma a emissão
POST	/api/v1/comercial/avencas/emitir	Emite já as avenças vencidas
GET	/api/v1/comercial/clientes	Lista os clientes
POST	/api/v1/comercial/clientes	Cria um cliente
DELETE	/api/v1/comercial/clientes/:id	Apaga um cliente
GET	/api/v1/comercial/clientes/:id	Mostra um cliente
PUT	/api/v1/comercial/clientes/:id	Atualiza um cliente
GET	/api/v1/comercial/clientes/:id/extrato	Extrato do cliente
POST	/api/v1/comercial/clientes/:id/movimentos	Lança um movimento na conta corrente
GET	/api/v1/comercial/clientes/:id/saldo	Saldo devedor e crédito disponível
GET	/api/v1/comercial/clientes/busca	Procura clientes para o balcão
POST	/api/v1/comercial/clientes/importar	Importa clientes de uma folha de cálculo
GET	/api/v1/comercial/comissoes	Lista os movimentos de comissão
POST	/api/v1/comercial/comissoes/apurar	Apura as comissões de um período
POST	/api/v1/comercial/comissoes/enviar-rh	Fecha o período, marcando as comissões como pagas
GET	/api/v1/comercial/comissoes/mapa	Total de comissões por vendedor num período
GET	/api/v1/comercial/comissoes/regras	Lista as regras de comissão
POST	/api/v1/comercial/comissoes/regras	Cria uma regra de comissão
DELETE	/api/v1/comercial/comissoes/regras/:id	Apaga uma regra de comissão
GET	/api/v1/comercial/definicoes	Mostra as definições comerciais da empresa
PUT	/api/v1/comercial/definicoes	Guarda as definições comerciais da empresa
GET	/api/v1/comercial/descontos	Lista as regras de desconto
POST	/api/v1/comercial/descontos	Cria uma regra de desconto
DELETE	/api/v1/comercial/descontos/:id	Apaga uma regra de desconto
GET	/api/v1/comercial/documentos	Lista os documentos fiscais emitidos
GET	/api/v1/comercial/documentos/:id	Mostra um documento fiscal
POST	/api/v1/comercial/documentos/:id/anular	Anula um documento sem libertar o número
POST	/api/v1/comercial/documentos/:id/imprimir	Devolve o talão térmico em ESC/POS
GET	/api/v1/comercial/documentos/:id/pdf	Imprime o documento em PDF
GET	/api/v1/comercial/documentos/:id/talao	Devolve o talão numa página pronta a imprimir
GET	/api/v1/comercial/fiscal/isencoes	Lista os motivos de isenção de IVA
GET	/api/v1/comercial/fiscal/saft	Exporta o SAF-T do período
GET	/api/v1/comercial/fiscal/verificar-cadeia	Percorre as séries à procura de quebras no encadeamento
GET	/api/v1/comercial/grupos-cliente	Lista os grupos de clientes
POST	/api/v1/comercial/grupos-cliente	Cria um grupo de clientes
GET	/api/v1/comercial/orcamentos	Lista os orçamentos
POST	/api/v1/comercial/orcamentos	Cria um orçamento em rascunho
GET	/api/v1/comercial/orcamentos/:id	Mostra um orçamento com as linhas
POST	/api/v1/comercial/orcamentos/:id/aceitar	Regista o sim do cliente
POST	/api/v1/comercial/orcamentos/:id/anular	Retira o orçamento
POST	/api/v1/comercial/orcamentos/:id/converter	Transforma um orçamento aceite numa venda
POST	/api/v1/comercial/orcamentos/:id/enviar	Marca o orçamento como enviado ao cliente
GET	/api/v1/comercial/orcamentos/:id/proforma	-
POST	/api/v1/comercial/orcamentos/:id/recusar	Regista o não, com o motivo
GET	/api/v1/comercial/orcamentos/a-expirar	Os orçamentos que perdem validade nos próximos dias
GET	/api/v1/comercial/pagamentos	Lista as cobranças eletrónicas
GET	/api/v1/comercial/pagamentos/:id	Mostra uma cobrança
POST	/api/v1/comercial/pagamentos/:id/reconciliar	Pergunta ao agregador o estado de uma cobrança
POST	/api/v1/comercial/pagamentos/iniciar	Pede ao agregador uma cobrança para uma venda
GET	/api/v1/comercial/painel	Os números de abertura do módulo comercial
GET	/api/v1/comercial/pos/cliente	Procura um cliente por nome, NIF ou telefone
GET	/api/v1/comercial/pos/produto	Lê um produto pelo código de barras ou pelo SKU
GET	/api/v1/comercial/pos/turno	O turno de caixa em curso
POST	/api/v1/comercial/pos/turno/:id/fechar	Fecha o turno e regista a diferença
POST	/api/v1/comercial/pos/turno/abrir	Abre um turno de caixa
GET	/api/v1/comercial/pos/turnos	Histórico de turnos de caixa
POST	/api/v1/comercial/pos/venda	Faz uma venda de balcão numa só chamada
GET	/api/v1/comercial/precos/resolver	Resolve o preço de um produto para um cliente
GET	/api/v1/comercial/relatorios/comissoes	Mapa de comissões de um período
GET	/api/v1/comercial/relatorios/contas-a-receber	Antiguidade de saldos por cliente
GET	/api/v1/comercial/relatorios/faturas-vencidas	Os documentos por cobrar cujo prazo já passou
GET	/api/v1/comercial/relatorios/margem	Margem por produto
GET	/api/v1/comercial/relatorios/ranking-produtos	Os artigos que mais faturam
GET	/api/v1/comercial/relatorios/variacao-cambial	O que a variação cambial fez ao que está por receber
GET	/api/v1/comercial/relatorios/vendas	Vendas somadas por dia, produto, cliente ou vendedor
GET	/api/v1/comercial/series	Lista as séries de documento
POST	/api/v1/comercial/series	Cria uma série
GET	/api/v1/comercial/series/:id	Mostra uma série
PUT	/api/v1/comercial/series/:id	Atualiza uma série
POST	/api/v1/comercial/series/:id/revogar	-
GET	/api/v1/comercial/series/postos	-
POST	/api/v1/comercial/series/postos	-
GET	/api/v1/comercial/tabelas-preco	Lista as tabelas de preço
POST	/api/v1/comercial/tabelas-preco	Cria uma tabela de preço
GET	/api/v1/comercial/tabelas-preco/:id	Mostra uma tabela com os preços dela
PUT	/api/v1/comercial/tabelas-preco/:id/precos	Define o preço de um produto na tabela
DELETE	/api/v1/comercial/tabelas-preco/:id/precos/:produto	Tira um produto da tabela
GET	/api/v1/comercial/vendas	Lista as vendas
POST	/api/v1/comercial/vendas	Abre uma venda em rascunho
DELETE	/api/v1/comercial/vendas/:id	Apaga um rascunho
GET	/api/v1/comercial/vendas/:id	Mostra uma venda com as linhas e os pagamentos
PUT	/api/v1/comercial/vendas/:id	Substitui as linhas de um rascunho
POST	/api/v1/comercial/vendas/:id/anular	Anula uma venda
POST	/api/v1/comercial/vendas/:id/confirmar	Confirma a venda
POST	/api/v1/comercial/vendas/:id/devolucao	Aceita parte da mercadoria de volta
POST	/api/v1/comercial/vendas/:id/pagamentos	Recebe dinheiro de uma venda
GET	/api/v1/comercial/vendas/:id/pdf	Imprime a venda em PDF
PUT	/api/v1/comercial/vendas/:id/vendedores	Reparte uma venda por vários vendedores