rev1-2026-05-16

OportunidadeVenda

CRUD de Oportunidade de Venda (tabela AD1) via wrapper FATA300. Registro único — pipeline CRM com estágio, prioridade, vendedor responsável e entidade vinculada. Sem sub-itens.

Código auto-gerado. AD1_NROPOR é gerado por GetSXENum no POST — o endpoint retorna o código gerado em data.AD1_NROPOR. {codigo} no path do POST é placeholder (qualquer valor).

Vinculação com o ERP

TabelaAD1Oportunidade de Venda (sem sub-itens)

Rotina automáticaFATA300MsExecAuto · op 3/4/5

Wrapper AdvPLU_FT300Excsrc/lib/MAT/FT300EXC.prw

Fonte RESTWsAD1.prwsrc/api/OportunidadeVenda/

ChaveAD1_NROPORGetSXENum no POST

Dependências

Cadastro

Vendedor (SA3)

AD1_VEND — vendedor responsável pela oportunidade.

Cadastro

Entidade (SA1/SA2)

AD1_CODENT — entidade vinculada (cliente ou prospecto).

Tabela

Moeda (SM2)

AD1_MOEDA — moeda da oportunidade; opcional.

Convenções

Envelope canônico. { success, message, data }. POST retorna data.AD1_NROPOR auto-gerado.

Datas em ISO. AD1_DATA, AD1_DTINI, AD1_PROVEN aceitam YYYY-MM-DD ou AAAAMMDD.

Whitelist. AD1_DESCRI, AD1_DATA, AD1_HORA, AD1_USER, AD1_VEND, AD1_NOMVEN, AD1_DTINI, AD1_PROVEN, AD1_STAGE, AD1_MOEDA, AD1_PRIOR, AD1_STATUS, AD1_CODENT, AD1_TIPO. Sem sub-itens.

Sem typeahead. Endpoint expõe só _list + GET por código.

Oportunidade de Venda — mutação

Inclusão / alteração / exclusão via FATA300.

POST/WsAD1/INCLUIR/000001Inclui regra — FATA300 op=3

Descrição

Inclui oportunidade de venda. Código AD1_NROPOR é gerado pelo GetSXENum — path é placeholder.

Cenário

Request body

AD1_DESCRIstring · obrigatório

Descrição da oportunidade.

AD1_VENDstring

Vendedor responsável (SA3).

AD1_STAGEstring

Estágio CRM.

AD1_PRIORstring

Prioridade.

AD1_STATUSstring

Status (aberta/ganha/perdida).

Mínimo. Descrição e vendedor responsável.

Request

POST https://erpapi.jetme.com.br/api/99/01/WsAD1/INCLUIR/000001

{
  "AD1_DESCRI": "Oportunidade Cliente Premium",
  "AD1_VEND": "V001"
}

Completo. Estágio, prioridade, status e entidade vinculada.

Request

POST https://erpapi.jetme.com.br/api/99/01/WsAD1/INCLUIR/000001

{
  "AD1_DESCRI": "Projeto CRM Enterprise",
  "AD1_VEND": "V001",
  "AD1_STAGE": "02",
  "AD1_PRIOR": "1",
  "AD1_STATUS": "A",
  "AD1_CODENT": "000001"
}

Respostas

201

Criado. data.AD1_NROPOR auto-gerado.

400

Payload inválido.

422

Erro FATA300 (produto inválido, datas, sobreposição).

PUT/WsAD1/ALTERAR/000001Altera regra — FATA300 op=4

Descrição

Altera regra existente. Cabeçalho e itens opcionais. Itens via LINPOS + AUTDELETA como em PedidoVenda.

Cenário

Request body

AD1_STAGEstring · opcional

Novo estágio CRM.

AD1_STATUSstring · opcional

Novo status.

Avançar estágio.

Request

PUT https://erpapi.jetme.com.br/api/99/01/WsAD1/ALTERAR/000001

{
  "AD1_STAGE": "03",
  "AD1_STATUS": "G"
}

Respostas

200

Alterado.

404

Não encontrada.

422

