rev1-2026-05-16

PerfilTribProduto

Gerencia o grid de produtos (F24) de um Perfil Tributário via wrapper FISA166. Cada produto pode ter múltiplas origens tributárias (F25). O perfil-pai (F20) deve existir com tipo 04 antes de qualquer operação. Não há PUT — alterações exigem DELETE + POST.

Endpoint de grid. Cada chamada POST acrescenta uma linha ao grid de produtos do perfil. DELETE remove uma linha por código de produto (F24_CDPROD). Não há PUT neste endpoint.

Vinculação com o ERP

Tabela mestreF24Produtos do perfil tributário

Tabela origensF25Origens tributárias por produto

Tabela cabeçalhoF20Perfil Tributário · tipo 04

Rotina automáticaFISA166MsExecAuto · op 4/5

Wrapper AdvPLU_FA166MVCsrc/lib/MAT/FA166MVC.prw

Fonte RESTWsF24.prwsrc/api/PerfilTribProduto/

Dependências e índices

Índice F24-1

F24_FILIAL+F24_CODIGO+F24_CDPROD

Listagem de produtos do perfil.

Índice F25-1

F25_FILIAL+F25_CODIGO+F25_CDPROD

Origens tributárias por produto.

Pré-requisito

F20 · tipo "04"

Perfil-pai deve existir antes do POST/DELETE.

TIPO_PERFIL

"04" (fixo)

Perfis de produto usam sempre tipo 04 em F20.

Convenções

Envelope canônico. { success, message, data }. POST retorna data.perfil, data.F24_CDPROD e data.origens.

Chave no path. POST usa {perfil} = código do perfil (F24_CODIGO). DELETE usa {perfil}/{cdprod} — 2 segmentos finais da URL.

Origens opcionais. Campo origens no body do POST aceita array de strings (["0","1"]) ou array de objetos ([{"F25_ORIGEM":"0"}]). Omitir = sem origens.

Consulta por recno. GET /{perfil}/_byid/{recno} acessa via DbGoTo(nRecno) — útil para recarregamento após POST.

Sem PUT. Não existe método PUT neste endpoint. Para alterar origens de um produto: DELETE + POST.

Sem bloqueio TOTVS. F24/F25 não possuem MSBLQL/MSBLQD. Sem lógica de bloqueio neste endpoint.

PerfilTribProduto — mutação

Adição e remoção de produtos via FISA166.

POST/WsF24/P001Adiciona produto ao perfil — FISA166 op=4

Descrição

Adiciona um produto ao grid do perfil. O perfil-pai (F20 com tipo "04") deve existir. F24_CDPROD é obrigatório. origens é opcional.

Path parameter

perfilstring · obrigatório

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

Cenário

Request body

F24_CDPRODstring · obrigatório

Código do produto (SB1).

origensarray · opcional

Origens tributárias: ["0","1"] ou [{"F25_ORIGEM":"0"}].

Mínimo. Produto sem origens tributárias.

Request

POST https://erpapi.jetme.com.br/api/99/01/WsF24/P001

{
  "F24_CDPROD": "P0001"
}

Response 201

{
  "success": true,
  "message": "Produto adicionado ao perfil.",
  "data": {
    "perfil": "P001",
    "F24_CDPROD": "P0001",
    "origens": []
  }
}

Com origens. Produto com origens tributárias 0 e 1.

Request

POST https://erpapi.jetme.com.br/api/99/01/WsF24/P001

{
  "F24_CDPROD": "P0001",
  "origens": ["0", "1"]
}

Response 201

{
  "success": true,
  "message": "Produto adicionado ao perfil.",
  "data": {
    "perfil": "P001",
    "F24_CDPROD": "P0001",
    "origens": ["0", "1"]
  }
}

Respostas

201

Produto adicionado. data.perfil, data.F24_CDPROD, data.origens.

400

Perfil ausente no path, body inválido ou F24_CDPROD vazio.

404

Perfil F20 (tipo 04) não encontrado.

422

Erro FISA166 (produto inválido, duplicidade etc).

DELETE/WsF24/P001/P0001Remove produto do perfil — FISA166 op=5

Descrição

Remove o produto {cdprod} do grid do perfil {perfil} via FISA166 op=5. Retorna 404 quando o erro contém "nao encontrado", senão 422.

Path parameters

perfilstring · obrigatório

Código do perfil tributário (penúltimo segmento).

cdprodstring · obrigatório

Código do produto a remover (último segmento).

Cenário

Exemplo

Request

DELETE https://erpapi.jetme.com.br/api/99/01/WsF24/P001/P0001

Response 200

{
  "success": true,
  "message": "Produto P0001 removido do perfil P001.",
  "data": ""
}

Respostas

200

Produto removido.

400

Segmentos de path insuficientes.

404

