Cobrança via boleto

Fluxo do processo

1 - Escuta de Comunicação Inicial:

O micro serviço erpx-bnk-cob-register-boleto é responsável por escutar requisições vindas de um ERP externo.

2 - Chamada da API registerBankSlipBilling:

A API é chamada com os seguintes parâmetros:
- banco: Informações sobre o banco onde o boleto será registrado;
- beneficiário: Dados do beneficiário do boleto;
- lista de títulos a receber: Uma lista contendo os títulos que serão registrados como boletos;
Esta chamada inicia o processo de registro de boletos.

3 - Validação de Payload:

O payload recebido na API registerBankSlipBilling é validado para verificar se todas as informações necessárias estão presentes e corretas.

4 - Chamada da API realizarIntegracoesFoundation:

Esta chamada ocorre dentro do micro serviço erpx-bnk-cob-boleto;
O sistema verifica se o cliente de cada título já está cadastrado:
- Se não estiver, procede-se com o cadastro do cliente.

5 - Chamada da API registrarCobrancaBoletoAsync:

Realiza as validações de negócio necessárias;
Para títulos que não passam nas validações:
- A API finalizarCobranca é chamada para atualizar a situação dos títulos para Finalizado e notificar o ERP externo dos erros através do evento bankSlipCreated.

6 - Processamento de Títulos Válidos:

Para os títulos que passaram pelas validações:
- A API executarIntegracaoParceiro é chamada;
  - Atualiza a situação dos títulos para Processando;
  - Monta o payload de acordo com as especificações do banco;
  - Envia o payload para o sistema parceiro (eSales) e aguarda retorno.

Fluxo de Erros

Notificação de Erros:
- Títulos que não cumprem as validações de negócio são marcados como Finalizado e um evento bankSlipCreated é emitido para notificar o ERP externo dos erros encontrados.

Fluxo de Retorno

A API de fachada de retorno fica no micro serviço erpx-bnk-cob-cobranca, na action retornoCobrancaESales para o parceiro eSales e retornoCobrancaBoletoBtg para o parceiro BTG .

O Retorno do parceiro acontece em 3 etapas:

Retorno da Cobrança (API retornoEnvioCobranca): Quando não ocorre erro, o parceiro notifica o Banking de que o boleto está em processamento. Caso ocorra erro, o retorno é Null. Esta API recupera as cobranças da base e realiza um loop nos títulos para verificar erros, preenchendo tabelas de histórico e erros se necessário. Verifica se todos os títulos estão processados e, se estiverem, chama o signal finalizarCobranca. Ocorre no micro serviço erpx-bnk-cob-boleto;
Confirmação de Envio (API retornoConfirmacaoCobranca): Após o envio para o banco, esta API verifica se o arquivo foi aceito (Ativo) ou negado (Negado).
Retorno Final do Banco (API retornoPagamentoCobranca): Quando o banco aceita o arquivo e a cobrança está ativa, o retorno final é Concluída.

Todas essas APIs de retorno ficam hospedadas no micro serviço erpx-bnk-cob-boleto.

Premissas

O processo de cobrança via boleto pelo ERP Banking contempla os seguintes aspectos da implementação e restrições operacionais:

1- Geração de Boletos através do ERP externo

O cliente que utiliza o ERP externo possui duas opções para a geração de boletos:
- Terceirização para o banco: O cliente pode optar por terceirizar a geração do boleto, permitindo que o banco gere e envie o boleto para o recebimento no ERP senior X;
- Geração pelo sistema do cliente: o cliente pode gerar o boleto diretamente usando seu sistema de ERP externo, para posterior recebimento no ERP senior X.
Campo nossoNumero: este campo é opcional. No entanto, se o ERP externo gerar o boleto com este campo informado, o ERP Senior X executará automaticamente a validação do tamanho, conforme as regras específicas de cada banco:
- Itaú: 08 posições;
- Bradesco: 11 posições;
- CEF: 17 posições;
- BB: 17 posições;
- Santander: 08 posições;
- Sicredi: 09 posições;
- BTG: 20 posições.
Se o valor máximo for excedido, é exibida a seguinte mensagem de erro: "Para o [BANCO], só é permitido informar até [VALOR MÁXIMO] caracteres para o campo nosso número."

2 - Dados do Avalista:

