1. Oportunidades
WebgexERP API
  • Introdução
  • Padrão de Response
  • Endpoints
    • Cadastros
      • Organização
        • Unidades
          • Unidades
        • Centros de Resultado
          • Centros de Resultado
        • Armazens
          • Armazéns
        • Plano de Contas
          • Plano de Contas
        • Naturezas Financeiras
          • Naturezas Financeiras
        • Itens Contábeis
          • Itens Contábeis
        • Classificações Contábeis
          • Classificações Contábeis
        • Códigos de Remuneração
          • Códigos de Remuneração
      • Pessoas Físicas/Jurídicas
        • Clientes
          • Cliente
          • Clientes
        • Fornecedores
          • Fornecedor
          • Fornecedores
          • Detalhes do Fornecedor
        • Parceiros
          • Parceiro
          • Parceiros
          • Detalhes do Parceiro
        • Empregados
          • Empregado
          • Empregados
          • Detalhes do Empregado
        • Grupos Empresariais
          • Grupos Empresariais
      • Produtos e Serviços
        • Categorias
          • Categorias
        • Produtos
          • Produto
          • Produtos
        • Serviços
          • Serviços
          • Detalhes do Serviço
        • Materiais
          • Materiais
          • Detalhes do Material
        • Produtos Base
          • Produtos Base
          • Detalhes do Produto Base
        • Produtos Variantes
          • Produtos Variantes
        • Kits e Composições
          • Kits e Composições
        • Preços
          • Preços
          • Preço
    • Lançamentos
      • Despesas
        • Despesas
        • Detalhes da Despesa
        • Criar Despesa
        • Folha de Pagamento
      • Documentos Fiscais
        • Notas Fiscais Emitidas
          • Notas Fiscais Emitidas
          • Detalhes da Nota Fiscal Emitida
        • Notas Fiscais ao Consumidor Emitidas
          • Notas Fiscais ao Consumidor Emitidas
          • Detalhes da nota fiscal ao consumidor emitida
        • Cupons Fiscais Emitidos
          • Cupons Fiscais Emitidos
          • Detalhes do Cupom Fiscal Emitido
        • Notas Fiscais de Serviço Emitidas
          • Notas Fiscais de Serviço Emitidas
          • Detalhes da Nota Fiscal de Serviço Emitidas
        • Notas Fiscais de Entrada
          • Notas Fiscais Recebidas
          • Detalhes da Nota fiscal de Entrada
        • Conhecimentos de Frete
          • Conhecimentos de Frete Recebidos
    • Controladoria
      • Escrita Fiscal
        • Impostos
      • Contabilidade
        • Lançamentos Contábeis
          • Lançamentos Contábeis
        • Saldos Contábeis
          • Saldos Contábeis
      • Orçamento
        • Orçamento
          • Orçamento
      • Imobilizado
        • Itens de Imobilizado
          • Itens de Imobilizado
    • Financeiro
      • Tesouraria
        • Contas, Caixas e Cartões
          • Contas, Caixas e Cartões
        • Saldos das Contas
          • Saldos das Contas
      • Contas a Pagar
        • Contas a Pagar
          • Contas a Pagar*
      • Contas a Receber
        • Contas a Receber
          • Contas a Receber*
    • Operacional
      • Controle de Estoque
        • Posição de Estoque
          • Posição de Estoque
      • Compras
        • Carteira Pedidos de Compra
          • Carteira Pedidos de Compra
        • Histórico de Compras
          • Histórico de Compras
      • Projetos e Contratos
        • Projetos
          • Projetos
        • Gestão de Projetos
          • Gestão de Projetos
      • Serviços
        • Veículos
          • Veículos
        • Histórico de Serviços
          • Histórico de Veículos
      • Ordens de Serviço
        • Ordens de Serviço Automotivas
        • Detalhes da Ordem de Serviço Automotiva
    • Relatórios
      • Relatórios de Vendas
        • Vendas Detalhadas
    • Configuração
      • Acessos e Auditoria
        • Utilizadores
          • Utilizadores
      • Parametrização
        • Transações
          • Transações*
    • Crm
      • Crm Gerencial
        • Oportunidades
          • Oportunidade
            POST
  • Raiz
  • Esquemas
    • OrdemServicoAutomotivaCabecalho
    • OportunidadeRequest
    • OrdemServicoAutomotivaItem
    • Cliente
    • OrdemServicoAutomotivaPagamento
    • Endereco
    • OrdemServicoAutomotivaDetalhe
    • Item
    • Pagamento
    • CreatedEnvelope
    • ProblemDetail
  1. Oportunidades

