Devolução de Cheque Próprio pela Primeira Vez
DevolucaoDeChequeProprioPrimeiraVez
Rotina do módulo Financeiro, dentro do grupo “Caixa”, que registra a devolução de um cheque próprio (emitido pela empresa) que ainda não sofreu nenhuma devolução anterior — por isso “1ª vez”.
Visão Geral
Rotina do módulo Financeiro, dentro do grupo “Caixa”, que registra a devolução de um cheque próprio (emitido pela empresa) que ainda não sofreu nenhuma devolução anterior — por isso “1ª vez”. Ao confirmar a devolução, o sistema baixa o cheque como devolvido, gera a movimentação financeira correspondente e realiza a integração/lançamento contábil da operação, além de permitir a impressão do comprovante de caixa.
Endpoints
POST /DevolucaoDeChequeProprioPrimeiraVez/Salvar
Confirma a devolução de um ou mais cheques próprios selecionados na tela, gerando a movimentação financeira e o respectivo lançamento contábil.
Permissão: “DevolucaoDeChequeProprioPrimeiraVez/Salvar” (ID 1924)
Parâmetros:
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| dto | DTOCabecalhoDeOperacoes | Sim | Cabeçalho da operação de devolução. O campo relevante para esta ação é “TitulosAProcessar” (lista de “DTODeTituloAProcessar”), que contém os cheques próprios selecionados para devolução, além de dados gerais como filial, carteira de pagamento e fato contábil |
“` POST /DevolucaoDeChequeProprioPrimeiraVez/Salvar
Content-Type: application/json
{ “IDDaFilial”: 1, “IDDaCarteiraDePagamento”: 12, “IDDoFatoContabil”: 45, “TitulosAProcessar”: [ { “ID”: 9001, “Valor”: 1500.00, “ValorMoeda”: 1500.00 } ] } “`
“`json { “success”: true, “listaDeOperacoesFinanceiras”: [ /* movimentações financeiras geradas */ ], “listaDeOperacoesContabeis”: [ /* lançamentos contábeis gerados */ ] } “`
POST /DevolucaoDeChequeProprioPrimeiraVez/Imprimir
Gera (ou reutiliza, se já existir) o modelo de relatório de comprovante de caixa (“ComprovanteCaixa.rpt”) na pasta de documentos do cliente, disponibilizando-o para impressão. Não executa nenhuma regra de negócio sobre o cheque em si — apenas prepara o arquivo do relatório.
Permissão: “DevolucaoDeChequeProprioPrimeiraVez/Imprimir” (ID 1925)
Parâmetros: nenhum.
“` POST /DevolucaoDeChequeProprioPrimeiraVez/Imprimir “`
“`json { “success”: true } “`
Modelos de Dados
DTOCabecalhoDeOperacoes (parâmetro de Salvar)
| Campo | Tipo | Descrição |
|---|---|---|
| TitulosAProcessar | Lista de DTODeTituloAProcessar | Cheques próprios selecionados para devolução nesta operação |
| IDDaFilial | Numérico | Filial em que a operação é realizada |
| IdRotina | Numérico | Identificador da rotina de origem da operação |
| DataDeLancamento | Data | Data de lançamento da operação |
| IDDoFatoContabil | Numérico | Fato contábil configurado para a operação “Devolução Cheque Próprio” — obrigatório para gerar o lançamento contábil |
| IDDaCarteiraDePagamento | Numérico | Carteira usada para processar a devolução — obrigatória |
| ValorDinheiro / ValorCheques / ValorChequesProprios | Numérico | Totais por forma de pagamento envolvidos na operação |
| ChequesDeTerceiros, ChequesProprios, TitulosACompensar, MovimentacoesFinanceiras | Listas | Demais coleções do cabeçalho de operações, não utilizadas diretamente por esta rotina |
DTODeTituloAProcessar (item de TitulosAProcessar)
| Campo | Tipo | Descrição |
|---|---|---|
| ID | Numérico | Identificador do cheque próprio a devolver |
| Valor | Numérico | Valor de face do cheque |
| ValorMoeda | Numérico | Valor do cheque convertido para a moeda padrão utilizada na operação |
| IDDoFatoContabil | Numérico | Fato contábil específico do título, quando informado no lugar do fato contábil geral |
| IDDaCarteiraDePagamento | Numérico | Carteira específica do título, quando informada no lugar da carteira geral |
| IDDaCarteira | Numérico | Carteira de origem do cheque |
| IDDaFilial | Numérico | Filial associada ao título |
| Juros, Desconto, Tarifa, Multa, Acrescimo, Saldo, Liquido | Numérico | Componentes financeiros do título |
| DataEmissao | Data | Data de emissão do cheque |
| TituloCompleto | Texto (calculado) | Identificação completa do título para exibição |
Regras de Negócio
- Título obrigatório para salvar. Se nenhum cheque for informado em “TitulosAProcessar”, a operação não é executada.Mensagem exibida: “Não foi possível Salvar. Os dados informados podem estar incorretos. Verifique se os dados informados estão corretos.”
- Carteira de pagamento obrigatória. A devolução exige uma carteira de pagamento configurada; se não for encontrada, a operação é interrompida.Mensagem exibida: “Não foi possível devolver cheques próprios. Carteira não encontrada. Configure uma carteira para operação.”
- Fato contábil obrigatório. Sem um fato contábil configurado para a operação “Devolução Cheque Próprio” (por filial/variação), o lançamento contábil não pode ser gerado.Mensagem exibida: “Não foi possível realizar operação. É obrigatório informar um fato contábil para a operação: DEVOLUÇÃO CHEQUE PRÓPRIO / Variação: {0}. Informe um fato contábil para a operação DEVOLUÇÃO CHEQUE PRÓPRIO.”
(o placeholder {0} identifica a variação/filial da operação sem fato contábil configurado)
- Carteira de cheques devolvidos por filial. Além da carteira de pagamento geral, o sistema pode exigir uma carteira específica para receber cheques devolvidos, configurada por filial.Mensagem exibida: “Não foi possível devolver cheques próprios. Carteira não encontrada. Por favor configure a carteira de cheques devolvidos na filial: {0}.”
(o placeholder {0} identifica a filial sem essa configuração)
- Cheque não encontrado. Se o cheque informado não for localizado na base, a operação é bloqueada.Mensagem exibida: “Não foi possível realizar operação. Cheque não encontrado: {0}. Verifique e informe o cheque corretamente.”
(o placeholder {0} identifica o cheque não localizado)
- Tipo de documento do cheque inválido/não configurado. Existe um parâmetro do financeiro que define o tipo de documento usado ao registrar cheques; se ele estiver ausente ou mal configurado, a devolução não é concluída.Mensagem exibida: “Não foi possível realizar a operação. O tipo do documento para cheque está inválido. Favor configurar o parâmetro {0} na lista de parâmetros do financeiro para a inclusão do novo cheque.”
(variação: “Não foi encontrado nenhum tipo de documento para cheque cadastrado com o código {0}, verifique a configuração do parâmetro {1}”)
- Transação atômica com integração contábil. Toda a operação (baixa do cheque, geração da movimentação financeira e lançamento contábil) roda dentro de uma única transação de banco de dados: se qualquer etapa falhar, nada é gravado.Mensagem exibida (falha genérica na operação): “{0}. Falha na operação. Verifique os dados e tente novamente.”
(o placeholder {0} traz o detalhe técnico do erro ocorrido)
- Impressão não altera dados financeiros. A ação “Imprimir” apenas prepara o arquivo do relatório de comprovante de caixa (copiando o modelo padrão para a pasta do cliente, se ainda não existir) — não consulta nem altera o cheque devolvido.
Permissões
Acesso à rotina: “EditViewDeDevolucaoProprioPrimeiraVez” (ID 1596) — recurso filho de “Caixa” (ID 1589)
| Ação | Permissão | ID |
|---|---|---|
| Salvar | “DevolucaoDeChequeProprioPrimeiraVez/Salvar” | 1924 |
| Imprimir | “DevolucaoDeChequeProprioPrimeiraVez/Imprimir” | 1925 |