rev1-2026-05-16

PerfilTribParticipante

Endpoint GRID que gerencia participantes (F22) de um perfil tributário (F20). Adiciona ou remove linhas do grid via wrapper U_FA164MVC / rotina FISA164. Não tem PUT — participantes são incluídos ou excluídos, não alterados.

Endpoint GRID, não CRUD completo. Sem PUT e sem MSBLQL/MSBLQD. O perfil cabeçalho (F20) é pré-requisito — POST e DELETE retornam 404 se o perfil não existir em F20.

Vinculação com o ERP

Tabela mestreF22Participantes do perfil tributário

Tabela cabeçalhoF20Perfil Tributário (pré-requisito)

Rotina automáticaFISA164MsExecAuto op 4 (add) / op 5 (del)

Wrapper AdvPLU_FA164MVCsrc/lib/MAT/FA164MVC.prw

Fonte RESTWsF22.prwsrc/api/PerfilTribParticipante/

TipoGRIDSem PUT nem MSBLQL

Dependências e chaves

Índice F22

F22_CODIGO + F22_TIPOPF

Usado em fGetLst para varredura do grid do perfil.

Perfil cabeçalho

F20 (F20_CODIGO + F20_TIPOPF)

POST e DELETE verificam existência antes de acionar U_FA164MVC.

F22_TPPART

"1"=Fornecedor, "2"=Cliente

Validado antes do MVC. Valor fora de "12" retorna 400.

GET byid

RecNo (inteiro)

fGetById usa DbGoTo(nRecno) diretamente.

Convenções

Envelope canônico. { success, message, data }. POST retorna data.perfil, data.tipo e os campos do participante.

Perfil + tipo no path. POST e GET usam /{perfil}/{tipo} (dois últimos segmentos). DELETE usa /{perfil}/{tipo}/{tppart}/{clifor}/{loja} (cinco últimos segmentos).

Sem PUT. Participantes do grid não têm operação de alteração — exclui e recria se precisar mudar.

F22_TPPART. "1" = Fornecedor (SA2), "2" = Cliente (SA1). Obrigatório no POST; usado como chave de deleção no DELETE.

GET _byid via RecNo. /WsF22/{perfil}/{tipo}/_byid/{recno} — acessa diretamente pelo número de registro físico. Frágil a reindexações; usar GET listagem para queries normais.

PerfilTribParticipante — mutação

Adicionar / remover participante via FISA164.

POST/WsF22/PERF01/01Adiciona participante ao perfil — FISA164 op=4

Descrição

Adiciona uma linha de participante ao grid F22 do perfil {perfil}/{tipo}. Verifica existência do perfil em F20 antes de acionar U_FA164MVC. Resposta 201 com dados do participante criado.

Path parameters

perfilstring · obrigatório

Código do perfil tributário (F20_CODIGO).

tipostring · obrigatório

Tipo do perfil (F20_TIPOPF).

Cenário

Request body

F22_TPPARTstring ("1"/"2") · obrigatório

1=Fornecedor, 2=Cliente.

F22_CLIFORstring · obrigatório

Código do participante (SA1/SA2).

F22_LOJAstring · obrigatório

Loja do participante.

Adicionar fornecedor 000001/01 ao perfil PERF01/01.

Request

POST https://erpapi.jetme.com.br/api/99/01/WsF22/PERF01/01

{
  "F22_TPPART": "1",
  "F22_CLIFOR": "000001",
  "F22_LOJA": "01"
}

Response 201

{
  "success": true,
  "message": "Participante adicionado ao perfil.",
  "data": {
    "perfil": "PERF01",
    "tipo": "01",
    "F22_TPPART": "1",
    "F22_CLIFOR": "000001",
    "F22_LOJA": "01"
  }
}

Respostas

201

Participante adicionado. data traz perfil, tipo e campos do participante.

400

Perfil/tipo ausente, body inválido, F22_TPPART fora de "12", ou F22_CLIFOR/F22_LOJA vazios.

404

Perfil {perfil}/{tipo} não localizado em F20.

422

Erro FISA164 (participante já existe, validação MVC etc).

DELETE/WsF22/PERF01/01/1/000001/01Remove participante do perfil — FISA164 op=5

Descrição

Remove linha de participante do grid F22 via U_FA164MVC op=5. Cinco segmentos finais do path: perfil, tipo, tppart, clifor, loja. Retorna 404 se "nao encontrada" na resposta do MVC, 422 para outros erros.

Path parameters

perfilstring · obrigatório

Código do perfil (F20_CODIGO).

tipostring · obrigatório

Tipo do perfil (F20_TIPOPF).

tppartstring ("1"/"2") · obrigatório

Tipo do participante (F22_TPPART).

cliforstring · obrigatório

Código do participante (F22_CLIFOR).

lojastring · obrigatório

Loja do participante (F22_LOJA).

Cenário

