rev1-2026-05-16

CadastroServico

CRUD do cadastro de Serviço (CCQ) via wrapper MATA943. Diferente dos demais cadastros: o código (CCQ_CODIGO) vai no body do POST (não no path); PUT/DELETE/GET usam {codigo} no path.

Sem bloqueio MSBLQL. A tabela CCQ não tem o par de bloqueio TOTVS — uso é controlado por integridade referencial (item em SF1/SF2).

Vinculação com o ERP

Tabela mestreCCQCadastro de Serviços

Rotina automáticaMATA943MsExecAuto · op 3/4/5

Wrapper AdvPLU_MT943Excsrc/lib/MAT/MT943EXC.prw

Fonte RESTWsCCQ.prwsrc/api/CadastroServico/

ChaveCCQ_CODIGObody em POST · path em PUT/DELETE/GET

BloqueioN/ACCQ sem MSBLQL

Dependências

Cadastro

Centro de custo (CTT)

CCQ_CC validado no MATA943 contra CTT_CUSTO.

Cadastro

Conta contábil (CT1)

CCQ_CONTA validado contra CT1_CONTA.

Tabela genérica

Código LC 116

CCQ_LC116 = código do serviço na lista da Lei Complementar 116/2003 (ISS).

Convenções

Envelope canônico. { success, message, data }.

Chave varia por verbo. POST: CCQ_CODIGO no body. PUT/DELETE/GET: {codigo} no path. Padrão diferente do WsSA3/WsPedidoVenda (que usam INCLUIR/ALTERAR/EXCLUIR no path).

Whitelist de campos. Payload aceita CCQ_CODIGO, CCQ_DESCRI, CCQ_CC, CCQ_CONTA, CCQ_LC116, CCQ_ALIQ. Demais ignorados.

CCQ_ALIQ é numérico. Alíquota de ISS — passa direto pro MATA943 sem conversão.

Serviço — mutação

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

POST/WsCCQ/Inclui serviço — MATA943 op=3

Descrição

Inclui serviço. O código vai no body (CCQ_CODIGO) — não no path. Duplicidade retorna 409.

Cenário

Request body

CCQ_CODIGOstring · obrigatório

Código do serviço.

CCQ_DESCRIstring · obrigatório

Descrição.

CCQ_CCstring · opcional

Centro de custo (CTT_CUSTO).

CCQ_CONTAstring · opcional

Conta contábil (CT1_CONTA).

CCQ_LC116string · opcional

Código LC 116.

CCQ_ALIQnumber · opcional

Alíquota ISS (%).

Mínimo. Código + descrição.

Request

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

{
  "CCQ_CODIGO": "SRV001",
  "CCQ_DESCRI": "Consultoria TI"
}

Completo. Com CC, conta, LC116 e alíquota.

Request

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

{
  "CCQ_CODIGO": "SRV001",
  "CCQ_DESCRI": "Consultoria TI",
  "CCQ_CC": "101001",
  "CCQ_CONTA": "1234567",
  "CCQ_LC116": "01.07",
  "CCQ_ALIQ": 5.0
}

Respostas

201

Criado.

400

Payload inválido.

409

Código já existe.

422

Erro MATA943 (CC/conta inválidos etc).

PUT/WsCCQ/SRV001Altera serviço — MATA943 op=4

Descrição

Altera serviço existente. Código vai no path; CCQ_CODIGO no body é ignorado.

Cenário

Request body

CCQ_DESCRIstring · opcional

Nova descrição.

CCQ_ALIQnumber · opcional

Nova alíquota.

Request

PUT https://erpapi.jetme.com.br/api/99/01/WsCCQ/SRV001

{
  "CCQ_DESCRI": "Consultoria TI Senior",
  "CCQ_ALIQ": 3.0
}

Respostas

200

Alterado.

404

Não encontrado.

422

Erro MATA943.

DELETE/WsCCQ/SRV001Exclui serviço — MATA943 op=5

Descrição

Exclui serviço via op=5. Falha (422) quando referenciado em SF1/SF2 (NF de serviço).

