rev1-2026-05-07 Protheus 12.1.33

TabelaPrecos

CRUD de Tabela de Preços (cabeçalho DA0 + itens DA1) via rotina automática OMSA010 — modelo 2 (capa + grade em tabelas separadas). A chave da tabela (DA0_CODTAB) é fornecida pelo usuário (não há GetSXENum); as alterações de item suportam inclusão, alteração e exclusão lógica via linpos.

Bloqueio TOTVS: tabela DA0/DA1 — verificar SX3 se DA0_MSBLQL existe; bloqueio relevante esta em SB1 (produto).

Base URL https://erpapi.jetme.com.br/api/99/01 Empresa 99 · Filial 01

Vinculação com o ERP

Tabela cabeçalho DA0 Tabela de Preços (capa)

Tabela itens DA1 Itens da tabela (grade)

Rotina automática OMSA010 Modelo 2 · MsExecAuto

Wrapper AdvPL U_OM010Exc src/lib/OM010EXC.prw

Operações & modos

POST modo 3 PUT modo 4 DEL modo 5

Origem da chave user-informado DA0_CODTAB · sem GetSXENum

Dependências de ambiente

Cadastro

Produtos (SB1)

cada DA1_CODPRO precisa existir em SB1
produto inexistente faz o OMSA010 rejeitar com 422

Estrutura

Modelo 2 (cabec + itens)

aCab formato {campo,valor,Nil} (3 elementos)
aItens aceita autdeleta e linpos

Dicionário

Campos obrigatórios

DA0_CODTAB + DA0_DATDE (Date) obrigatórios no SX3
DA1_CODPRO + DA1_PRCVEN obrigatórios por item

Convenções

Identificador externo. Todas as rotas /WsDA0/{codtab} usam DA0_CODTAB como chave. Diferente dos cadastros com sequência automática, aqui o cliente fornece o código — POST com DA0_CODTAB já existente retorna 409. Em POST, o DA0_CODTAB é obrigatório no cabecalho do body; em PUT/DELETE, a chave do path manda.

Modelo 2 — cabeçalho e itens. OMSA010 opera em modelo 2: payload sempre tem dois nós, cabecalho (1 registro DA0) e itens (N registros DA1). Em POST, itens é obrigatório e cria a grade do zero. Em PUT, é opcional — se omitido, só o cabeçalho é alterado.

Edição granular de itens (PUT). Para alterar ou excluir um item já existente, inclua "linpos": "0001" apontando para o DA1_ITEM alvo. Sem linpos, o item é tratado como inclusão. Para excluir, passe "linpos": "NNNN" + "autdeleta": "S" — OMSA010 marca o registro DA1 para exclusão lógica.

Formatos de data e hora. DA0_DATDE e DA0_DATATE aceitam string AAAAMMDD (ex.: "20260507") — o parser converte para Date interno via sToD. DA0_HORADE / DA0_HORAAT aceitam "HH:MM" (string, não convertida).

Exclusão em cascata. DELETE /WsDA0/EXCLUIR/{codtab} remove a capa DA0 e todos os itens DA1 vinculados — não é necessário excluir item por item antes. Tabela com referência ativa em pedidos/orçamentos pode ser rejeitada pelo OMSA010 com 422.

Paginação. /_list retorna apenas o cabeçalho (não traz itens) e usa page/pageSize (default 50, máx 500). Para a grade completa, consultar /WsDA0/{codtab}.

Tabela

CRUD por DA0_CODTAB

GET /WsDA0/{codtab} Consulta tabela com itens

Descrição

Retorna o cabeçalho (DA0) e todos os itens (DA1) vinculados pela chave DA0_CODTAB. Aplica filtro de filial (xFilial("DA0")) e respeita os whitelists CAMPOS_CAB_GET e CAMPOS_ITEM_GET definidos no .prw.

Path parameter

codtab string · path · obrigatório DA0.DA0_CODTAB

Código da tabela (chave fornecida pelo cadastro).

Chamada de exemplo

RequestHTTP/1.1 · sem body

GET https://erpapi.jetme.com.br/api/99/01/WsDA0/007
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Respostas

200

Tabela encontrada. Envelope { success: true, data: { cabecalho, itens[] } }.

400

Código inválido ou ausente. Tier: validation-error.

404

Tabela inexistente para o código informado. Tier: not-found.

500

