IN CadastroItensPedido.integrador: mudanças entre as edições

De CIGAM WIKI
Linha 847: Linha 847:
=== ListarModificacoes ===
=== ListarModificacoes ===
<p align="justify"><i>
<p align="justify"><i>
Método que tem por finalidade retornar através de uma faixa de datas as requisições modificadas nessa faixa no ERP CIGAM.</br></i></p>
Método que tem por finalidade retornar através de uma faixa de datas as requisições modificadas nessa faixa no ERP CIGAM.
</i></p>


*<b>Parâmetros:</b></br>
*<b>Parâmetros:</b><br>
<div style="background-color: #f2f2f2">
{{#tree: minExpandLevel=2 |
&nbsp;&nbsp;&nbsp;<b>pin:</b><br>
*pin
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: String 20<br>
** Obrigatório, Tipo: String 20


&nbsp;&nbsp;&nbsp;<b>dataInicial</b><br>
*dataInicial
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: Date<br>
** Tipo: Date


&nbsp;&nbsp;&nbsp;<b>horaInicial</b><br>
*horaInicial
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: Time<br>
** Tipo: Time 6


&nbsp;&nbsp;&nbsp;<b>dataFinal</b><br>
dataFinal
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: date<br>
Tipo: Date


&nbsp;&nbsp;&nbsp;<b>horaFinal</b><br>
horaFinal
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Obrigatório, Tipo: Time<br>
Tipo: Time 6
}}
<p align=“justify” style=“margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;”><br/>
<b>Retorno:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
*codigoPedido
** Tipo: String 12
 
*dataItem
** Tipo: Date
 
*codigoMaterial
** Tipo: String 20
 
*centroControle
** Tipo: String 2
 
*quantidade
** Tipo: Float 8.6
 
*quantidadeSaldo
** Tipo: Float 8.6
 
*codigoEspecie
** Tipo: String 1
 
*precoUnitario
** Tipo: Float 10.5
 
*documento
** Tipo: String 10
 
*serie
** Tipo: String 5
 
*nf
** Tipo: Float 10
 
*remessaDia
** Tipo: Float 8.6
 
*descricao
** Tipo: String 201
 
*codigoCliente
** Tipo: String 6
 
*atualiza
** Tipo: String 1
 
*situacao
** Tipo: String 1
 
*prazoEntrega
** Tipo: Date
 
*plano
** Tipo: Int 4
 
*pecas
** Tipo: Float 8.6
 
*saldoPecas
** Tipo: Float 8.6
 
*sequencia
** Tipo: Int 5
 
*codigoUsuarioModificacao
** Tipo: String 3
 
*codigoTipoOperacao
** Tipo: String 5
 
*cfop
** Tipo: String 6
 
*dataEmbarque
** Tipo: Date
 
*codigoContaGerencial
** Tipo: String 25
 
*incidenciaIpi
** Tipo: String 1
 
*percentualIpi
** Tipo: Float 3.2
 
*codigoOrigem
** Tipo: String 1
 
*codigoTransfCentroArmazenagem
** Tipo: String 4
 
*percentualComissao
** Tipo: Float 3.2
 
*ncm
** Tipo: Int 10
 
*percBonificacaoQuantidade
** Tipo: Float 8.6
 
*percentualDesconto
** Tipo: Float 2.4
 
*veiculo
** Tipo: String 1
 
*prioridade
** Tipo: String 1
 
*codigoMercado
** Tipo: String 2
 
*detalhe
** Tipo: String 6
 
*tabelaPrecos
** Tipo: String 6
 
*sequenciaOriginalSolicitacao
** Tipo: Int 5
 
*valorSuframaSimbahia
** Tipo: Float 8.6
 
*precoOriginal
** Tipo: Float 10.5
 
*emissaoEtiqueta
** Tipo: Date
 
*dataValidade
** Tipo: Date
 
*codigoCompradorFinal
** Tipo: String 6
 
