Pular para o conteúdo principal

Propostas

O orçamento antes da assinatura: publicar, enviar, gerar PDF e aceitar. Aceitar é o que converte a proposta em assinatura — e undo-accept desfaz.

ComandoHTTPDescrição
proposals listGET /v1/proposalsListar propostas
proposals createPOST /v1/proposalsCriar proposta
proposals getGET /v1/proposals/{id}Obter proposta
proposals updatePATCH /v1/proposals/{id}Atualizar proposta
proposals deleteDELETE /v1/proposals/{id}Excluir proposta
proposals acceptPOST /v1/proposals/{id}/acceptAceitar proposta
proposals cancelPOST /v1/proposals/{id}/cancelCancelar proposta
proposals duplicatePOST /v1/proposals/{id}/duplicateDuplicar proposta
proposals generate-pdfPOST /v1/proposals/{id}/generate-pdfGerar PDF da proposta
proposals jsonGET /v1/proposals/{id}/jsonObter snapshot JSON da proposta
proposals pricingGET /v1/proposals/{id}/pricingObter cálculo de preço da proposta
proposals publishPOST /v1/proposals/{id}/publishPublicar proposta
proposals sendPOST /v1/proposals/{id}/sendEnviar proposta por e-mail
proposals undo-acceptPOST /v1/proposals/{id}/undo-acceptDesfazer aceite da proposta
proposals unpublishPOST /v1/proposals/{id}/unpublishDespublicar proposta
proposals bulk-cancel createPOST /v1/proposals/bulk-cancelCancelar propostas em lote
proposals bulk-delete createPOST /v1/proposals/bulk-deleteExcluir propostas em lote
proposals bulk-send createPOST /v1/proposals/bulk-sendEnviar propostas em lote
proposals items getGET /v1/proposals/{id}/itemsListar itens da proposta
proposals items createPOST /v1/proposals/{id}/itemsAdicionar item à proposta
proposals items updatePATCH /v1/proposals/{id}/items/{itemId}Atualizar item da proposta
proposals items deleteDELETE /v1/proposals/{id}/items/{itemId}Excluir item da proposta
proposals stats listGET /v1/proposals/statsObter estatísticas de propostas

Exemplos​

--params carrega parâmetros de query e de caminho (id, página, filtros); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

# Listar propostas
kobana billing proposals list \
--fields "id,public_id,external_id,company_id,code"

# Obter proposta
kobana billing proposals get --params '{"id": "PROPOSAL_ID"}'

# Criar proposta
kobana billing proposals create \
--json '{"company_id": "COMPANY_ID", "title": "TITLE", "description": "DESCRIPTION"}'

# Atualizar proposta
kobana billing proposals update \
--params '{"id": "PROPOSAL_ID"}' \
--json '{"company_id": "COMPANY_ID", "title": "TITLE", "description": "DESCRIPTION"}'

# Aceitar proposta
kobana billing proposals accept \
--params '{"id": "PROPOSAL_ID"}' \
--json '{"cycle": "monthly"}'

# Excluir proposta
kobana billing proposals delete --params '{"id": "PROPOSAL_ID"}' --dry-run

Próximos passos​