salvar_modelo_proposta
Create or update a proposal, sale, or document template in Ploomes CRM. Manages HTML content, margins, and page setup for automated PDF generation.
Instructions
Criar ou atualizar um modelo de Proposta/Venda/Documento (PVD) no Ploomes CRM.
Passe o ID (DocumentTemplateId) para atualizar um modelo existente.
Observações (revisadas a partir de captura real de rede do app Ploomes
ao criar um modelo em Configurações > Modelos de proposta):
1. entidade_id (EntityId): obrigatório ao criar um modelo novo. Use
buscar_campos_entidades ou buscar_schema para descobrir o EntityId
de Proposta (Quotes), Venda (Orders), Documento do Negócio ou
Documento do Cliente.
2. O Formulário (Form) do modelo é criado automaticamente pelo
Ploomes ao criar o DocumentTemplate (o próprio app não cria um
Form à parte antes). Não crie um Form manualmente — informe
form_id apenas se quiser reaproveitar um formulário já existente.
3. O conteúdo do PDF (cabeçalho/rodapé/corpo HTML e margens) vive
dentro de "páginas" do modelo (Pages), não em campos soltos do
DocumentTemplate. Ao criar um modelo sem pagina_id, este tool
cria a primeira página automaticamente ("Seção 1", margens de
20mm) com o HTML informado. Para editar uma página existente,
informe pagina_id (Id dentro de Pages — consulte
buscar_templates_documentos com $expand=Pages).
4. Ao atualizar (id informado) sem pagina_id, cabecalho_html/
rodape_html/corpo_html/margens são ignorados (não há como saber
qual página alterar) e o tool retorna erro pedindo pagina_id.
5. Depois de criado, use salvar_secao_formulario_proposta e
salvar_campo_formulario_proposta para montar os campos do
formulário do modelo (o que o usuário preenche ao gerar a PVD).
6. Blocos de produto (grupo repetível de itens da proposta): o
formulário do modelo é DERIVADO pelo Ploomes a partir do parsing
do HTML salvo em corpo_html (Pages[].BodySourceCode) — não existe
endpoint de "criar campo de bloco" isolado. Depois de criar o
modelo aqui, use montar_bloco_produtos_proposta para inserir o
bloco de Produtos no HTML da página automaticamente. Bloco de
parcelas ainda não tem ferramenta equivalente.
7. margem_topo/margem_rodape/margem_lateral são em mm e afetam o PDF,
não o HTML.
8. cabecalho_html/rodape_html/corpo_html aceitam código HTML com
referências a campos (ex.: [Negócio.Título]) — veja um modelo
existente com buscar_formulario_proposta como referência.
9. Confirme o resultado com buscar_templates_documentos e
buscar_formulario_proposta após salvar, e valide numa conta de
sandbox antes de usar em produção — parte dos campos desta
entidade têm documentação de API incompleta.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | ||
| nome | Yes | ||
| padrao | No | ||
| form_id | No | ||
| pagina_id | No | ||
| corpo_html | No | ||
| entidade_id | No | ||
| margem_topo | No | ||
| nome_pagina | No | ||
| rodape_html | No | ||
| altura_rodape | No | ||
| margem_rodape | No | ||
| tem_paginacao | No | ||
| cabecalho_html | No | ||
| margem_lateral | No | ||
| altura_cabecalho | No | ||
| ordenacao_pagina | No | ||
| equipes_permitidas | No | ||
| usuarios_permitidos | No | ||
| campo_valor_parcelas | No | ||
| formula_nome_arquivo | No | ||
| parcelas_obrigatorias | No | ||
| variaveis_nome_arquivo | No |