Erro FATA300.

DELETE/WsAD1/EXCLUIR/000001Exclui regra — FATA300 op=5

Descrição

Exclui regra. Sem body.

Cenário

Exemplo

Request

DELETE https://erpapi.jetme.com.br/api/99/01/WsAD1/EXCLUIR/000001

Respostas

200

Excluída.

404

Não encontrada.

Consulta

Por código + listagem (sem typeahead).

GET/WsAD1/000001Regra por código

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsAD1/000001

Response 200

{
  "success": true,
  "data": {
    "AD1_NROPOR": "000001",
    "AD1_REVISA": "001",
    "AD1_DESCRI": "Oportunidade Cliente Premium",
    "AD1_VEND": "V001",
    "AD1_STAGE": "02",
    "AD1_STATUS": "A"
  }
}

GET/WsAD1/_listListagem paginada

Query parameters

page, pageSizeinteger

Paginação (default 1/50, max 500).

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsAD1/_list?page=1&pageSize=25

Schemas

Componentes do contrato

OportunidadeVendaPayload

object

Campos da oportunidade (tabela AD1, registro único sem sub-itens).

AD1_DESCRI, AD1_STAGE, AD1_PRIOR, ...ver Cabecalho

Campos diretos da tabela AD1. Ver schema Cabecalho.

Cabecalho

object · AD1

Registro de oportunidade (tabela AD1). Whitelist CAMPOS_ALLOW.

AD1_DESCRIstringAD1.AD1_DESCRI

Descrição da oportunidade.

AD1_DATAstring (date)AD1.AD1_DATA

Data de abertura.

AD1_HORAstringAD1.AD1_HORA

Hora de abertura.

AD1_USERstringAD1.AD1_USER

Usuário responsável.

AD1_VENDstringAD1.AD1_VEND

Código do vendedor (SA3).

AD1_NOMVENstringAD1.AD1_NOMVEN

Nome do vendedor.

AD1_DTINIstring (date)AD1.AD1_DTINI

Data prevista de início.

AD1_PROVENstring (date)AD1.AD1_PROVEN

Previsão de fechamento.

AD1_STAGEstringAD1.AD1_STAGE

Estágio do pipeline CRM.

AD1_MOEDAstringAD1.AD1_MOEDA

Moeda (SM2).

AD1_PRIORstringAD1.AD1_PRIOR

Prioridade da oportunidade.

AD1_STATUSstringAD1.AD1_STATUS

Status (aberta, ganha, perdida).

AD1_CODENTstringAD1.AD1_CODENT

Entidade vinculada (SA1/SA2).

AD1_TIPOstringAD1.AD1_TIPO

Tipo de oportunidade.

EnvelopeSucesso

object

Envelope canônico.

success/message/data

Padrão.

EnvelopeErro

object

success=false + message.

message

Causa.

Cenários

1-pra-1 com YAML.

incluir-periodo

POST /WsAD1/INCLUIR/{codigo}

Mínimo: descrição + vendedor.

AD1_DESCRI, AD1_VEND

Campos obrigatórios mínimos.

incluir-com-produtos

POST /WsAD1/INCLUIR/{codigo}

Completo: estágio, prioridade, status e entidade.

AD1_STAGE, AD1_PRIOR, AD1_STATUS, AD1_CODENT

Pipeline CRM completo.

alterar

PUT /WsAD1/ALTERAR/{codigo}

Avança estágio / marca como ganha.

AD1_STAGE, AD1_STATUS

Novos valores de estágio/status.

excluir

DELETE /WsAD1/EXCLUIR/{codigo}

Sem body.

path.codigo

000001

consulta-byid

GET /WsAD1/{codigo}

Cabeçalho + itens.

path.codigo

000001

listagem

GET /WsAD1/_list

Primeira página.

page, pageSize

1, 25

Pendências conhecidas (rev2)

Sem typeahead. Não há GET /_search. Filtros via /_list com page/pageSize.

AD1_NROPOR auto-gerado. Path no POST é placeholder; código real vem do GetSXENum e retorna em data.AD1_NROPOR.