Alteração Forma de Cobrança
CobrancaAlteracaoDeFormaDeCobranca
Esta rotina do módulo Financeiro permite alterar, em lote, a forma de cobrança (para títulos a receber) ou a forma de pagamento (para títulos a pagar) de um conjunto de títulos já lançados no sistema, registrando o movimento contábil/financeiro decorrente dessa alteração e mantendo o histórico da forma anterior.
Visão Geral
Esta rotina do módulo Financeiro permite alterar, em lote, a forma de cobrança (para títulos a receber) ou a forma de pagamento (para títulos a pagar) de um conjunto de títulos já lançados no sistema, registrando o movimento contábil/financeiro decorrente dessa alteração e mantendo o histórico da forma anterior. Ela corresponde à tela de menu “Alteração forma cobrança”, dentro do agrupamento “Cobrança”.
Endpoints
[POST] /CobrancaAlteracaoDeFormaDeCobranca/Salvar
Recebe uma lista de títulos e uma forma de cobrança/pagamento de destino, e aplica a alteração a cada título informado. Para cada título, o sistema identifica automaticamente se ele é um título a receber ou a pagar, atualiza a forma de cobrança/pagamento, preserva a forma anterior em um campo de histórico e gera o lançamento financeiro correspondente. Ao final, retorna a lista das movimentações financeiras geradas pela operação (dados usados para emissão do comprovante).
Permissão: “CobrancaAlteracaoDeFormaDeCobranca/Salvar” (ID 1789)
Parâmetros (corpo da requisição):
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| TitulosAProcessar | Lista de títulos | Sim | Lista dos títulos a terem a forma de cobrança/pagamento alterada. Cada item precisa ao menos do identificador (campo “ID”) do título. |
| IDDaFormaDeCobranca | Número | Sim | Identificador da forma de cobrança (ou forma de pagamento, no caso de título a pagar) para a qual os títulos selecionados serão alterados. |
| GeraLanctosIndependentes | Texto (“Sim”/”Não”) | Não | Define se cada título deve gerar um lançamento financeiro próprio e independente, em vez de agrupar todos os títulos processados em um único lançamento. |
| EhLiquidacaoMoedaExtrangeira | Verdadeiro/Falso | Não | Indica se a operação envolve liquidação em moeda estrangeira. |
Observação: o campo “IDDoFatoContabil” também existe no modelo de dados da requisição, mas é preenchido automaticamente pelo próprio sistema antes do processamento — não precisa (e não deve) ser informado pelo usuário/tela.
“` POST /CobrancaAlteracaoDeFormaDeCobranca/Salvar { “TitulosAProcessar”: [ { “ID”: “12345” }, { “ID”: “12346” } ], “IDDaFormaDeCobranca”: 3, “GeraLanctosIndependentes”: “Não”, “EhLiquidacaoMoedaExtrangeira”: false } “`
“`json { “success”: true, “listaDeOperacoesFinanceiras”: [] } “`
[POST] /CobrancaAlteracaoDeFormaDeCobranca/Imprimir
Ação de apoio à emissão do comprovante de alteração. Antes de gerar o comprovante, o sistema garante que a pasta de documentos do cliente exista e que o modelo de relatório (arquivo “ComprovanteAlteracaoInfoFin.rpt”) esteja disponível nessa pasta, copiando-o do modelo padrão quando necessário. Não realiza nenhuma alteração de dados de negócio — é apenas preparação de arquivo para a impressão do comprovante.
Permissão: “CobrancaAlteracaoDeFormaDeCobranca/Imprimir” (ID 1790)
Parâmetros: nenhum.
“` POST /CobrancaAlteracaoDeFormaDeCobranca/Imprimir “`
“`json { “success”: true } “`
Modelos de Dados
Item de “TitulosAProcessar” (título a alterar) — campos relevantes para esta rotina:
| Campo | Tipo | Descrição |
|---|---|---|
| ID | Texto | Identificador (chave de fato) do título a receber ou a pagar que terá a forma de cobrança/pagamento alterada. |
Cabeçalho da operação — campos relevantes para esta rotina:
| Campo | Tipo | Descrição |
|---|---|---|
| TitulosAProcessar | Lista de títulos | Títulos selecionados para alteração. |
| IDDaFormaDeCobranca | Número | Forma de cobrança/pagamento de destino. |
| GeraLanctosIndependentes | Texto (“Sim”/”Não”) | Se cada título gera lançamento financeiro próprio. |
| EhLiquidacaoMoedaExtrangeira | Verdadeiro/Falso | Se a operação envolve moeda estrangeira. |
| IDDoFatoContabil | Número | Preenchido automaticamente pelo sistema (fato contábil da operação); não é um campo de entrada do usuário. |
Regras de Negócio
Regra 1 — Identificação automática do tipo de título. Para cada título informado, o sistema primeiro tenta localizá-lo entre os títulos a receber. Se encontrado, trata-o como lançamento a débito e usa a operação financeira de alteração de forma de cobrança (recebimento). Se não for encontrado entre os títulos a receber, o sistema busca entre os títulos a pagar e, se encontrado, trata-o como lançamento a crédito, usando a operação financeira de alteração de forma de pagamento.
Regra 2 — Preservação do histórico da forma anterior. Antes de sobrescrever a forma de cobrança (ou de pagamento) do título, o sistema registra a forma anterior em um campo de histórico, no formato “Código – Nome” (ex: “3 – Boleto”), permitindo rastrear qual era a forma antes da alteração.
Regra 3 — Restrição para lançamentos independentes em moeda estrangeira. Não é permitido gerar lançamentos financeiros independentes (um lançamento por título) quando a operação envolve liquidação em moeda estrangeira. Se o usuário solicitar “GeraLanctosIndependentes” = “Sim” junto com “EhLiquidacaoMoedaExtrangeira” = verdadeiro, a operação é bloqueada.
Regra 4 — Obrigatoriedade de ao menos um título. A operação de salvar não pode ser executada sem nenhum título selecionado.
Regra 5 — Falha durante o processamento de um título. Se ocorrer qualquer erro ao processar um dos títulos da lista (por exemplo, dado inconsistente do título), toda a operação de alteração é interrompida e desfeita, e o sistema exibe a mensagem de erro abaixo, substituindo “{0}” pelo detalhe técnico do problema ocorrido.
Regra 6 — Persistência transacional. A alteração de todos os títulos da lista ocorre dentro de uma única transação de banco de dados: só é confirmada (efetivada) se todos os títulos forem processados com sucesso; qualquer falha no meio do processo desfaz as alterações já feitas na operação.
Regra 7 — Geração de lançamento financeiro. Para cada título alterado, o sistema gera um lançamento financeiro (registro de movimentação) vinculado ao fato contábil apropriado (um fato contábil para alteração de forma de cobrança de títulos a receber, outro para títulos a pagar), associando a filial do banco/caixa do título, o participante e os dados de data de lançamento e de movimentação informados.
Permissões
Acesso à rotina: “EditViewDeTitulosParaAlteracaoTRECFORM” (ID 1574) — pertence ao agrupamento “Cobrança” (ID 1562) do menu Financeiro.
| Ação | Permissão | ID |
|---|---|---|
| Salvar (aplicar a alteração de forma de cobrança/pagamento) | “CobrancaAlteracaoDeFormaDeCobranca/Salvar” | 1789 |
| Imprimir (gerar/preparar comprovante) | “CobrancaAlteracaoDeFormaDeCobranca/Imprimir” | 1790 |