Exemplo

Request

DELETE https://erpapi.jetme.com.br/api/99/01/WsF22/PERF01/01/1/000001/01

Response 200

{
  "success": true,
  "message": "Participante removido do perfil.",
  "data": ""
}

Respostas

200

Participante removido.

400

Segmentos insuficientes no path.

404

Perfil não localizado em F20, ou linha não encontrada no grid.

422

Erro FISA164.

Consulta

Listar participantes do perfil e acesso por recno.

GET/WsF22/PERF01/01Lista participantes do perfil

Descrição

Varre F22 pelo índice F22_CODIGO+F22_TIPOPF e retorna todos os participantes do perfil. Campos retornados: F22_FILIAL, F22_CODIGO, F22_TPPART, F22_CLIFOR, F22_LOJA, F22_TIPOPF.

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsF22/PERF01/01

Response 200

{
  "success": true,
  "message": "",
  "data": {
    "perfil": "PERF01",
    "tipo": "01",
    "count": 2,
    "items": [
      {
        "F22_FILIAL": "01",
        "F22_CODIGO": "PERF01",
        "F22_TPPART": "1",
        "F22_CLIFOR": "000001",
        "F22_LOJA": "01",
        "F22_TIPOPF": "01"
      }
    ]
  }
}

Respostas

200

data.items com lista; data.count com total.

400

Perfil/tipo ausente no path.

GET/WsF22/PERF01/01/_byid/123Participante por RecNo

Descrição

Acessa participante diretamente via DbGoTo(nRecno). Útil para confirmar inclusão após POST. Preferir listagem para consultas gerais (recno pode mudar após reindexação).

Path parameters

perfil / tipostring · obrigatório

Perfil e tipo (para contexto de filial).

recnointeger · obrigatório

Número de registro físico da linha F22.

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsF22/PERF01/01/_byid/123

Response 200

{
  "success": true,
  "message": "",
  "data": {
    "recno": 123,
    "F22_FILIAL": "01",
    "F22_CODIGO": "PERF01",
    "F22_TPPART": "1",
    "F22_CLIFOR": "000001",
    "F22_LOJA": "01",
    "F22_TIPOPF": "01"
  }
}

Respostas

200

Registro encontrado. data traz campos CAMPOS_GET + recno.

404

RecNo não encontrado ou fora da filial.

Schemas

Componentes do contrato OpenAPI

PerfilTribParticipantePayload

object · POST body

Campos aceitos no body do POST. Sem whitelist de PUT (não existe).

F22_TPPARTstring ("1"/"2") · obrigatórioF22.F22_TPPART

1=Fornecedor (SA2), 2=Cliente (SA1). Validado antes do MVC.

F22_CLIFORstring · obrigatórioF22.F22_CLIFOR

Código do participante na tabela SA1 ou SA2.

F22_LOJAstring · obrigatórioF22.F22_LOJA

Loja do participante.

PerfilTribParticipante

object · F22

Participante retornado pelo GET (CAMPOS_GET). Sem MSBLQL/MSBLQD — não aplicável a tabela F22.

F22_FILIALstring

Filial do registro.

F22_CODIGOstring

Código do perfil (= {perfil} do path).

F22_TPPARTstring

"1"=Fornecedor, "2"=Cliente.

F22_CLIFORstring

Código do participante.

F22_LOJAstring

Loja do participante.

F22_TIPOPFstring

Tipo do perfil (= {tipo} do path).

recnointeger

Número de registro físico (só em _byid).

Cenários

1-pra-1 com examples: do YAML.

incluir-participante

POST /WsF22/{perfil}/{tipo}

Happy path minimal — adicionar fornecedor ao perfil tributário. Requer F22_TPPART, F22_CLIFOR e F22_LOJA.

F22_TPPART

"1" (Fornecedor)

F22_CLIFOR

"000001"

F22_LOJA

"01"

remover-participante

DELETE /WsF22/{perfil}/{tipo}/{tppart}/{clifor}/{loja}

Remove participante pelo path completo com 5 segmentos. Sem body.

path

/WsF22/PERF01/01/1/000001/01

listar-participantes

GET /WsF22/{perfil}/{tipo}

Lista todos os participantes do perfil PERF01/01. Retorna items + count.

path.perfil

PERF01

path.tipo

consulta-byid

GET /WsF22/{perfil}/{tipo}/_byid/{recno}

Acesso direto por número de registro físico. Usar para confirmar POST.

path.recno

123 (retornado implicitamente após POST)

Pendências conhecidas (rev2)

RecNo é frágil. _byid usa DbGoTo(nRecno) — posição física pode mudar após reindexação. Não persistir recno como chave primária; usar a combinação perfil+tipo+tppart+clifor+loja.

Sem _search / _list paginado. GET lista todos os participantes sem filtro ou paginação. Perfis com muitos participantes podem retornar payload grande.