Entidade PLANOS_PAGAMENTOS

PLAPAG.PLANOS_PAGAMENTOS

Descrição

Forma como o pagamento será efetuado ao longo do tempo (número de parcelas, valores e datas de vencimento).

Atributos

AtributoDomínioRegrasDescrição
IDID(18)Rqd PK Id:
Chave de identificação interna
PLANO_PAGAMENTOUPPERRqd UK Plano de pagamento:
Nome dado ao plano de pagamento. Ex: "AV", "30/60/90", etc.
As opções de planos de pagamento disponíveis para um determinado contexto consideram as regras abaixo:
  • Deve estar ativo e válido;
  • Somente são apresentados planos onde o valor do pedido/documento for superior ao valor mínimo do plano (caso informado);
  • Caso o cliente não tenha crédito, não deve apresentar planos que utilizem o limite de crédito;
  • Caso o cliente use apenas planos específicos, então deve apresentar apenas os planos indicados para ele;
  • Caso o cliente tenha um conceito bloqueado, então não apresenta planos que não permitam clientes neste conceito;
  • O plano deve ser para todos os clientes ou selecionado para o cliente;
  • O plano deve ser para todos os estabelecimentos ou selecionado para o estabelecimento em questão.
  • Deve estar marcado no cadastro do estabelecimento para utilizar planos de pagamentos.
  • Planos de pagamentos configurados no Tipos de pedidos (Planos de pagamento do tipo de pedido) caso o campo "Todos planos de pagamento" não esteja selecionado.
  • Se o pedido for vinculado a uma lista de preços que não aceita todos os planos, o plano deve estar selecionado.
ATIVOFLAG(1)Rqd Ativo:
Indica se o plano de pagamento está ativo ou não.

Valor padrão = S
VALIDOFLAG(1)Rqd Válido:
As parcelas são definidas através do número de parcelas, dia de vencimento ou prazos.

O plano ficará válido quando informado número de parcelas ou dia de vencimento ou prazos. Quando informado prazos, a soma dos percentuais deve totalizar 100%.

O plano ficará inválido quando:
  • Não informar número de parcelas, dia de vencimento ou prazos;
  • Definir mais de uma forma de geração das parcelas do plano (por exemplo, informar dia de vencimento e número de parcelas, ou informar número de parcelas e criar prazos).

Valor padrão = N
CONDICOES_PAGAMENTO_IDID(18)FK Forma de pagamento:
Indica a (principal) forma de pagamento do plano.
Exemplos:
  • BOLETO
  • CARTAO CREDITO
  • CARTAO DEBITO
  • CARTEIRA
  • DEPOSITO
  • ESPECIE
Esta informação é utilizada como um agrupador dos planos de pagamento. No final, o que realmente vale são os tipos de títulos registrados nas parcelas do respectivo plano. Cabe ao responsável pela elaboração do plano, a coerência entre uma informação e outra.

Referência para CONDICOES_PAGAMENTOS
TIPO_TITULO_IDID(18)Rqd FK Tipo de título:
Tipo de título gerado para o plano de pagamento.

Referência para TIPOS_TITULOS
NUMERO_PARCELASINTEGERNúmero de parcelas:
Número de parcelas, considerando vencimentos mensalmente em dias iguais. P.ex.: 2 parcelas com vencimento em 30 e 60 dias.
Quando informado, não deve possuir informações de parcelamentos.
DIA_VENCIMENTOINTEGERDia vencimento:
Dia de vencimento fixo para as cobranças mensais com valores permitidos de 1 a 31.
AGREGAR_MESES_VENCIMENTOINTEGERAgregar meses vencimento:
Quantidade de meses que deve ser agregado ao vencimento do título.
Este campo deve ser informado somente quando informado o campo DIA_VENCIMENTO, e caso não informado é utilizado o padrão 0 meses.
PERCENTUAL_JUROSPERCENT(18)Percentual de acréscimos/descontos:
Indica o percentual de acréscimo ou desconto (valor negativo, p.ex.: -5) concedido diretamente nos itens de pedidos ou documentos ou nos títulos resultantes de uma negociação financeira.
Os valores de acréscimos/descontos nos pedidos e/ou documentos não serão apresentados de forma específica (apresentação do valor dos acréscimos ou descontos), pois o percentual será aplicado diretamente sobre o valor unitário dos itens dos pedidos e/ou documentos. P.ex.: Preço unitário de R$ 100,00 em um pedido com um plano de pagamento que possua 5% de desconto apresentará o valor unitário do item com o valor de R$ 95,00.
O valor dos acréscimos/descontos será considerado diretamente sobre o valor total de uma negociação de títulos. P.ex.: Negociação de títulos que totalizam R$ 2.000,00 aplicando um plano de pagamento em duas parcelas com acréscimo de 10% resultará em 2 títulos de R$ 1.100,00 (R$ 2.000,00 + 10% = R$ 2.200,00 / 2 parcelas).