*pedidoCliente
** Tipo: String 20
 
*stockNumber
** Tipo: String 35
 
*formaEmbarque
** Tipo: String 1
 
*prazoProgramado
** Tipo: Date
 
*dataAprovacao
** Tipo: Date
 
*lote
** Tipo: String 10
 
*dataLimiteCompraFinal
** Tipo: Date
 
*codigoFabrica
** Tipo: String 6
 
*tipoAmostra
** Tipo: String 2
 
*dataCriacaoProduto
** Tipo: Date
 
*sessao
** Tipo: Int 8
 
*peso
** Tipo: Float 8.5
 
*codigoUnidadeNegocio
** Tipo: String 3
 
*codigoCentroArmazenagem
** Tipo: String 4
 
*codigoEspecif1
** Tipo: String 6
 
*especif2
** Tipo: String 6
 
*valorDesconto
** Tipo: Float 11.2
 
*valorOutrasDespesasAcessorias
** Tipo: Float 11.2
 
*valorFrete
** Tipo: Float 11.2
 
*baseIcmsIpi
** Tipo: Bool
 
*DifAliquotaIcms
** Tipo: Float 3.2


  </div>
*numeroRomaneio
</br>
** Tipo: Float 10
{{#tree:
 
*Retorno:
*dataRomaneio
**codigoPedido                       
** Tipo: Date
**dataItem                     
 
**codigoMaterial               
*codigoContrato
**centroControle               
** Tipo: String 8
**QUANTIDADE                   
 
**quantidadeSaldo               
*quantidadeExtra
**codigoEspecie                 
** Tipo: Float 8.6
**precoUnitario                 
 
**DOCUMENTO                     
*codigoUnidadeMedida
**SERIE                         
** Tipo: String 3
**NF                           
 
**remessaDia                   
*usouConversor
**DESCRICAO                     
** Tipo: Bool
**codigoCliente                 
 
**ATUALIZA                     
*totalDespesas
**SITUACAO                     
** Tipo: Float 11.2
**prazoEntrega                 
 
**PLANO                         
*totalItemLiquido
**pecas                         
** Tipo: Float 11.2
**saldoPecas                   
 
**SEQUENCIA                     
*percentualIcms
**codigoUsuarioModificacao             
** Tipo: Float 2.4
**codigoTipoOperacao           
 
**CFOP                         
*incidenciaIcms
**dataEmbarque                 
** Tipo: String 1
**codigoContaGerencial         
 
**incidenciaIpi                 
*baseSubstituicao
**percentualIpi                 
** Tipo: Float 11.2
**codigoOrigem                 
 
**codigoTransfCentroArmazenagem               
*percentualSubstituicao
**percentualComissao           
** Tipo: Float 3.2
**NCM                           
 
**percBonificacaoQuantidade             
*percentualIrrf
**percentualDesconto           
** Tipo: Float 3.2
**VEICULO                       
 
**PRIORIDADE                   
*valorIpi
**codigoMercado                 
** Tipo: Float 11.2
**detalhe                       
 
**tabelaPrecos                 
*sequenciaBaixa
**sequenciaOriginalSolicitacao               
** Tipo: Int 8
**valorSuframaSimbahia         
 
**precoOriginal                 
*saldoReserva
**emissaoEtiqueta               
** Tipo: Float 8.6
**dataValidade                 
 
**codigoCompradorFinal         
*saldoProducao
**pedidoCliente                 
** Tipo: Float 8.6
**stockNumber                   
 
**formaEmbarque                 
*horarioPrometido
**prazoProgramado               
** Tipo: Int 8
**dataAprovacao                 
 
**LOTE                         
*dataFaturamento
**dataLimiteCompraFinal           
** Tipo: Date
**codigoFabrica                 
 
**tipoAmostra                   
*codigoIndice
**dataCriacaoProduto           
** Tipo: String 5
**sessao                       
 
**PESO                         
*codigoContabil
**codigoUnidadeNegocio         
** Tipo: String 8
**codigoCentroArmazenagem             
 
**codigoEspecif1               
*remessaSolicitacao
**especif2                     
** Tipo: String 12
**valorDesconto                 
 
**valorOutrasDespesasAcessorias                 
*codigoRetorno
**valorFrete                   
** Tipo: String 2
**baseIcmsIpi                   
 
**DifAliquotaIcms               
*largura
**numeroRomaneio               
** Tipo: String 8
**dataRomaneio                 
 
**codigoContrato               
*grade
**quantidadeExtra               
** Tipo: String 2
**codigoUnidadeMedida           
 
**usouConversor                 
*codigoUsuarioCriacao
**totalDespesas                 
** Tipo: String 3
**totalItemLiquido             
 
**percentualIcms               
*dataModificacao
**incidenciaIcms               
** Tipo: Date
**baseSubstituicao             
 
**percentualSubstituicao         
*dataCadastro
**percentualIrrf               
** Tipo: Date
**valorIpi                     
 
**sequenciaBaixa               
*legendaMedidaProvisorioDoBem
**saldoReserva                 
** Tipo: Date
**saldoProducao                 
 
**horarioPrometido             
*horaEntrega
**dataFaturamento               
** Tipo: Int 8
**codigoIndice                 
 
**codigoContabil               
*excecaoNcm
**remessaSolicitacao           
** Tipo: String 6
**codigoRetorno                 
 
**LARGURA                       
*itemOs
**GRADE                         
** Tipo: String 6
**codigoUsuarioCriacao         
 
**dataModificacao               
*complementoIncidenciaIcms
**dataCadastro                 
** Tipo: String 1
**legendaMedidaProvisorioDoBem                         
 
**horaEntrega                   
*tipoPedido
**excecaoNcm                   
** Tipo: String 1
**itemOs                       
 
**complementoIncidenciaIcms             
*remessaGerada
**tipoPedido                   
** Tipo: String 1
**remessaGerada                 
 
**explodiuItemComercial         
*explodiuItemComercial
**naoMovimentaEstoque           
** Tipo: String 1
**codigoUnidadeNegocioTransfer               
 
**prazoFinanceiro               
*naoMovimentaEstoque
**ultimaSequenciaBaixa           
** Tipo: String 2
**gerouDuplicatasItensPedido             
 
**buscarRegraFiscal             
*codigoUnidadeNegocioTransfer
**entregaMercadoriaAposFatura               
** Tipo: String 3
**reducaoIcms                   
 
**percentualIcmsSubstituicao             
*prazoFinanceiro
**ordemServico                 
** Tipo: String 3
**percentualMargemLucro             
 
**demandaGeral                 
*ultimaSequenciaBaixa
**entrega                       
** Tipo: String 5
**remessaProdutoCliente         
 
**USRITPE1                     
*gerouDuplicatasItensPedido
**USRITPE2                     
** Tipo: Bool
**USRITPE3                     
 
**USRITPE4                     
*buscarRegraFiscal
**valorIcms                     
** Tipo: Bool
**valorEncargoFinanceiro         
 
**CONTROLE                     
*entregaMercadoriaAposFatura
**impedimento1                 
** Tipo: Bool
**impedimento2                 
 
**impedimento3                 
*reducaoIcms
**impedimento4                 
** Tipo: Float 3.5
**tipoBaixa                     
 
**gerouNfRoyalty               
*percentualIcmsSubstituicao
**valorBaseSubstituicao         
** Tipo: Float 8.6
 
*ordemServico
** Tipo: Float 11.2
 
*percentualMargemLucro
** Tipo: Float 11.2
 
*demandaGeral
** Tipo: Float 11
 
*entrega
** Tipo: String 12
 
*remessaProdutoCliente
** Tipo: String 20
 
*usritpe1
** Tipo: String 10
 
*usritpe2
** Tipo: String 20
 
*usritpe3
** Tipo: Date
 
*usritpe4
** Tipo: Float 11.2
 
*valorIcms
** Tipo: Float 11.2
 
*valorEncargoFinanceiro
** Tipo: Float 11.2
 
*controle
** Tipo: String 2
 
*impedimento1
** Tipo: String 1
 
*impedimento2
** Tipo: String 1
 
*impedimento3
** Tipo: String 1
 
*impedimento4
** Tipo: String 1
 
*tipoBaixa
** Tipo: String 1
 
*gerouNfRoyalty
** Tipo: Bool
 
*valorBaseSubstituicao
** Tipo: Float 8.6
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retornos:</b><br/>
<b>Retornos:</b><br/>
Linha 1 008: Linha 1 267:
<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>


=== ListarPendentes ===
=== ListarPendentes ===

Edição das 13h58min de 17 de fevereiro de 2022

Cadastrar

  • Parâmetros:


Retorno:
   Se sucesso:
      idRegistro - ID que representa este registro na tabela de integração.

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se algum parâmetro inválido:
      Parâmetro necessário não informado.

ListarId

Método que tem por finalidade retornar os códigos de pedidos e sequencia cadastradas no ERP CIGAM.

  • Parâmetros:


Retorno:
   Se sucesso:

   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

ListarIndividual

Método que tem por finalidade retornar através do código do pedido e sequencia as informações cadastradas no ERP CIGAM.

  • Parâmetros:


Retorno:
   Se sucesso:


Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

ListarModificacoes

Método que tem por finalidade retornar através de uma faixa de datas as requisições modificadas nessa faixa no ERP CIGAM.

  • Parâmetros:

dataFinal Tipo: Date horaFinal Tipo: Time 6


Retorno:
   Se sucesso:


Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se nenhum registro encontrado:
      A consulta não retornou nenhum registro.

ListarPendentes

Método que tem por finalidade retornar o ID dos registros que contenham a ação de Cadastrar ou Excluir e tenham o status de Liberado para Integração ou Pendente para Integração, conforme for indicado nos parâmetros.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   acao
      Obrigatório, Tipo: String 1
      C=Cadastrar, E=Excluir
      Se for informado algo diferente de C ou E não será aplicado nenhum filtro.

   statusRegistro
      Obrigatório, Tipo: String 1
      L=Liberado, P=Pendente
      Se for informado algo diferente de P ou L não será aplicado nenhum filtro.


  • Exemplo de Retorno:
    • idRegistro
    • acao
    • statusRegistro
    • dataRequisicao
    • horaRequisicao
    • idCorrelato
    • codigoPedido
    • dataItem
    • codigoMaterial
    • situacao
    • codigoTipoOperacao

LiberarPendentes

Método que tem por finalidade liberar registros que contenham o status 'P' (Pendente para Integração), conforme ID informado nos parâmetros.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   id
      Obrigatório, Tipo: int

   liberarCorrelatos
      Tipo: bool


Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se erro na conexão com banco de dados:
      A conexão com o banco de dados e/ou comando SQL possui erros.

   Se ID inválido ou não encontrado:
      Falha ao liberar registro.

   Se Sucesso:
      Sucesso.

Visualizar

Método que tem por finalidade o retorno de dados do item do pedido indicado nos parâmetros.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   codigoPedido
      Obrigatório, Tipo: string 12

   sequencia
      Obrigatório, Tipo: int 5

Excluir

Método que tem por finalidade excluir o item conforme o código do pedido e sequencia indicados.

  • Parâmetros:

   pin:
      Obrigatório, Tipo: String 20

   codigoPedido:
      Tipo: String 12

   sequencia:
      Tipo: int 5



Retornos:
   Se pin inválido:
      O usuário não possui direitos suficientes para executar esta rotina.

   Se erro na conexão com banco de dados:
      A conexão com o banco de dados e/ou comando SQL possui erros.

   Se ID inválido ou não encontrado:
      Falha ao excluir registro.

   Se Sucesso:
      Sucesso.