Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Boleto Bancário - Criar Objeto Beneficiário

Cria um objeto do tipo Beneficiário.

Parâmetro 1

Mapa de Parâmetros:

  • Agencia

  • AgenciaDigito

  • CodigoBeneficiario

  • CodigoTransmissao

  • Conta

  • ContaDigito

  • Documento

  • Modalidade

  • Numero

  • Logradouro

  • Complemento

  • Cep

  • Bairro

  • Cidade

  • Uf

  • Cip

  • Nome

  • TipoCobranca

  • TipoPessoa

  • RespEmis

  • Convenio - Obrigatório para Banco do Brasil

Observações

Valores válidos para a chave TipoPessoa

  • FISICA
  • JURIDICA

Valores válidos para a chave TipoCobranca:

  • BANCO_DO_BRASIL
  • BANCO_DO_BRASIL_SICOOB
  • BANCO_DA_AMAZONIA
  • BANCO_DO_NORDESTE
  • BANESTES
  • SANTANDER
  • BANRISUL
  • BRB
  • UNICRED_RS
  • BANCO_CECRED
  • UNIPRIME
  • CAIXA_ECONOMICA
  • CAIXA_ECONOMICA_SICOB
  • BRADESCO
  • ITAU
  • BANCO_MERCANTIL
  • SICRED
  • BANCOOB
  • HSBC
  • BIC_BANCO
  • BRADESCO_SICOOB
  • BANCO_SAFRA
  • BRADESCO_SAFRA

Retorno

Objeto do tipo Beneficiário

Boleto Bancário - Criar Objeto Boleto

Cria um objeto do tipo Boleto.

Parâmetro 1

Mapa de Parâmetros:

  • Aceite

  • Carteira

  • DataAbatimento

  • DataDocumento

  • DataDesconto

  • DataEmissao

  • DataMulta

  • DataProcessamento

  • DataProtesto

  • DataVencimento

  • DataMoraJuros
  • EspecieDocumento

  • NossoNumero

  • Ocorrencia

  • Pagador - Usar a função Criar Objeto Pagador

  • PercentualMulta

  • PrimeiraInstrucao

  • SegundaInstrucao

  • Instrucoes

  • SeuNumero

  • NumeroDocumento

  • Valor

  • ValorAbatimento

  • ValorDesconto

  • ValorIOF

  • ValorMoraJuros

  • EspecieMoeda

  • ValorMoeda

  • ValorOutrosAcrescimos

  • ValorCobrado)

  • Mensagem (lista de mensagens, cada elemento da lista é uma texto do tipo letras)

  • TipoDesconto

  • DiasProtesto

Observações

Valores válidos para a chave ESPECIE_DOCUMENTO:

  • DUPLICATA_MERCANTIL
  • DUPLICATA_SERVICO
  • NOTA_PROMISSORIA
  • RECIBO
  • LETRA_DE_CAMBIO
  • NOTA_DE_SEGURO

