rev1-2026-05-16

CondicaoPagamento

CRUD de Condição de Pagamento (cabeçalho SE4 + itens SEC opcionais) via wrapper MATA360. Cabeçalho descreve a regra geral (E4_TIPO, E4_COND); itens (SEC) detalham parcelas em condições compostas — opcionais.

Coexiste com WsSE4NFC. Este endpoint (WsSE4) faz CRUD pleno. Para o workflow NFC com filtro E4_ATVWF, usar WsSE4NFC (read-only).

Vinculação com o ERP

Tabela mestreSE4Condição de Pagamento (cabeçalho)

Tabela detalheSECParcelas (itens opcionais)

Rotina automáticaMATA360MsExecAuto · op 3/4/5

Wrapper AdvPLU_MT360Excsrc/lib/MAT/MT360EXC.prw

Fonte RESTWsSE4.prwsrc/api/CondicaoPagamento/

Chave externaE4_CODIGOno path · 3 chars

Dependências e variantes

Variante

WsSE4NFC

Endpoint paralelo (read-only) com filtro E4_ATVWF para fluxo NFC. CRUD aqui (WsSE4).

Regra de negócio

E4_TIPO

Define a fórmula de parcelas (e.g. 9=tipo livre, demais valores no SX5 06).

Regra de negócio

E4_COND

String compactada da condição (e.g. "30,60,90" = 3 parcelas em 30/60/90 dias).

Itens (opcional)

SEC

Quando E4_TIPO=9 (livre), informar array de parcelas em itens[] com EC_DDD (dias) e EC_RATEIO (%).

Convenções

Envelope canônico. { success, message, data }. POST/PUT retornam data.E4_CODIGO.

Itens opcionais. Para condições simples (parcela única ou tipo padrão SX5), basta o cabeçalho. Itens em SEC só fazem sentido em E4_TIPO=9 (livre).

Whitelist de campos. Cabeçalho aceita E4_TIPO, E4_COND, E4_DESCRI, E4_MSGNFE. Itens aceitam EC_TIPO, EC_COND, EC_IPI, EC_DDD, EC_SOLID, EC_RATEIO. Demais ignorados.

EC_RATEIO soma 100. Quando itens são informados, a soma de EC_RATEIO deve fechar 100% — MATA360 rejeita com 422 caso contrário.

Condição de Pagamento — mutação

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

POST/WsSE4/INCLUIR/001Inclui condição — MATA360 op=3

Descrição

Inclui condição. {codigo} = E4_CODIGO único; duplicidade → 409.

Cenário

Request body

cabecalho.E4_TIPOstring · obrigatório

Tipo (SX5 06). "9" = livre (usa itens).

cabecalho.E4_CONDstring · obrigatório

String compactada da condição.

cabecalho.E4_DESCRIstring · opcional

Descrição.

itens[].EC_DDDnumber · obrigatório (tipo livre)

Dias da parcela.

itens[].EC_RATEIOnumber · obrigatório (tipo livre)

% da parcela. Soma deve fechar 100.

Simples. Condição "30 dias" sem itens.

Request

POST https://erpapi.jetme.com.br/api/99/01/WsSE4/INCLUIR/001

{
  "cabecalho": {
    "E4_TIPO": "1",
    "E4_COND": "30",
    "E4_DESCRI": "30 dias"
  }
}

Com itens. Tipo livre, 2 parcelas 30/60 a 50%/50%.

Request

POST https://erpapi.jetme.com.br/api/99/01/WsSE4/INCLUIR/002

{
  "cabecalho": {
    "E4_TIPO": "9",
    "E4_COND": "30,60",
    "E4_DESCRI": "2x 30/60 livre"
  },
  "itens": [
    { "EC_DDD": 30, "EC_RATEIO": 50 },
    { "EC_DDD": 60, "EC_RATEIO": 50 }
  ]
}

Respostas

201

Criado. data.E4_CODIGO.

400

Payload inválido.

409

Código já existe.

422

Erro MATA360 (rateio ≠ 100, tipo inválido).

PUT/WsSE4/ALTERAR/001Altera condição — MATA360 op=4

Descrição

Altera condição existente. cabecalho e itens opcionais.

Cenário

Request body

cabecalho.E4_DESCRIstring · opcional

Nova descrição.

cabecalho.E4_MSGNFEstring · opcional

Mensagem da NFe.

Request

PUT https://erpapi.jetme.com.br/api/99/01/WsSE4/ALTERAR/001

{
  "cabecalho": {
    "E4_DESCRI": "30 dias - revisado"
  }
}

Respostas

200

Alterado.

404

Não encontrado.

422

Erro MATA360.

DELETE/WsSE4/EXCLUIR/001Exclui condição — MATA360 op=5

Descrição

Exclui condição. Falha (422) quando referenciada em pedidos/contas (SC5, SE2 etc).

Cenário

Exemplo

Request

