Documento de BO

Produto:	Datasul
Ocorrência:	Documentação de BO
Nome Físico	dibo/bodi084.p

RecordSet

Temp-Table principal utilizada para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.

tt-it-doc-fisc
Atributo	Tipo	Formato	Descrição	Obr.
Cod-estabel	Char	X(3)	Estabelecimento	Sim
Serie	Char	X(5)	Série	Sim
nr-seq-doc	Inte	>>,>>9	Sequência	Sim
Cod-emitente	Inte	>>>>>>>>9	Cliente/Fornec	Sim
it-codigo	Char	X(16)	Item	Sim
Peso-liq	Dec	>>>,>>>,>>9.99999	Peso Liquido	Sim
vl-merc-liq	Dec	>,>>>,>>>,>>9.99	Vl Mercadoria Líquido	Sim
vl-tot-item	Dec	>,>>>,>>>,>>9.99	Vl Total Item
Nat-operacao	Char	X(06)	Natureza Operação	Sim
cd-trib-ipi	Inte	99	Tributação IPI	Sim
Aliquota-ipi	Dec	>>9.99	Alíquota IPI	Sim
Perc-red-ipi	Dec	>>9.99	% Redução IPI	Sim
cd-trib-iss	Inte	99	Tributação ISS	Sim
Aliquota-iss	Dec	>>9.99	Alíquota ISS
cd-trib-icm	inte	99	Cod Tributação ICM	Sim
Perc-red-icm	Dec	>>9.9999	% Redução ICMS
vl-despes-it	Dec	>,>>>,>>>,>>9.99	Valor Despesas Item	Sim
vl-bicms-it	Dec	>,>>>,>>>,>>9.99	Base Calc ICMS Item
vl-icms-it	Dec	>,>>>,>>>,>>9.99	Valor ICMS Item
vl-icmsnt-it	Dec	>,>>>,>>>,>>9.99	Vl ICMS Não Trib
vl-icmsou-it	Dec	>,>>>,>>>,>>9.99	Vl ICMS Outras
vl-bipi-it	Dec	>,>>>,>>>,>>9.99	Base Calc IPI Item
vl-ipi-it	Dec	>,>>>,>>>,>>9.99	Valor IPI Item	Sim
vl-ipint-it	Dec	>,>>>,>>>,>>9.99	Vl IPI Não Tributado	Sim
vl-ipiou-it	Dec	>,>>>,>>>,>>9.99	Vl IPI Outras	Sim
vl-biss-it	Dec	>,>>>,>>>,>>9.99	Base Calc ISS Item	Sim
vl-iss-it	Dec	>,>>>,>>>,>>9.99	Valor ISS Item	Sim
vl-issnt-it	Dec	>,>>>,>>>,>>9.99	Vl ISS Não Tributado	Sim
vl-issou-it	Dec	>,>>>,>>>,>>9.99	Vl ISS Outras	Sim
vl-bsubs-it	Dec	>,>>>,>>>,>>9.99	Base ICMS Item Subs	Sim
vl-icmsub-it	Dec	>,>>>,>>>,>>9.99	Valor ICMS Item Subs	Sim
Tipo-contr	Inte	99	Tipo Controle	Sim
Perc-red-iss	Dec	>>9.99	% Redução ISS	Sim
vl-merc-sicm	Dec	>,>>>,>>>,>>9.99	Vl Mercad sem ICMS	Sim
Quantidade	Dec	->>>>,>>>,>>9.9999	Quantidade	Sim
Un	Char	Xx	Un	Sim
Class-fiscal	Char	9999.99.99	Classificação Fiscal	Sim
nr-doc-fis	Char	x(16)	Documento Fiscal	Sim
dt-emis-doc	Date	99/99/9999	Dt Emissão	Sim
Tipo-nat	Inte	99	Tipo Natur Oper	Sim
cd-vin-ipi	Char	99.9-x	Cod Vinculação IPI	Sim
dt-ent-doc	Date	99/99/9999	Dt Entrada
dt-docto	Date	99/99/9999	Dt Documento	Sim
Descricao-db	Char	x(2000)	Descrição Débito Diret	Sim
Codigo-rejei	Inte	>>9	Cod Devolução	Sim
Serie-com	Char	x(5)	Série Complementar	Sim
nr-nota-com	Char	x(16)	NF Complementar	Sim
dt-emis-com	Date	99/99/9999	Dt Emissão
Cod-servico	Inte	>>>>9	Cod Serviço	Sim
Ind-ori-doc	Inte	99	Origem Docto
vl-ipi-dev	Dec	>>>>,>>>,>>9.99	Valor IPI Devol	Sim
Nivel-restituicao	Char	!	Nível de Restituição
pc-desc-icms	Dec	>>9.99	% Desc ICMS
pc-restituicao	Dec	>>9.99	%Restituição
vl-ipi-devol	Dec	>>>,>>>,>>9.99	Valor IPI Devol
ct-codigo	Char	x(17)	Receita Vendas
sc-codigo	Char	x(8)	Sub-Conta
Aliquota-icm	Dec	>>9.99	Alíquota ICMS
Conta-contabil	Char	x(17)	Conta Cont bil
Char-1	Char	x(100)	?
Char-2	Char	x(100)	?
Dec-1	Dec	->>>>>>>>>>>9.99	?
Dec-2	Dec	->>>>>>>>>>>9.99	?
int-1	Inte	->>>>>>>>>9	?
int-2	Inte	->>>>>>>>>9	?
Log-1	Logi	Sim/Não	?
Log-2	Logi	Sim/Não	?
Data-1	Date	99/99/9999	?
Data-2	Date	99/99/9999	?
Check-sum	Char	x(20)	Check-sum
vl-bsubs-it-en	Dec	>,>>>,>>>,>>9.99	Base St Petróleo/Energ	Sim
vl-icmsub-it-en	Dec	>,>>>,>>>,>>9.99	ICMS St Petróleo/Energ	Sim

