rev1-2026-05-16

RegraBonificacao

CRUD de Regra de Bonificação (cabeçalho ACQ + itens ACR) via wrapper FATA090. Cabeçalho define produto gerador (ACQ_CODPRO), vigência e tipo; itens listam produtos brindes (ACR_CODPRO).

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

Vinculação com o ERP

CabeçalhoACQRegra de Bonificação

ItensACRProdutos brindes

Rotina automáticaFATA090MsExecAuto · op 3/4/5

Wrapper AdvPLU_FT090Excsrc/lib/MAT/FT090EXC.prw

Fonte RESTWsACQ.prwsrc/api/RegraBonificacao/

ChaveACQ_CODREGGetSXENum no POST

Dependências

Cadastro

Produto (SB1)

ACR_CODPRO validado contra SB1 pelo FATA090.

Tabela

Tipo de regra (ACQ_TPRGBN)

Define comportamento da bonificação (ex: percentual de quantidade).

Convenções

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

Datas em ISO. ACQ_DATDE/ACQ_DATATE aceitam YYYY-MM-DD ou AAAAMMDD.

Whitelist. Cabeçalho: ACQ_DESCRI, ACQ_CODPRO, ACQ_DATDE, ACQ_DATATE, ACQ_QUANT, ACQ_TPRGBN. Itens: ACR_CODPRO (produto brinde).

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

Regra de Bonificação — mutação

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

POST/WsACQ/INCLUIR/000001Inclui regra — FATA090 op=3

Descrição

Inclui regra de bonificação. Código ACQ_CODREG é gerado pelo GetSXENum — path é placeholder.

Cenário

Request body

cabecalho.ACQ_DESCRIstring · obrigatório

Descrição da regra.

cabecalho.ACQ_DATDEstring (date) · obrigatório

Data inicial.

cabecalho.ACQ_DATATEstring (date) · obrigatório

Data final.

cabecalho.ACQ_CODPROstring · opcional

Produto gerador da bonificação (SB1).

cabecalho.ACQ_QUANTnumber · opcional

Quantidade mínima para ativar a regra.

cabecalho.ACQ_TPRGBNstring · opcional

Tipo de regra de bonificação.

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

Produto brinde (SB1).

Período só. Regra geral aplicada a todos os produtos.

Request

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

{
  "cabecalho": {
    "ACQ_DESCRI": "Bonificação Janeiro 2026",
    "ACQ_DATDE": "2026-11-24",
    "ACQ_DATATE": "2026-11-30"
  }
}

Com brindes. Produto gerador P0001 → brindes P0010, P0011.

Request

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

{
  "cabecalho": {
    "ACQ_DESCRI": "Bonificação Linha TVs",
    "ACQ_CODPRO": "P0001",
    "ACQ_DATDE": "2026-11-24",
    "ACQ_DATATE": "2026-11-30",
    "ACQ_QUANT": 10.0
  },
  "itens": [
    { "ACR_CODPRO": "P0010" },
    { "ACR_CODPRO": "P0011" }
  ]
}

Respostas

201

Criado. data.ACQ_CODREG auto-gerado.

400

Payload inválido.

422

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

PUT/WsACQ/ALTERAR/000001Altera regra — FATA090 op=4

Descrição

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

Cenário

Request body

cabecalho.ACQ_DATATEstring (date) · opcional

Nova data final.

cabecalho.ACQ_DESCRIstring · opcional

Nova descrição.

Estender data final.

Request

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

{
  "cabecalho": {
    "ACQ_DATATE": "2026-12-05"
  }
}

Respostas

200

Alterado.

404

Não encontrada.

422

Erro FATA090.

DELETE/WsACQ/EXCLUIR/000001Exclui regra — FATA090 op=5

Descrição

Exclui regra. Sem body.

Cenário

Exemplo

Request

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

Respostas

200

Excluída.

404

Não encontrada.

Consulta

Por código + listagem (sem typeahead).

GET/WsACQ/000001Regra por código

Cenário

Exemplo

Request

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

Response 200

{
  "success": true,
  "data": {
    "cabecalho": {
      "ACQ_CODREG": "000001",
      "ACQ_DESCRI": "Bonificação Janeiro 2026",
      "ACQ_DATDE": "20261124",
      "ACQ_DATATE": "20261130"
    },
    "itens": [
      { "ACR_ITEM": "01", "ACR_CODPRO": "P0010" }
    ]
  }
}

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

Schemas

Componentes do contrato

RegraBonificacaoPayload

object

Cabeçalho + array de itens.

cabecalhoCabecalho

Ver Cabecalho.

itensarray[Item]

Ver Item.

Cabecalho

object · ACQ

Cabeçalho. Whitelist CAMPOS_CAB_ALLOW.

ACQ_DESCRIstringACQ.ACQ_DESCRI

Descrição da regra.

ACQ_CODPROstringACQ.ACQ_CODPRO

Produto que gera a bonificação (SB1).

ACQ_DATDE, ACQ_DATATEstring (date)

Vigência (YYYY-MM-DD).

ACQ_QUANTnumberACQ.ACQ_QUANT

Quantidade mínima para ativar.

ACQ_TPRGBNstringACQ.ACQ_TPRGBN

Tipo de regra de bonificação.

Item

object · ACR

Produto beneficiado.

ACR_CODPROstring · obrigatório

Produto brinde (SB1). Único campo 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 /WsACQ/INCLUIR/{codigo}

Regra geral só com vigência.

cabecalho.{DESCRI,DATDE,DATATE}

Sem produtos = aplicável a todos.

incluir-com-produtos

POST /WsACQ/INCLUIR/{codigo}

Produto gerador + 2 brindes (P0010, P0011).

itens[]

Itens ACR com produto brinde.

alterar

PUT /WsACQ/ALTERAR/{codigo}

Estende ACQ_DATATE.

cabecalho.ACQ_DATATE

Nova data fim.

excluir

DELETE /WsACQ/EXCLUIR/{codigo}

Sem body.

path.codigo

000001

consulta-byid

GET /WsACQ/{codigo}

Cabeçalho + itens.

path.codigo

000001

listagem

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

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