rev1-2026-05-04 Protheus 12.1.33

BaixaPagar

Baixa e cancelamento de titulos do Contas a Pagar (tabela SE2) via rotina automatica FINA080 do Protheus. Aceita uma lista de titulos num unico POST e processa cada um individualmente, retornando um detalhamento por posicao do array. Duas operacoes: 3 = Baixa e 5 = Cancelamento de baixa.

Bloqueio TOTVS: endpoint de processo (baixa via FINA070), sem MSBLQL — bloqueio relevante esta no fornecedor (SA2).

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

Vinculacao com o ERP

Tabela mestre SE2 Titulos a pagar

Rotina automatica FINA080 MsExecAuto . baixa de titulos

Wrapper AdvPL U_FN080Exe src/lib/FIN/FN080EXC.prw

Operacoes & modos

POST op 3 - Baixa POST op 5 - Cancela

Dependencias de ambiente

Cadastro

Titulo do contas a pagar

tabela SE2 . chave E2_PREFIXO+E2_NUM+E2_PARCELA+E2_TIPO+E2_FORNECE+E2_LOJA
titulo precisa existir e estar na filial informada no payload

Cadastro . condicional

Banco (para baixa)

tabela SA6 . campos AUTBANCO+AUTAGENCIA+AUTCONTA
conta corrente que recebe o lancamento financeiro da baixa (op 3)

Wrapper

U_FN080Exe

src/lib/FIN/FN080EXC.prw . MsExecAuto({|x,y| FINA080(x,y)}, aArray, nOper)
itera Titulos[], agrega lMsErroAuto por titulo, retorna detalhamento

Build

Protheus 240223P+

build minimo validado: 240223P; padroes herdados do WSCT2 rev2
thread REST: oWsSelf capturado antes de Begin Sequence

Convencoes

Lista de titulos por chamada. O endpoint sempre recebe Titulos[] com pelo menos um item. Cada titulo e processado individualmente pelo wrapper; uma falha num item nao aborta os demais. O status HTTP final consolida o resultado: 200 (todos ok), 207 (parcial), 422 (todos falharam).

Operacao 3 (Baixa) vs 5 (Cancelamento). Em Operacao=3 os campos AUT* de pagamento sao esperados (motivo de baixa, valor, datas, banco). Em Operacao=5 basta a chave do titulo (campos E2_*); os AUT* presentes sao ignorados pelo FINA080.

Valor pago e AUTVLRPG. Quando ausente, zero ou negativo, o wrapper calcula automaticamente o valor pelo saldo aberto do titulo (E2_SALDO). Util quando o consumidor quer baixar o titulo inteiro sem conhecer o saldo previo.

Formato de datas. AUTDTBAIXA e AUTDTCREDITO aceitam string ISO YYYY-MM-DD. O wrapper converte para Date AdvPL via sToD(StrTran(...,"-","")) antes de empurrar para o MsExecAuto.

Identificacao do titulo. A chave da SE2 e composta - E2_PREFIXO+E2_NUM+E2_PARCELA+E2_TIPO+E2_FORNECE+E2_LOJA. Os seis campos sao obrigatorios em ambas as operacoes; E2_PARCELA pode vir vazio em titulos sem parcelamento (valor padrao em branco).

Baixa

Baixa e cancelamento via FINA080

POST /WsBaixaPagar/ Baixa ou cancela titulos a pagar

Descricao

Processa uma lista de titulos do Contas a Pagar via FINA080. O campo Operacao seleciona o modo do MsExecAuto: 3 para baixa, 5 para cancelamento de baixa. Cada titulo do array e processado isoladamente; o resultado consolidado e retornado em data.detalhe, chaveado por posicao (1-based) no array de entrada.

Status HTTP consolidado.

200 - todos os titulos processados com sucesso.
207 - parcial: ao menos um ok e ao menos um com erro.
422 - falha de validacao do payload ou todos os titulos falharam.
400 - body ausente, JSON malformado ou estrutura invalida.
500 - excecao nao tratada (capturada por Begin Sequence).

Request body

application/json BaixaPagarRequest . obrigatorio

Envelope com Filial, Operacao e Titulos[]. Schema completo em BaixaPagarRequest.

Baixa simples (op 3) - um titulo com todos os campos AUT* de pagamento preenchidos. Fixture: fixtures/baixa.json.

RequestHTTP/1.1 . application/json

POST https://erpapi.jetme.com.br/api/99/01/WsBaixaPagar/
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Content-Type: application/json
Accept: application/json

