Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Nome Atributo

Tipo do Atributo

Obrigatório

Descrição

id_registro

Número

Sim

Cada registro da view deve ter um número único, para diferenciar cada linha de retorno na view, porém nunca serão usados como filtros.

chave_unica

Texto

Sim

Está chave é a identificação única por beneficiário, é a identificação da Pessoa. Este chave não deve se repetir em nenhuma hipótese, para uma outra Pessoa ou Beneficiário.

id_operadora

Texto

Sim

Retorna com o número da operadora, retornar 001

codigo_contrato

Texto

Sim

Código que identifica de qual contrato esse beneficiário está vinculado.

titulo_codigo

Texto

Sim

Código do título no seu sistema interno, exemplo REE00012345.

titulo_id

Texto

Sim

Se o seu sistema exigir o id do título como chave para localizar o mesmo nos demais métodos, este campo deverá ser considerado obrigatório.

Somente números inteiros (Não podem existir letras, espaços em branco, ou pontos decimais).

data_pagamento

Data

Não

Data de pagamento do débito.

data_vencimento

Data

Sim

Data de vencimento do débito.

cedente_nome

Texto

Sim

Nome do cedente.

valor

Número

Sim

Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99)

imprime_boleto

Texto

Sim

  • S = Sim, permite a geração do boleto.

  • N = Não. Não permite a geração do boleto.

Exemplos a serem considerados:

  1. Se o tipo de cobrança for Débito em Conta e o titulo NÃO estiver vencido, não deve permitir gerar o boleto. Neste caso, envie "N".

  2. Se o tipo de cobrança for Boleto, mas a situação do titulo for PAGO, não deve permitir gerar o boleto. Neste caso, envie "N".

  3. Se o tipo de cobrança for Débito em Conta, a situação for Atrasado e já está vencido a 3 dias, libera para geração do Título. Neste caso, envie "S".

Em resumo, o aplicativo irá permitir a geração do boleto toda vez que este campo vier com "S".

Apenas maiúsculos.

situacao

Texto

Sim

Formato:

  • P = A Vencer (em aberto porém ainda não está vencido).

  • A = Atrasado (em aberto, porém já vencido).

  • B = Baixado (já foi pago).

Apenas maiúsculos.

tipo_cobranca

Texto

Sim

Formato:

  • C = Consignação / desconto em folha.

  • B = Boleto.

  • D = Débito em conta.

Apenas maiúsculos.

observacao

Texto

Não

Informe um texto de observação para ser apresentado na tela de detalhes do boleto. Este texto será apresentado abaixo da linha digitavel.

texto_confirmacao

Texto

Não

Para os casos onde é permitido pressionar um botão "gerar boleto", indique uma mensagem de alerta após pressionado este botão.

Só se aplica quando o campo ImprimeBoleto for S(im) .