DELETE https://erpapi.jetme.com.br/api/99/01/WsSE4/EXCLUIR/001

Respostas

200

Excluída.

404

Não encontrada.

422

Em uso.

Consulta

Por código, listagem, typeahead.

GET/WsSE4/001Condição por código

Descrição

Retorna cabeçalho + itens em data.{cabecalho,itens}.

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsSE4/002

Response 200

{
  "success": true,
  "data": {
    "cabecalho": {
      "E4_CODIGO": "002",
      "E4_TIPO": "9",
      "E4_COND": "30,60",
      "E4_DESCRI": "2x 30/60 livre"
    },
    "itens": [
      { "EC_ITEM": "01", "EC_DDD": 30, "EC_RATEIO": 50 },
      { "EC_ITEM": "02", "EC_DDD": 60, "EC_RATEIO": 50 }
    ]
  }
}

GET/WsSE4/_listListagem paginada

Query parameters

codstring · opcional

Prefixo E4_CODIGO.

descristring · opcional

Prefixo E4_DESCRI.

page, pageSizeinteger

Paginação (default 1 / 50, max 500).

Cenário

Exemplo

Request

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

GET/WsSE4/_searchTypeahead por descrição

Descrição

TCGenQry em E4_DESCRI com prefixo q. Mín 2 chars; limit 10/25.

Query parameters

qstring · min 2 · obrigatório

Prefixo da descrição.

limitinteger · default 10, max 25

Limite.

Cenário

Exemplo

Request

GET https://erpapi.jetme.com.br/api/99/01/WsSE4/_search?q=30&limit=5

Schemas

Componentes do contrato OpenAPI

CondPagPayload

object

Envelope de entrada POST/PUT. Cabeçalho + itens (opcionais).

cabecalhoCabecalho · obrigatório (POST)

Ver Cabecalho.

itensarray[Item] · opcional

Parcelas em tipo livre (E4_TIPO=9). Ver Item.

Cabecalho

object · SE4

Cabeçalho da condição. Whitelist CAMPOS_CAB_ALLOW.

E4_TIPOstring · obrigatório (POST)SE4.E4_TIPO

Tipo (SX5 06). "9"=livre, demais=preset.

E4_CONDstring · obrigatório (POST)SE4.E4_COND

String compactada da condição.

E4_DESCRIstring · opcionalSE4.E4_DESCRI

Descrição visual.

E4_MSGNFEstring · opcionalSE4.E4_MSGNFE

Mensagem fixa na NFe.

Item

object · SEC

Parcela. Whitelist CAMPOS_ITEM_ALLOW. Soma de EC_RATEIO deve fechar 100.

EC_DDDnumber · obrigatórioSEC.EC_DDD

Dias após emissão.

EC_RATEIOnumber · obrigatórioSEC.EC_RATEIO

% da parcela.

EC_TIPO, EC_COND, EC_IPI, EC_SOLIDstring · opcional

Tipo/condição/IPI/solidário por parcela.

EnvelopeSucesso

object · envelope

Envelope canônico.

success / message / data

Padrão biblioteca; data inclui E4_CODIGO em POST/PUT.

EnvelopeErro

object · envelope

success=false + message.

message

Causa (e.g. "Rateio não totaliza 100%").

Cenários

1-pra-1 com examples: do YAML.

incluir-simples

POST /WsSE4/INCLUIR/{codigo}

Condição preset, sem itens.

E4_TIPO=1, E4_COND=30

"30 dias" típico.

incluir-com-itens

POST /WsSE4/INCLUIR/{codigo}

Tipo livre (E4_TIPO=9), 2 parcelas 30/60 a 50%.

E4_TIPO=9 + 2 itens

Soma EC_RATEIO = 100.

alterar-descri

PUT /WsSE4/ALTERAR/{codigo}

Atualiza descrição e mensagem NFe.

E4_DESCRI, E4_MSGNFE

Texto livre.

excluir

DELETE /WsSE4/EXCLUIR/{codigo}

Sem body. Falha quando referenciada.

path.codigo

"001"

consulta-byid

GET /WsSE4/{codigo}

Cabeçalho + itens.

path.codigo

"002" (com itens)

listagem

GET /WsSE4/_list

Primeira página, 25/pag.

page, pageSize

1, 25

typeahead

GET /WsSE4/_search

Sugestões para "30" — acento-insensitive.

q, limit

"30", 5

Pendências conhecidas (rev2)

Sem bloqueio MSBLQL. SE4 não tem flag de bloqueio padrão. Controle via integridade referencial em SC5/SE2 etc.

EC_RATEIO 100%. Validação de soma é responsabilidade do MATA360 — payload sem total 100 retorna 422 (não pré-validado no endpoint).

Variante NFC. WsSE4NFC (read-only) filtra por E4_ATVWF para workflow NFC; aqui (WsSE4) faz CRUD pleno sem esse filtro.