CONTEÚDO
- Visão Geral
- Descrição
- Como e onde usar
- Parâmetros e retorno
01. VISÃO GERAL
Linha de Produto: | Microsiga Protheus® |
Segmento: | Serviços |
Módulo: | SIGAFIS - Livros Fiscais |
Função: | MaFisRef |
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 MaFisRef() foi desenvolvida para integrar a MATXFIS com programas que possuam interface para manipulação de dados do documento fiscal, (Inclusão, Alteração, Exclusão e Visualização).
A função tem a responsabilidade de localizar a referência fiscal nos arrays internos da MATXFIS, comparar o valor passado pelo parâmetro xValor com o valor constante nos arrays internos (aNFCab e ou aNFItem) e havendo divergência entre os conteúdos, realizar a alteração para o novo conteúdo de xValor, disparar o recalculo de todos impostos ligados a referência informada e atualizar os novos conteúdos na variável PRIVATE aCols da aplicação sincronizando assim o conteúdo dos arrays internos da MATXFIS com as variáveis da aplicação, ou seja, para utilizar esta função é obrigatório que haja uma interface onde exista uma MsGetDados() para os itens da aplicação com as variáveis aHeader e aCols disponíveis.
O uso convencional desta função se dá no X3_VALID dos campos do dicionário de dados SX3.
Exemplo:
Campo | X3_VALID |
---|---|
D1_VALIPI | MaFisRef("IT_VALIPI" , "MT100" , M->D1_VALIPI ) |
Contudo, nada impede que esta função seja chamada diretamente da própria aplicação em um contexto adequado ao seu funcionamento.
03. COMO E ONDE USAR
A função é usada no X3_VALID dos campos das tabelas de cabeçalho e itens da aplicação que resultarão no documento fiscal que será processado. Mas como dito anteriormente, nada impede de ser usada diretamente na aplicação.
Veja!
Antes de utilizar essa função visite as documentações das seguintes funções:
04. PARÂMETROS E RETORNO
Ordem | Parâmetro | Tipo | Descrição |
---|---|---|---|
01 | cReferencia | Caractere | Referência Fiscal “NF_” ou “IT_” que conste no arquivo MATXDEF.CH, exemplo: “IT_PRODUTO”, “NF_ESPECIE” |
02 | cProg | Caractere | Identificador do arquivo, exemplo: "MT100" |
03 | xValor | Caractere/Numérico/Array/Lógico | Conteúdo a ser carregado para a referência fiscal na MATXFIS. Exemplo: Get no aCols com o valor do campo em memória: M->D1_PRODUTO |
Ordem | Retorno | Tipo | Descrição |
---|---|---|---|
01 | lOk | Lógico | .T. = Se a referência fiscal foi encontrada e pode ser atualizada. .F. = Se a referência fiscal NÃO foi encontrada e ou atualizada. |