O avalista é identificado como a filial do ERP, mas os dados (nome e documento) são fornecidos diretamente pela API.

3 - Limitações de Títulos:

O limite é de 100 títulos por chamada API.

4 - Controle de Resposta:

Não há controle de resposta por lote, dado que a confirmação de emissão do boleto não é instantânea.

5 - Endereço do Devedor:

O endereço utilizado é o principal registrado no cadastro de pessoas do foundation.

6 - Campo SeuNúmero:

Deve ser fornecido pelo ERP externo, com os seguintes critérios específicos por banco:
- Sicredi - 10 Posições (Não pode conter espaços);
- Santander - 10 Posições;
- CEF - 10 Posições;
- BB - 10 Posições;
- Bradesco - 25 Posições;
- Itaú - 25 Posições;
- BTG: 10 posições.
Importante: Não é permitida a duplicidade no campo SeuNúmero.

7 - Validações:

Em caso de beneficiário e avalista idênticos, a transação será recusada pelo banco;
O banco BTG atende exclusivamente pessoas jurídicas. Assim, ao utilizar seus serviços, o CPF não é aceito, sendo necessário informar o CNPJ.

8 - Data de Emissão:

É gerenciada pelo sistema bancário, eliminando a necessidade de controle pelo ERP.

9 - Gestão de Ocorrências:

Criação das tabelas ocorrenciaBanco e motivoOcorrenciaBanco;
As ocorrências e seus motivos são recebidos no mesmo JSON, mas enviados separadamente ao ERP;
Ocorrências ou motivos não mapeados geram logs de erro e são devolvidos ao ERP com uma descrição genérica.

10 - Histórico de Transações:

Histórico detalhado das ocorrências relacionadas a cada boleto.

11 - Abordagem de Fachada:

Adotada a mesma estratégia de fachada usada para o PIX Cobrança, visando minimizar problemas de comunicação entre ERP e sistema bancário.

12 - Consulta de Endereços:

A busca de endereços é feita considerando as seguintes formas:
- Cidade: id ou codrai;
- Estado: id ou uf;
- País: id ou codPai.
Obs.: Para busca do país é utilizado o código do SPED.

13 - Controle de Retorno de Lote:

Não é feito controle de retorno de lotes para o ERO.
Por exemplo, o envio de 100 títulos pode não resultar na devolução simultânea dos mesmos no evento bankSlipCreated;.

14 - Descontos e Abatimentos:

Controle para que o desconto ou abatimento não exceda 100% do valor nominal do título;
Obs.: O banco Itaú especificamente não permite descontos superiores a 90% do valor nominal.

Estrutura registerBankSlipBilling

{ "receivableBank": "NOME_DO_BANCO", "beneficiary": { "name": "string", "documentNumber": "string", "covenant": "string(20)", "branchNumber": "integer minValue : 0 maxValue : 99999", "branchDigit": "string ( 2 )", "accountNumber": "string (15)", "accountDigit": "string ( 2 )" "pixKey": "string?" }, "accountsReceivable": [ { "accountReceivableId": "string", "accountReceivableNumber": "string", "accountReceivableType": "string", "generatePixQrCode": "boolean default: false", "yourNumber": "string ( 25 )", "ourNumber": "string ( 20 )", "customer": { "id": "string", "email": "string (100)", "phoneNumber": "string (20)", "address": { "street": "string", "neighborhood": "string", "country": { "id": "string" }, "state": { "code": "string" }, "city": { "id": "string" }, "postalCode": "string" } }, "dueDate": "date", "specie": "string", "wallet": "string", "guarantor": { "name": "string", "documentNumber": "string ( 14 )" }, "values": { "original": "money", "interest": { "calculationType": "enumCalculationTypeInterest", "valueOrPercentage": "string" }, "assessment" : { "calculationType" : "enumCalculationType", "valueOrPercentage" : "money" }, "rebate": { "calculationType": "enumCalculationType", "valueOrPercentage": "money" }, "discount" :{ "calculationType": "enumCalculationTypeDiscount", "discountFixedDate" : [ { "limitDate": "date", "valueOrPercentage": "money" } ] }, "protest" : { "type" : "enumProtestType", "deadline" : "integer?" }, "messages" : "string?*" } } ] }

receivableBank

Informar o nome do banco que deseja realizar a cobrança:

Bancos aceitos:

Banco do Brasil - 001;
Santander - 033;
Caixa Econômica Federal - 104;
Bradesco - 237;
Itaú - 341;
Sicredi - 748;
BTG - 208;

Informação obrigatória.

beneficiary

Informar os dados do beneficiário:

name: Nome do beneficiário;
documentNumber: Número do documento;
covenant: Convênio;
branchNumber: Número da agência;
branchDigit: Dígito da agência;
accountNumber: Número da conta;
accountDigit: Dígito da conta.
pixKey: Chave Pix.

Observação

Os campos de Nome do beneficiário (name), Dígito da agência (branchDigit) e Dígito da conta(accountDigit) são opcionais;

accountsReceivable

Informar os dados do título para registrar a cobrança:

accountReceivableId: Identificador do Título;
accountReceivableNumber: Número do Título;
accountReceivableType: Tipo do Título;
generatePixQrCode: Gera no boleto um QR Code para pagamento via Pix;
yourNumber: Número de identificação do boleto no sistema emissor;
customer: Identificador do Cliente;
dueDate: Data de Vencimento;
specie: Espécie;
wallet: Carteira;
ourNumber: Número de identificação do boleto no banco;

Observações

Os campos de Avalista (guarantor), Protesto (protest), Mensagens (messages), Espécie (specie), Carteira (wallet), Número de identificação do boleto no banco (ourNumber) e Pix QR Code (generatePixQrCode) são opcionais;
O campo Pix QR Code (generatePixQrCode), caso não seja preenchido, retorna por padrão o valor Falso. Já, ao preencher este campo como Verdadeiro, o código retornado pelo banco fica disponível no campo Pix copia e cola, localizado nos Detalhes do boleto. Além disso, o boleto é gerado com o QR Code para pagamento via Pix. Essas funcionalidades estão disponíveis apenas para o banco BTG.
O campo values é obrigatório, mas só é necessário informar o campo Valor Original (original). Os demais campos de Juros (interest), Multas (assessment), Abatimentos (rebate) e Desconto (discount) são opcionais;

O campo de Customer deve ser informado:

id: Identificador do cliente;
CPF/CNPJ, documentNumber: Número do documento;
name: Nome;
tradeName: Nome fantasia;
address: Endereço;
email: E-mail;
phoneNumber: Número do telefone.

Observações

Todos os campos são opcionais. Entretanto, é necessário informar ao menos um destes campos: Identificador do cliente (id) ou Número do documento (CPF/CNPJ) (documentNumber).
Se o Número do documento enviado for CPF ou documentNumber, deve ser informado o campo Nome (name).
Se o Número do documento enviado for CNPJ, deve ser informado o Nome fantasia (tradeName);

Campo de Juros (interest)

Informar o campo Tipo de cálculo (calculationType), que será buscado do enumCalculationTypeInterest e o campo Valor ou Percentual (valueOrPercentage).
- O enumCalculationTypeInterest representa a modalidade de juros para a cobrança.

Campo de Multas (assessment) e Abatimentos (rebate):

Informar o campo Tipo de cálculo (calculationType) que será buscado do enumCalculationType e o campo Valor ou Percentual (valueOrPercentage).
- O enumCalculationType representa a modalidade de abatimento para a cobrança.

Campo de Desconto (discount)

Informar o campo Tipo de cálculo (calculationType), que será buscado do enumCalculationTypeDiscount , Valor ou Percentual (valueOrPercentage) e o campo Descontos definidos de acordo com a data estabelecida (discountFixedDate).
- O enumCalculationTypeDiscount representa a modalidade de desconto para a cobrança.

cURL de simulação de cobrança

