Proposal templates

The templates proposals are born from, with one marked as the default.

Command	HTTP	Description
proposal-templates list	GET /v1/proposal_templates	List proposal templates
proposal-templates create	POST /v1/proposal_templates	Create a proposal template
proposal-templates get	GET /v1/proposal_templates/{id}	Get a proposal template
proposal-templates update	PATCH /v1/proposal_templates/{id}	Update a proposal template
proposal-templates delete	DELETE /v1/proposal_templates/{id}	Delete a proposal template
proposal-templates activate	POST /v1/proposal_templates/{id}/activate	Activate a proposal template
proposal-templates deactivate	POST /v1/proposal_templates/{id}/deactivate	Deactivate a proposal template
proposal-templates duplicate	POST /v1/proposal_templates/{id}/duplicate	Duplicate a proposal template
proposal-templates set-default	POST /v1/proposal_templates/{id}/set-default	Set the template as default

Examples

--params carries query and path parameters (id, page, filters); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List proposal templates
kobana billing proposal-templates list \
  --fields "id,public_id,external_id,name,description"

# Get a proposal template
kobana billing proposal-templates get \
  --params '{"id": "PROPOSAL_TEMPLATE_ID"}'

# Create a proposal template
kobana billing proposal-templates create \
  --json '{"name": "NAME", "googleDocId": "GOOGLEDOCID"}'

# Update a proposal template
kobana billing proposal-templates update \
  --params '{"id": "PROPOSAL_TEMPLATE_ID"}' \
  --json '{"name": "NAME", "description": "DESCRIPTION", "documentType": "google_doc"}'

# Activate a proposal template
kobana billing proposal-templates activate \
  --params '{"id": "PROPOSAL_TEMPLATE_ID"}'

# Delete a proposal template
kobana billing proposal-templates delete \
  --params '{"id": "PROPOSAL_TEMPLATE_ID"}' \
  --dry-run

Next steps

• Invoices (NF-e)
• Schema introspection — every parameter this resource accepts.