Valores válidos para a chave OCORRENCIA:

  • REGISTRAR
  • BAIXAR
  • DEBITAR_EM_CONTA
  • CONCEDER_ABATIMENTO
  • CANCELAR_ABATIMENTO
  • CANCELAMENTO_ABATIMENTO (Itaú)
  • CONCEDER_DESCONTO
  • ALTERACAO_VENCIMENTO (Itaú)
  • CANCELAR_DESCONTO
  • ALETARACAO_USO_EMPRESA (Itaú)
  • ALTERAR_VENCIMENTO
  • ALTERACAO_SEU_NUMERO
  • ALTERAR_VENCIMENTO_SUSTAR_PROTESTO
  • PROTESTAR_ITAU
  • PROTESTAR
  • SUSTAR_PROTESTO
  • PROTESTO_PARA_FINS_ALIMENTARES
  • CANCELAR_INSTRUCAO_PROTESTO_BAIXA
  • CANCELAR_INSTRUCAO_PROTESTO
  • DISPENSAR_JUROS
  • ALTERAR_NOME_ENDERECO_SACADO
  • ALTERAR_NUMERO_CONTROLE
  • OUTRAS_OCORRENCIAS
  • ALTERAR_CONTROLE_PARTICIPANTE
  • SUSTAR_PROTESTO_ITAU
  • ALTERAR_SEU_NUMERO
  • TRANSFERENCIA_CESSAO_CREDITO
  • TRANSF_CESSAO_CREDITO_ID_PROD10
  • TRANSFERENCIA_CARTEIRA
  • DEV_TRANSFERENCIA_CARTEIRA
  • DESAGENDAR_DEBITO_AUTOMATICO
  • ACERTAR_RATEIO_CREDITO
  • CANCELAR_RATEIOCREDITO
  • ALTERAR_USOEMPRESA
  • NAO_PROTESTAR
  • PROTESTO_FINS_FALIMENTARES
  • BAIXA_POR_PAGTO_DIRETO_CEDENTE
  • CANCELAR_INSTRUCAO
  • EXCLUSAO_DE_SACADOR_AVALISTA
  • ALTERACAO_OUTROS_DADOS
  • ALTERAR_VENC_SUSTAR_PROTESTO
  • CEDENTE_DISCORDA_SACADO
  • CEDENTE_SOLICITA_DISPENSA_JUROS
  • BAIXA_POR_TER_PAGO_DIRETAMENTE_AO_BENEFICIARIO
  • OUTRAS_ALTERACOES
  • ALTERAR_MODALIDADE
  • CANCELAMENTO_INSTRUCAO
  • ALTERAR_EXCLUSIVO_CLIENTE
  • NAO_COBRAR_JUROS_MORA
  • ALTERACAO_DO_VENCIMENTO_SUSTAR_PROTESTO
  • COBRAR_JUROS_MORA
  • BENEFICIARIO_NAO_CONCORDA_COM_ALEGACAO_PAGADOR
  • ALTERAR_VALOR_TITULO
  • EXCLUIR_SACADOR_AVALISTA
  • ALTERAR_NUMERO_DE_DIAS_PARA_PROTESTO
  • BENEFICIARIO_SOLICITA_DISPENSA_JUROS
  • ALTERACAO_DADOS_EXTRAS
  • ENTRADA_EM_NEGATIVACAO_EXPRESSA
  • NAO_NGATIVAR
  • EXCLUIR_NEGATIVACAO_EXPRESSA
  • CANCELAR_NEGATIVACAO_EXPRESSA
  • DESCONTAR_TíTULOS_ENCAMINHADOS_DIA

Valores válidos para a chave TipoDesconto:

  • NAO_CONCEDER_DESCONTO
  • VALOR_FIXO_ATE_DATA_INFORMADA
  • PERCENTUAL_ATE_DATA_INFORMADA
  • VALOR_ANTECIPADO_DIA_CORRIDO
  • VALOR_ANTECIPADO_DIA_UTIL
  • PERCENTUAL_SOBRE_VALOR_NOMINAL_DIA_CORRIDO
  • PERCENTUAL_SOBRE_VALOR_NOMINAL_DIA_UTIL
  • CANCELAMENTO_DESCONTO

Retorno

Objeto Boleto

Boleto Bancário - Criar Objeto Pagador

Cria um objeto do tipo Pagador.

Parâmetro 1

Mapa de Parâmetros:

  • Avalista

  • Bairro

  • Cep

  • Cidade

  • Documento

  • Logradouro

  • Nome

  • Numero

  • TipoPessoa

  • Uf

Observações

Valores válidos para a chave TIPO_PESSOA

  • FISICA
  • JURIDICA

Retorno

Objeto Pagador

Boleto Bancário - HTML

Gera um arquivo HTML com os boletos. A função não possui retorno.

Parâmetro 1