Métodos Básicos

Métodos básicos de acesso ao banco de dados.

Método: goToKey

Descrição:

Reposiciona registro com base no índice CH-IT-DOC, recebe valor dos campos do índice CH-IT-DOC e retorna status do processo.

Requisitos:Nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pcod-estabel	Char	X(3)	X			Código do Estabelecimento
Pserie	Char	X(5)	X			Série
pnr-doc-fis	Char	X(16)	X			Documento Fiscal
pcod-emitente	Inte	>>>>>>>>9	X			Cliente/Fornec
pnat-operacao	Char	X(6)	X			Natureza Operação
pnr-seq-doc	Inte	>>,>>9	X			Sequência

Método: afterDeleteRecord

Descrição:

Posiciona na tabela doc-fiscal através da procedure findUpdateDocFiscal com os valores dos campos de RowObject. Atualiza (acumula valores) tabela doc-fiscal após deleção de registros de it-doc-fisc.

Requisitos:

Doc-fiscal existente.

Parâmetros:

nenhum.

Método: afterNewRecord

Descrição:

Inicializa campos. Valores default´s.

Requisitos:

nenhum.

Parâmetros:

nenhum.

Método: validateRecord

Descrição:

Executa validações na temp-table antes de criar registro na base de dados.

Requisitos:

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pType	Char		X			Tipo do parâmetro (Create, Copy, Delete e Update)

Queries e Constraints

Definição das Queries (acesso ao banco de dados) e Contraints (regras de leitura) utilizadas para buscar grupos de registros da base de dados.

Método:

openQueryStatic (“DocFiscal”)

Descrição:

Busca conjunto de registros da tabela it-doc-fisc.

Constraints Associados:

setConstraintDocFiscal

Método: setConstraintDocFiscal

Descrição:

Complemento do openQueryDocFiscal. Busca os registros da tabela it-doc-fisc que relacionam-se com a tabela doc-fiscal. Seta as variáveis de controle para queries.

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEstabel	Char	X(3)	X			Código do Estabelecimento
pSerie	Char	X(5)	X			Série
pNrDocFis	Char	x(16)	X			Documento Fiscal
pCodEmitente	Int	>>>>>>>>9	X			Cliente/Fornec
pNatOperacao	Char	x(6)	X			Natureza Operação

Métodos Negócio

Métodos adicionais de atualização e acesso a base de dados.

Método: atualizaAliquotaIcm

Descrição:

Atualiza alíquota de icm na tabela doc-fiscal, com o valor do campo alíquota icm do primeiro item do respectivo documento fiscal.

Requisitos:

Executa findRowidDocFiscal, pois nesta procedure é posicionado doc-fiscal sem a palavra no-lock (para alterar a tabela).

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pRwDocFiscal	Rowid	0x0000XX	X			Rowid de doc-fiscal

Método: enableFields

Descrição:

Habilita/Desabilita campos pela regra de negócio

Requisitos:

nenhum

Parâmetros:

Método: findClassFiscal

Descrição:

Localiza classificação fiscal (classif-fisc.class-fiscal) informada através do parâmetro passado à procedure. Se não encontrar um registro, insere um erro em rowErrors.

Requisitos:

nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pClassFiscal	Char	X(10)	X			Código da classificação fiscal

Método: findDocFiscal

Descrição:

Posiciona em doc-fiscal, através dos parâmetros passados á procedire. Se não encontrar um registro, insere um erro em rowErrors.

Requisitos:

nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEstabel	Char	X(3)	X			Código do Estabelecimento
pSserie	Char	X(5)	X			Série
pNrDocFis	Char	x(16)	X			Documento Fiscal
pCodEmitente	Int	>>>>>>>>9	X			Cliente/Fornec
pNatOperacao	Char	x(6)	X			Natureza Operação

Método: findEmitente

Descrição:

Localiza emitente (emitente.cod-emitente) informado através do parâmetro passado à procedure. Se não encontrar um registro, insere um erro em rowErrors.

Requisitos:

nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEmitente	Int	>>>>>>>>9	X			Código do emitente

Método: findEstabelec

Descrição:

Localiza estabelecimento (estabelec.cod-estabel) informado através do parâmetro passado à procedure. Se não encontrar um registro, insere um erro em rowErrors.

Requisitos:

nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEstabel	Char	X(3)	X			Código do estabelecimento

Método: findItem

Descrição:

Localiza item (item.it-codigo) informado através do parâmetro passado à procedure. Se não encontrar um registro, insere um erro em rowErrors.

Requisitos:

nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pItCodigo	Char	X(16)	X			Código do item

Método: findNaturOper

Descrição:

Localiza natureza de operação (natur-oper.nat-operacao) informada através do parâmetro passado à procedure. Se não encontrar um registro, insere um erro em rowErrors.

Requisitos:

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pNatOperacao	Char	X(6)	X			Código da natureza de operação

Método: findRowidDocFiscal

Descrição:

Localiza doc-fiscal através do rowid passado à procedure. Se encontrar um registro retorna OK, senão retorna NOK.

Requisitos:

nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pRwDocFiscal	Rowid	0x0000XX	X			Rowid de doc-fiscal

Método: findTabCodSer

Descrição:

Localiza código de serviço (tab-codser.cod-servico) informado através do parâmetro passado à procedure. Se não encontrar um registro, insere um erro em rowErrors.

Requisitos:

nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pUn	Char	X(2)	X			Código da Unidade

Método: findTabUnidade

Descrição:

Localiza tabela de unidade (tab-unidade.un) informada através do parâmetro passado à procedure. Se não encontrar um registro, insere um erro em rowErrors.

Requisitos:

nenhum

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pUn	Char	X(2)	X			Código da Unidade

Método: findUpdateDocFiscal

Descrição:

Posiciona em doc-fiscal através dos valores dos campos de RowObject. Executa find sem a palavra no-lock. Se encontrar um registro retorna OK, senão retorna NOK.

Requisitos:

nenhum

Parâmetros:

nenhum

Método: getDescriptionFields

Descrição:

Obtem dados do campo solicitado através dos parãmetros passados à procedure. Se não encontrar o registro, retorna brancos.

Requisitos:

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pFieldName	Char		X			Nome do campo que contém a descrição solicitada
pDescription	Char			X		Dados do campo solicitado

Método: getSeqItem

Descrição:

Obtem a sequência do registro it-doc-fisc. Posiciona no último registro de it-doc-fisc. Se não existir it-doc-fisc, então o campo receberá o valor 10.

Requisitos:

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pSeq	Int	>>,>>9		X		Sequência do item

Método: piInicializa

Descrição: I

nicializa valores default´s de campos da temp-table RowObject.

Requisitos:

Item.it-codigo e rowid de doc-fiscal

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pItCodigo	Char	X(16)	X			Código do Item
pRwDocFiscal	Rowid	0x0000XX	X			Rowid de doc-fiscal

Método: piGeraValores

Descrição:

Calcula valores de impostos e valor total do item, após confirmação pelo usuário. Executada apenas para “Create” e “Update”.

Requisitos:

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pType	Char		X			Tipo do parâmetro (Create, Copy, Delete e Update)
pRwDocFiscal	Rowid	0x0000XX	X			Rowid de doc-fiscal

Método: validateInput

Descrição:

Executa validações para inclusão de registros. Utilizada para mostrar valores default´s para Web.

Requisitos:

Parâmetros:

Parâmetro	Tipo	Formato	I	O	IO	Descrição
pCodEestabel	Char	X(3)	X			Código do Estabelecimento
pSerie	Char	X(5)	X			Série
pNrDocFis	Char	X(16)	X			Documento Fiscal
pCodEmitente	Int	>>>>>>>>9	X			Cliente/Fornec
pNatOperacao	Char	X(6)	X			Natureza Operação
pNrSeqDoc	Int	>>,>>9	X			Seqüência do Item
pItCodigo	Char	X(16)	X			Código do Item
RowErrors	Table			X		Tabela de erros (rowErrors)

Árvore de páginas

BODI084 - Itens dos Documentos Fiscais

Documento de BO

RecordSet

Métodos Básicos

Queries e Constraints

Métodos Negócio