Erro interno (DbSeek, serialização). Tier: business-error.

POST /WsDA0/INCLUIR/{codtab} Inclui nova tabela de preços

Descrição

Inclui tabela nova (cabeçalho DA0 + grade DA1) via OMSA010 em modo 3 (MODEL_OPERATION_INSERT). A chave DA0_CODTAB é fornecida pelo cliente e deve estar presente no cabecalho do body — o path param serve apenas para conferência.

Whitelist do cabeçalho: ver Cabecalho (CAMPOS_CAB_ALLOW).
Whitelist do item: ver Item (CAMPOS_ITEM_ALLOW).
itens[] é obrigatório e não vazio.

Path parameter

codtab string · path · obrigatório DA0.DA0_CODTAB

Código da tabela. Deve ser igual ao cabecalho.DA0_CODTAB do payload.

Request body

application/json TabelaCreate · obrigatório

Estrutura aninhada com cabecalho e itens[]. Schema em TabelaCreate.

Payload mínimo — cabeçalho com obrigatórios do OMSA010 (DA0_CODTAB, DA0_DESCRI, DA0_DATDE) e dois itens.

RequestHTTP/1.1 · application/json

POST https://erpapi.jetme.com.br/api/99/01/WsDA0/INCLUIR/007
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "cabecalho": {
    "DA0_CODTAB": "007",
    "DA0_DESCRI": "TABELA TESTE",
    "DA0_DATDE":  "20260507",
    "DA0_ATIVO":  "1"
  },
  "itens": [
    { "DA1_CODPRO": "01", "DA1_PRCVEN": 100 },
    { "DA1_CODPRO": "02", "DA1_PRCVEN": 250 }
  ]
}

Payload realista — cabeçalho com vigência (data inicial + final), horário, moeda e flag de tipo de horário; itens com quantidade mínima por lote.

RequestHTTP/1.1 · application/json

POST https://erpapi.jetme.com.br/api/99/01/WsDA0/INCLUIR/008
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "cabecalho": {
    "DA0_CODTAB": "008",
    "DA0_DESCRI": "TABELA VIGENCIA Q2",
    "DA0_DATDE":  "20260501",
    "DA0_DATATE": "20260731",
    "DA0_HORADE": "00:00",
    "DA0_HORAAT": "23:59",
    "DA0_TPHORA": "1",
    "DA0_ATIVO":  "1",
    "DA0_MOEDA":  1
  },
  "itens": [
    { "DA1_CODPRO": "01", "DA1_PRCVEN": 99.90,  "DA1_ATIVO": "1", "DA1_QTDLOT": 1 },
    { "DA1_CODPRO": "02", "DA1_PRCVEN": 249.00, "DA1_ATIVO": "1", "DA1_QTDLOT": 10 }
  ]
}

Respostas

201

Tabela incluída. Envelope CrudResponse com data.codtab = código persistido.

400

Body inválido (JSON malformado, cabecalho/itens ausentes, DA0_CODTAB faltando). Tier: validation-error.

409

DA0_CODTAB já existe na filial. Tier: business-error.

422

Erro de regra do OMSA010 — produto inexistente em SB1, campo fora do whitelist, data inválida, etc. Tier: business-error.

500

Erro interno.

PUT /WsDA0/ALTERAR/{codtab} Altera cabeçalho e/ou itens

Descrição

Altera a tabela existente via OMSA010 em modo 4 (MODEL_OPERATION_UPDATE). Aceita subconjuntos:

Só cabeçalho — omitir itens deixa a grade intacta.
Incluir item novo — entrada sem linpos em itens[].
Alterar item existente — linpos: "NNNN" apontando para o DA1_ITEM alvo.
Excluir item — linpos: "NNNN" + autdeleta: "S".

O DA0_CODTAB do path é a chave canônica; o body pode omiti-lo ou repeti-lo para conferência.

Path parameter

codtab string · path · obrigatório DA0.DA0_CODTAB

Código da tabela existente.

Request body

application/json TabelaUpdate · obrigatório

Subconjunto de cabeçalho e/ou itens. Schema em TabelaUpdate.

Altera só o cabeçalho — atualiza descrição e vigência sem mexer nos itens. itens omitido.

RequestHTTP/1.1 · application/json

PUT https://erpapi.jetme.com.br/api/99/01/WsDA0/ALTERAR/007
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "cabecalho": {
    "DA0_DESCRI": "TABELA TESTE - ATUALIZADA",
    "DA0_DATATE": "20261231"
  }
}

