Contratos e avenças

Faturação recorrente, com renovação e revisão de preço.

Para quem cobra todos os meses o mesmo: avenças de manutenção, mensalidades, alugueres. O contrato emite sozinho na data, e avisa antes de renovar, porque uma renovação automática que ninguém viu é a reclamação do mês seguinte.

O que a licença destranca#

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

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

Aproveita: compras, rh. Sem eles funciona, e faz menos.

O que se consegue ver a acontecer#

• Um contrato emite a fatura do período na data, sem ninguém carregar em nada
• Uma revisão de preço aplica-se a partir da data que se lhe der, e não retroage
• Um contrato a chegar ao fim aparece na lista antes de renovar
• A rescisão calcula o que falta faturar até ao fim do aviso prévio

Os 36 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/contrato/contratos	Lista os contratos
POST	/api/v1/contrato/contratos	Cria um contrato, em rascunho
GET	/api/v1/contrato/contratos/:id	Mostra um contrato
PUT	/api/v1/contrato/contratos/:id	Atualiza um contrato
POST	/api/v1/contrato/contratos/:id/aprovar	Aprova o contrato
POST	/api/v1/contrato/contratos/:id/assinar	Regista que as partes assinaram
GET	/api/v1/contrato/contratos/:id/assinaturas	Quem já assinou um contrato
POST	/api/v1/contrato/contratos/:id/assinaturas	Regista quem assinou o contrato
POST	/api/v1/contrato/contratos/:id/ativar	Põe o contrato em vigor
POST	/api/v1/contrato/contratos/:id/avenca	Liga o contrato à venda recorrente que o factura
GET	/api/v1/contrato/contratos/:id/denuncia	Este contrato está denunciado?
POST	/api/v1/contrato/contratos/:id/denuncia	Avisa que o contrato não vai continuar
GET	/api/v1/contrato/contratos/:id/pdf	O contrato em PDF
GET	/api/v1/contrato/contratos/:id/percurso	Quem decidiu o quê, e quando
GET	/api/v1/contrato/contratos/:id/pre-visualizacao	O texto do contrato, sem o embrulhar em PDF
POST	/api/v1/contrato/contratos/:id/rejeitar	Devolve o contrato ao rascunho
POST	/api/v1/contrato/contratos/:id/renovar	Renova o contrato à mão
POST	/api/v1/contrato/contratos/:id/rescindir	Termina o contrato antes do fim
POST	/api/v1/contrato/contratos/:id/rever	Marca que alguém começou a rever
GET	/api/v1/contrato/contratos/:id/revisoes	O histórico de preços de um contrato
POST	/api/v1/contrato/contratos/:id/revisoes	Atualiza o valor do contrato
POST	/api/v1/contrato/contratos/:id/submeter	Entrega o contrato para revisão
GET	/api/v1/contrato/contratos/:id/valor-em	Por quanto estava o contrato numa data
GET	/api/v1/contrato/contratos/:id/versoes	Histórico de versões
GET	/api/v1/contrato/contratos/:id/versoes/:v	O contrato como ele estava numa versão
GET	/api/v1/contrato/contratos/a-expirar	Contratos que acabam nos próximos dias
GET	/api/v1/contrato/contratos/relatorios/a-expirar	Contratos a expirar, por mês
GET	/api/v1/contrato/contratos/relatorios/ativos	Contratos em vigor
GET	/api/v1/contrato/contratos/relatorios/por-tipo	Contagem e valor por tipo de contrato
GET	/api/v1/contrato/contratos/relatorios/valor-comprometido	O que a empresa está obrigada a pagar
GET	/api/v1/contrato/partes	Procura clientes, fornecedores ou funcionários
GET	/api/v1/contrato/sem-faturacao	Os contratos recorrentes que não faturam nada
GET	/api/v1/contrato/templates	Lista os modelos de documento
POST	/api/v1/contrato/templates	Cria um modelo
DELETE	/api/v1/contrato/templates/:id	Apaga um modelo
PUT	/api/v1/contrato/templates/:id	Atualiza um modelo