Receitas
Receitas
A rotina Receitas pertence ao módulo Financeiro, dentro da funcionalidade de Caixa.
Visão Geral
A rotina Receitas pertence ao módulo Financeiro, dentro da funcionalidade de Caixa. Ela permite lançar o recebimento de um título (uma receita) diretamente no caixa/carteira do usuário, gerando a movimentação financeira e o respectivo lançamento contábil (débito na carteira/caixa e crédito na conta de resultado associada ao histórico padrão informado). A rotina também oferece uma ação auxiliar de impressão de comprovante e uma consulta de configuração usada para pré-carregar a tela.
Endpoints
POST /Receitas/Salvar
Processa e persiste o recebimento (a receita) de um título selecionado pelo usuário, gerando a movimentação financeira e a contabilização correspondente.
Permissão: “Receitas/Salvar” (ID 1856)
Parâmetros:
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| dto | DTOCabecalhoDeOperacoes | Sim | Cabeçalho da operação. Campos relevantes usados por esta ação: `TitulosAProcessar` (lista com o título a processar — apenas o primeiro item da lista é efetivamente processado), `VariacaoDoFatoContabil` (string no formato “algo|N”, onde N é o identificador numérico da variação de rotina contábil), `IdHistoricoPadrao`, `Documento`, `IdCentroDeCusto`, `Observacao` |
| dto.TitulosAProcessar[0] | DTODeTituloAProcessar | Sim | Dados do título a receber: `IDDaCarteiraDePagamento` (carteira/caixa de destino do recebimento), `Valor`, `ValorMoeda`, `DataEmissao`, entre outros |
“` POST /Receitas/Salvar
Content-Type: application/json
{ “TitulosAProcessar”: [ { “IDDaCarteiraDePagamento”: 12, “Valor”: 150.00, “DataEmissao”: “2026-09-10” } ], “VariacaoDoFatoContabil”: “Padrao|1”, “IdHistoricoPadrao”: 45, “Documento”: “NF-1234”, “IdCentroDeCusto”: “10”, “Observacao”: “Recebimento em espécie” } “`
“`json { “success”: true, “listaDeOperacoesFinanceiras”: [ /* movimentações financeiras geradas para a operação */ ], “listaDeOperacoesContabeis”: [ /* lançamentos contábeis gerados a partir da chave da operação */ ] } “`
POST /Receitas/Imprimir
Garante que o modelo (template) do relatório “Comprovante de Movimentação Financeira” exista na pasta específica do cliente, copiando-o da pasta padrão quando necessário, e sinaliza sucesso para o front-end iniciar a impressão do comprovante.
Permissão: “Receitas/Imprimir” (ID 1857)
Parâmetros: nenhum.
“` POST /Receitas/Imprimir “`
“`json { “success”: true } “`
GET /Receitas/ObterCentroDeCustoDefault
Retorna o centro de custo padrão configurado no sistema, e informa se a carteira padrão do usuário é uma carteira em moeda estrangeira (para exibir o símbolo da moeda e a cotação na tela).
Permissão: ação de leitura sem entrada própria — está marcada com `[PermiteAcessoAnonimo]` no código, mas isso não dispensa o acesso à rotina em si: a tela só é alcançada por quem já tem a permissão de acesso “EditViewDeReceitas” (ID 1590).
Parâmetros: nenhum (usa a carteira padrão do usuário logado, lida da configuração de filtros do Financeiro).
“` GET /Receitas/ObterCentroDeCustoDefault “`
“`json { “success”: true, “centroDeCustoDefault”: “10”, “ehMoedaEstrangeira”: false, “simboloMoeda”: “”, “cotacao”: 0 } “`
Modelos de Dados
DTOCabecalhoDeOperacoes (campos usados por esta rotina)
| Campo | Tipo | Descrição |
|---|---|---|
| TitulosAProcessar | Lista de DTODeTituloAProcessar | Título(s) selecionado(s) para receber — apenas o primeiro item da lista é processado por “Salvar” |
| VariacaoDoFatoContabil | string | Identifica a variação da regra contábil aplicada ao lançamento; formato “texto|id”, onde o id é extraído após o caractere “|” |
| IdHistoricoPadrao | int | Histórico contábil padrão a ser usado no lançamento, caso diferente do histórico já associado ao fato contábil |
| Documento | string | Número/identificação do documento associado à operação (ex: nota fiscal, comprovante) |
| IdCentroDeCusto | string | Centro de custo a ser rateado no lançamento contábil gerado |
| Observacao | string | Observação livre registrada junto à movimentação |
DTODeTituloAProcessar (campos relevantes usados por esta rotina)
| Campo | Tipo | Descrição |
|---|---|---|
| IDDaCarteiraDePagamento | int | Carteira/caixa em que o recebimento será lançado (destino do dinheiro) |
| Valor | decimal | Valor do título recebido |
| ValorMoeda | decimal | Valor do título em moeda estrangeira, quando aplicável |
| DataEmissao | DateTime | Data de emissão do título |
Regras de Negócio
- Título obrigatório para salvar. A ação “Salvar” só processa a operação se `TitulosAProcessar` contiver ao menos um item; caso contrário, a operação é rejeitada.Mensagem exibida: “Não foi possível Salvar. Os dados informados podem estar incorretos. Verifique se os dados informados estão corretos.”
- Apenas o primeiro título da lista é processado. Mesmo que `TitulosAProcessar` contenha mais de um item, somente o primeiro (`TitulosAProcessar[0]`) é efetivamente recebido nesta chamada.
- Lançamento contábil automático. Ao salvar, o sistema gera automaticamente a movimentação financeira (débito na carteira/caixa de destino) e o lançamento contábil correspondente (crédito na conta de resultado vinculada ao histórico), integrando a receita à contabilidade sem intervenção manual adicional.
- Recebimento entre filiais diferentes (operação de mútuo). Se a filial do usuário logado (origem) for diferente da filial vinculada à carteira de destino do recebimento, o sistema classifica a operação como “mútuo entre filiais” e gera lançamentos adicionais específicos para representar essa transferência entre filiais, além do lançamento normal da receita.
- Essa operação de mútuo exige que ambas as filiais envolvidas (a do título e a do pagamento) tenham uma “Carteira para Lançamento Mútuo” configurada em seu cadastro. Se a filial do pagamento não tiver essa configuração:Mensagem exibida: “Não foi possível validar Dados. Não é possível executar uma operação financeira mútua sem a carteira mútua. Por favor, realizar parametrização no cadastro da filial, em Dados Relacionados=>Conta Lancto Mútuo.”
- Se for a filial do título que não tiver a configuração, a mensagem exibida é equivalente: “Não foi possível validar Dados. Não é possível executar uma operação financeira mutua sem a carteira mutua. Por favor configure a carteira mutua para a filial da operação.”
- Histórico padrão do lançamento. Se o `IdHistoricoPadrao` informado for diferente do histórico já vinculado ao primeiro lançamento do fato contábil da rotina, o sistema busca e usa o histórico informado; caso contrário, mantém o histórico já associado ao fato contábil.
- Falha inesperada durante o processamento. Qualquer erro não previsto durante a gravação (ex: falha de banco de dados) interrompe a transação e nenhum dado é persistido.Mensagem exibida: “[mensagem técnica do erro]. Falha na operação. Verifique os dados e tente novamente.”
- Comprovante de impressão. Antes de imprimir o comprovante da operação, o sistema garante que exista, na pasta do cliente, uma cópia do modelo padrão do relatório “ComprovanteMovtoFin.rpt” — copiando-a automaticamente da pasta padrão na primeira vez que for necessária.
- Moeda estrangeira na tela. Ao carregar a tela, o sistema verifica se a carteira padrão configurada para o usuário é uma carteira em moeda estrangeira; se for, retorna o símbolo da moeda e a cotação vigente para exibição, além do centro de custo padrão (ID de configuração 29).
Permissões
Acesso à rotina: “EditViewDeReceitas” (ID 1590)
| Ação | Permissão | ID |
|---|---|---|
| Salvar | “Receitas/Salvar” | 1856 |
| Imprimir | “Receitas/Imprimir” | 1857 |
| ObterCentroDeCustoDefault (consulta) | coberta por “EditViewDeReceitas” | — |