Altera preço de item existente — linpos aponta para o DA1_ITEM; cabeçalho omitido para preservar a capa.

RequestHTTP/1.1 · application/json

PUT https://erpapi.jetme.com.br/api/99/01/WsDA0/ALTERAR/007
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "itens": [
    { "linpos": "0001", "DA1_PRCVEN": 150 }
  ]
}

Inclui item novo na tabela — entrada sem linpos é tratada como nova linha de DA1 (o DA1_ITEM é atribuído pelo OMSA010).

RequestHTTP/1.1 · application/json

PUT https://erpapi.jetme.com.br/api/99/01/WsDA0/ALTERAR/007
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "itens": [
    { "DA1_CODPRO": "03", "DA1_PRCVEN": 75.50, "DA1_ATIVO": "1" }
  ]
}

Exclui item específico — combinação linpos + autdeleta: "S". O OMSA010 marca o DA1 para exclusão lógica.

RequestHTTP/1.1 · application/json

PUT https://erpapi.jetme.com.br/api/99/01/WsDA0/ALTERAR/007
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Content-Type: application/json
Accept: application/json

{
  "itens": [
    { "linpos": "0002", "autdeleta": "S" }
  ]
}

Respostas

200

Tabela alterada. Envelope CrudResponse.

400

Body inválido. Tier: validation-error.

404

Tabela inexistente. Tier: not-found.

422

Erro de regra — linpos aponta para item inexistente, produto novo não está em SB1, campo fora do whitelist, etc. Tier: business-error.

500

Erro interno.

DEL /WsDA0/EXCLUIR/{codtab} Exclui tabela inteira (cascata em DA1)

Descrição

Exclui a tabela inteira via OMSA010 em modo 5 (MODEL_OPERATION_DELETE). A exclusão é em cascata: a capa DA0 e todos os itens DA1 vinculados são removidos numa única chamada. Tabelas referenciadas por pedidos/orçamentos em aberto podem ser rejeitadas pelo OMSA010 com 422.

Path parameter

codtab string · path · obrigatório DA0.DA0_CODTAB

Código da tabela a excluir.

Chamada de exemplo

RequestHTTP/1.1 · sem body

DELETE https://erpapi.jetme.com.br/api/99/01/WsDA0/EXCLUIR/007
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Respostas

200

Tabela excluída (capa + todos os itens). Envelope CrudResponse.

400

Código inválido. Tier: validation-error.

404

Tabela inexistente. Tier: not-found.

422

Tabela com dependência ativa (pedidos/orçamentos referenciando) — OMSA010 rejeita exclusão. Tier: business-error.

500

Erro interno.

Listagem

Listagem paginada do cabeçalho

GET /WsDA0/_list Lista tabelas com filtros e paginação

Descrição

Lista tabelas de preços (apenas cabeçalho DA0; a grade DA1 não é retornada aqui — usar GET /WsDA0/{codtab} para a tabela completa). Filtros opcionais por prefixo de código, substring de descrição e flag de ativo.

Query parameters

cod string · query · opcional DA0.DA0_CODTAB

Prefixo de DA0_CODTAB.

descri string · query · opcional DA0.DA0_DESCRI

Substring de DA0_DESCRI (case-insensitive).

ativo string · query · opcional DA0.DA0_ATIVO

Filtro pelo estado da tabela.

12

page integer · query · opcional

Página (default 1).

pageSize integer · query · opcional

Tamanho da página (default 50, máx 500).

Chamada de exemplo

Request · filtro por descriçãoHTTP/1.1 · sem body

GET https://erpapi.jetme.com.br/api/99/01/WsDA0/_list?descri=TESTE&ativo=1&page=1&pageSize=50
Authorization: Bearer eyJhbGciOiJIUzI1NiIs…
Accept: application/json

Respostas

200

Página de tabelas. Envelope com data (array de cabeçalhos resumidos: DA0_CODTAB, DA0_DESCRI, DA0_DATDE, DA0_ATIVO), page, pageSize, count.

400

Parâmetro fora do domínio (ex.: pageSize > 500, ativo fora do enum).

500

Erro interno.

Schemas

Definições canônicas — campos com origem SX3 rastreável

Cabecalho

object

