Documentação de BO
Produto: | Datasul |
Ocorrência: | Documentação de BO |
Nome Físico: | dibo/bodi135.p |
RecordSet
Temp-Table principal utilizada para utilização dos métodos da BO e suas respectivas definições.
| Nota Fiscal (nota-fiscal) | ||||
| Atributo | Tipo | Formato | Descrição | Obr. |
| cod-estabel | character | x(5) | Estabelecimento | Sim |
| serie | character | x(5) | Série | Sim |
| nr-nota-fis | character | x(16) | Nr Nota Fiscal | Sim |
| nome-ab-cli | character | x(12) | Cliente/Fornec | Sim |
| dt-emis-nota | date | 99/99/9999 | Dt Emissão | Sim |
| ind-sit-nota | integer | 99 | Situação NF | Sim |
| dt-confirma | date | 99/99/9999 | Dt Confirmação | Sim |
| hr-confirma | character | 99:99 | Hora Confirmação | Sim |
| dt-cancela | date | 99/99/9999 | Dt Cancelamento | Sim |
| desc-cancela | character | x(2000) | Motivo Cancelamento | Sim |
| hr-atualiza | character | 99:99 | Hora Atualização | Sim |
| cod-cond-pag | integer | >>>9 | Cond Pagto | Sim |
| nr-pedcli | character | x(12) | Pedido Cliente | Sim |
| cod-entrega | character | x(12) | Entrega | Sim |
| endereco | character | X(40) | Endereço | Sim |
| bairro | character | X(30) | Bairro | Sim |
| cidade | character | x(25) | Cidade | Sim |
| estado | character | x(04) | UF | Sim |
| cep | character | x(12) | CEP | Sim |
| pais | character | X(20) | País | Sim |
| cgc | character | x(19) | CGCMF | |
| ins-estadual | character | X(19) | Inscrição Estadual | Sim |
| perc-desco1 | decimal | ->9.999 | Desconto Cliente | |
| perc-desco2 | decimal | ->9.999 | Desconto-2 | |
| cond-redespa | character | x(2000) | Condições Redespacho | Sim |
| cidade-cif | character | x(25) | Cidade CIF | |
| cod-des-merc | integer | 99 | Destino Mercadoria | |
| nome-transp | character | x(12) | Transportador | Sim |
| tp-preco | integer | 99 | Tipo Preço | Sim |
| cod-rota | character | x(12) | Rota | Sim |
| ind-lib-nota | logical | Sim/Não | Libera NF | |
| nr-tabpre | character | x(8) | Tab Preços | Sim |
| vl-tot-nota | decimal | >>,>>>,>>>,>>9.99 | Vl Total Nota | Sim |
| vl-mercad | decimal | >>,>>>,>>>,>>9.99 | Vl Mercadoria | Sim |
| vl-frete | decimal | >>,>>>,>>>,>>9.99 | Valor Frete | |
| vl-seguro | decimal | >>,>>>,>>>,>>9.99 | Valor Seguro | |
| vl-embalagem | decimal | >>,>>>,>>>,>>9.99 | Vl Embalagem | |
| nr-praz-med | decimal | >>9.99 | Prazo Médio Vecto | |
| nr-fatura | character | x(16) | Nr Fatura | Sim |
| nat-operacao | character | x(06) | Natureza operação | Sim |
| emite-duplic | logical | Sim/Não | Gera Faturamento | Sim |
| cod-mensagem | integer | >>9 | Mensagem | |
| preco-saida | integer | 99 | Preço Saída | Sim |
| marca-volume | character | x(20) | Marca Volumes | Sim |
| nr-volumes | character | x(10) | Nr Volumes | |
| peso-liq-tot | decimal | >>>,>>>,>>9.999 | Peso Líquido Total | Sim |
| peso-bru-tot | decimal | >>>,>>>,>>9.999 | Peso Bruto Total | Sim |
| ind-tip-nota | integer | 99 | Tipo Nota | Sim |
| cod-portador | integer | >>>>9 | Portador | Sim |
| modalidade | integer | 9 | Modalidade | Sim |
| mercado | integer | 99 | Mercado | Sim |
| tipo-fat | integer | 99 | Tipo Faturamento | Sim |
| dt-prvenc | date | 99/99/9999 | Dt Primeiro Vencto | |
| observ-nota | character | x(2000) | Observação | |
| nr-tab-finan | integer | >>9 | Tab Financ | Sim |
| nr-ind-finan | integer | >9 | Nr Índice Financto | Sim |
| ind-contabil | logical | Sim/Não | Contabilizada | |
| dt-at-ofest | date | 99/99/9999 | Dt Atual Obrig Fisc | |
| dt-atual-cr | date | 99/99/9999 | Dt Atualização CR | Sim |
| placa | character | x(10) | Placa | |
| vl-acum-dup | decimal | >>,>>>,>>>,>>9.99 | Vl Acum Duplicatas | Sim |
| cod-rep | integer | >>>>9 | Representante | Sim |
| no-ab-reppri | character | x(12) | Representante | Sim |
| nome-ab-reg | character | x(12) | Região | Sim |
| esp-docto | integer | >9 | Espécie Docum | Sim |
| distancia | decimal | >>>,>>9.9 | Distância(Km) | Sim |
| cd-vendedor | character | x(12) | Vendedor | Sim |
| dt-saida | date | 99/99/9999 | Dt Saída Merc | |
| taxa-orig | decimal | >>9.99999 | Taxa Orig | Sim |
| user-calc | character | x(12) | Usuário Cálculo | |
| taxa-real | decimal | >>9.99999 | Taxa Real | Sim |
| per-des-icms | decimalSim | ->>9.999 | Perc Desc ICMS | |
| nr-embarque | integer | >>>>,>>9 | Embarque | Sim |
| tp-pedido | character | x(2) | Tipo Pedido | |
| nome-tr-red | character | x(12) | Trans Redespa | |
| cod-emitente | integer | >>>>>>>>9 | Cliente/Fornec | Sim |
| vl-taxa-exp | deci-8 | >>>>,>>9.99999999 | Taxa Exportação | |
| nr-proc-exp | character | x(12) | Nr Processo Exp | |
| vl-totnota-e | decimal[3] | >>,>>>,>>>,>>9.99 | Vl Total Nota | |
| vl-mercad-e | decimal[3] | >>,>>>,>>>,>>9.99 | Vl Mercadoria | |
| vl-frete-e | decimal[3] | >>,>>>,>>>,>>9.99 | Vl Frete | |
| vl-seguro-e | decimal[3] | >>,>>>,>>>,>>9.99 | Valor Seguro | |
| vl-embalagem-e | decimal[3] | >>,>>>,>>>,>>9.99 | Vl Embalagem | |
| vl-acumdup-e | decimal[3] | >>,>>>,>>>,>>9.99 | Vl Acum Duplicatas | |
| vl-taxaexp-e | decimal[3] | >>>>,>>9.99 | Taxa Exportação | |
| identific | character | x(12) | Identificação | Sim |
| cod-dep-ext | character | x(3) | Depósito Externo | |
| fat-retro | logical | Sim/Não | Retroativo | Sim |
| vl-fatura | decimal | >>,>>>,>>>,>>9.99 | Vl Fatura | |
| docto-orig | character | x(16) | Docto Origem Fat | |
| descto2 | decimal | >>>,>>>,>>9.99 | Vl Desconto 2 | |
| descto1 | decimal | >>>,>>>,>>9.99 | Vl Desconto 1 | |
| nr-fat-retro | character | x(16) | Nr Fat Retroativo | Sim |
| dt-entr-cli | date | 99/99/9999 | Dt Entrega Real | |
| cd-sit-desp | integer | 99 | Despacho | Sim |
| hr-entr-cli | character | 99:99:99 | Hora Entrega Real | |
| nivel-restituicao | character | ! | Nível de Restituição | |
| nr-parcelas | integer | >9 | Nr Parcelas | |
| nr-resumo | integer | >>>>,>>9 | Nr Resumo | |
| pc-restituicao | decimal | >>9.99 | %Restituição | |
| vl-tot-itens-fat | decimal | >>,>>>,>>>,>>9.99 | Vl Tot Faturado | |
| uf-placa | character | !! | UF | |
| invoice-id | character | x(1) | Versão | Sim |
| vl-tot-com | decimal | >>,>>>,>>>,>>9.99 | Valor Comissão | |
| vl-comis-nota | decimal | >>,>>>,>>9.99 | Vl Comissão | |
| zip-code | character | x(12) | CEP | |
| serie-ant | character | x(5) | Série Ant | |
| nr-nota-ant | character | x(16) | NF Anterior | |
| dt-embarque | date | 99/99/9999 | Dt Embarque | |
| mo-codigo | character | x(16) | Modelo | |
| nr-pedido-nf-orig | integer | 999999999 | Nr Pedido Origem | |
| replica-nf | logical | Sim/Não | Replica NF | |
| dt-at-est | date | 99/99/9999 | Dt Atualização Estatís | |
| cod-tax | integer | >>>9 | Código Imposto | |
| tax-desp | decimal | ->>>,>>>,>>9.99 | Vl Imp Diversos | |
| tax-frete | decimal | ->>>,>>>,>>9.99 | Vl Imp Frete | |
| vl-tot-ipi | decimal | ->>>,>>>,>>>,>>9.99 | Vl Tot Imp | |
| vl-tot-iva | decimal | ->>>,>>>,>>>,>>9.99 | Vl Total Imp | |
| caixa-postal | character | x(10) | Caixa Postal | |
| serie-orig | character | x(5) | Série Orig | |
| nro-nota-orig | character | x(16) | Nr Nota Orig | |
| cn-codigo | character | x(40) | Condado | |
| ind-orig-entrada | integer | >9 | Origem Entrada | |
| ind-via-envio | integer | >9 | Via Envio | |
| nro-proc-entrada | integer | >>>>>>>>9 | Processo Entrada | |
| nro-proc-saida | integer | >>>>>>>>9 | Processo Saída | |
| dt-at-ct | date | 99/99/9999 | Dt Atualização Contábi | |
| refer-ct | character | x(12) | Referência Contábil | |
| vl-merc-tot-fat | decimal | ->>,>>>,>>9.99 | Vl Total Merc Fat | |
| char-1 | character | x(2000) | ? | |
| char-2 | character | x(2000) | ? | |
| dec-1 | deci-8 | ->>>>>>>>>>>9.9999999 | ? | |
| dec-2 | deci-8 | ->>>>>>>>>>>9.9999999 | ? | |
| int-1 | integer | ->>>>>>>>>9 | ? | |
| int-2 | integer | ->>>>>>>>>9 | ? | |
| log-1 | logical | Sim/Não | ? | |
| log-2 | logical | Sim/Não | ? | |
| data-1 | date | 99/99/9999 | ? | |
| data-2 | date | 99/99/9999 | ? | |
| cod-canal-venda | integer | >>9 | Canal Venda | |
| vl-desconto | decimal | >>,>>9.99 | Vl Desconto | |
| cod-imagem | character | x(30) | Imagem | |
| check-sum | character | x(20) | Check-sum | |
| log-usa-tabela-desconto | logical | Sim/Não | Usa Tabela Descontos | |
| val-pct-desconto-tab-preco | decimal | ->>9.99 | Perc Desc Tabela Preço | |
| des-pct-desconto-inform | character | x(50) | Perc Desc Informado | |
| val-pct-desconto-total | decimal | ->>9.9999 | Perc Desc Total | |
| val-desconto-total | decimal | >>>,>>>,>>9.99 | Valor Desconto Total | |
| vl-tot-nota-me | decimal | >>,>>>,>>>,>>9.99999 | Vl Total Nota Moeda | |
| vl-mercad-me | decimal | >>,>>>,>>>,>>9.99999 | Valor Mercadoria Moeda | |
| vl-frete-me | decimal | >>,>>>,>>>,>>9.99999 | Valor Frete Moeda | |
| vl-seguro-me | decimal | >>>,>>>,>>9.99999 | Valor Seguro Moeda | |
| vl-embalagem-me | decimal | >>>,>>>,>>9.99999 | Valor Embalagem Moeda | |
| vl-acum-dup-me | decimal | >>,>>>,>>>,>>9.99999 | Vl Acum Duplic Moeda | |
| vl-fatura-me | decimal | >>,>>>,>>>,>>9.99999 | Valor Fatura Moeda | |
| vl-tot-itens-fat-me | decimal | >>,>>>,>>>,>>9.99999 | Vl Tot Faturado Moeda | |
| vl-tot-com-me | decimal | >>>,>>>,>>9.99999 | Valor Comissão Moeda | |
| vl-comis-nota-me | decimal | >>>,>>>,>>9.99999 | Vl Comissão Moeda | |
| vl-tot-iva-me | decimal | ->>>,>>>,>>>,>>9.9999 | Vl Total Imp Moeda | |
| vl-merc-tot-fat-me | decimal | ->>,>>>,>>>,>>9.99999 | Vl Total Merc Fat Moed | |
| vl-desconto-me | decimal | >>>,>>>,>>9.99999 | Vl Desconto Moeda | |
| vl-cotacao-fatur | decimal | >>>,>>>,>>9.99999 | Vl Cotação Fatur Moeda | |
| vl-cotacao-pedido | decimal | >>>,>>>,>>9.99999 | Vl Cotação Pedido Moed | |
| dt-atual-ap | date | 99/99/9999 | Dt Atualização AP | |
| nr-siscomex | character | X(20) | Nr Siscomex | |
| cod-tax-fre | integer | >>9 | Imposto Frete | |
| cod-tax-div | integer | >>9 | Imposto Diversos | |
| perc-tax-fre | decimal | >>9.99 | Percentual Imposto Fre | |
| perc-tax-div | decimal | >>9.99 | Percentual Imposto Div | |
| nr-invoice | character | X(16) | Invoice | |
| val-pct-desconto-valor | decimal | ->>9.9999 | Perc Desc Valor | |
| ind-tp-frete | integer | 9 | Tipo Frete | |
| tax-emb | decimal | ->>>,>>>,>>9.99 | Vl Imp Embalagem | |
| tax-emb-me | decimal | ->>>,>>>,>>9.99999 | Vl Imp Embalagem Moeda | |
| tax-seg | decimal | ->>>,>>>,>>9.99 | Vl Imp Seguro | |
| tax-seg-me | decimal | ->>>,>>>,>>9.99999 | Vl Imp Seguro Moeda | |
| tax-fre-me | decimal | ->>>,>>>,>>9.99999 | Vl Imp Frete Moeda | |
| tax-div-me | decimal | ->>>,>>>,>>9.99999 | Vl Imp Diversos Moeda | |
| perc-tax-emb | decimal | >>9.99 | Percentual Imposto Emb | |
| perc-tax-seg | decimal | >>9.99 | Percentual Imposto Seg | |
| cod-tax-emb | integer | >>9 | Imposto Embalagem | |
| cod-tax-seg | integer | >>9 | Imposto Seguro | |
| nome-abrev-tri | character | X(12) | Cliente Remessa Triang | |
| endereco_text | character | X(2000) | Endereço Completo | |
| refer-cr | character | x(12) | Referência Contábil | |
| desc-valor-ped | decimal | >>,>>>,>>9.99999 | Desconto por Valor | |
| desc-valor-nota | decimal | >>,>>>,>>9.99999 | Desconto por Valor | |
| val-desp-outros | decimal | ->>>,>>>,>>9.99999 | Valor Despesa Outros | |
| val-desp-outros-inf | decimal | ->>>,>>>,>>9.99999 | Valor Despesa Outros | |
| num-rma-orig | character | X(16) | RMA Origem | |
| log-estorn-comis-repres | logical | Sim/Não | Estorna Comissao Repre | |
| cod-rma | character | X(16) | Nr RMA | |
| obs-gerada | character | x(2000) | Informações Geradas | |
| cod-estab-estoq | character | x(5) | Estabel Estoque | |
| tab-ind-fin | decimal | >9.99999 | Índice | |
| log-juros-prorate | logical | Sim/Não | Juros Pro Rata | |
| log-possui-retenc | logical | Sim/Não | Possui Retenção | |
| val-desc-pis-zfm | decimal | >,>>>,>>9.99999 | Desconto PIS Zona Fran | |
| val-desc-cofins-zfm | decimal | >,>>>,>>9.99999 | Desconto COFINS Zona F | |
| idi-sit-nf-eletro | integer | >9 | Situação NF-e | |
| cod-chave-aces-nf-eletro | character | x(60) | Chave Acesso NF-e | |
| idi-forma-emis-nf-eletro | integer | >9 | Forma Emissão NF-e | |
| des-espec-volum | character | x(60) | Espécie Volumes | |
| cod-placa-2 | character | x(8) | Placa 2 | |
| cod-uf-placa-2 | character | x(8) | UF Placa 2 | |
| cod-lacre | character[2] | X(60) | Número Lacre | |
| val-iof | decimal | ->>>,>>>,>>>,>>9.99 | Valor IOF | |
| cod-protoc | character | x(15) | Protocolo | |
| num-romaneio | integer | >>>>>>>>9 | Nr Romaneio | |
| cod-usuar-contingen-nf-eletro | character | x(12) | Usuário Contingência N | |
| cod-estab-proces-export | character | x(5) | Estab Proc Exp | |
| hra-emis-nf | character | 99:99:99 | Hr Emis NF | |
| dt-atualiza | date | 99/99/9999 | Data Atualização | |
| hra-atualiz | character | 99:99:99 | Hora Atualização | |
| cod-safra | character | 9999/9999 | Safra | |
| num-cx-financ | integer | >>>>,>>9 | Caixa Financeiro | |
| num-process-negoc | integer | >>>>,>>9 | Processo Negocio | |
| cdd-embarq | deci-0 | >>>>>>>>>>>>>>>9 | Embarque | |
| log-var-cambial | logical | Sim/Não | NF Variação Cambial | |
Método:
cancelaNotaFiscal
Descrição:
Executa o cancelamento da nota fiscal, e atualização de todas as tabelas relacionadas.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-cod-estabel | Caracter |
| X |
|
| Código do Estabelecimento
|
| c-serie | Caracter | X | Código da Série | |||
| c-nr-nota-fis | Caracter | X | Número da Nota Fiscal | |||
| p-dt-cancela | Data | X | Data de Cancelamento | |||
| c-desc-motivo | Caracter | X | Motivo do Cancelamento | |||
| l-valida-dt-saida | Lógico | X | Valida data de Saída | |||
| p-reabre-resumo | Lógico | X | Reabre Resumo do Embarque | |||
| p-cancela-titulos | Lógico | X | Cancela Títulos | |||
| p-arq-estoque | Caracter | X | Arquivo Destino Atualização Estoque | |||
| p-usuario | Caracter | X | Usuário de Cancelamento |
Método:
cancelaNotaFiscalNFe
Descrição:
Executa a inutilização de uma faixa de notas fiscais, e atualização de todas as tabelas relacionadas.
Requisitos:
Nenhum
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-cod-estabel | Caracter |
| X |
|
| Código do Estabelecimento |
| c-serie | Caracter | X | Código da Série | |||
| c-nr-nota-fis-i | Caracter | X | Número da Nota Fiscal Inicial | |||
| c-nr-nota-fis-f | Caracter | X | Número da Nota Fiscal Final | |||
| p-dt-cancela | Data | X | Data de Cancelamento | |||
| c-desc-motivo | Caracter | X | Motivo do Cancelamento | |||
| l-valida-dt-saida | Lógico | X | Valida data de Saída | |||
| p-reabre-resumo | Lógico | X | Reabre Resumo do Embarque | |||
| p-cancela-titulos | Lógico | X | Cancela Títulos | |||
| p-arq-estoque | Caracter | X | Arquivo Destino Atualização Estoque | |||
| p-usuario | Caracter | X | Usuário de Cancelamento |
Método:
validaNotaFiscal
Descrição:
Verifica se a nota fiscal pode ser cancelada. Retorna NOK caso haja algum impedimento para o cancelamento da nota.
Requisitos:
Executar o método getRowErrors para retornar os erros encontrados no processo.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
c-cod-estabel | Caracter |
| X |
|
| Código do Estabelecimento |
| c-serie | Caracter | X | Código da Série | |||
| c-nr-nota-fis | Caracter | X | Número da Nota Fiscal | |||
| p-dt-cancela | Data | X | Data de Cancelamento | |||
| c-desc-motivo | Caracter | X | Motivo do Cancelamento | |||
| l-valida-dt-saida | Lógico | X | Valida data de Saída | |||
| p-reabre-resumo | Lógico | X | Reabre Resumo do Embarque | |||
| p-cancela-titulos | Lógico | X | Cancela Títulos |
Método:
getRowErrors
Descrição:
Retorna os erros encontrados durante a execução da procedure anterior.
Parâmetros:
Parâmetro | Tipo | Formato | I | O | IO | Descrição |
TowErrors | Temp Table |
|
| X |
| Temp Table de erros |
Definição da temp-table RowErrors
| RowErrors | ||||
| Atributo | Tipo | Formato | Descrição | Obr. |
| ErrorSequence | Inteiro | Sequência do Erro | ||
| ErrorNumber | Inteiro | Código do Erro | ||
| ErrorDescription | Caracter | Descrição do Erro | ||
| ErrorParameters | Caracter | Parâmetros do Erro. utilizado pelo sistema para montar a descrição quando esta possui dados do registro com erro. | ||
| ErrorType | Caracter | Tipo do erro. Valores possíveis: EMS, INTERNAL, PROGRESS, OUTROS. | ||
| ErrorHelp | Caracter | Texto de ajuda do erro. | ||
| ErrorSubType | Caracter | Subtipo do Erro. Valores possíveis: Error, Information, Warning. | ||
Método:
destroy
Descrição:
Apaga os handles utilizados no cancelamento na nota da memória da sessão. Utilizar antes de apagar o handle da bodi135cancel.
Requisitos:
Nenhum
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas