Documento de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico | dibo/bodi037.p |
RecordSet
Temp-Table principal utilizada para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.
tt-doc-fiscal |
Atributo | Tipo | Formato | Descrição | Obr. |
cod-estabel | Char | X(3) | Estabelecimento | Sim |
Serie | Char | X(5) | Série | Sim |
nr-doc-fis | Char | X(16) | Documento Fiscal | Sim |
cod-emitente | Inte | >>>>>>>>9 | Cliente/Fornec | Sim |
Nome-ab-emi | Char | X(12) | Emitente | Sim |
dt-emis-doc | Date | 99/99/9999 | Dt Emissão | Sim |
ind-sit-doc | Inte | 99 | Situação do Docto | Sim |
Endereco | Char | X(40) | Endereço | Sim |
Bairro | Char | X(30) | Bairro | Sim |
Cidade | Char | x(25) | Cidade | Sim |
Estado | Char | x(04) | UF | Sim |
Cep | Char | x(12) | CEP | Sim |
Pais | Char | X(20) | País | Sim |
Cgc | Char | x(19) | CGCMF | |
Ins-estadual | Char | x(19) | Inscrição Estadual | Sim |
Cod-des-merc | Inte | 99 | Destino Mercadoria | |
vl-cont-doc | Dec | >>,>>>,>>>,>>9.99 | Valor Contábil | Sim |
Nat-operacao | Char | x(06) | Natureza Operação | Sim |
Preco-saida | Inte | 99 | Preço Saída | Sim |
Ind-tip-nota | Inte | 99 | Tipo Nota | Sim |
Observação | Char | x(2000) | Observação | Sim |
Esp-docto | Char | x(3) | Espécie Doc | |
Cod-observa | Inte | 99 | Cod Observação | Sim |
Aliquota-icm | Dec | >>9.99 | Alíquota ICMS | Sim |
vl-bicms | Dec | >,>>>,>>>,>>9.99 | Base Calc ICMS | |
vl-icms | Dec | >,>>>,>>>,>>9.99 | Valor ICMS Tributado | |
vl-icmsnt | Dec | >,>>>,>>>,>>9.99 | Vl ICMS Não Trib | |
vl-icmso | Dec | >,>>>,>>>,>>9.99 | Vl ICMS Outras | |
vl-bsubs | Dec | >,>>>,>>>,>>9.99 | Base ICMS Subst | Sim |
vl-icmsub | Dec | >,>>>,>>>,>>9.99 | Valor ICMS Subst | Sim |
Manut-icm-it | Logi | Sim/Não | Manut ICMS | Sim |
Manut-ipi-it | Logi | Sim/Não | Manut IPI | Sim |
Ind-icm-ret | Logi | Sim/Não | Retém ICMS Fonte | |
vl-icms-com | Dec | >,>>>,>>>,>>9.99 | ICMS Complementar | Sim |
Tipo-nat | Inte | 99 | Tipo Natur Oper | Sim |
cd-situacao | Inte | 99 | Situação | Sim |
cd-registro | Char | x(2) | Cod Registro | Sim |
vl-ipi | Dec | >,>>>,>>>,>>9.99 | Valor IPI | |
vl-bipi | Dec | >,>>>,>>>,>>9.99 | Base Calc IPI | Sim |
vl-ipiou | Dec | >,>>>,>>>,>>9.99 | Vl IPI Outras | Sim |
vl-ipint | Dec | >,>>>,>>>,>>9.99 | Vl IPI Não Tributado | Sim |
vl-biss | Dec | >,>>>,>>>,>>9.99 | Base Calc ISS | |
vl-iss | Dec | >,>>>,>>>,>>9.99 | Valor ISS | Sim |
vl-issou | Dec | >,>>>,>>>,>>9.99 | Vl ISS Outras | Sim |
vl-issnt | Dec | >,>>>,>>>,>>9.99 | Vl ISS Não Tributado | Sim |
vl-irf | Dec | >,>>>,>>>,>>9.99 | Valor IRRF | Sim |
ind-imprenda | Logi | Sim/Não | Retém IRRF | Sim |
Perc-red-iss | Dec | >>9.99 | % Redução ISS | Sim |
Perc-red-ipi | Dec | >>9.99 | % Redução IPI | Sim |
Perc-red-icm | Dec | >>9.9999 | % Redução ICMS | Sim |
dt-docto | Date | 99/99/9999 | Dt Documento | Sim |
vl-finsocial | Dec | >,>>>,>>>,>>9.99 | Valor Cofins | Sim |
vl-pis | Dec | >,>>>,>>>,>>9.99 | Valor PIS | Sim |
ind-cifob | Inte | 99 | CIF/FOB | |
dt-ult-alt | Date | 99/99/9999 | Dt Última Alteração | |
User-alt | Char | X(12) | Usuário Ult Alt | |
ind-ori-doc | Inte | 99 | Origem Docto | |
dt-impl | Date | 99/99/9999 | Dt Implantação | 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 | |
cod-mensagem | Inte | >>9 | Mensagem | |
cod-rejeicao | Inte | >>9 | Cod Devolução | |
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 | |
nr-siscomex | Char | x(20) | Nr Siscomex | |
Temp-Tables adicionais utilizadas nos demais métodos de negócio para comunicação dos métodos da BO com o mundo externo e suas respectivas definições.
tt-doc-fiscal |
Atributo | Tipo | Formato | Descrição | Obr. |
| | | | |
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-DOCTO. Recebe valor do campo do índice CH-DOCTO 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 | Int | >>>>>>>>9 | X | | | Cliente/Fornec |
pnat-operacao | Char | X(6) | X | | | Natureza Operação |
Método:
afterNewRecord
Descrição:
Inicializa valores após criar registro na temp-table, para obter 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(“ByEmitente”)
Descrição: Abrea query com todos os registro da tabela Doc-fiscal, ordenado-os por código do emitente.
Método:
openQueryStatic(“DocFiscal”)
Descrição: Busca um conjunto de registros da tabela Doc-fiscal, dentro das faixas: código do estabelecimento, serie, número do documento fiscal, código do emitente e natureza de operação. Os registros são ordenados por código do estabelecimento.
Constraints Associados:
setConstraintDocFiscal
Método:
setConstraintDocFiscal
Descrição:
Seta as variáveis de controle para queries contendo código do estabelecimento, série, número do documento fiscal, código do emitente e natureza de operação
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 | Int | >>>>>>>>9 | X | | | Cliente/Fornec |
pnat-operacao | 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: enableFields
Descrição: Habilita/Desabilita campos pela regra de negócio
Requisitos:
Parâmetros:
Método: findEmitente
Descrição:
Localiza emitente informado 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 |
pCodemitente | Int | >>>>>>>>9 | X | | | Código do emitente |
Método: findEstabelec
Descrição:
Localiza estabelecimento informado 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 |
pCodEstabel | Char | X(3) | X | | | Código do estabelecimento |
Método: findNaturOper
Descrição:
Localiza natureza de operação 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:
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pRwDocFiscal | Rowid | 0x0000XX | X | | | Rowid de doc-fiscal |
Método: findUnidFeder
Descrição:
Localiza unidade da federação 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 |
pUf | Char | X(4) | X | | | Código da unidade da federação (estado) |
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: piCancelar
Descrição:
Altera status do documento para cancelado (ind-sit-doc = 2).
Requisitos: Rowid do documento á cancelar
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
pRwDocFiscal | Rowid | 0x0000XX | X | | | Rowid de doc-fiscal |
Método: piDocto
Descrição:
Executa atualizações na temp-table, na inclusão e alteração (campos default´s, conforme natureza de operação e emitente informados).
Requisitos:
Natureza de Operação e Código do Emitente devem existir.
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 |
Método: validateCreateRecord
Descrição:
Executa validações na temp-table antes de criar registro na base de dados, somente na opção de “Create”.
Requisitos:
Parâmetros:
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 |
RowErrors | Table | | | X | | Tabela de erros (rowErrors) |
#trackbackRdf ($trackbackUtils.getContentIdentifier($page) $page.title $trackbackUtils.getPingUrl($page))