V2
Vendas
Introdução

Como Criar uma Nova Venda

Este guia apresenta o fluxo completo de criação de uma nova venda utilizando as funções disponíveis na API. O processo é composto por três etapas principais, cada uma implementada por uma api:

  1. Criar Venda (NewSale)
  2. Enviar Evidências (UploadEvidences)
  3. Concluir Venda (ConcludeSale)

📌 1. Criar Venda - NewSale

Responsável por iniciar o processo de venda.


📎 2. Enviar Evidências - UploadEvidences

Após a criação da venda, é necessário enviar os documentos obrigatórios.

  • Cada documento deve ser classificado com um evidenceType específico.
  • Para NEOENERGIA, os tipos aceitos são:
    • POV – Áudio do contratante
    • AUT – Áudio do responsável financeiro
    • DOC_CONTRATANTE – Documento do contratante (PDF)
    • DOC_RESPONSAVEL_FINANCEIRO – Documento do responsável financeiro (PDF)

A obrigatoriedade dos documentos varia conforme o tipo de cliente. Veja mais detalhes na documentação.


✅ 3. Concluir Venda - ConcludeSale

Finaliza o processo de venda.

  • Valida se a venda está pronta para ser concluída.

  • Verifica se todos os documentos obrigatórios foram enviados.

  • Envia a venda para a fila de processamento SQS da concessionária.

  • Acesse a documentação da ConcludeSale ➝


🧾 Checklist Final para Nova Venda (NEOENERGIA)

Tipo de ClienteEvidências Necessárias
Com responsável financeiroPOV, AUT, DOC_CONTRATANTE, DOC_RESPONSAVEL_FINANCEIRO
Sem responsável financeiroPOV, DOC_CONTRATANTE

🧑‍💼 Suporte

Para dúvidas, entre em contato com o time responsável pela API de vendas.