Mapa de Parâmetros:

  • Arquivo

  • Beneficiario - Usar a função Criar Objeto Beneficiário

  • Boletos  - Usar a função Criar Objeto Boleto

  • ChaveApi

  • Layout

  • Depurar - Permite desativar a exclusão automática dos arquivos temporários para geração do boleto.

Observações

Valores válidos para a chave LAYOUT 

  • CARNE
  • FATURA
  • FATURA_ENTREGA

Valores válidos para chave Modelo

  • BOLETO_UNICO_CORREIOS
  • BOLETO_UNICO_FICHA_COMPENSACAO_RECIBO_PAGADOR
  • BOLETO_UNICO_FICHA_COMPENSACAO
  • BOLETO_DUPLO_RECIDO_PAGADOR
  • BOLETO_DUPLO_SEM_RECIBO_PAGADOR
  • BOLETO_TRIPLO_RECIBO_PAGADOR_LATERAL
  • BOLETO_TRIPLO_SIMPLES
  • BOLETO_NORMAL

Boleto Bancário - IMPRIMIR

Gera um arquivo HTML com os boletos. A função não possui retorno.

Parâmetro 1

Mapa de Parâmetros:

  • Beneficiario - Usar a função Criar Objeto Beneficiário

  • Boletos  - Usar a função Criar Objeto Boleto

  • ChaveApi

  • Layout

  • Depurar - Permite desativar a exclusão automática dos arquivos temporários para geração do boleto.

Observações

Valores válidos para a chave LAYOUT 

  • CARNE
  • FATURA
  • FATURA_ENTREGA

Boleto Bancário - PDF

Gera um arquivo PDF com os boletos. A função não possui retorno.

Parâmetro 1

Mapa de Parâmetros:

  • Arquivo

  • Beneficiario - Usar a função Criar Objeto Beneficiário

  • Boletos  - Usar a função Criar Objeto Boleto

  • ChaveApi

  • Layout

  • Depurar - Permite desativar a exclusão automática dos arquivos temporários para geração do boleto.

  • Modelo - Modelo do boleto a ser gerado.

Observações

Valores válidos para a chave LAYOUT 

  • CARNE
  • FATURA
  • FATURA_ENTREGA

Valores válidos para chave Modelo

  • BOLETO_UNICO_CORREIOS
  • BOLETO_UNICO_FICHA_COMPENSACAO_RECIBO_PAGADOR
  • BOLETO_UNICO_FICHA_COMPENSACAO
  • BOLETO_DUPLO_RECIDO_PAGADOR
  • BOLETO_DUPLO_SEM_RECIBO_PAGADOR
  • BOLETO_TRIPLO_RECIBO_PAGADOR_LATERAL
  • BOLETO_TRIPLO_SIMPLES
  • BOLETO_NORMAL

Boleto Bancário - Remessa

Gera um arquivo PDF com os boletos. A função não possui retorno.

Parâmetro 1

Mapa de Parâmetros:

  • Arquivo

  • Beneficiario - Usar a função Criar Objeto Beneficiário

  • Boletos  - Usar a função Criar Objeto Boleto

  • ChaveApi

  • Numero

  • Layout
  • Depurar - Permite desativar a exclusão automática dos arquivos temporários para geração do boleto.

Observações

Valores válidos para a chave LAYOUT 

  • CNAB_240

  • CNAB_400

Boleto bancário - Gerar Arquivo Remessa - CECRED

Gera um arquivo remessa para o banco Cecred (Função de compatibilização)

Parametro 1: 
Lista contendo os Boletos

Parametro 2: 
Caminho onde o arquivo remessa será salvo

Parâmetro 3:
Chave da Api (Letras)

Boleto Bancário - Gerar Boleto Bancário (Antiga)

