Ocorrência:

Documentação de BO

Requisito

Documento Origem Nota Entrada

Sintaxe

CancelaDocumento in h-handle (input  pr-nota)

Descrição

Realiza o cancelamento do documento do conversor de NF-e

Parâmetros

Descrição

pr-nota

Rowid do documento a ser cancelado

Retorno

A BO irá retornar “OK”.

Requisito

Documento Origem Nota Entrada

Sintaxe

reprocessaNota in h-handle (input  pr-nota,

                            output l-ok)

Descrição

Realiza o reprocessa do documento origem (NF-e) para o recebimento fiscal

Parâmetros

Descrição

pr-nota

l-ok

Rowid do documento a ser reprocessado

Indica se o processamento da nota ocorreu com sucesso

Retorno

O retorno do processamento deve ser verificado através do “l-ok”.

Requisito

Documento Origem Nota Entrada

Sintaxe

processaFisico in h-handle (input  pr-nota,

                            output l-erro-doc-proc-fis,

                            output l-erro-item-proc-fis,

                            output l-erro-rat-proc-fis,

                            output l-warning)

Descrição

Realiza o processamento do documento origem (NF-e) para o recebimento físico

Parâmetros

Descrição

pr-nota

l-erro-doc-proc-fis

l-erro-item-proc-fis

l-erro-rat-proc-fis

l-warning

Rowid do documento a ser processado

Indica erro no processamento do documento

Indica erro no processamento no item do documento

Indica erro no processamento do rateio

Indica presença de warnings no processamento

Retorno

O retorno do processamento deve ser verificado através dos “outputs” detalhados anteriormente.

Sintaxe

setConstranintDocumento in h-handle(input  p-chave-acesso,

                                    input  p-idi-origem)

Descrição

Seta as restrições por documento

Parâmetros

Descrição

p-chave-acesso

p-idi-origem

Chave de acesso do documento

Origem do documento

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

Requisito

A setConstraintDocumento ter sido executada anteriormente.

Sintaxe

run openQueryDocumento in h-handle.

Descrição

Parâmetros

Descrição

Não Contém

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

Sintaxe

setConstranintDocumentosDoc in h-handle(input  p-nro-docto-ini,

                                        input  p-nro-docto-fim,

                                        input  p-serie-docto-ini,                      

                                        input  p-serie-docto-fim,                             

                                        input  p-nat-operacao-ini,   

                                        input  p-nat-operacao-fim,

                                        input  p-dt-emissao-ini,                    

                                        input  p-dt-emissao-fim,            

                                        input  p-dt-transacao-ini,      

                                        input  p-dt-transacao-fim,      

                                        input  p-ch-acesso-nfe)                                               

Descrição

Seta as restrições por faixas

Parâmetros

Descrição

p-nro-docto-ini

p-nro-docto-fim

p-serie-docto-ini

p-serie-docto-fim

p-nat-operacao-ini                                      

p-nat-operacao-fim 

p-dt-emissao-ini                                                         

p-dt-emissao-fim                                                 

p-dt-transacao-ini     

p-dt-transacao-fim

p-ch-acesso-nfe                         

Número do documento inicial

Número do documento final

Série do documento inicial

Sério do documento final

Natureza de operação inicial

Natureza de operação final

Data de emissão inicial

Data de emissão final

Data de transação inicial

Data de transação final

Chave de acesso da NF-e

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

Requisito

A setConstraintDocumentosDoc ter sido executada anteriormente.

Sintaxe

run openQueryDocumentosDoc in h-handle.

Descrição

Parâmetros

Descrição

Não Contém

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

Sintaxe

setConstranintMonitor in h-handle(input  l-digitada,

                                  input  l-digit-fisico,

                                  input  l-erro-neg,

                                  input  l-atualizada,

                                  input  l-elimininda,

                                  input  l-cancelada,

                                  input  l-atualizada-fisico,

                                  input  l-inutilizada,

                                  input  l-validacao,

                                  input  p-cod-emitente-ini,

                                  input  p-cod-emitente-fim,

                                  input  p-cod-estabel-ini,

                                  input  p-cod-estabel-fim,

                                  input  p-serie-ini,

                                  input  p-serie-fim,

                                  input  p-nro-docto-ini,

                                  input  p-nro-docto-fim,

                                  input  p-dt-emissao-ini,

                                  input  p-dt-emissao-fim,

                                  input  p-idi-orig-trad)

Descrição

Seta as restrições para o monitor de notas

Parâmetros

Descrição

l-digitada

l-digit-fisico

l-erro-neg

l-atualizada

l-eliminada

l-cancelada

l-atualizada-fisico

l-inutilizada

l-validacao

p-cod-emitente-ini

p-cod-emitente-fim

p-cod-estabel-ini

p-cod-estabel-fim

p-serie-ini

p-serie-fim

p-nro-docto-ini

p-nro-docto-fim

p-dt-emissao-ini

p-dt-emissao-fim

p-idi-orig-trad

Apresentar notas digitadas no recebimento fiscal

Apresentar notas digitadas no recebimento físico

Apresentar notas com erro de negócio

Apresentar notas atualizadas no recebimento fiscal

Apresentar notas eliminadas

Apresentar notas canceladas

Apresentar notas atualizas no recebimento físico

Apresentar notas inutilizadas

Apresentar notas em validação

Código do emitente inicial a ser apresentado

Código do emitente final a ser apresentado

Código do estabelecimento inicial a ser apresentado

Código do estabelecimento final a ser apresentado

Série inicial dos documentos a serem apresentados

Série final dos documentos  a serem apresentados

Número do documento inicial a ser apresentado

Número do documento final a ser apresentado 

Data de emissão inicial das notas a serem apresentadas

Data de emissão final das notas a serem apresentadas

Origem dos documentos a serem apresentados   

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.

Requisito

A setConstraintMonitor ter sido executada anteriormente.

Sintaxe

run openQueryMonitor in h-handle.

Descrição

Parâmetros

Descrição

Não Contém

Retorno

A API/BO irá setar o return-value de forma a informar ao programa “chamador” se a execução foi realizada com sucesso ou não. Os valores possíveis para o return-value são: OK (execução correta) e NOK (execução com problemas). Os motivos para a rejeição do movimento de reporte são especificados na temp-table RowErrors.