CONTEÚDO
- Visão Geral
- Descrição
- Como usar
- Parâmetros
- Retorno
- Outras Informações
01. VISÃO GERAL
Linha de Produto: | Microsiga Protheus® |
Segmento: | Serviços |
Módulo: | SIGAFIS - Livros Fiscais |
Função: | MaFisRet |
Abrangências: | Microsiga Protheus 12 |
Versões: | Microsiga Protheus 12 |
Sistemas Operacionais: | Todos |
Compatível com as Bases de Dados: | Todos |
Nível de Acesso: | Nível 1 (Acesso Clientes) |
Idiomas: | Todos |
02. DESCRIÇÃO
A Função MaFisIniLoad retorna o conteúdo, no caso de valores de impostos por exemplo irá retornar os valores já calculados, da referência fiscal informada no parâmetro cCampo. Ao informar referências “IT_” e “LF_” os valores retornados serão do item informado no parâmetro nItem, array interno aNFItem e referências “NF_” retornarão conteúdos do array interno aNFCab, assim dispensam a passagem do nItem.
Assim podemos considerar que:
- nItem: é o item do documento, caso a informação seja relativa a um item. Caso seja uma informação do cabeçalho não é necessário passar a informação.
- cCampo: É um texto fixo que corresponde a uma informação da nota fiscal.
- aTrbGen: É um array bidimensional que corresponde a valores dos tributos genéricos calculados pelo configurador de tributos.
03. COMO USAR
Utilizada praticamente em todos os tipos de aplicação, serve para obter o valor de impostos calculados pela MATXFIS no momento da chamada da função e/ou qualquer outro conteúdo dos array de cabeçalho e item internos da MATXFIS, pode ser utilizado também para obter valores do livro fiscal, referência fiscal “LF_”, e obter valores como o ‘Valor Contábil” e demais valores que não são próprios do item.
Estão disponíveis diversas referências válidas e para identificá-las realize os seguintes passos:
1 - Sabendo em qual Tabela/Campo o valor será gravado ao final do processamento, é possível encontrar a referência no dicionário de dados, no campo X3_VALID.
2 - Utilizar a função: MaFisRelImp(cProg,aAlias), onde cProg é qual o programa em execução, porém o parâmetro pode ser passado como "", e aAlias é a tabela onde será efetuada a pesquisa das referências, por exemplo SD2 para o item do documento, e SF2 para o cabeçalho. O retorno será uma lista com todas as referências que são utilizadas para a gravação na tabela.
3 - Para utilizar a busca de um valor do configurador de tributos é possível chamar a MaFisRet de algumas formas:
- Resultado genérico:
- MaFisRet(nItem, "NF_TRIBGEN") // Dessa forma retornará um array com todas as informações de cabeçalho dos tributos genéricos calculados pelo configurador de tributos.
- MaFisRet(nItem, "IT_TRIBGEN") // Dessa forma retornará um array com todas as informações de item dos tributos genéricos calculados pelo configurador de tributos.
- Pode ser usado o terceiro parâmetro da função MaFisRet para retornar o valor de um tributo genérico específico:
- Exemplo: MafisRet(nItem,"IT_TRIBGEN",aTrbGen)
O array aTrbGen pode ter tamanho 1 ou 2:
A primeira posição é a sigla do tributo que esta procurando.
A segunda posição é a referencia do tributo que esta procurando.
Exemplo: {'ICMTEST','TG_IT_BASE'} // Retorna a base do tributo genérico ICMTEST
Exemplo: {'ICMTEST','TG_IT_ALIQUOTA'} // Retorna a alíquota do tributo genérico ICMTEST
Exemplo: {'ICMTEST','TG_IT_VALOR'} // Retorna o valor do tributo genérico ICMTEST
Quando informado somente a sigla do tributo, retorna todos os dados do tributo genérico.
- MaFisRet(nItem, "IT_TRIBGEN", {"ICMTEST"})
Quando informado a sigla e a referencia do tributo, retorna somente o valor da referencia do tributo genérico.
- MaFisRet(nItem, "IT_TRIBGEN", {"ICMTEST", "TG_IT_VALOR"})
04. PARÂMETROS
Ordem | Parâmetro | Tipo | Descrição |
---|---|---|---|
01 | nItem | Numérico | Numero do item do array aNfItem Obrigatório para referências “IT_” e “LF” em cCampo |
02 | cCampo | Caracter | Referência do campo que deseja obter o valor ou conteúdo dos array aNFCab e aNFItem, informar para referências do cabeçalho “NF_xxxxx” e para referências dos itens “IT_xxxxx” e “LF_xxxxx” . |
03 | aTrbGen | Array | Array bidimensional com informações que queira receber dos tributos calculados pelo configurador de tributos. |
05. RETORNO
Ordem | Retorno | Tipo | Descrição |
---|---|---|---|
01 | xConteúdo da referência pesquisada | Todos conforme referência | Conteúdo da referência Fiscal nos array internos aNFCab e aNFItem no momento da chamada da função |
06. OUTRAS INFORMAÇÕES
Importante!
A função MaFisIni() tem que ser usada obrigatoriamente em qualquer operação que envolva a MATXFIS, sempre deve ser utilizada antes da carga de qualquer Item.
Para utilização dessa função verifique esta documentação: Função MaFisIni