Configurações da Biblioteca
Configurações da Biblioteca
Neste tópico você vai encontrar todas as chaves possíveis da biblioteca e também uma explicação para cada chave, algumas configurações você vai encontrar no tópico: Configurações da Biblioteca (Geral) e Configurações DFe. Para BoletoWeb é necessário realizar as Configurações SSLHttpLib em [DFe].
Obs.: Para Integração Bancária por WebService ou API, consulte o tópico abaixo para saber os bancos com essa disponibilidade e as configurações específicas para integração WEB.
https://www.projetoacbr.com.br/forum/topic/57991-acbrboleto-via-webservice/
[BoletoBancoConfig] |
|||||
CHAVE |
DESCRIÇÃO |
||||
TipoCobranca |
Define qual o Banco será utilizado seguindo os códigos abaixo (É necessário a definição do Banco antes de utilizar qualquer método do componente Boleto):
|
||||
Numero |
O Código utilizado pelo Banco (Caso não informado será preenchido automaticamente pelo componente, baseado nas configurações da classe do banco selecionado em "TipoCobrança". |
||||
NumeroCorrespondente |
O Código do Correspondente Bancário utilizado pelo Banco. (Utilizado apenas por algumas Cooperativas de Crédito). |
||||
LayoutVersaoArquivo |
O Número da Versão do Layout do arquivo de Remessa (Não preencher se não necessário). |
||||
LayoutVersaoLote |
O Número da Versão do Lote do arquivo de Remessa (Não preencher se não necessário). |
||||
LocalPagamento |
Define o local de pagamento a ser impresso no boleto desse banco. |
||||
OrientacaoBanco |
Define uma String com as orientações do Banco para ser impresso no Boleto. |
||||
Digito |
O Dígito do Banco (Não preencher se não existir). |
||||
CasasDecimaisMoraJuros |
A Quantidade de casa decimais do campo juros/mora. |
||||
CIP |
Código usado por alguns bancos para impressão no boleto. |
[BoletoCedenteConfig] |
|
CHAVE |
DESCRIÇÃO |
Agencia |
Define o Numero da Agência do Cedente. |
AgenciaDigito |
Define o Numero do Dígito da Agência. |
Conta |
Define o Numero da Conta do Cedente. |
ContaDigito |
Define o Numero do Digito da Agência. |
DigitoVerificadorAgenciaConta |
Define o Digito verificador da Agência e Conta (Utilizado apenas por alguns Bancos). |
Convenio |
Define o Número do Convénio (deve ser verificado com o Banco). |
CodigoCedente |
Define o Código do Cedente (deve ser verificado com o Banco). |
CodigoTransmissao |
Define o Código de Transmissão (deve ser verificado com o Banco, quando existir). |
Modalidade |
Define o Código da Modalidade (deve ser verificado com o Banco, quando existir). |
ResponEmissao |
Define o Responsável pela emissão do boleto, conforme Códigos abaixo: 0 - Cliente Emite 1 - Banco Emite 2 - Banco Reemite 3 - Banco não Reemite |
TipoCarteira |
Define o Responsável pela emissão do boleto, conforme Códigos abaixo: 0 - Carteira Simples 1 - Carteira Registrada 2 - Carteira Eletrônica |
TipoDocumento |
Define o Tipo de Documento, conforme Códigos abaixo: 0 - Documento Tradicional 1 - Documento Escritural |
TipoInscricao |
Define o Tipo de Inscrição, conforme Códigos abaixo: 0 - Pessoa Física 1 - Pessoa Jurídica 2 - Outros |
CaracTitulo |
Define Características de Cobrança do Título, conforme Códigos abaixo: 0 - Cobrança Simples 1 - Cobrança Vinculada 2 - Cobrança Caucionada 3 - Cobrança Descontada 4 - Cobrança Vendor 5 - Cobrança Simples (Rápida com Registo) 6 - Cobrança Caucionada (Rápida com Registro) |
CodigoNegativacao |
Define o Código de Negativação, conforme Códigos abaixo: |
CNPJCPF |
O Número do CNPJ ou CPF do Cedente. |
Nome |
O Nome do Cedente. |
Logradouro |
O Endereço do Cedente. |
NumeroRes |
O Número Residencial do Cedente. |
Complemento |
O Complemento de Endereço do Cedente. |
Bairro |
O Bairro do Cedente. |
Cidade |
A Cidade do Cedente. |
CEP |
O CEP do Cedente. |
UF |
A UF do Cedente. |
Telefone |
O telefone do Cedente. |
IdentDistribuicao |
Utilizado por alguns bancos para definir quem distribui o boleto: 0 - tbBancoDistribui 1 - tbClienteDistribui |
Operacao |
Utilizado por alguns bancos para definir dados adicionais. |
ChavePIX |
Informe chave pix. |
TipoChavePIX |
Define o tipo de chave pix abaixo: 3 - CNPJ 4 - Celular |
[BoletoDiretorioConfig] |
|
CHAVE |
DESCRIÇÃO |
LayoutRemessa |
Define o Modelo do CNAB para geração da Remessa, conforme códigos abaixo:
1 - CNAB400 |
DirArqRemessa |
Define o Diretório para geração do arquivo de remessa. |
DirArqRetorno |
Define o Diretório para leitura do arquivo de retorno. |
NomeArqRemessa |
Define o Nome do Arquivo de Remessa a ser gerado pelo componente Boleto. |
NomeArqRetorno |
Define o Nome do Arquivo de Retorno a ser lido pelo componente Boleto. |
NumeroArquivo |
Define o numero sequencial do Arquivo Remessa a ser gerado. (Também pode ser parametrizado via comando). |
DataArquivo |
Data de geração do Arquivo de Remessa. (Não preencher se não utilizado). |
DataCreditoLanc |
Data de Créditos de Lançamento do Arquivo de Retorno. (Não preencher se não utilizado). |
ImprimirMensagemPadrao |
Define a Impressão ou não de Mensagens Padrão no Boleto: 0 - Não 1 - Sim |
LeCedenteRetorno |
Define se Lê os dados do Cedente para validar o Arquivo de Retorno. |
RemoveAcentosArqRemessa |
Define se deve ou não remover os acentos no arquivo de remessa: 0 - Não 1 - Sim |
PrefixArqRemessa |
Define um prefixo para o nome do arquivo de remessa (exclusivo Banco Daycoval). |
[BoletoBancoFCFortesConfig] |
|
CHAVE |
DESCRIÇÃO |
NomeArquivo |
Define o Nome do Arquivo para geração do Boleto em PDF (Informar o Path Completo ex: c:\temp\BoletoPDF.pdf). |
DirLogo |
Define o Diretório onde está localizado os Logotipos dos Bancos. |
Filtro |
Define o Filtro para geração do Boleto conforme Código abaixo: 0 - Nenhum 1 - PDF 2 - HTML 3 - JPG |
Layout |
Define o tipo de Layout para Impressão do Boleto conforme Código abaixo: 0 - Padrão 1 - Carnê 2 - Fatura 3 - Padrão Entrega 4 - Recibo Topo 5 - Padrão Entrega2 6 - FaturaDetalhe 7 - Termica80mm 8 - PadraoPIX |
MostrarPreview |
Define a opção para Mostrar ou não o Preview: 0 - Não 1 - Sim |
MostrarProgresso |
Define a opção para Mostrar Progresso de Impressão: 0 - Não 1 - Sim |
MostrarSetup |
Define a opção para Mostrar Setup de Impressão: 0 - Não 1 - Sim |
NumeroCopias |
Define o Número de Cópias para Impressão. |
PrinterName |
Nome da impressora para impressão. |
SoftwareHouse |
Nome da SoftwareHouse. |
AlterarEscalaPadrao |
Permite alterar a escala padrão para geração da impressão 0 - Não 1 - Sim |
NovaEscala |
Valor da nova escala padrão (default = 96) |
CalcularNomeArquivoPDFIndividual |
Define se o nome do PDF gerado individualmente deve ser calculado utilizando o número do documento, caso contrário usa o nome informado nos parâmetros. 0 - Não 1 - Sim |
MargemInferior |
Define a margem inferior da impressão. |
MargemSuperior |
Define a margem superior da impressão. |
MargemEsquerda |
Define a margem esquerda da impressão. |
MargemDireita |
Define a margem direita da impressão. |
|
|
[BoletoCedenteWS] |
|
CHAVE |
DESCRIÇÃO |
ClientID |
CredencialD fornecida pelo Banco para integração WebService. |
ClientSecret |
Chave Credencial fornecida pelo Banco para integração WebService. |
KeyUser |
Gerada pelo Banco para o cadastro do Cliente. |
Scope |
Scope do Serviço da API ou WebService de Cada Banco. |
IndicadorPix |
Indica se Realiza intergação do Boleto por Pix (Apenas API Banco do Brasil): 0 - Não 1 - Sim |
[BoletoWebSevice] |
|
CHAVE |
DESCRIÇÃO |
PathGravarRegistro |
Define se será gerado o log de cada requisição: |
Ambiente |
Ambiente 0 - Produção 1 - Homologação 2 - SandBox |
Operação |
Tipo de Operação: 0 - Inclusão 1 - Alteração 2 - Baixa 3 - Consulta 4 - ConsultaDetalhada 5 - PIXCriar 6 - PIXCancelar 7 - PIXConsultar 8 - Cancelar 9 - Ticket |
VersaoDF |
Versão do layout Serviço Web (Não informar se não existir). |
UseCertificateHTTP |
Define se utiliza ou não certificado Digital para integração com o Banco (Default todos são 0): 0 - Não 1 - Sim |
SSLType |
Define o tipo de comunicação segura a ser utilizada: 0 = LT_all 1 = LT_SSLv2 2 = LT_SSLv3 3 = LT_TLSv1 4 = LT_TLSv1_1 5 = LT_TLSv1_2 6 = LT_SSHv2 |
Timeout |
Define o tempo em milissegundos de espera por uma resposta do webservice: Padrão = 5000 |
ArquivoCRT |
Caminho do Arquivo CRT (Informar o Path Completo ex: c:\temp\ArquivoCRT.crt). |
ArquivoKEY |
Caminho do Arquivo KEY (Informar o Path Completo ex: c:\temp\ArquivoKEY.key). |
LogNivel |
Define o tipo de log utilizado para monitorar as Requisições Web: 0 - logNenhum 1 - logSimples 2 - logNormal 3 - logCompleto 4 - logParanoico |
PathGravarRegistro |
Define o caminho onde ver ser salvo o arquivo de log das Requisições WEB, exemplo: |
NomeArquivoLog |
Define o nome do arquivo log de sua preferência, exemplo: |
Created with the Personal Edition of HelpNDoc: Full-featured multi-format Help generator