Oportunidade

POST
/erp-oportunidades
Cria uma oportunidade com cliente, itens e formas de pagamento.

Cliente#

O cliente é localizado pelo cpfCnpj. Se já existir, os campos enviados atualizam o
cadastro; os campos omitidos são mantidos. Se não existir, o cliente é criado com situação
PD, contribuinte de ICMS = Não, e Inscrição Estadual/Municipal gravadas como ISENTO.

Identificação do produto (itens[].idProduto)#

idProduto aceita qualquer um destes códigos da variante do produto:
CódigoOnde está no ERPUnicidade
Código ERP da varianteCadastro de Produtos → código da varianteÚnico
Código legado (referência do sistema de origem)Cadastro de Produtos → código legadoNão é garantido único
O servidor procura o valor nos dois campos. Se um código legado estiver cadastrado em mais
de uma variante, o produto usado não é determinístico.
Nesses casos, envie o código ERP.

Idempotência#

Se pedidoCliente for enviado e já existir uma oportunidade não cancelada com o mesmo número
na mesma unidade, a requisição é recusada com 400
(Pedido já existe no ERP, número origem: ...).

Valores#

valor do pedido = soma de itens[].valorTotal. O servidor não recalcula o total do
item a partir de quantidade, preço e desconto: envie valores já consistentes.

Requisição

Authorization
Adicionar parâmetro em header
WGX-API-KEY
Exemplo:
WGX-API-KEY: ********************
Parâmetros Bodyapplication/jsonObrigatório

Examples

Respostas

🟢201
application/json
Oportunidade criada. content traz o identificador (id) da oportunidade.
Bodyapplication/json

🟠400BadRequest
🟠401Unauthorized
🟠429TooManyRequests
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/erp-oportunidades' \
--header 'WGX-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "codigoUnidade": "10001",
    "codigoVendedor": 51,
    "situacao": "PD",
    "tipo": "PV",
    "pedidoCliente": "LOJA-000123",
    "dataAbertura": "2026-09-25",
    "horaAbertura": "10:30:00",
    "dataFechamento": "2026-09-25",
    "horaFechamento": "10:30:00",
    "observacoes_comerciais": "Entregar em horário comercial",
    "enviaPDV": false,
    "cliente": {
        "cpfCnpj": "11.222.333/0001-81",
        "nome": "Empresa Exemplo Ltda",
        "nomeFantasia": "Exemplo",
        "email": "financeiro@exemplo.com.br",
        "celular": "85998098877",
        "endereco": {
            "logradouro": "Rua das Flores",
            "numero": "100",
            "bairro": "Centro",
            "cep": "60000000",
            "uf": "CE",
            "idMunicipio": "2304400",
            "nomeMunicipio": "Fortaleza"
        }
    },
    "itens": [
        {
            "idProduto": "S000002",
            "quantidade": 1,
            "valorUnitario": 175,
            "percentualValorDesconto": 0,
            "valorDesconto": 0,
            "valorTotal": 175
        }
    ],
    "pagamentos": [
        {
            "finalizadora": "DIN",
            "prazo": "1X",
            "valor": 175,
            "vencimento": "2026-09-25"
        }
    ]
}'
Response Response Example
201 - Sucesso
{
    "isSuccess": true,
    "status": "CREATED",
    "date": "2026-09-25T10:30:01",
    "contentType": "application/json",
    "content": 60400000123456
}
Modificado em 2026-09-25 17:51:04
Página anterior
Transações*
Próxima página
OrdemServicoAutomotivaCabecalho
Built with