{
  "Filial": "01",
  "Operacao": 3,
  "Titulos": [
    {
      "E2_PREFIXO": "A01",
      "E2_NUM": "000001",
      "E2_PARCELA": "001",
      "E2_TIPO": "NF",
      "E2_FORNECE": "000001",
      "E2_LOJA": "01",
      "AUTMOTBX": "DEB",
      "AUTVLRPG": 1000.00,
      "AUTDTBAIXA": "2026-05-04",
      "AUTDTCREDITO": "2026-05-04",
      "AUTBANCO": "001",
      "AUTAGENCIA": "00001",
      "AUTCONTA": "000001",
      "AUTJUROS": 0,
      "AUTDESCONT": 0,
      "AUTMULTA": 0,
      "AUTOUTGAS": 0,
      "AUTVLRME": 0,
      "AUTCHEQUE": ""
    }
  ]
}

Cancelamento de baixa (op 5) - apenas os campos identificadores E2_* sao necessarios. Eventuais AUT* presentes sao ignorados pelo FINA080. Fixture: fixtures/cancelamento.json.

RequestHTTP/1.1 . application/json

POST https://erpapi.jetme.com.br/api/99/01/WsBaixaPagar/
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Content-Type: application/json
Accept: application/json

{
  "Filial": "01",
  "Operacao": 5,
  "Titulos": [
    {
      "E2_PREFIXO": "A01",
      "E2_NUM": "000001",
      "E2_PARCELA": "001",
      "E2_TIPO": "NF",
      "E2_FORNECE": "000001",
      "E2_LOJA": "01"
    }
  ]
}

Baixa com valor automatico - omite AUTVLRPG (ou envia 0) para que o wrapper calcule o valor pelo saldo aberto (E2_SALDO). Util quando o consumidor nao quer consultar o saldo previo.

RequestHTTP/1.1 . application/json

POST https://erpapi.jetme.com.br/api/99/01/WsBaixaPagar/
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Content-Type: application/json
Accept: application/json

{
  "Filial": "01",
  "Operacao": 3,
  "Titulos": [
    {
      "E2_PREFIXO": "A01",
      "E2_NUM": "000002",
      "E2_PARCELA": "",
      "E2_TIPO": "NF",
      "E2_FORNECE": "000001",
      "E2_LOJA": "01",
      "AUTMOTBX": "PIX",
      "AUTDTBAIXA": "2026-05-04",
      "AUTDTCREDITO": "2026-05-04",
      "AUTBANCO": "001",
      "AUTAGENCIA": "00001",
      "AUTCONTA": "000001"
    }
  ]
}

Respostas

200

Todos os titulos processados com sucesso. Envelope BaixaPagarResponse com data.ok == data.total.

207

Processamento parcial (multi-status): ao menos um titulo ok e ao menos um com erro. data.detalhe[i] traz ok + msg por titulo. Tier: edge-valid.

400

Body ausente, JSON malformado ou estrutura invalida (faltando Operacao, Titulos nao e array, etc). Tier: validation-error.

422

Operacao fora de {3,5}, Titulos vazio, ou todos os titulos falharam no MsExecAuto. Tier: business-error.

500

Excecao nao tratada no wrapper ou no MsExecAuto (capturada por Begin Sequence). Tier: business-error.

Exemplo de resposta

Response . 200 OKapplication/json

{
  "success": true,
  "message": "Todos os titulos processados com sucesso.",
  "data": {
    "total": 1,
    "ok": 1,
    "erros": 0,
    "detalhe": {
      "1": {
        "titulo": 1,
        "ok": true,
        "msg": "OK"
      }
    }
  }
}

Response . 207 Multi-Status (parcial)application/json

{
  "success": true,
  "message": "Processamento parcial: 1 ok, 1 com erro.",
  "data": {
    "total": 2,
    "ok": 1,
    "erros": 1,
    "detalhe": {
      "1": {
        "titulo": 1,
        "ok": true,
        "msg": "OK"
      },
      "2": {
        "titulo": 2,
        "ok": false,
        "msg": "Titulo nao localizado na SE2."
      }
    }
  }
}

Schemas

Definicoes canonicas - campos com origem SX3 rastreavel

BaixaPagarRequest

object

Envelope do POST. Encapsula a filial-alvo, o modo de operacao e a lista de titulos a processar. Validado no proprio endpoint antes de chamar o wrapper.

Filialstring . obrigatorio

Codigo da filial Protheus alvo da operacao (ex.: "01"). Aplicado como filtro de xFilial("SE2").

Operacaointeger . obrigatorio

3 = Baixa, 5 = Cancelamento de baixa. Outros valores retornam 422.

