...
Nome Atributo | Tipo Atributo | Obrigatório | Descrição |
|---|---|---|---|
id_omni_debito | Número | Sim | A ideia desse é ser um atributo do tipo primary key, ou seja, se a implementação for tabela ou wien este atributo deve ser um número único por registro. |
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. |
numero_contrato | Texto | Sim | Número do contrato |
id_titulo | Número | Sim | Id de banco de dados do título no seu sistema interno. 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). |
codigo_titulo | Texto | Sim | Código do título no seu sistema interno, exemplo “MS00579”. Formato: Texto livre. |
data_emissao | Data | Sim | Data de emissão do débito. |
data_vencimento | Data | Sim | Data de vencimento do débito. |
situacao_id | Texto | Sim | 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). |
situacao_descricao | Texto | Sim | “A vencer”, “Atrasado”, “Baixado” |
situacao_cor | Texto | Não | Hexadecimal. com o #. da cor que deseja que seja usada para representar a situação do débito. Ex.: |
tipo_cobranca_id | Texto | Sim | C = Consignação / desconto em folha. B = Boleto. D = Débito em conta. |
tipo_cobranca_descricao | Texto | Sim | Descrição da situação do débito |
tipo_cobranca_cor | Texto | não | Hexadecimal. com o #. da cor que deseja que seja usada para representar o tipo de cobranca do débito. Ex.: Caso não informado o aplicativo utilizará a tabela de cor padrão. |
valor_atual | Número | Sim | Numérico, 2 posições decimais. Indicador decimal = PONTO (9999999.99) |
descricao | Texto | Não | Utilize este campo para adicionar uma descrição do título na lista de boletos. Este campo é ideal para identificar na listagem um título de coparticipação, titulo de mensalidade ou de renegociação. |
fatura_digital | Número | Não | Utilize este campo para informar se o contratante fez adesão à fatura digital para este contrato. Conteúdos aceitos: 0 = Não 1 = Sim |
debito_automatico | Número | Não | Utilize este campo para informar se a forma de pagamento deste contrato é Débito Automático. Conteúdos aceitos: 0 = Não 1 = Sim |
numero_contrato | Texto | Sim | numero do contrato vinculado a este debito. Este código deve ter relação com o código do contrato do Usuário logado. |
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. |
linha_digitavel | Texto | Condicional | Código completo da linha digitável do boleto. |
informacoes | Texto | Não | Utilize este campo para apresentar informações ao pagador. Você pode utilizar este espaço para justificar eventuais alterações de valores por motivo de atraso no pagamento. |
valor_original | Número | Não | Informe o valor original do título antes de sofrer eventuais ajustes de multas por atraso. |
vencimento_original | Data | Não | Informe a data de vencimento original do título antes de sofrer alteração em função de acordos. |
cedente_cnpj | Texto | Condicional | Cnpj do emissor do título. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cedente_nome | Texto | Sim | Nome do cedente. |
cendente_banco | Texto | Condicional | Código do banco do título Exemplo:
|
cedente_agencia | Texto | Condicional | Número (sem o dígito) da Agência Bancária do emissor do título. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cedente_digito_agencia | Texto | Condicional | Dígito da Agência Bancária do emissor do título. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cedente_conta_corrente | Texto | Condicional | Número da Conta Corrente do emissor do título, sem o dígito. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cendente_digito_cc | Texto | Condicional | Dígito da Conta Corrente do emissor do título. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cedente_numero_convenio | Texto | Condicional | Número do convênio bancário utilizado pelo registro do boleto. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cendente_nosso_numero | Texto | Condicional | Preencher com o “Nosso Número”. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cendente_digito_nosso_numero | Texto | Condicional | Preencher com o Dígito do Nosso Número Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
instrucao_boleto | Texto | Condicional | Texto para preencher o espaço de “Instruções” da ficha de compensação do Boleto. |
cendente_logradouro | Texto | Condicional | Informar Rua com número do Cedente Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cendente_bairro | Texto | Condicional | Informar Bairro do Cedente. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cendente_cidade | Texto | Condicional | Informar Cidade do Cedente Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cendente_uf | Texto | Condicional | Informar UF do Cedente. Ex: SP, ES, RJ. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cendente_cep | Texto | Condicional | Informar CEP do Cedente sem pontuação. Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
cendente_aceite | Texto | Condicional | Informar “S”, para aceite do boleto pós vencimento. “N” para não aceitar boleto pós vencimento Obrigatório quando a forma de cobrança for do tipo Boleto, ou seja, tipo_cobranca_id = 'B' |
especie_documento | Texto | Sim | retornar a sigla da especie do documento. |
...