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

De CIGAM WIKI
Linha 427: Linha 427:
</p>
</p>


=== ListarIndividual ===
== ListarIndividual ==
<p align="justify"><i>
<p align="justify"><i>
Método que tem por finalidade retornar através do código do pedido e sequencia as informações cadastradas no ERP CIGAM.</br></i></p>
Método que tem por finalidade retornar através do código do pedido e sequencia as informações cadastradas 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>codigoPedido:</b><br>
*codigoPedido
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tipo: String 12<br>
** Obrigatório, Tipo: String 12


&nbsp;&nbsp;&nbsp;<b>sequencia:</b><br>
*sequencia
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Tipo: int 5<br>
** Obrigatório, Tipo: int 5
  </div>
}}
</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>Exemplo:</b></br>
<b>Retorno:</b><br/>
{{#tree:  
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
*Retorno:
{{#tree: minExpandLevel=2 |
**codigoPedido                   
*codigoPedido
**dataItem                      
** Tipo: String 12
**codigoMaterial                        
 
**centroControle                
*dataItem
**QUANTIDADE                     
** Tipo: Date
**quantidadeSaldo                
 
**codigoEspecie                  
*codigoMaterial
**precoUnitario                  
** Tipo: String 20
**DOCUMENTO                     
 
**SERIE                         
*centroControle
**NF                             
** Tipo: String 2
**remessaDia                    
 
**DESCRICAO                     
*quantidade
**codigoCliente                  
** Tipo: Float 8.6
**ATUALIZA                       
 
**SITUACAO                       
*quantidadeSaldo
**prazoEntrega                      
** Tipo: Float 8.6
**PLANO                         
 
**pecas                          
*codigoEspecie
**saldoPecas                    
** Tipo: String 1
**SEQUENCIA                     
 
**codigoUsuarioModificacao                          
*precoUnitario
**codigoTipoOperacao                      
** Tipo: Float 10.5
**CFOP                           
 
**dataEmbarque                  
*documento
**codigoContaGerencial                    
** Tipo: String 10
**incidenciaIpi                  
 
**percentualIpi                  
*serie
**codigoOrigem                  
** Tipo: String 5
**codigoTransfCentroArmazenagem                            
 
**percentualComissao                  
*nf
**NCM                           
** Tipo: Float 10
**percBonificacaoQuantidade                          
 
**percentualDesconto                  
*remessaDia
**VEICULO                       
** Tipo: Float 8.6
**PRIORIDADE                     
 
**codigoMercado                  
*descricao
**detalhe                        
** Tipo: String 201
**tabelaPrecos                  
 
**sequenciaOriginalSolicitacao                            
*codigoCliente
**valorSuframaSimbahia                    
** Tipo: String 6
**precoOriginal                  
 
**emissaoEtiqueta                  
*atualiza
**dataValidade                  
** Tipo: String 1
**codigoCompradorFinal                                        
 
**pedidoCliente                                
*situacao
**stockNumber                              
** Tipo: String 1
**formaEmbarque                                
 
**prazoProgramado                                            
*prazoEntrega
**dataAprovacao                                          
** Tipo: Date
**LOTE                           
 
**dataLimiteCompraFinal                                            
*plano
**codigoFabrica                                
** Tipo: Int 4
**tipoAmostra                              
 
**dataCriacaoProduto                                          
*pecas
**sessao                                
** Tipo: Float 8.6
**PESO                           
 
**codigoUnidadeNegocio                                        
*saldoPecas
**codigoCentroArmazenagem                                            
** Tipo: Float 8.6
**codigoEspecif1                                  
 
**especif2                            
*sequencia
**valorDesconto                                      
** Tipo: Int 5
**valorOutrasDespesasAcessorias                                    
 
**valorFrete                              
*codigoUsuarioModificacao
**baseIcmsIpi                                
** Tipo: String 3
**DifAliquotaIcms                                    
 
**numeroRomaneio                                  
*codigoTipoOperacao
**dataRomaneio                                    
** Tipo: String 5
**codigoContrato                                  
 
**quantidadeExtra                                    
*cfop
**codigoUnidadeMedida                                          
** Tipo: String 6
**usouConversor                                  
 
**totalDespesas                                    
*dataEmbarque
**totalItemLiquido                                      
** Tipo: Date
**percentualIcms                                    
 
**incidenciaIcms                                  
*codigoContaGerencial
**baseSubstituicao                                    
** Tipo: String 25
**percentualSubstituicao            
 
**percentualIrrf                    
*incidenciaIpi
**valorIpi                          
** Tipo: String 1
**sequenciaBaixa                    
 
**saldoReserva                      
*percentualIpi
**saldoProducao                    
** Tipo: Float 3.2
**horarioPrometido                        
 
**dataFaturamento                      
*codigoOrigem
**codigoIndice                      
** Tipo: String 1
**codigoContabil                    
 
**remessaSolicitacao                      
*codigoTransfCentroArmazenagem
**codigoRetorno                    
** Tipo: String 4
**LARGURA                           
 
**GRADE                             
*percentualComissao
**codigoUsuarioCriacao                          
** Tipo: Float 3.2
**dataModificacao                            
 
**dataCadastro                      
*ncm
**legendaMedidaProvisorioDoBem                                          
** Tipo: Int 10
**horaEntrega                      
 
**excecaoNcm                        
*percBonificacaoQuantidade
**itemOs                            
** Tipo: Float 8.6
**complementoIncidenciaIcms                              
 
**tipoPedido                        
*percentualDesconto
**remessaGerada                    
** Tipo: Float 2.4
**explodiuItemComercial                        
 
**naoMovimentaEstoque                      
*veiculo
**codigoUnidadeNegocioTransfer                                
** Tipo: String 1
**prazoFinanceiro                    
 
**ultimaSequenciaBaixa                            
*prioridade
**gerouDuplicatasItensPedido                              
** Tipo: String 1
**buscarRegraFiscal                      
 
**entregaMercadoriaAposFatura                                
*codigoMercado
**reducaoIcms                      
** Tipo: String 2
**percentualIcmsSubstituicao                              
 
**ordemServico                      
*detalhe
**percentualMargemLucro                          
** Tipo: String 6
**demandaGeral                      
 
**entrega                          
*tabelaPrecos
**remessaProdutoCliente                        
** Tipo: String 6
**USRITPE1                         
 
**USRITPE2                         
*sequenciaOriginalSolicitacao
**USRITPE3                         
** Tipo: Int 5
**USRITPE4                         
 
**valorIcms                        
*valorSuframaSimbahia
**valorEncargoFinanceiro                              
** Tipo: Float 8.6
**CONTROLE                         
 
**impedimento1                      
*precoOriginal
**impedimento2                      
** Tipo: Float 10.5
**impedimento3                      
 
**impedimento4                      
*emissaoEtiqueta
**tipoBaixa                        
** Tipo: Date
**gerouNfRoyalty                    
 
**valorBaseSubstituicao                          
*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
 
*numeroRomaneio
** Tipo: Float 10
 
*dataRomaneio
** Tipo: Date
 
*codigoContrato
** Tipo: String 8
 
*quantidadeExtra
** Tipo: Float 8.6
 
*codigoUnidadeMedida
** Tipo: String 3
 
*usouConversor
** Tipo: Bool
 
*totalDespesas
** Tipo: Float 11.2
 
*totalItemLiquido
** Tipo: Float 11.2
 
*percentualIcms
** Tipo: Float 2.4
 
*incidenciaIcms
** Tipo: String 1
 
*baseSubstituicao
** Tipo: Float 11.2
 
*percentualSubstituicao
** Tipo: Float 3.2
 
*percentualIrrf
** Tipo: Float 3.2
 
*valorIpi
** Tipo: Float 11.2
 
*sequenciaBaixa
** Tipo: Int 8
 
*saldoReserva
** Tipo: Float 8.6
 
*saldoProducao
** Tipo: Float 8.6
 
*horarioPrometido
** Tipo: Int 8
 
*dataFaturamento
** Tipo: Date
 
*codigoIndice
** Tipo: String 5
 
*codigoContabil
** Tipo: String 8
 
*remessaSolicitacao
** Tipo: String 12
 
*codigoRetorno
** Tipo: String 2
 
*largura
** Tipo: String 8
 
*grade
** Tipo: String 2
 
*codigoUsuarioCriacao
** Tipo: String 3
 
*dataModificacao
** Tipo: Date
 
*dataCadastro
** Tipo: Date
 
*legendaMedidaProvisorioDoBem
** Tipo: Date
 
*horaEntrega
** Tipo: Int 8
 
*excecaoNcm
** Tipo: String 6
 
*itemOs
** Tipo: String 6
 
*complementoIncidenciaIcms
** Tipo: String 1
 
*tipoPedido
** Tipo: String 1
 
*remessaGerada
** Tipo: String 1
 
*explodiuItemComercial
** Tipo: String 1
 
*naoMovimentaEstoque
** Tipo: String 2
 
*codigoUnidadeNegocioTransfer
** Tipo: String 3
 
*prazoFinanceiro
** Tipo: String 3
 
*ultimaSequenciaBaixa
** Tipo: String 5
 
*gerouDuplicatasItensPedido
** Tipo: Bool
 
*buscarRegraFiscal
** Tipo: Bool
 
*entregaMercadoriaAposFatura
** Tipo: Bool
 
*reducaoIcms
** Tipo: Float 3.5
 
*percentualIcmsSubstituicao
** 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/>
Linha 583: Linha 843:
<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>


=== ListarModificacoes ===
=== ListarModificacoes ===

Edição das 13h51min 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:

   pin:
      Obrigatório, Tipo: String 20

   dataInicial
      Obrigatório, Tipo: Date

   horaInicial
      Obrigatório, Tipo: Time

   dataFinal
      Obrigatório, Tipo: date

   horaFinal
      Obrigatório, Tipo: Time



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.