Valor padrão = 0
POSSUI_ENTRADAFLAG(1)Possui entrada:
Indica que a primeira parcela do plano de pagamento será considerado como valor de entrada ou de antecipação.
Deverá ser apresentado o campo para que possa ser informado o valor da entrada nas telas de orçamentos e pedidos onde for selecionado um plano de pagamento que possua indicação de entrada.
DATA_ULTIMA_ATUALIZACAODATE_TIMERqd Última alteração:
Data da última alteração realizada no cadastro do plano de pagamento.
INFORMACAO_NFEOPCAO(1)Rqd Informação para NFe:
Indica a forma de pagamento a ser informada no documento fiscal eletrônico que é enviado ao SEFAZ.

Valores permitidos:
  • 0 - Pagamento à vista
  • 1 - Pagamento à prazo
  • 2 - Outros

Valor padrão = 2
TABELA_DESCONTO_IDID(18)FK Tabela de desconto:
Quando informado, indica que este plano está sujeito a uma Tabelas de descontos.

Referência para TABELA_DESCONTOS
DIAS_VENCIMENTOTEXTDias para vencimento:
Sugestão de dias para vencimento, separados por virgula.
P.ex: 1,5,10,15,20,25

Quando informado, o dia para vencimento terá de ser um destes dias.
LOP_PADRAO_IDID(18)FK LOP padrão:
LOP padrão a ser utilizado nos títulos gerados por este plano de pagamento.
Títulos gerados a partir de documentos seguem a sequência abaixo para definição do LOP dos títulos gerados:
  1. LOP informado no documento (nota fiscal).
  2. LOP padrão informado no cadastro do destinatário do documento (Clientes).
  3. LOP do prazo dentro do plano de pagamento
  4. LOP do plano de pagamento informado no documento.
  5. LOP padrão informado no tipo de título a ser utilizado.
  6. LOP padrão informado no Estabelecimentos do documento.

Referência para LOPS
RECORRENTEFLAG(1)Recorrente:
Define se a operação está relacionada a um pagamento recorrente ou não. É utilizado para separar os planos de pagamentos que podem ser utilizados em processos de faturamento repetitivos, tais como contratos com pagamentos mensais, dos processos de faturamento único, tais como uma venda específica.

Valor padrão = N
PRAZO_CONFIRMACAOINTEGERPrazo para confirmação:
Quando informado, indica que irá existir um prazo (em dias) durante o qual uma das partes (cliente ou estabelecimento) poderá desistir da transação. Durante este prazo, o valor da transação fica retido mas não pode ser liquidado.

Na prática, este atributo é utilizado nas integrações com cartão de crédito. Quando é escolhido um LOP que utiliza integração com cartão de crédito e este atributo não está preenchido a captura do valor é imediatamente realizada. Caso este atributo for informado com um número de dias X, no momento da venda é realizada apenas a autorização e a captura fica agendada para ser realizada X dias depois da venda.
TODOS_CLIENTESFLAG(1)Rqd Todos clientes:
Define se este plano de pagamento é disponível para operações de todos os clientes. Ao desmarcar esta opção, será necessário indicar quais os clientes que utilizarão o plano.
P.ex.:
  • Plano de pagamento A VISTA DINHEIRO é permitido para todos os clientes.
  • Plano de pagamento 7/14/21/28 DD BOLETO somente poderá ser utilizado para clientes específicos.
Atenção
Se no cadastro do cliente estiver marcada a opção "Apenas planos selecionados", então este plano não será disponível mesmo que ele seja marcado "Todos clientes".

Valor padrão = N
TODOS_ESTABELECIMENTOSFLAG(1)Rqd Todos estabelecimentos:
Define se este plano de pagamento é visível para todos os estabelecimentos. Ao desmarcar esta opção, será necessário indicar quais os estabelecimentos que utilizarão o plano.

Valor padrão = S
VALOR_MINIMOVALUE(18)Valor mínimo:
Valor mínimo da operação financeira para utilização do plano de pagamento. Considera o valor total da operação, independentemente do valor resultante das parcelas dos plano de pagamento.
UTILIZA_LIMITE_CREDITOFLAG(1)Rqd Utiliza limite de crédito:
Indica se o plano utiliza ou não o limite de crédito definido para o cliente. Planos que não utilizam crédito do cliente são disponibilizados mesmo para clientes que não tem mais limite ou que estejam bloqueados.