curl --location 'https://cloud-leaf.senior.com.br/t/senior.com.br/bridge/1.0/rest/erpx_bnk_cob/cobranca/actions/retornoCobrancaESales' \ --header 'Authorization: bearer s8zRgq67GdGGf46xf52yCFBkpTFU5FRa' \ --header 'Content-Type: application/json' \ --data '{ "tipo": "boleto", "cobrancas": [ { "txid": "<TXID AQUI>", "status": "CONCLUIDA", "pagamentos": [ { "valor": "101.00", "tipo": "boleto", "horario": "2025-01-09T00:00:00.000Z", "componentesValor": { "original": { "valor": "100.00" }, "multa": { "valor": "3.00" }, "juros": { "valor": "2.00" }, "abatimento": { "valor": "2.00" }, "desconto": { "valor": "2.00" } } } ], "boleto": { "seuNumero": "6237856", "nossoNumero": "9999999996", "linhaDigitavel": "34191099909980594029538970470001891650000034444", "ocorrencias": [ { "codigo": "06", "descricao": "Liquidação" } ], "dataLiquidacao": "2025-01-14" } }, { "txid": "<TXID AQUI>", "status": "CONCLUIDA", "pagamentos": [ { "valor": "101.00", "tipo": "boleto", "horario": "2025-01-09T00:00:00.000Z" } ], "boleto": { "seuNumero": "6237856", "nossoNumero": "9999999996", "linhaDigitavel": "34191099909980594029538970470001891650000034444", "ocorrencias": [ { "codigo": "06", "descricao": "Liquidação" }, { "codigo": "66", "descricao": "Motivo ocorrência" } ], "dataLiquidacao": "2025-01-15" } } ] }'

Enum de serviço

"Enumeration do tipo de cálculo dos valores de cobrança do título" enumeration enumCalculationType { "Percentual" PERCENTAGE "Valor fixo" FIXED_VALUE } "Enumeration do tipo de cálculo dos valores de desconto do título" enumeration enumCalculationTypeDiscount { "Valor fixo até a(s) data(s) informada(s)" FIXED_VALUE_UNTIL_LIMIT_DATE "Percentual até a data informada" PERCENTAGE_UNTIL_LIMIT_DATE } "Enumeration do tipo de cálculo dos valores de juros do título" enumeration enumCalculationTypeInterest { "Valor (dias corridos)" VALUE_FOR_CALENDAR_DAYS "Percentual ao dia (dias corridos)" PERCENTAGE_FOR_CALENDAR_DAYS } "Enumeration de espécie" enumeration enumSpecie { "Duplicata mercantil" COMMERCIAL_DUPLICATE "Duplicata de serviço" SERVICE_DUPLICATE } "Enumeration de carteira" enumeration enumWallet { "Simples" SIMPLE "Descontada" DISCOUNTED "Caucionada" SECURED } "Enumeration dos tipos de protestos" enumeration enumProtestType { "Dias corridos" CALENDAR_DAYS "Dias úteis" BUSINESS_DAYS "Não protestar" NO_PROTEST } "Enumeration dos bancos de recebimento" enumeration enumBancoRecebimento { "Banco do Brasil - 001" BANCO_DO_BRASIL "Santander - 033" SANTANDER "Caixa Econômica Federal - 104" CAIXA_ECONOMICA_FEDERAL "BTG Pactual - 208" BTG_PACTUAL "Bradesco - 237" BRADESCO "Itaú - 341" ITAU "Sicredi - 748" SICREDI } "Enumeration de espécie" enumeration enumEspecie { "Duplicata mercantil" DUPLICATA_MERCANTIL "Duplicata de serviço" DUPLICATA_SERVICO } "Enumeration de carteira" enumeration enumCarteira { "Simples" SIMPLES "Descontada" DESCONTADA "Caucionada" CAUCIONADA } "Enumeration do tipo de cálculo dos valores de juros do título" enumeration enumTipoCalculoJuros { "Valor (dias corridos)" VALOR_DIAS_CORRIDOS "Percentual ao dia (dias corridos)" PERCENTUAL_AO_DIA_DIAS_CORRIDOS } "Enumeration do tipo de cálculo dos valores de cobrança do título" enumeration enumTipoCalculo { "Percentual" PERCENTUAL "Valor fixo" VALOR_FIXO } "Enumeration do tipo de cálculo dos valores de desconto do título" enumeration enumTipoCalculoDesconto { "Valor fixo até a(s) data(s) informada(s)" VALOR_FIXO_ATE_DATA_INFORMADA "Percentual até a data informada" PERCENTUAL_FIXO_ATE_DATA_INFORMADA } "Enumeration dos tipos de protestos" enumeration enumTipoProtesto { "Dias corridos" DIAS_CORRIDOS "Dias úteis" DIAS_UTEIS "Não protestar" NAO_PROTESTAR }

Fluxo do processo

A API pública registerBankSlipOperation é responsável por receber informações de um ERP externo para realizar operações específicas. Ela requer o envio do processo, tipo de operação e uma lista dos títulos que serão processados.

