rev1-2026-05-04 Protheus 12.1.33

GrupoProduto

Leitura de Grupos de Produto (tabela SBM) via REST. MATA035 não publica rotina automática oficial — o endpoint usa BeginSql direto, sem efeito colateral. Uma única rota GET com dispatch interno: sem path param devolve a listagem completa da filial; com {grupo} retorna o registro específico.

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

Vinculação com o ERP

Tabela mestre SBM Grupo de Produto

Rotina nativa MATA035 Sem ExecAuto oficial (leitura via query)

Helpers AdvPL U_RestErro · U_RestQ src/lib/_shared/RestUtils.prw

Operações & modos

GET leitura SQL

Dependências de ambiente

Cadastro

Grupo de Produto (SBM)

campos BM_GRUPO, BM_DESC, BM_CC, BM_APROPRI
filtro por xFilial("SBM") e %notDel%

Sem escrita

MATA035 sem ExecAuto oficial

TOTVS não publicou MATA035 com rotina automática até Maio/2026.
Quando publicar, criar MT035EXC.prw e adicionar POST/PUT/DELETE ao endpoint.

Sem bloqueio TOTVS

SBM nesta base não expõe MSBLQL/MSBLQD

endpoint não aplica o padrão de bloqueio U_C980Blq (par MSBLQL/MSBLQD ausente no SX3 da base 240223P).

Convenções

Dispatch por path param. O build 240223P do AppServer não distingue múltiplos WSMETHOD GET por WSSYNTAX. O endpoint expõe um único GET que decide entre listagem e consulta individual olhando o último segmento da URL: vazio (ou igual a WsSBM) dispara a listagem; qualquer outro valor é tratado como BM_GRUPO.

Leitura somente. Não há rotina automática oficial do TOTVS para MATA035. O endpoint executa BeginSql com %notDel% e %xFilial:SBM%; não há trilha de auditoria, lock ou efeito colateral. Escrita continua sendo feita na tela MATA035 do SmartClient.

Filial. Aceita header opcional filial (string de 2 caracteres). Quando ausente, o endpoint usa "01" como default antes de chamar RpcSetEnv("99", filial).

Whitespace nos retornos. Todos os campos passam por AllTrim antes de irem para o JSON (BM_DESC, BM_CC, BM_APROPRI) — a doc reflete os valores enxutos, não as strings com padding do AdvPL.

GrupoProduto

Consulta de grupos de produto (SBM)

GET /WsSBM/ Lista todos os grupos da filial

Descrição

Retorna todos os grupos de produto cadastrados na filial, ordenados por BM_GRUPO. Usa BeginSql com filtro %xFilial:SBM% e %notDel%. Sem paginação — o universo de grupos costuma ser pequeno (dezenas).

Caminho de roteamento: o último segmento da URL é vazio (ou igual a WsSBM). Build 240223P, dispatcher interno no único WSMETHOD GET.

Header parameter

filial string · header · opcional SBM.BM_FILIAL

Filial alvo (2 caracteres). Default "01" quando ausente.

Chamada de exemplo

RequestHTTP/1.1 · sem body

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

Request · com header filialHTTP/1.1 · sem body

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

Respostas

200

Listagem completa. Envelope RespostaLista com data.total e data.grupos[] de GrupoItem.

500

Erro interno (SQL/serialização). Tier: business-error.

GET /WsSBM/{grupo} Consulta grupo específico

Descrição

Retorna o grupo cuja chave BM_GRUPO bate exatamente com o path param. Aplica filtro de filial (xFilial("SBM")) e %notDel%. Inexistência devolve 404 com envelope Erro.

Path parameter

grupo string · path · obrigatório SBM.BM_GRUPO

Código do grupo (até 4 caracteres, alfanumérico). Comparação exata, sem padding automático no endpoint.

Header parameter

filial string · header · opcional SBM.BM_FILIAL

Filial alvo (2 caracteres). Default "01".

Chamada de exemplo

RequestHTTP/1.1 · sem body

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

Respostas

200

Grupo encontrado. Envelope RespostaItem com data = GrupoItem.

404

Grupo inexistente na filial. Tier: not-found.

500

Erro interno. Tier: business-error.

Schemas

Modelos referenciados pelas operações

GrupoItem

object

Item de grupo retornado tanto na listagem (RespostaLista.data.grupos[]) quanto na consulta individual (RespostaItem.data). Todos os campos passam por AllTrim antes da serialização.

grupostring · obrigatórioSBM.BM_GRUPO

Código do grupo (até 4 caracteres).

descricaostring · obrigatórioSBM.BM_DESC

Descrição do grupo (ex: MATERIA PRIMA).

ccstring · opcionalSBM.BM_CC

Centro de custo associado (frequentemente vazio).

apropristring · opcionalSBM.BM_APROPRI

Código de apropriação contábil (frequentemente vazio).

RespostaLista

object · envelope

Envelope da listagem (GET /WsSBM/). data.total reflete a contagem efetiva de itens retornados na chamada.

successboolean · const: true

Sempre true em respostas 2xx.

messagestring · obrigatório

Mensagem editorial; vazia em sucesso.

data.totalinteger · obrigatório

Quantidade de grupos retornados.

data.grupos[]array<GrupoItem> · obrigatório

Lista ordenada por BM_GRUPO; ver GrupoItem.

RespostaItem

object · envelope

Envelope da consulta individual (GET /WsSBM/{grupo}). data é um único GrupoItem.

successboolean · const: true

Sempre true em 200.

messagestring · obrigatório

Mensagem editorial; vazia em sucesso.

dataGrupoItem · obrigatório

Ver GrupoItem.

Erro

object · envelope

Envelope padrão de erros 4xx/5xx do endpoint.

successboolean · const: false

Sempre false em erro.

messagestring · obrigatório

Mensagem editorial do erro (ex: "Grupo 0001 nao localizado.").

datastring · opcional

Token interno / detalhe técnico. Em geral string vazia neste endpoint.