Perfil F20 ou produto F24 não encontrado.

422

Erro FISA166.

Consulta

Listagem do grid do perfil e consulta por recno.

GET/WsF24/P001Lista produtos do perfil

Descrição

Varre F24 pelo índice F24_CODIGO. Cada item inclui os campos CAMPOS_GET (F24_FILIAL|F24_CODIGO|F24_CDPROD|F24_TIPOPF), o recno físico e o array origens de F25 ([{"F25_ORIGEM":"0"}]).

Path parameter

perfilstring · obrigatório

Código do perfil tributário.

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsF24/P001

Response 200

{
  "success": true,
  "message": "OK",
  "data": {
    "items": [
      {
        "F24_FILIAL": "01",
        "F24_CODIGO": "P001",
        "F24_CDPROD": "P0001",
        "F24_TIPOPF": "04",
        "recno": 42,
        "origens": [
          { "F25_ORIGEM": "0" },
          { "F25_ORIGEM": "1" }
        ]
      }
    ],
    "perfil": "P001",
    "count": 1
  }
}

GET/WsF24/P001/_byid/42Produto por recno

Descrição

Acessa F24 via DbGoTo(nRecno). Retorna campos CAMPOS_GET + recno. Sem origens (usar listagem para dados completos). 404 quando recno inválido ou de outra filial.

Path parameters

perfilstring · obrigatório

Código do perfil (segmento antes de _byid).

recnointeger · obrigatório

RecNo físico da linha F24 (retornado pelo POST ou GET listagem).

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsF24/P001/_byid/42

Response 200

{
  "success": true,
  "message": "OK",
  "data": {
    "F24_FILIAL": "01",
    "F24_CODIGO": "P001",
    "F24_CDPROD": "P0001",
    "F24_TIPOPF": "04",
    "recno": 42
  }
}

Respostas

200

Dados do produto.

400

recno inválido (não numérico ou zero).

404

recno não encontrado ou de outra filial.

Schemas

Componentes do contrato OpenAPI

PerfilTribProdutoPayload

object · POST body

Payload do POST para adicionar produto ao grid do perfil.

F24_CDPRODstring · obrigatórioF24.F24_CDPROD

Código do produto (SB1). Chave da linha no grid.

origensarray · opcionalF25.F25_ORIGEM

Origens tributárias. Strings ["0","1"] ou objetos [{"F25_ORIGEM":"0"}]. Omitir = sem origens.

PerfilTribProduto

object · F24

Linha de produto retornada pelo GET. CAMPOS_GET: F24_FILIAL|F24_CODIGO|F24_CDPROD|F24_TIPOPF + recno + origens (apenas no GET listagem).

F24_FILIALstringF24.F24_FILIAL

Filial do registro.

F24_CODIGOstringF24.F24_CODIGO

Código do perfil tributário ao qual pertence o produto.

F24_CDPRODstringF24.F24_CDPROD

Código do produto.

F24_TIPOPFstringF24.F24_TIPOPF

Tipo do perfil (sempre "04" para perfis de produto).

recnointeger

RecNo físico da linha F24. Usar em GET _byid.

origensarrayF25.F25_ORIGEM

Origens tributárias vinculadas. Presente apenas no GET listagem. Formato: [{"F25_ORIGEM":"0"}].

EnvelopeSucesso

object · envelope

Envelope canônico.

success

true.

message

Mensagem descritiva da operação.

data

POST: { perfil, F24_CDPROD, origens }. GET lista: { items, perfil, count }. GET byid: objeto F24. DELETE: string vazia.

EnvelopeErro

object · envelope

success=false + message com a causa.

message

Causa do erro (ex: "F24_CDPROD obrigatorio.", "Produto recno 42 nao localizado.").

Cenários

1-pra-1 com examples: do YAML.

incluir-produto

POST /WsF24/{perfil}

Mínimo viável — produto sem origens tributárias.

F24_CDPROD

"P0001"

incluir-produto-com-origens

POST /WsF24/{perfil}

Produto com origens tributárias 0 e 1.

F24_CDPROD + origens

"P0001" + ["0","1"]

remover-produto

DELETE /WsF24/{perfil}/{cdprod}

DELETE sem body. 2 segmentos: perfil + cdprod.

path.perfil / path.cdprod

"P001" / "P0001"

listar-produtos

GET /WsF24/{perfil}

Lista todos os produtos do perfil. Resposta inclui items[] com origens F25 aninhadas.

path.perfil

"P001"

consulta-byid

GET /WsF24/{perfil}/_byid/{recno}

Acesso por recno físico (DbGoTo). Sem origens. Útil para recarregar após POST.

path.perfil / path.recno

"P001" / 42

Pendências conhecidas (rev2)

Nenhuma aberta. Endpoint de grid; sem bloqueio TOTVS, sem serialização Date pendente.