Gera um boleto bancário para diferentes bancos em PDF (Função de compatibilização com a API 3.0)
Parametro 1:
Código do banco: 

  • 001 - Banco do Brasil, 
  • 003 - Banco do Amazonia, 
  • 004 - Banco do Nordeste,
  • 237 - Bradesco, 
  • 356 - Banco Real, 
  • 021 - Banestes, 
  • 041 - Banrisul,
  • 070 - BRB, 
  • 091-4 - Unicred do Rio Grande do Sul,
  • 104 - Caixa Econômica,
  • 399 - HSBC, 
  • 341 - Itaú, 
  • 033 - Santander, 
  • 085-x - Banco Cecred, 
  • 422 - Banco Safra, 
  • 748 - Sicred,
  • 389 - Banco Mercantil, 
  • 756 - Bancoob

Parâmetro 2:
Mapeamento ou lista de mapeamentos com os seguintes itens: 

  • ARQUIVO_BOLETO - Nome do arquivo PDF que deve ser gerado, deixe em branco para que o sistema gere um nome automaticamente
  • CEDENTE_NOME - Nome do cedente (emissor) [OBRIGATÓRIO];
  • CEDENTE_FONE - Telefone do cedente
  • CEDENTE_EMAIL - Email do cendente
  • CEDENTE_LOGRADOURO - Endereço do cendente [OBRIGATÓRIO];
  • CEDENTE_BAIRRO
  • CEDENTE_MUNICIPIO
  • CEDENTE_UF
  • CEDENTE_CEP
  • CEDENTE_DOC - CNPJ ou CPF do cedente [OBRIGATÓRIO];
  • CEDENTE_LOGO - Logomarca do cedente em formato JPEG.
  • DESCRICOES - Texto que irá ser impresso no topo da página descrevendo o boleto
  • CARTEIRA - Código da certeira de cobrança no banco
  • AGENCIA - Número da agência, sem o dígito
  • AGENCIA_DV - Digito veriricador da agência
  • CONTA_CORRENTE - Número da conta corrente sem o dígito
  • CONTA_CORRENTE_DV - Digito veriricador da conta corrente
  • DATA_DOCUMENTO - Data do documento
  • DATA_PROCESSAMENTO - Data do processamento
  • DATA_VENCIMENTO - Data de vencimento
  • INSTRUCOES - Instruções de recebimento impressas no corpo do boleto, até 5 linhas
  • INSTRUCAO1..INSTRUCAO5 - Linha individual da instrução
  • NOSSO_NUMERO - Nosso número (identificador único do boleto)
  • NOSSO_NUMERO_DV - Dígito verificador do Nosso número (opcional na maioria dos bancos)
  • NUMERO_DOCUMENTO
  • VALOR_BOLETO
  • ACRESCIMO
  • LOCAL_PAGAMENTO
  • LOCAL_PAGAMENTO2
  • VALOR_MOEDA
  • ESPECIE_DOCUMENTO
  • MOEDA
  • ACEITE
  • NUMERO_CONVENIO
  • CODIGO_OPERACAO
  • CODIGO_FORNECIDO_AGENCIA
  • CODIGO_FORNECIDO_AGENCIA_DV
  • SACADO_NOME
  • SACADO_ENDERECO
  • SACADO_BAIRRO
  • SACADO_CIDADE
  • SACADO_UF
  • SACADO_CEP
  • SACADO_CPF
  • COD_CLIENTE - Santander
  • IOS
  • MODALIDADE - BRB
  • CHAVE_API - Chave de licenciamento

Retorno:
Mapa com os seguintes itens:

  • ARQUIVO_BOLETO - Nome do arquivo PDF gerado no servidor.
  • CODIGO_BARRA

Observações

Valores válidos para a chave LAYOUT 

  • CNAB_240

  • CNAB_400

Boleto Bancário - Gerar Boleto Bancário (Dinamico)

Gera um boleto bancário para diferentes bancos em PDF (Função de compatibilização com a API 3.0)
Parametro 1:
Código do banco: 

  • 001 - Banco do Brasil, 
  • 003 - Banco do Amazonia, 
  • 004 - Banco do Nordeste,
  • 237 - Bradesco, 
  • 356 - Banco Real, 
  • 021 - Banestes, 
  • 041 - Banrisul,
  • 070 - BRB, 
  • 091-4 - Unicred do Rio Grande do Sul,
  • 104 - Caixa Econômica,
  • 399 - HSBC, 
  • 341 - Itaú, 
  • 033 - Santander, 
  • 085-x - Banco Cecred, 
  • 422 - Banco Safra, 
  • 748 - Sicred,
  • 389 - Banco Mercantil, 
  • 756 - Bancoob

