VextaNFe via VextaScript
- Carlos Alberto Longen
- 16 de jul.
- 3 min de leitura
Interface do Componente VextaNFe
VextaNFe.Emitir(ValoresChave)
VextaNFe.Cancelar(ValoresChave, MotivoDoCancelamento, EmailDestinatarios) (EmailDestinatarios pode ser ''/em branco, e o componente usará o e-mail NF-e padrão da pessoa)
VextaNFe.Email(ValoresChave, EmailDestinatarios) (EmailDestinatarios pode ser ''/em branco, e o componente usará o e-mail NF-e padrão da pessoa)
VextaNFe.PDF(ValoresChave)
ValoresChave são informados através de string no formato 'EMPRESA_ID;NOTA_FISCAL_ID|EMPRESA_ID;NOTA_FISCAL_ID|...|EMPRESA_ID;NOTA_FISCAL_ID'. Várias notas fiscais podem ser informadas. Pode-se informar valores chave ao Emitir, e não informar ao disparar Email, ou PDF, e o componente manterá as notas fiscais carregadas inicialmente no comando Emitir.
ValoresChave são informados através de string no formato 'EMPRESA_ID;NOTA_FISCAL_ID|EMPRESA_ID;NOTA_FISCAL_ID|...|EMPRESA_ID;NOTA_FISCAL_ID'. Várias notas fiscais podem ser informadas. Pode-se informar valores chave ao Emitir, e não informar ao disparar Email, ou PDF, e o componente manterá as notas fiscais carregadas inicialmente no comando Emitir.
Complemento da Interface do Componente VextaNFe
VextaNFe.ExibirMensagens (boolean) Determina se as mensagens padrões do sistema devem ser exibidas. Ao definir com false nenhuma mensagem de sucesso é exibida em tela, e apenas Exceções são exibidas, se ocorrerem (e podem ser interceptadas através de try/except)
VextaNFe.EnviarEmail (boolean) Determina se deverá enviar e-mail automaticamente ao emitir uma NF-e/NFC-e, ou ao cancelar
VextaNFe.AbrirArquivo (boolean) Determina se deverá abrir automaticamente o arquivo PDF ao emitir a NF-e/NFC-e
VextaNFe.EmpresaID (int) Definir, de forma manual, qual empresa deve ser usada na manipulação de NF-e
VextaNFe.FilialID (int) Definir, de forma manual, qual filial deve ser usada na manipulação de NF-e. A empresa será definida automaticamente com a empresa "dona" da filial.
VextaNFe.UsuarioID (int) Definir, de forma manual, outro usuário para ser identificado ao enviar e-mail da NF-e ou do cancelamento.
VextaNFe.Reset Método usado para reiniciar o uso do componente VextaNFe durante o script. Este método "anula" EmpresaID, FilialID, UsuarioID e, se não definimos manualmente em seguida, identificará automaticamente ao fazer a primeira operação, sobre a primeira nota fiscal carregada - para emitir, cancelar, imprimir PDF, enviar e-mail ou baixar XML.
VextaNFe.Limpar Limpa a lista de notas fiscais previamente carregadas. As notas são automaticamente limpas da lista quando ValoresChave são informados nos métodos acima
Exemplos de Uso no VextaScript
VextaNFe.Emitir( '1;123456|1;123457' )
Emite as duas notas fiscais informadas. Emitir é uma função que retorna a quantidade de erros ocorridos. Caso tenha 100% de sucesso, o retorno é igual a 0/zero.
Se VextaNFe.ExibirMensagens estiver como true, mensagens de sucesso serão exibidas em tela; caso contrário, nada é exibido em tela (apenas Exceções).
Se VextaNFe.EnviarEmail estiver como true, o e-mail é enviado para o e-mail padrão dos clientes das notas fiscais; Se VextaNFe.ExibirMensagens estiver como true, mensagens de sucesso no envio do e-mail são exibidas em tela; caso contrário, nada é exibido em tela (apenas Exceções).
Se VextaNFe.AbrirArquivo estiver como true, um arquivo PDF com as notas fiscais é aberto automaticamente na sessão; caso contrário, a abertura deverá ser feita manualmente através de VextaNFe.PDF
VextaNFe.Cancelar( '1;123456|1;123457', 'Teste de Cancelamento via Script', '')
Efetua o cancelamento das duas notas fiscais informadas, usando o motivo de cancelamento para as duas notas fiscais, e envia o e-mail do cancelamento para o e-mail padrão dos clientes de cada nota fiscal. Cancelar é uma função que retorna a quantidade de erros ocorridos. Caso tenha 100% de sucesso, o retorno é igual a 0/zero.
Se VextaNFe.ExibirMensagens estiver como true, mensagens de sucesso no cancelamento serão exibidas em tela; caso contrário, nada é exibido em tela (apenas Exceções).
Se VextaNFe.EnviarEmail estiver como true, o e-mail do cancelamento é enviado para o e-mail padrão dos clientes das notas fiscais; Se VextaNFe.ExibirMensagens estiver como true, mensagens de sucesso no envio do e-mail são exibidas em tela; caso contrário, nada é exibido em tela (apenas Exceções).
VextaNFe.Email('1;123456|1;123457', 'teste@vexta.com.br')
Envia o e-mail da emissão, ou do cancelamento se a nota fiscal já está cancelada, das notas fiscais informadas, para o e-mail informado em seguida.
Se VextaNFe.ExibirMensagens estiver como true, mensagens de sucesso no envio do e-mail serão exibidas em tela; caso contrário, nada é exibido em tela (apenas Exceções).
VextaNFe.PDF('1;123456|1;123457')
Gera (se não existente, ou tenha sido eliminado) o PDF das notas fiscais informadas (apenas se emitidas) num único arquivo PDF, e abre o arquivo na sessão
Como o propósito da função é abrir o arquivo ela ignora a propriedade VextaNFe.AbrirArquivo
Exemplo de Script com Emissão e Cancelamento em Seguida
if VextaNFe.Emitir( '506;639890|506;639880' ) = 0 then begin
if VextaNFe.Cancelar( '506;639890|506;639880', 'Teste de Cancelamento', '' ) = 0 then
Self.Atualizar else
Writeln('Erro ao cancelar');
end else
Writeln('Erro ao emitir');
Exemplo de Script com Emissão de NFe de Empresa Própria e Depois de Outra Empresa
VextaNFe.Emitir( '1;123456' );
VextaNFe.Reset;
VextaNFe.Emitir( '5;987654' );
Comentários