Atualmente, as operações disponíveis com o parceiro eSales incluem a alteração de data de vencimento e a modificação de protesto.

Para garantir o correto processamento das operações, são realizadas as seguintes validações:

Após as validações, se tudo estiver correto, a API privada registrarOperacaoBoletoAsync é chamada. Esta API recebe as mesmas informações da registerBankSlipOperation.

Processamento dos Títulos

Para cada título recebido, é feita uma busca na entidade cobrancaItemBoleto para verificar a sua situação atual:

Se a situação for igual a COBRANCA_GERADA, o processamento é permitido;
Se a situação for diferente de COBRANCA_GERADA, o processamento não é permitido, e a situação do título é alterada para OPERACAO_NAO_PERMITIDA;
Se o título estiver apto para processamento, sua situação é atualizada para PROCESSANDO_OPERACAO.

Além disso, é vinculado o registro na entidade cobrancaItemBoleto e criado um registro correspondente na entidade de histórico.

Agrupamento e Execução das Operações

Após a verificação dos títulos aptos para processamento:

Os títulos aptos são agrupados por banco;
A API executarOperacaoESales é chamada para os títulos aptos, atualizando a situação deles e criando o registro histórico. Um payload é montado e o evento iniciarIntegracaoOperacaoBoletoESales é disparado. Após o envio de todos os títulos, a primitiva finalizarOperacao é chamada.

Finalização das Operações

A API finalizarOperacao atualiza a situação da entidade OperacaoBoleto para FINALIZADO e dispara o evento operationSent.

Retorno das Operações

A API retornoCobrancaESales é utilizada para retornar informações do parceiro. Essa API pode receber retornos de cobranças de diferentes modalidades, como Boleto, PIX e outras, na mesma lista de cobranças. Portanto, é necessário iterar pela lista de cobranças recebidas e separá-las em listas específicas para cada cenário.

Após iterar por cada cobrança e preencher as listas:

Se o retorno for de operações, os valores são mapeados para o Banking, e a API retornoOperacoes é chamada;
A API retornoOperacoes recupera as cobranças da base de dados, itera sobre os resultados recebidos, atualiza a situação do boleto, cria registros históricos e dispara o evento operationFinished.

Estrutura da registerBankSlipOperation