Parâmetro 2:

Carteira

Parâmetro 3:

Mapeamento ou lista de mapeamentos com os seguintes itens: 

  • ARQUIVO_BOLETO - Nome do arquivo PDF que deve ser gerado, deixe em branco para que o sistema gere um nome automaticamente
  • CEDENTE_NOME - Nome do cedente (emissor) [OBRIGATÓRIO];
  • CEDENTE_FONE - Telefone do cedente
  • CEDENTE_EMAIL - Email do cendente
  • CEDENTE_LOGRADOURO - Endereço do cendente [OBRIGATÓRIO];
  • CEDENTE_BAIRRO
  • CEDENTE_MUNICIPIO
  • CEDENTE_UF
  • CEDENTE_CEP
  • CEDENTE_DOC - CNPJ ou CPF do cedente [OBRIGATÓRIO];
  • CEDENTE_LOGO - Logomarca do cedente em formato JPEG.
  • DESCRICOES - Texto que irá ser impresso no topo da página descrevendo o boleto
  • CARTEIRA - Código da certeira de cobrança no banco
  • AGENCIA - Número da agência, sem o dígito
  • AGENCIA_DV - Digito veriricador da agência
  • CONTA_CORRENTE - Número da conta corrente sem o dígito
  • CONTA_CORRENTE_DV - Digito veriricador da conta corrente
  • DATA_DOCUMENTO - Data do documento
  • DATA_PROCESSAMENTO - Data do processamento
  • DATA_VENCIMENTO - Data de vencimento
  • INSTRUCOES - Instruções de recebimento impressas no corpo do boleto, até 5 linhas
  • INSTRUCAO1..INSTRUCAO5 - Linha individual da instrução
  • NOSSO_NUMERO - Nosso número (identificador único do boleto)
  • NOSSO_NUMERO_DV - Dígito verificador do Nosso número (opcional na maioria dos bancos)
  • NUMERO_DOCUMENTO
  • VALOR_BOLETO
  • ACRESCIMO
  • LOCAL_PAGAMENTO
  • LOCAL_PAGAMENTO2
  • VALOR_MOEDA
  • ESPECIE_DOCUMENTO
  • MOEDA
  • ACEITE
  • NUMERO_CONVENIO
  • CODIGO_OPERACAO
  • CODIGO_FORNECIDO_AGENCIA
  • CODIGO_FORNECIDO_AGENCIA_DV
  • SACADO_NOME
  • SACADO_ENDERECO
  • SACADO_BAIRRO
  • SACADO_CIDADE
  • SACADO_UF
  • SACADO_CEP
  • SACADO_CPF
  • COD_CLIENTE - Santander
  • IOS
  • MODALIDADE - BRB

Parâmetro 4:

  • Modelo de Impressão

Parâmetro 5:

  • CHAVE_API - Chave de licenciamento

Retorno:
Mapa com os seguintes itens:

  • ARQUIVO_BOLETO - Nome do arquivo PDF gerado no servidor.
  • CODIGO_BARRA

Observações

Valores válidos para a chave LAYOUT 

  • CNAB_240

  • CNAB_400

Boleto Bancário - Retorno

Gera um arquivo PDF com os boletos. A função não possui retorno.

Parâmetro 1

Mapa de Parâmetros:

  • Arquivo

  • Beneficiario - Usar a função Criar Objeto Beneficiário

  • ChaveApi

  • Layout
  • Depurar - Permite desativar a exclusão automática dos arquivos temporários para geração do boleto.

Observações

Valores válidos para a chave LAYOUT 

  • CNAB_240

  • CNAB_400