Cenário

Exemplo

Request

DELETE https://erpapi.jetme.com.br/api/99/01/WsCCQ/SRV001

Respostas

200

Excluído.

404

Não encontrado.

422

Em uso.

Consulta

Por código, listagem, typeahead.

GET/WsCCQ/SRV001Serviço por código

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsCCQ/SRV001

Response 200

{
  "success": true,
  "data": {
    "CCQ_CODIGO": "SRV001",
    "CCQ_DESCRI": "Consultoria TI",
    "CCQ_CC": "101001",
    "CCQ_CONTA": "1234567",
    "CCQ_LC116": "01.07",
    "CCQ_ALIQ": 5.0
  }
}

GET/WsCCQ/_listListagem paginada

Query parameters

pageinteger · default 1

Página.

pageSizeinteger · default 50, max 500

Tamanho.

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsCCQ/_list?page=1&pageSize=25

GET/WsCCQ/_searchTypeahead

Descrição

TCGenQry em CCQ_CODIGO ou CCQ_DESCRI com prefixo term. Mín 2 chars; limit 10/25.

Query parameters

termstring · min 2 · obrigatório

Prefixo (código ou descrição).

limitinteger · default 10, max 25

Limite.

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsCCQ/_search?term=SRV&limit=5

Schemas

Componentes do contrato OpenAPI

ServicoPayload

object

Payload plano de POST/PUT. CCQ_CODIGO obrigatório no POST (no body); no PUT vai no path.

CCQ_CODIGOstring · obrigatório (POST)CCQ.CCQ_CODIGO

Código do serviço.

CCQ_DESCRIstring · obrigatório (POST)CCQ.CCQ_DESCRI

Descrição.

CCQ_CCstring · opcionalCCQ.CCQ_CC

Centro de custo (CTT).

CCQ_CONTAstring · opcionalCCQ.CCQ_CONTA

Conta contábil (CT1).

CCQ_LC116string · opcionalCCQ.CCQ_LC116

Código LC 116 (ISS).

CCQ_ALIQnumber · opcionalCCQ.CCQ_ALIQ

Alíquota ISS (%).

Servico

object · CCQ

Serviço retornado pelo GET (CAMPOS_GET).

CCQ_FILIAL + campos do ServicoPayload

Inclui CCQ_FILIAL.

EnvelopeSucesso

object · envelope

Envelope canônico.

success / message / data

Padrão da biblioteca.

EnvelopeErro

object · envelope

success=false + message.

message

Causa (e.g. "CC inválido", "Serviço em uso por SF2").

Cenários

1-pra-1 com examples: do YAML.

incluir-minimo

POST /WsCCQ/

Código + descrição.

CCQ_CODIGO, CCQ_DESCRI

"SRV001", "Consultoria TI"

incluir-completo

POST /WsCCQ/

Com CC, conta, LC116 e alíquota.

CCQ_CC, CCQ_CONTA, CCQ_LC116, CCQ_ALIQ

"101001", "1234567", "01.07", 5.0

alterar

PUT /WsCCQ/{codigo}

Atualiza descrição e alíquota.

CCQ_DESCRI, CCQ_ALIQ

Novos valores.

excluir

DELETE /WsCCQ/{codigo}

Sem body. Falha quando referenciado em SF1/SF2.

path.codigo

"SRV001"

consulta-byid

GET /WsCCQ/{codigo}

Serviço SRV001.

path.codigo

"SRV001"

listagem

GET /WsCCQ/_list

Primeira página, 25/pag.

page, pageSize

1, 25

typeahead

GET /WsCCQ/_search

Sugestões para "SRV".

term, limit

"SRV", 5

Pendências conhecidas (rev2)

Sem MSBLQL. CCQ não tem flag de bloqueio. Para "desativar" um serviço sem excluir, alterar a descrição (e.g. prefixar "[INATIVO]"). Convenção operacional, não enforced.

Validação CC/conta delegada ao MATA943. Centro de custo/conta inexistentes só falham no MsExecAuto (não há pré-validação no endpoint).