*REGISTER* "API responsável pela execução de operações sobre o registro de cobrança do boleto ### Resources - res://senior.com.br/erpx_bnk_cob/register_boleto/actions/registerBankSlipOperation" public action registerBankSlipOperation { in { "Id do processo" processId: string "Tipo de operação a ser executada" operationType : enumOperationType "Lista de identificadores dos títulos a serem processados" accountsReceivableId : string* "Nova data de vencimento" dueDate : date? "Protesto" protest : protest? "Novo valor" newValue: money? "Juros" interest: recCalculationInterest? "Multas" assessment : recCalculationValue? "Descontos" discount : recCalculationDiscount? } out { "Id do processo" processId: string } responses { 400 : "Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente" 403 : "Permissão negada" // 404 : "Registro não localizado através do ID ERPX ou chave de negócio informados" } }

Parâmetros de entrada esperados no corpo da requisição

processId: identifica o processo que está sendo executado;
operationType: a operação que será executada;
accountsReceivableId: lista dos títulos das operações;
dueDate e protest: As operações possíveis junto ao parceiro eSales atualmente são: alteração de data de vencimento e de protesto. Ambos são opcionais;
newValue, interest, assessment e discount: As operações possíveis junto ao parceiro BTG são: alterações do valor do boleto, do juros, da multa ou do desconto.

Retorno da API

A API não retorna dados específicos em uma resposta de sucesso. Uma resposta bem-sucedida é indicada pela ausência de erros e pelo código HTTP 200.

Possíveis códigos de resposta da API:

400 - Requisição inválida: Parâmetros obrigatórios não foram informados ou algum campo foi preenchido incorretamente;
403 - Permissão negada: O usuário não possui permissão para realizar essa ação;
404 - Registro não encontrado: O registro não foi localizado com base no ID ERPX ou na chave de negócio fornecidos.

Estrutura do Enum e Record do serviço

"Enumeration de tipos de operações boleto" enumeration enumOperationType { "Baixar" WRITE_OFF "Alterar data de vencimento" CHANGE_DUE_DATE "Protestar" PROTEST "Sustar protesto" CANCEL_PROTEST "Alterar valor" CHANGE_VALUE "Alterar juros" CHANGE_INTEREST "Alterar multas" CHANGE_ASSESSMENT "Alterar descontos" CHANGE_DISCOUNT "Cancelar boleto" CANCEL_BANK_SLIP } "Record dos dados para protesto" record protest { "Tipo do protesto" type: enumProtestType "Prazo do protesto" deadline: integer minValue:0 }

Estrutura da getStatusBankSlipBilling

"Query de listagem do status dos títulos de cobrança boleto
### Resources
- res://senior.com.br/erpx_bnk_cob/register_boleto/queries/getStatusBankSlipBilling"
public query getStatusBankSlipBilling {
    in {
        "Filtro"				
        filter : recFilterGetStatusBankSlipBilling?
        "Controle de paginação e ordenação"
        pageRequest : recPageRequest
    }
    
    out {
        "Dados da cobrança boleto"
        recBankSlipBilling : recBankSlipBilling*
    }
    
    responses {
        400 : "Requisição inválida, parâmetros obrigatórios não informados ou campo informado incorretamente"
        403 : "Permissão negada"
        404 : "Registro não encontrado"
    }
}

recFilterGetStatusBankSlipBilling

Filtro de status dos títulos de cobrança Boleto;
Se o filtro incluir IDs de títulos e um intervalo de datas, a consulta prioriza os IDs, desconsiderando as datas informadas;
Caso o ID não seja informado, é obrigatório fornecer uma data inicial e uma data final. A data inicial não pode ser futura, e o intervalo entre as datas deve ser de, no máximo, 7 dias corridos.
O filtro aceita apenas IDs, apenas datas ou uma combinação de IDs e datas.

Records e Enumerations


"Record do filtro de status dos títulos de cobrança boleto"
        record recFilterGetStatusBankSlipBilling {
            "Lista de Identificadores dos títulos"
            billingId : string?*
            "Data de emissão inicial"
            startDate : date?
            "Data de emissão final"
            endDate : date?
        }

        "Record para paginação e ordenação"
        record recPageRequest {
            "Página atual"
            offset : integer
            "Total de registros da página"
            size : integer
            "Campos da ordenação dos registros a serem pesquisados"
            orderBy : recFieldsOrderBy?*
        }

        "Define o registro com os dados dos campos à serem ordenados"
        record recFieldsOrderBy {
            "Nome do campo a ser ordenado"
            field : string
            "Tipo de ordenação do campo (ASC / DESC)"
            order : enumTypeOrder
        }

        "Enumeração para o tipo de ordenação"
        enumeration enumTypeOrder {
            "Tipo de ordenação - Crescente"
            ASC
            "Tipo de ordenação - Decrescente"
            DESC
        }

        "Record de dados da cobrança de boleto"
        record recBankSlipBilling {
            "Identificador do título"
            accountReceivableId : string
            "Situação do título"
            situation : enumBankSlipBillingItemsSituation
            "Linha digitável"
            digitableLine : string
            "Nosso número"
            ourNumber : string ( 20 )?
            "Pix copia e cola"
            pixCopyAndPaste : string?
            "Pix QRCode"
            pixQRCode: string?
            "Valor Pago"
            amountPaid : money?
            "Valor original"
            originalValue : money?
            "Valor abatimento"
            rebateValue : money?
            "Valor multa"
            assessmentValue : money?
            "Valor desconto"
            discountValue : money?
            "Valor juros"
            interestValue : money?
            "Data liquidação"
            settlementDate : date?
            "Código da ocorrência"
            occurrenceCode : string?
            "Descrição da ocorrência"
            occurrenceDescription : string?
            "Lista de motivos da ocorrências"
            description : string?*
            "Lista de erros na geração do boleto"
            errors : recError?*
        }

        "Record com informações de erro do boleto"
        record recError {
            "Mensagem de erro"
            message : string
            "Campo do erro"
            field : string?
        }

        "Enumeration de situação da cobrança item"
        enumeration enumBankSlipBillingItemsSituation {
            "Aguardando cobrança"
            AWAITING_BILLING
            "Processando envio da cobrança"
            PROCESSING_BILLING_SEND
            "Cobrança enviada"
            BILLING_SENT
            "Cobrança com problemas"
            BILLING_WITH_PROBLEMS
            "Cobrança gerada"
            BILLING_GENERATED
            "Cobrança negada"
            BILLING_DENIED
            "Cobrança paga"
            BILLING_PAID
            "Cobrança inapta para processamento"
            BILLING_UNFIT_FOR_PROCESSING
            "Cobrança inativada"
            BILLING_INACTIVATED
            "Erro inesperado"
            UNEXPECTED_ERROR
            "Falha na validação"
            VALIDATION_FAILURE
            "Cancelando cobranca"
            CANCELLING_BILLING
            "Cobranca cancelada"
            BILLING_CANCELLED
            "Erro cancelamento cobranca"
            BILLING_CANCELLATION_ERROR
        }
    }

CURL de exemplo getStatusBankSlipBilling

curl --location 'https://cloud-leaf.senior.com.br/t/senior.com.br/bridge/1.0/rest/erpx_bnk_cob/register_boleto/queries/getStatusBankSlipBilling' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer N7PafIfsCqok4dxXM1w9BuwVekFZ9J2s' \
--data '{
    "filter": {
        "billingId": ["c36d4abd-a4ba-498e-bcbd-26bb692d2702"],
        "startDate": "2025-05-14",
        "endDate": "2025-05-16"
    },
    "pageRequest": {
        "offset": "1",
        "size": "10"
    }
}'

bankSlipCreatedLegacy: Responsável pelo retorno da criação de boleto legado

public event bankSlipCreatedLegacy {
  payload {
    accountsReceivable : recAccountsReceivableCreatedLegacy*
  }
}

	"Record com os dados de criação do boleto"
	   record recAccountsReceivableCreatedLegacy {
	   "Convênio"
	   agreement: string?
	   "Seu número do boleto"
	   yourNumber : string?
	   "Nosso número"
	   ourNumber : string?
	   "Linha digitável"
	   digitableLine : string?
	   "Situação da geração do boleto"
	   situation : enumSituationCreated
	   "Ocorrência"
	   occurrence : recOcurrence?
	   "Motivos da ocorrência"
	   causesOccurrence : recOcurrence?*
	   "Lista de erros na geração do boleto"
	   errors : recError?*
	   "PIX Copia e Cola gerado pelo banco"
           pixCopyAndPaste : string?
           "Pix QRCode"
           pixQRCode : string?
		}

bankSlipReceivedLegacy: Responsável pelo retorno do pagamento de boleto legado

public event bankSlipReceivedLegacy {
  payload {
    accountsReceivable: recAccountsReceivablePaydOffLegacy*
  }
}

"Record com os dados de pagamento do boleto legado"
		record recAccountsReceivablePaydOffLegacy {
		"Convênio"
		agreement: string?
	        "Seu número do boleto"
	        yourNumber : string?
	        "Nosso número"
	        ourNumber : string?
		"Linha digitável"
		digitableLine : string?
		"Valor recebido"
		valueReceived : money
		"Valor original"
		originalValue : money
		"Valor de abatimento"
		rebateValue : money
		"Valor de multa"
		assessmentValue : money
		"Valor de desconto"
		discountValue : money
		"Valor de juros"
		interestValue : money
		"Data do recebimento"
		payDate : date
		"Data de liberação"
                settledAt : date?
	        "Ocorrência"
	        occurrence : recOcurrence?
	        "Motivos da ocorrência"
	        causesOccurrence : recOcurrence?*
		}
}