Cabeçalho da tabela de preços (DA0). Whitelist de campos definido em CAMPOS_CAB_ALLOW / CAMPOS_CAB_GET no .prw.

DA0_CODTABstring · obrigatório em POSTDA0.DA0_CODTAB

Código da tabela (chave). Fornecido pelo cadastro, não gerado por GetSXENum.

DA0_DESCRIstring · opcionalDA0.DA0_DESCRI

Descrição editorial da tabela.

DA0_DATDEstring · obrigatório em POSTDA0.DA0_DATDE

Data inicial de vigência. Formato AAAAMMDD (ex.: "20260507").

DA0_DATATEstring · opcionalDA0.DA0_DATATE

Data final de vigência. Formato AAAAMMDD; vazio = sem prazo.

DA0_HORADEstring · opcionalDA0.DA0_HORADE

Hora inicial de vigência. Formato "HH:MM".

DA0_HORAATstring · opcionalDA0.DA0_HORAAT

Hora final de vigência. Formato "HH:MM".

DA0_TPHORAstring · opcionalDA0.DA0_TPHORA

Tipo do controle de horário (definido no SX3 da base).

DA0_ATIVOstring · opcionalDA0.DA0_ATIVO

Flag de tabela ativa.

12

DA0_MOEDAinteger · opcionalDA0.DA0_MOEDA

Código da moeda (1 = R$, demais conforme cadastro de moedas SM2).

Item

object

Linha da grade de preços (DA1). Whitelist CAMPOS_ITEM_ALLOW / CAMPOS_ITEM_GET. Em PUT, os campos meta linpos e autdeleta controlam alteração e exclusão lógica do item.

DA1_ITEMstring · apenas em GETDA1.DA1_ITEM

Sequencial do item na tabela (atribuído pelo OMSA010). Em PUT, use linpos para referenciá-lo.

DA1_CODPROstring · obrigatório em inclusãoDA1.DA1_CODPRO

Código do produto. Deve existir em SB1 — produto inexistente faz o OMSA010 rejeitar com 422.

DA1_PRCVENnumber · obrigatório em inclusãoDA1.DA1_PRCVEN

Preço de venda do produto na tabela.

DA1_ATIVOstring · opcionalDA1.DA1_ATIVO

Flag de item ativo (default "1").

DA1_QTDLOTnumber · opcionalDA1.DA1_QTDLOT

Quantidade mínima por lote.

linposstring · apenas em PUT

Aponta para o DA1_ITEM existente a alterar ou excluir. Sem linpos, a entrada é tratada como inclusão.

autdeletastring · apenas em PUT

Combinado com linpos, marca o item para exclusão lógica.

S

TabelaCreate

object

Payload de POST. Ambos os nós são obrigatórios e itens[] não pode estar vazio.

cabecalhoCabecalho · obrigatório

Capa da tabela. Schema em Cabecalho. Em POST, DA0_CODTAB e DA0_DATDE são obrigatórios.

itensarray<Item> · obrigatório (não vazio)

Linhas iniciais da grade. Cada item exige ao menos DA1_CODPRO + DA1_PRCVEN.

TabelaUpdate

object

Payload de PUT. Ambos os nós são opcionais — pelo menos um deve estar presente. Edição de item existente requer linpos; exclusão lógica requer linpos + autdeleta: "S".

cabecalhoCabecalho · opcional

Subconjunto do whitelist do DA0. Omitir preserva a capa atual. DA0_CODTAB dentro do body é ignorado em PUT (chave do path manda).

itensarray<Item> · opcional

Mix de inclusões (sem linpos), alterações (linpos + campos) e exclusões (linpos + autdeleta: "S").

CrudResponse

object · envelope

Envelope padrão das respostas de POST / PUT / DELETE. data.codtab ecoa o DA0_CODTAB da operação.

successboolean · const: true

Sempre true em respostas de sucesso.

messagestring · obrigatório

Mensagem editorial de sucesso.

data.codtabstring · opcional

Eco do DA0_CODTAB da operação efetivada.

Erro

object · envelope

Envelope padrão de erros 4xx/5xx. data pode conter o token interno da causa (ex.: log do NomeAutoLog do OMSA010) para tratamento programático.

successboolean · const: false

Sempre false em erros.

messagestring · obrigatório

Mensagem editorial do erro (apresentável ao usuário final).

datastring · opcional

Token interno / detalhe técnico (ex.: log do MsExecAuto).