Orçamentos, Produtos e PDFs
Endpoints para gerenciar catálogo de produtos, emissão de cotações comerciais, cálculo de descontos e geração de PDFs.
O Perpetuus CRM possui ferramentas comerciais nativas para emissão de orçamentos e propostas comerciais em PDF diretamente a partir do histórico de cards dos boards.
Catálogo de Produtos e Categorias
Antes de emitir cotações comerciais, você deve estruturar seus produtos ou serviços.
1. Criar Produto
- Método:
POST - Caminho:
/products - Payload:
{ "data": { "name": "Plano Anual Enterprise", "sku": "PLANO-ENTERPRISE-ANUAL", "price": 12000.00, "minPrice": 9600.00, "productType": "digital", "billingType": "recurring" } }
Piso de Preço (minPrice): Se você tentar emitir um orçamento contendo um produto com valor unitário menor que o seu minPrice configurado, a API retornará status 400 Bad Request, a menos que o token de API possua a permissão explícita de override de tabela.
2. Listar Categorias de Produtos
Permite organizar e classificar o catálogo.
- Método:
GET - Caminho:
/product-categories
Módulo de Orçamentos (Quotes)
Cotações comerciais vinculadas a um card e a um contato.
1. Criar Orçamento Comercial
Cria um orçamento para o card. O número do documento, o subtotal e o total geral são calculados automaticamente pelo servidor.
-
Método:
POST -
Caminho:
/quotes -
Payload de Exemplo:
{ "card": "card_doc_id_lead_xyz", "contact": "contact_doc_id_cliente", "discountType": "percentage", "discountValue": 10.00, "updateCardValue": true, "items": [ { "name": "Licenças de Uso Software", "quantity": 10, "unitPrice": 120.00 }, { "product": "product_anual_enterprise", "quantity": 1, "unitPrice": 11000.00 } ] } -
updateCardValue: Se definido comotrue, o valor total calculado do orçamento atualizará automaticamente a propriedadevaluedo card vinculado no Kanban.
2. Ativar Orçamento
Marca este orçamento como active (ativo) e rebaixa automaticamente qualquer outro orçamento anteriormente ativo para o mesmo card para draft (rascunho).
- Método:
POST - Caminho:
/quotes/{id}/activate
3. Duplicar Orçamento
Cria uma nova versão de rascunho (draft) copiando os dados do orçamento original, gerando um novo número e incrementando a versão do documento.
- Método:
POST - Caminho:
/quotes/{id}/duplicate
4. Gerar PDF do Orçamento (Download)
Gera e renderiza a proposta comercial em formato PDF estruturado para download.
- Método:
GET - Caminho:
/quotes/{id}/pdf - Parâmetro de Consulta:
templateId: Opcional.documentIddo PDF Template que deseja forçar no layout. Se omitido, usará o template padrão configurado no Board.