operationFinishedLegacy: Disparado ao final do processo de operações de cobrança boleto legado

public event operationFinishedLegacy {
  payload {
    accountsReceivable: accountReceivableOperationLegacy*
  }
}

"Record com as informações de processamento de operações do boleto legado"
        record accountReceivableOperationLegacy {
	 "Convênio"
	 agreement: string?
	 "Seu número do boleto"
	 yourNumber : string?
	 "Nosso número"
	 ourNumber : string?
	 "Linha digitável"
	 digitableLine : string?
         "Situação do processamento"
         situation : enumSituationOperation
         "Data de vencimento alterada"
         dueDateChanged: date?
        }

recRetornoConfirmacaoPagamento: Dados de confirmação de pagamento do boleto

"Dados de confirmação de pagamento do boleto"
		record recRetornoConfirmacaoPagamento {
			"Txid da cobrança"
			txId : string?
			"Convênio"
			convenio : string?
			"Documento do recebedor"
			documentoRecebedor : string?
			"Linha digitável"
			linhaDigitavel : string?
			"Seu número"
			seuNumero : string?
			"Nosso número"
			nossoNumero : string?
			"Valor pago"
			valorPago : money
			"Valor original"
			valorOriginal : recValor
			"Valor multa"
			valorMulta : recValor
			"Valor juros"
			valorJuros : recValor
			"Valor abatimento"
			valorAbatimento : recValor
			"Valor desconto"
			valorDesconto : recValor
			"Data da liquidação"
			dataLiquidacao: date
			"Data de liberação"
			dataLiberacao: date?
			"Ocorrência"
			ocorrencia: recOcorrencia
			"Lista de motivos da ocorrências"
			motivosOcorrencia: recOcorrencia?*
		}

