rev1-2026-05-16

PropostaComercial

CRUD de Proposta Comercial (cabeçalho ADY + itens ADZ) via wrapper FATA600. Cabeçalho define oportunidade vinculada, entidade e vendedor; itens listam produtos com preço e condição de pagamento.

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

Vinculação com o ERP

CabeçalhoADYProposta Comercial

ItensADZProdutos da proposta

Rotina automáticaFATA600MsExecAuto · op 3/4/5

Wrapper AdvPLU_FT600Excsrc/lib/MAT/FT600EXC.prw

Fonte RESTWsADY.prwsrc/api/PropostaComercial/

ChaveADY_OPORTUGetSXENum no POST

Dependências

Cadastro

Produto (SB1)

ADZ_PRODUT validado contra SB1 pelo FATA600.

Cadastro

Oportunidade (SAD1)

ADY_OPORTU vincula a proposta à oportunidade de origem.

Cadastro

Entidade (SA1/SA2)

ADY_ENTIDA + ADY_CODIGO + ADY_LOJA — cliente ou prospecto da proposta.

Tabela

Condição de Pagamento (SE4)

ADZ_CONDPG — condição de pagamento por item da proposta.

Convenções

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

Datas em ISO. ADY_DATA aceita YYYY-MM-DD ou AAAAMMDD.

Whitelist. Cabeçalho: ADY_DATA, ADY_ENTIDA, ADY_CODIGO, ADY_LOJA, ADY_TABELA, ADY_VEND, ADY_OBS, ADY_VLTOT. Itens: ADZ_PRODUT, ADZ_CONDPG, ADZ_TES, ADZ_QTDVEN, ADZ_PRCVEN, ADZ_VALOR, ADZ_CODAGR, ADZ_CODNIV.

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

Proposta Comercial — mutação

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

POST/WsADY/INCLUIR/000001Inclui regra — FATA600 op=3

Descrição

Inclui proposta comercial. Código ADY_OPORTU é gerado pelo GetSXENum — path é placeholder.

Cenário

Request body

cabecalho.ADY_DATAstring (date) · obrigatório

Data da proposta.

cabecalho.ADY_CODIGOstring · obrigatório

Código do cliente.

cabecalho.ADY_VENDstring

Vendedor.

itens[].ADZ_PRODUTstring · obrigatório p/ item

Produto (SB1).

itens[].ADZ_QTDVENnumber

Quantidade.

itens[].ADZ_PRCVENnumber

Preço de venda.

Mínimo. Cabeçalho sem itens.

Request

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

{
  "cabecalho": {
    "ADY_DATA": "2026-11-24",
    "ADY_CODIGO": "000001",
    "ADY_VEND": "V001"
  }
}

Com itens. 2 produtos com quantidade e preço.

Request

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

{
  "cabecalho": {
    "ADY_DATA": "2026-11-24",
    "ADY_CODIGO": "000001",
    "ADY_VEND": "V001"
  },
  "itens": [
    { "ADZ_PRODUT": "PROD01", "ADZ_QTDVEN": 10, "ADZ_PRCVEN": 150.00 },
    { "ADZ_PRODUT": "PROD02", "ADZ_QTDVEN": 5, "ADZ_PRCVEN": 200.00 }
  ]
}

Respostas

201

Criado. data.ADY_OPORTU auto-gerado.

400

Payload inválido.

422

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

PUT/WsADY/ALTERAR/000001Altera regra — FATA600 op=4

Descrição

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

Cenário

Request body

cabecalho.ADY_OBSstring · opcional

Novas observações.

cabecalho.ADY_VLTOTnumber · opcional

Novo valor total.

Atualizar observações.

Request

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

{
  "cabecalho": {
    "ADY_OBS": "Prazo negociado ate Dez"
  }
}

Respostas

200

Alterado.

404

Não encontrada.

422

Erro FATA600.

DELETE/WsADY/EXCLUIR/000001Exclui regra — FATA600 op=5

Descrição

Exclui regra. Sem body.

Cenário

Exemplo

Request

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

Respostas

200

Excluída.

404

Não encontrada.

Consulta

Por código + listagem (sem typeahead).

GET/WsADY/000001Regra por código

Cenário

Exemplo

Request

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

Response 200

{
  "success": true,
  "data": {
    "cabecalho": {
      "ADY_OPORTU": "000001",
      "ADY_REVISA": "001",
      "ADY_DATA": "20261124",
      "ADY_CODIGO": "000001",
      "ADY_VEND": "V001",
      "ADY_VLTOT": 1500.00
    },
    "itens": [
      { "ADZ_ITEM": "01", "ADZ_PRODUT": "PROD01", "ADZ_QTDVEN": 10, "ADZ_PRCVEN": 150.00, "ADZ_TIPO": "N" }
    ]
  }
}

GET/WsADY/_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/WsADY/_list?page=1&pageSize=25

Schemas

Componentes do contrato

PropostaComercialPayload

object

Cabeçalho + array de itens.

cabecalhoCabecalho

Ver Cabecalho.

itensarray[Item]

Ver Item.

Cabecalho

object · ADY

Cabeçalho da proposta (tabela ADY). Whitelist CAMPOS_CAB_ALLOW.

ADY_DATAstring (date)ADY.ADY_DATA

Data da proposta.

ADY_ENTIDAstringADY.ADY_ENTIDA

Tipo de entidade (J=jurídica, F=física).

ADY_CODIGOstringADY.ADY_CODIGO

Código do cliente/prospecto.

ADY_LOJAstringADY.ADY_LOJA

Loja do cliente.

ADY_TABELAstringADY.ADY_TABELA

Tabela de preços.

ADY_VENDstringADY.ADY_VEND

Vendedor responsável (SA3).

ADY_OBSstringADY.ADY_OBS

Observações.

ADY_VLTOTnumberADY.ADY_VLTOT

Valor total da proposta.

Item

object · ADZ

Item da proposta (produto + preço + condição).

ADZ_PRODUTstring · obrigatório

Produto (SB1).

ADZ_QTDVENnumber

Quantidade.

ADZ_PRCVENnumber

Preço de venda.

ADZ_VALORnumber

Valor total do item.

ADZ_CONDPGstring

Condição de pagamento (SE4).

ADZ_TESstring

TES do item.

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 /WsADY/INCLUIR/{codigo}

Cabeçalho sem itens de produto.

cabecalho.{DATA, CODIGO, VEND}

Proposta vazia vinculada ao cliente.

incluir-com-produtos

POST /WsADY/INCLUIR/{codigo}

Cabeçalho + 2 itens de produto com preço.

itens[]

2 itens (PROD01 10un R$150, PROD02 5un R$200).

alterar

PUT /WsADY/ALTERAR/{codigo}

Atualiza observações da proposta.

cabecalho.ADY_OBS

Novas observações.

excluir

DELETE /WsADY/EXCLUIR/{codigo}

Sem body.

path.codigo

000001

consulta-byid

GET /WsADY/{codigo}

Cabeçalho + itens.

path.codigo

000001

listagem

GET /WsADY/_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.

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