Inclusão de Decréscimo
CobrancaInclusaoDeDecrescimo
Rotina do módulo Financeiro, submenu Cobrança, que permite aplicar um decréscimo (redução de valor) em um ou mais títulos a receber selecionados, gerando a movimentação financeira e o lançamento contábil correspondentes.
Visão Geral
Rotina do módulo Financeiro, submenu Cobrança, que permite aplicar um decréscimo (redução de valor) em um ou mais títulos a receber selecionados, gerando a movimentação financeira e o lançamento contábil correspondentes.
Endpoints
POST /CobrancaInclusaoDeDecrescimo/Salvar
Processa a lista de títulos a receber informados, aplicando o valor de decréscimo de cada um, gerando a movimentação financeira, a integração contábil e (quando aplicável) a atualização de dados de boleto híbrido via API.
Permissão: “CobrancaInclusaoDeDecrescimo/Salvar” (ID 1802) — acesso à tela coberto por “EditViewDeTitulosParaAlteracaoTRECDECR” (ID 1570, submenu Cobrança)
Parâmetros:
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| dto | DTOCabecalhoDeOperacoes | Sim | Cabeçalho da operação, incluindo a lista de títulos a processar (TitulosAProcessar), a cotação da moeda (ValorCotacao) e o indicador de liquidação em moeda estrangeira (EhLiquidacaoMoedaExtrangeira) |
| dto.TitulosAProcessar[].ID | string | Sim | Identificador do título a receber que sofrerá o decréscimo |
| dto.TitulosAProcessar[].Decrescimo | decimal | Condicional | Valor do decréscimo em moeda nacional (usado quando DecrescimoMoeda não for informado) |
| dto.TitulosAProcessar[].DecrescimoMoeda | decimal | Condicional | Valor do decréscimo em moeda estrangeira (quando informado, o valor em moeda nacional é recalculado pela cotação) |
“` POST /CobrancaInclusaoDeDecrescimo/Salvar { “TitulosAProcessar”: [ { “ID”: “12345”, “Decrescimo”: 50.00, “DecrescimoMoeda”: 0 } ], “ValorCotacao”: 1, “EhLiquidacaoMoedaExtrangeira”: false } “`
“`json { “success”: true, “aviso”: null, “listaDeOperacoesFinanceiras”: [], “listaDeOperacoesContabeis”: [] } “`
POST /CobrancaInclusaoDeDecrescimo/Imprimir
Prepara o arquivo de layout do comprovante da operação (copia o modelo padrão do relatório de comprovante para a pasta do cliente, caso ainda não exista), para permitir a emissão do comprovante da operação de decréscimo.
Permissão: “CobrancaInclusaoDeDecrescimo/Imprimir” (ID 1803) — acesso à tela coberto por “EditViewDeTitulosParaAlteracaoTRECDECR” (ID 1570)
Parâmetros: nenhum.
“` POST /CobrancaInclusaoDeDecrescimo/Imprimir “`
“`json { “success”: true } “`
Modelos de Dados
DTOCabecalhoDeOperacoes (cabeçalho da operação — campos relevantes a esta rotina):
| Campo | Tipo | Descrição |
|---|---|---|
| TitulosAProcessar | List\<DTODeTituloAProcessar\> | Lista de títulos a receber que sofrerão o decréscimo |
| ValorCotacao | decimal | Cotação da moeda estrangeira usada para converter o valor de decréscimo em moeda para moeda nacional |
| EhLiquidacaoMoedaExtrangeira | bool | Indica se a operação envolve variação cambial (gera lançamento adicional de variação cambial antes do lançamento do decréscimo) |
| ChequesDeTerceiros / ChequesProprios | List | Sempre limpos (definidos como nulos) pela rotina antes do processamento — não se aplicam a decréscimo |
DTODeTituloAProcessar (um item da lista de títulos — campos relevantes a esta rotina):
| Campo | Tipo | Descrição |
|---|---|---|
| ID | string | Identificador do título a receber |
| Decrescimo | decimal | Valor do decréscimo em moeda nacional |
| DecrescimoMoeda | decimal | Valor do decréscimo em moeda estrangeira, quando aplicável |
Regras de Negócio
Regra 1 — Título obrigatório para salvar. Se a lista de títulos a processar (`TitulosAProcessar`) vier vazia ou nula, a operação não é executada.
Regra 2 — Cálculo do valor de decréscimo em moeda estrangeira. Se o título tiver `DecrescimoMoeda` maior que zero, o valor de decréscimo em moeda nacional é recalculado como `DecrescimoMoeda × ValorCotacao` (arredondado a 2 casas decimais); caso contrário, é usado o valor de `Decrescimo` informado diretamente.
Regra 3 — Determinação do fato contábil pela variação do título. O fato contábil usado no lançamento (operação financeira “tcTRECDECR”) varia conforme a filial ser cooperativa e o participante ser cooperado, e conforme o tipo de documento do título começar com o prefixo “AD” (adiantamento) ou não. Essa combinação define a rotina de variação contábil aplicada ao lançamento (ex.: Adiantamento Cooperado, Sem Variação Não Cooperado, etc.).
Regra 4 — Lançamento de variação cambial (moeda estrangeira). Quando a operação é sinalizada como liquidação em moeda estrangeira (`EhLiquidacaoMoedaExtrangeira = true`), o sistema gera, antes do lançamento do decréscimo, um lançamento adicional de variação cambial para o título.
Regra 5 — Integração contábil. Após processar todos os títulos, se houver movimentações financeiras geradas, o sistema executa a integração contábil (geração dos lançamentos contábeis correspondentes) de forma automática.
Regra 6 — Atualização de boleto híbrido via API. Após a integração contábil, o sistema tenta atualizar os dados do boleto híbrido (API) dos títulos afetados. Se houver falha nessa atualização:
- Se a regra de negócio determinar que a falha deve interromper a operação, a transação inteira é desfeita (rollback) e um erro é lançado com o log da falha.
- Caso contrário, a operação é concluída normalmente, mas um aviso com o detalhamento da falha (e/ou de títulos já baixados) é retornado ao usuário no campo `aviso` da resposta.
Regra 7 — Erro inesperado durante o processamento. Qualquer exceção não tratada durante o processamento é capturada e reportada ao usuário.
Permissões
Acesso à rotina: “EditViewDeTitulosParaAlteracaoTRECDECR” (ID 1570) — submenu “Cobrança” (ID 1562), módulo Financeiro
| Ação | Permissão | ID |
|---|---|---|
| Salvar | “CobrancaInclusaoDeDecrescimo/Salvar” | 1802 |
| Imprimir | “CobrancaInclusaoDeDecrescimo/Imprimir” | 1803 |