Valor padrão = S
RESTRINGIR_CLIENTES_CONCEITO_BLOQUEADOFLAG(1)Rqd Restringir clientes bloqueados:
Caso marcado, este plano não poderá ser utilizado para clientes que estejam bloqueados ou com um conceito que "Bloqueia venda". Muitas vezes, os planos que não utilizam limite de crédito podem ser utilizados mesmo para clientes bloqueados.

Exemplo: Pagamentos A VISTA EM ESPÉCIE são permitidos mesmo para clientes bloqueados.

É importante lembrar que se utilizado este plano em um pedido que no tipo esteja configurado para permitir clientes bloqueados, esta opção não será validada.

Valor padrão = S
TODAS_LISTAS_PRECOSFLAG(1)Rqd Todas listas de preços:
Define se este plano de pagamento é visível para todas as listas de preços. Ao desmarcar esta opção, será necessário indicar quais as listas de preços que utilizarão o plano.

Valor padrão = S
PRAZO_MEDIODOUBLE(18)Prazo médio:
Prazo médio do parcelamento em dias.
Esse atributo é calculado automaticamente, a partir da informação dos atributos "Dias" e "Percentual" da entidade Prazos planos pagamentos.

Regras

Validar percentuais (insert)

Valida os percentuais na inclusão do plano de pagamento.

ESTE MÉTODO ESTÁ DEPRECIADO!

Passará a ser utilizado o mesmo método que anteriormente validava os percentuais apenas na alteração.

Validar parcelas

(Antes de inserir, Antes de alterar)
Valida as parcelas do plano de pagamento. As parcelas são definidas através do número de parcelas, dia de vencimento ou prazos.

O plano ficará válido quando informado número de parcelas ou dia de vencimento ou prazos. Quando informado prazos, a soma dos percentuais deve totalizar 100%.

O plano ficará inválido quando:

Data última atualização

(Antes de inserir, Antes de alterar)
Data da última atualização do plano de pagamento.

Excluir prazos planos pagamentos

(Antes de excluir)
Ao excluir um plano de pagamento é ignorado os warnings apresentados ao excluir um prazo do plano.

Calcular prazo médio

(Antes de alterar)
Calcula o prazo médio ponderado do parcelamento em dias

Deve ser informado se possui entrada ou não

(Antes de inserir, Antes de alterar)
Quando número de parcelas informado deve ser informado se possui entrada ou não

Validar dia vencimento

(Antes de inserir, Antes de alterar)
Validar o dia vencimento para o plano de pagamento, e também deve ser validado o preenchimento do campo PLAPAG.PLANOS_PAGAMENTOS.AGREGAR_MESES_VENCIMENTO

Popular as opções de plano de pagamento(plano_pagamento, estabelecimento, cliente, popular_id, documento, somente_recorrentes)

As opções de planos de pagamento disponíveis para um determinado contexto consideram as regras abaixo:

Calcular parcelas(valor_total, valor_tributos, data_base, casas_decimais, parcelamento, tipo_titulo)

Retorna uma lista de registros representando o parcelamento calculado para o plano. Cada registro é composto pelos mesmos atributos da entidade Prazos dos planos de pagamentos seguido dos seguintes atributos:

Data do Parcelamento(data_inicial, parcela, fim_semana)

Retornar a data de vencimento de cada parcela

Data de parcelamento com dia fixo(data_inicial)

Retornar a data de vencimento para um título.

Data do Parcelamento(data_inicial, dias, fim_semana)

Retornar a data de vencimento de cada parcela

Parcela mínima(valor_total)

Função deve retornar se o plano de pagamento pode ser utilizado conforme o valor passado por parâmetro.

Número parcelas

Retornar o número de parcelas de um determinado plano de pagamentos.

Retorna Prazo Medio - DEPRECIADO - USAR ATRIBUTO NA ENTIDADE

DEPRECIADO!

EXISTE UM ATRIBUTO QUE UTILIZA A FORMA CORRETA (MEDIA PONDERADA PELO VALOR)


Função retorna o prazo médio para as parcelas.
P.ex: ENT + 28 + 56 = 0 + 28 + 56 = 84 / 3 = 28

Validar percentual

Verifica se a soma dos vencimentos totalizam 100%. Caso negativo, força o plano para inativo!

ESTE MÉTODO ESTÁ DEPRECIADO!