Saltar al contenido principal

Propuestas

Propuestas comerciales — del borrador a la aceptación, donde una firma se convierte en suscripción — y las plantillas con que se generan.

Familias en esta página​

FamiliaToolsreadwritedestructive
proposals — Propuestas257117
templates — Plantillas de propuesta9261

proposals​

ToolTipoPermisoEndpointQué hace
billing_proposals_listreadproposals.listGET /v1/proposalsList commercial proposals.
billing_proposals_getreadproposals.showGET /v1/proposals/:idFetch one proposal with its items and totals.
billing_proposals_createwriteproposals.createPOST /v1/proposalsCreate a draft proposal.
billing_proposals_upsertwriteproposals.createPUT /v1/proposalsCreate or update a proposal matched on id → external_id → code.
billing_proposals_updatewriteproposals.updatePATCH /v1/proposals/:idUpdate a proposal.
billing_proposals_deletedestructiveproposals.deleteDELETE /v1/proposals/:idSoft-delete a proposal.
billing_proposals_publishwriteproposals.updatePOST /v1/proposals/:id/publishPublish a proposal, making its public link reachable by the prospect.
billing_proposals_unpublishdestructiveproposals.updatePOST /v1/proposals/:id/unpublishTake a proposal offline; the public link stops resolving.
billing_proposals_sendwriteproposals.sendPOST /v1/proposals/:id/sendE-mail a proposal to its contact and move it to sent.
billing_proposals_acceptwriteproposals.approvePOST /v1/proposals/:id/acceptAccept a proposal on behalf of the customer.
billing_proposals_undo_acceptdestructiveproposals.approvePOST /v1/proposals/:id/undo-acceptUndo an acceptance, sending the proposal back to sent.
billing_proposals_canceldestructiveproposals.updatePOST /v1/proposals/:id/cancelCancel a proposal.
billing_proposals_duplicatewriteproposals.createPOST /v1/proposals/:id/duplicateCopy a proposal and its items into a new draft.
billing_proposals_generate_pdfwriteproposals.updatePOST /v1/proposals/:id/generate-pdfRender the proposal PDF from its template and store it.
billing_proposals_pricingreadproposals.showGET /v1/proposals/:id/pricingPrice breakdown of a proposal on every billing cycle: setup, monthly, cycle discount and total — what the prospect sees before picking one.
billing_proposals_jsonreadproposals.showGET /v1/proposals/:id/jsonThe full proposal payload as the template renderer receives it — the merge data behind the PDF.
billing_proposals_statsreadproposals.listGET /v1/proposals/statsAggregate proposal counts and values by status, for the whole organization.
billing_proposals_items_listreadproposals.showGET /v1/proposals/:id/itemsList the items of a proposal.
billing_proposals_items_createwriteproposals.updatePOST /v1/proposals/:id/itemsAdd an item to a draft proposal.
billing_proposals_items_getreadproposals.showGET /v1/proposals/:id/items/:itemIdFetch one proposal item with its negotiated pricing.
billing_proposals_items_updatewriteproposals.updatePATCH /v1/proposals/:id/items/:itemIdUpdate one item of a draft proposal.
billing_proposals_items_deletedestructiveproposals.updateDELETE /v1/proposals/:id/items/:itemIdRemove an item from a draft proposal.
billing_proposals_bulk_sendwriteproposals.sendPOST /v1/proposals/bulk-sendSend up to 100 proposals in one call.
billing_proposals_bulk_canceldestructiveproposals.updatePOST /v1/proposals/bulk-cancelCancel up to 100 proposals in one call.
billing_proposals_bulk_deletedestructiveproposals.deletePOST /v1/proposals/bulk-deleteSoft-delete up to 100 proposals in one call.

templates​

ToolTipoPermisoEndpointQué hace
billing_proposal_templates_listreadtemplates.listGET /v1/proposal_templatesList the templates proposals are rendered from.
billing_proposal_templates_getreadtemplates.showGET /v1/proposal_templates/:idFetch one proposal template.
billing_proposal_templates_createwritetemplates.createPOST /v1/proposal_templatesCreate a proposal template.
billing_proposal_templates_upsertwritetemplates.createPUT /v1/proposal_templatesCreate or update a proposal template matched on id → external_id → name.
billing_proposal_templates_updatewritetemplates.updatePATCH /v1/proposal_templates/:idUpdate a proposal template.
billing_proposal_templates_deletedestructivetemplates.deleteDELETE /v1/proposal_templates/:idSoft-delete a proposal template.
billing_proposal_templates_activatewritetemplates.updatePOST /v1/proposal_templates/:id/activateMake a template selectable on new proposals.
billing_proposal_templates_deactivatewritetemplates.updatePOST /v1/proposal_templates/:id/deactivateHide a template from new proposals.
billing_proposal_templates_duplicatewritetemplates.createPOST /v1/proposal_templates/:id/duplicateCopy a proposal template into a new one, ready to be edited.

Los campos de cada recurso están en la Referencia de la API y en billing_schemas_get.

Una tool que no puedes ejecutar no aparece en tools/list. Si falta alguna de esta página, ve Autenticación.