POST

api/comercial/ve/Oportunidade/Criar

Notas de Implementação:

Cria oportunidade com os dados recebidos. Necessário já ter a empresa e contato criados.

Informações de Envio:

Cabeçalhos de Envio:

Parâmetro Valor Descrição Tipo de parâmetro Tipo de dados
Authorization Bearer Hash gerado no login Header String

Acesse o método de login para mais informações: api/genericos/ge/Login/Autenticar

Direitos:

VEVENDAS_C

Modelo:

Dados da oportunidade em formato de DTO

OportunidadeDTO

NomeDescriçãoTipoInformação Adicional
Codigo

integer

Opcional

Somente enviar se for alteração, não enviar se for inclusão

CodigoCliente

string

Opcional

Titulo

TituloOportunidadeDTO

Opcional

TituloDescricao

string

Opcional

Data

date

Opcional

Hora

string

Opcional

CodigoContato

integer

Opcional

NomeContato

string

Opcional

PrevisaoVenda

date

Opcional

Mercado

string

Opcional

Conceito

string

Opcional

ControleContato

string

Opcional

EventoGerador

string

Opcional

CodigoContatante

string

Opcional

CodigoRepresentante

string

Opcional

CodigoVendedor

string

Opcional

CodigoPedido

string

Opcional

DataPrimeiraVisita

date

Opcional

HoraPrimeiraVisita

string

Opcional

DataProximoContato

date

Opcional

HoraProximoContato

string

Opcional

DataModificacao

date

Opcional

HoraModificacao

string

Opcional

GrupoObservacao

string

Opcional

ComissaoContatante

decimal number

Opcional

PercentualRepresentante

decimal number

Opcional

PercentualVendedor

decimal number

Opcional

CodigoUnidadeNegocio

string

Opcional

TotalVenda

decimal number

Opcional

Formato de Envio:

application/json, text/json

Exemplo:
{
  "Codigo": 1,
  "CodigoCliente": "string 1",
  "Titulo": {
    "Id": "string 1",
    "Descricao": "string 2",
    "ExisteRegistroTituloOportunidade": "string 3"
  },
  "TituloDescricao": "string 2",
  "Data": "2026-01-13",
  "Hora": "0",
  "CodigoContato": 4,
  "NomeContato": "string 5",
  "PrevisaoVenda": "2026-01-13",
  "Mercado": "string 6",
  "Conceito": "string 7",
  "ControleContato": "string 8",
  "EventoGerador": "string 9",
  "CodigoContatante": "string 10",
  "CodigoRepresentante": "string 11",
  "CodigoVendedor": "string 12",
  "CodigoPedido": "string 13",
  "DataPrimeiraVisita": "2026-01-13",
  "HoraPrimeiraVisita": "string 15",
  "DataProximoContato": "2026-01-13",
  "HoraProximoContato": "0",
  "DataModificacao": "2026-01-13",
  "HoraModificacao": "0",
  "GrupoObservacao": "string 18",
  "ComissaoContatante": 1.1,
  "PercentualRepresentante": 1.1,
  "PercentualVendedor": 1.1,
  "CodigoUnidadeNegocio": "string 19",
  "TotalVenda": 1.1
}

Informações de Retorno:

Cabeçalhos Adicionais:

Nome Descrição Valor
cigam-api-version Versão do build/compilação dessa versão da API 2.1.8565.21067

Modelo:

HttpCustomResponse

NomeDescriçãoTipoInformação Adicional
success

boolean

Opcional

hash

string

Opcional

messages

string

Opcional

data

Object

Opcional

tipoLogin

string

Opcional

Formato de Resposta:

Retorna a Oportunidade gerada

Código de status HTTP Descrição Modelo de resposta
200 OK

application/json, text/json

Exemplo:
{
  "success": true,
  "hash": "string 2",
  "messages": [
    "string 1"
  ],
  "data": {},
  "tipoLogin": "string 4"
}
400 Requisição inválida

application/json, text/json

Exemplo:
{
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"                    
                    
}
401 Não autorizado

application/json, text/json

Exemplo:
{
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"                    
                    
}
500 Requisição falhou

application/json, text/json

Exemplo:
{
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"                    
                    
}
502 Falha de comunicação

application/json, text/json

Exemplo:
{
                    "success": false,
                    "hash": "string 2",
                    "messages": [
                     "string 1"
                    ],
                     "data": {},
                     "tipoLogin": "string 4"                    
                    
}