recOcorrencia: Informações da ocorrência

"Record com as infomações da ocorrência"
		record recOcorrencia {
			"Código"
			codigo: string
			"Descrição"
			descricao: string?
		}

recError: Informações de erro do boleto

"Record com informações de erro do boleto"
		record recError {
			"Mensagem de erro"
			message : string
			"Campo do erro"
			field : string?
		}

enumSituationCreated: Situação da cobrança

"Situação da cobrança"
		enumeration enumSituationCreated {
			"Criado"
			CREATED
			"Não criado"
			NOT_CREATED
		}

enumSituationOperation: Situações da operação

 "Enumeration das situações da operação"
        enumeration enumSituationOperation {
            "Boleto baixado"
            WRITTEN_OFF
            "Boleto não baixado"
            NOT_WRITTEN_OFF
            "Data de vencimento alterada"
            CHANGED_DUE_DATE
            "Data de vencimento não alterada"
            NOT_CHANGED_DUE_DATE
            "Protestado"
            PROTESTED
            "Não protestado"
            NOT_PROTESTED
            "Protesto sustado"
            CANCELED_PROTEST
            "Protesto não sustado"
            NOT_CANCELED_PROTEST
	    "Processando baixa do boleto"
	    PROCESS_WRITTEN_OFF
	    "Processando alteração de data vencimento"
	    PROCESS_CHANGE_DUE_DATE
	    "Processando protesto"
	    PROCESS_PROTEST
	    "Processando sustação do protesto"
	    PROCESS_CANCEL_PROTEST
	    "Processando alteração de valor"
            PROCESS_CHANGE_VALUE
            "Valor alterado"
            CHANGED_VALUE
            "Valor não alterado"
            NOT_CHANGED_VALUE
            "Processando alteração de juros"
            PROCESS_CHANGE_INTEREST
            "Juros alterados"
            CHANGED_INTEREST
            "Juros não alterados"
            NOT_CHANGED_INTEREST
            "Processando alteração de multa"
            PROCESS_CHANGE_ASSESSMENT
            "Multa alterada"
            CHANGED_ASSESSMENT
            "Multa não alterada"
            NOT_CHANGED_ASSESSMENT
            "Processando alteração de desconto"
            PROCESS_CHANGE_DISCOUNT
            "Desconto alterado"
            CHANGED_DISCOUNT
            "Desconto não alterado"
            NOT_CHANGED_DISCOUNT
            "Processando cancelamento de boleto"
            PROCESS_CANCEL_BANK_SLIP
            "Boleto cancelado"
            CANCELED_BANK_SLIP
            "Boleto nao cancelado"
            NOT_CANCELED_BANK_SLIP
        }

Cobrança via boleto

Fluxo do processo de cobrança via boleto pelo ERP Banking

Parceiros bancários

Geração de cobrança do boleto através do ERP Banking

Descrição dos campos da registerBankSlipBilling

Como preencher o campo de Juros (interest), Multas (assessment), Abatimentos (rebate) e Desconto (discount)?

cURL de exemplo para simular a liquidação de cobrança

Estrutura dos Enums de serviço:

Tratamento das operações de alterar vencimento, baixar, protestar e sustar protesto

Consultar status da criação das cobranças via Boleto

Reenviar boleto com status Recusado

Tratamento de boleto legado

Eventos para tratar as operações de boletos legado

Records

Enumerations

PORTAL DE DOCUMENTAÇÃO
Gestão Empresarial \| ERP senior X