35

Titulosarray<TituloInput> . obrigatorio

Lista nao vazia de titulos a processar. Lista vazia provoca 422.

TituloInput

object

Item da lista Titulos[]. Em Operacao=3 (Baixa), os campos AUT* de pagamento sao esperados. Em Operacao=5 (Cancelamento), apenas os identificadores E2_* sao necessarios; AUT* presentes sao ignorados pelo FINA080.

E2_PREFIXOstring . obrigatorioSE2.E2_PREFIXO

Prefixo do titulo. Componente da chave SE2.

E2_NUMstring . obrigatorioSE2.E2_NUM

Numero do titulo.

E2_PARCELAstring . opcionalSE2.E2_PARCELA

Parcela. Vazio em titulos sem parcelamento.

E2_TIPOstring . obrigatorioSE2.E2_TIPO

Tipo do titulo (ex.: NF, DP, FT).

E2_FORNECEstring . obrigatorioSE2.E2_FORNECE

Codigo do fornecedor (FK SA2.A2_COD).

E2_LOJAstring . obrigatorioSE2.E2_LOJA

Loja do fornecedor (FK SA2.A2_LOJA).

AUTMOTBXstring . opcional (op 3)

Motivo de baixa (ex.: DEB, TED, PIX). Consultado pelo FINA080 para definir o lancamento financeiro.

AUTVLRPGnumber . opcional (op 3)

Valor pago. Se omitido, zero ou negativo, o wrapper usa o saldo aberto do titulo (E2_SALDO).

AUTJUROSnumber . opcional (op 3)

Valor de juros aplicado na baixa.

AUTDESCONTnumber . opcional (op 3)

Valor de desconto aplicado na baixa.

AUTMULTAnumber . opcional (op 3)

Valor de multa aplicado na baixa.

AUTOUTGASnumber . opcional (op 3)

Outras despesas associadas a baixa.

AUTDTBAIXAstring (date) . opcional (op 3)

Data da baixa, ISO YYYY-MM-DD. Default: data-base do ambiente.

AUTDTCREDITOstring (date) . opcional (op 3)

Data do credito bancario, ISO YYYY-MM-DD.

AUTBANCOstring . opcional (op 3)SA6.A6_COD

Codigo do banco. Triplica AUTBANCO+AUTAGENCIA+AUTCONTA identifica a conta corrente (SA6).

AUTAGENCIAstring . opcional (op 3)SA6.A6_AGENCIA

Agencia bancaria.

AUTCONTAstring . opcional (op 3)SA6.A6_NUMCON

Numero da conta corrente.

AUTVLRMEnumber . opcional (op 3)

Valor em moeda estrangeira (quando o titulo for em outra moeda).

AUTCHEQUEstring . opcional (op 3)

Numero do cheque, quando a baixa se da em cheque.

BaixaPagarResponse

object . envelope

Envelope das respostas 200 e 207. data consolida totais e expoe o detalhamento por posicao do array de entrada, chaveado por indice 1-based.

successboolean . const: true

true em respostas 200 e 207 (parcial conta como sucesso parcial).

messagestring . obrigatorio

Mensagem editorial. Em 207, descreve a contagem ok/erro.

data.totalinteger . obrigatorio

Total de titulos enviados em Titulos[].

data.okinteger . obrigatorio

Titulos processados com sucesso.

data.errosinteger . obrigatorio

Titulos que falharam (lMsErroAuto = .T. no wrapper).

data.detalhemap<string,TituloResult> . obrigatorio

Mapa chaveado por indice 1-based do array de entrada. Cada valor e um TituloResult.

TituloResult

object

Resultado individual de um titulo processado pelo FINA080. Em caso de erro, msg traz a primeira linha do log do NomeAutoLog capturado pelo wrapper.

titulointeger . obrigatorio

Indice do titulo no array de entrada (1-based).

okboolean . obrigatorio

true se o MsExecAuto retornou sem lMsErroAuto.

msgstring . obrigatorio

"OK" em sucesso, ou mensagem do NomeAutoLog em erro (ex.: "Titulo nao localizado na SE2.").

Erro

object . envelope

Envelope padrao de erros 4xx/5xx. data pode trazer o token interno da causa (por exemplo, log do NomeAutoLog) para tratamento programatico, quando aplicavel.

successboolean . const: false

Sempre false em erros.

messagestring . obrigatorio

Mensagem editorial do erro (apresentavel ao usuario final).

datastring . opcional

Token interno / detalhe tecnico (por exemplo, log do MsExecAuto).