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

De CIGAM WIKI
Linha 4 240: Linha 4 240:


==== VisualizarPedidoWeb ====
==== VisualizarPedidoWeb ====
<p align="justify"><i>
</i></p>
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Tipo: String 20
*codigoPedido
** Tipo: String 12
}}
<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/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
*codigoPedido
** Tipo: String 12
*codigoTipoOperacao
** Tipo: String 5
*tipoOperacao
** Tipo: String 60
*dataPedido
** Tipo: Date
*Via_transporte
** Tipo: String 1
*descricaoViaTransporte
** Tipo: String 60
*codigoCliente
** Tipo: String 6
*nomeCliente
** Tipo: String 60
*cpfCnpjCliente
** Tipo: String 14
*fantasiaCliente
** Tipo: String 40
*codigoCobranca
** Tipo: String 6
*nomeCobranca
** Tipo: String 60
*fantasiaCobranca
** Tipo: String 40
*codigoRepresentante
** Tipo: String 6
*nomeRepresentante
** Tipo: String 60
*fantasiaRepresentante
** Tipo: String 40
*percDescontoAteVencimento
** Tipo: Float 8.6
*valorTotalEncargosFinanceiros
** Tipo: Float 11.2
*percDescontoSugestaoItens
** Tipo: Float 8.6
*valorTotalDesconto
** Tipo: Float 11.2
*percGeralOutrasDespAcessorias
** Tipo: Float 8.6
*valorTotalFrete
** Tipo: Float 11.2
*valorTotalOutrasDespAcessorias
** Tipo: Float 11.2
*totalPedido
** Tipo: Float 11.2
*codigoTransportadora
** Tipo: String 6
*nomeTransportadora
** Tipo: String 60
*fantasiaTransportadora
** Tipo: String 40
*codigoConsignatario
** Tipo: String 6
*marca
** Tipo: String 12
*volume
** Tipo: String 15
*quantidade
** Tipo: Float 8.6
*especie
** Tipo: String 16
*pesoLiquido
** Tipo: Float 8.5
*pesoBruto
** Tipo: Float 8.5
*codigoConta
** Tipo: String 6
*codigoPortador
** Tipo: String 3
*percGeralEncargosFinanceiros
** Tipo: Float 8.6
*itensNoPedido
** Tipo: Int 5
*totalMercadorias
** Tipo: Float 11.2
*prazoEntrega
** Tipo: Date
*prazoProgramado
** Tipo: Date
*percentualGeralDesconto
** Tipo: Float 8.6
*valorInfOutrasDespAcessorias
** Tipo: Float 11.2
*comprador
** Tipo: String 20
*prazoProgramado1
** Tipo: Date
*descricaoViaTransporte1
** Tipo: String 60A
*codigoUsuarioModificacao
** Tipo: String 3
*codigoMercado
** Tipo: String 3
*dataCadastro
** Tipo: Date
*horaCadastro
** Tipo: Int 6
*dataAprovacao
** Tipo: Date
*horaAprovacao
** Tipo: Int 6
*dataEntrega
** Tipo: Date
*horaEntrega
** Tipo: Int 6
*dataLiberacao
** Tipo: Date
*horaLiberacao
** Tipo: Int 6
*dataValidade
** Tipo: Date
*valorIpi
** Tipo: Float 11.2
*tipoFrete
** Tipo: String 1
*notaFiscal
** Tipo: Float 10
*codigoOrdemCompra
** Tipo: String 12
*observacao
** Tipo: String 251
*embarque
** Tipo: String 40
*destino
** Tipo: String 40
*viaEmbarque
** Tipo: String 40
*codigoCondicaoPagamento
** Tipo: String 3
*descricaoCondicaoPagamento
** Tipo: String 40
*fatura
** Tipo: Float 10
*complementoFatura
** Tipo: String 5
*percentualEmissao
** Tipo: Float 8.6
*tipoProduto
** Tipo: String 1
*codigoNimexe
** Tipo: String 25
*pedidoAmostra
** Tipo: String 12
*codigoIndice
** Tipo: String 5
*codigoUnidadeNegocio
** Tipo: String 3
*nomeUnidadeNegocio
** Tipo: String 60
*fantasiaUnidadeNegocio
** Tipo: String 40
*impresso
** Tipo: Bool
*alteracaoFt
** Tipo: Bool
*seguro
** Tipo: Float 11.2
*codigoCancelamento
** Tipo: String 3
*quantidadeTotal
** Tipo: Float 8.6
*horaProgramada
** Tipo: Int 6
*codigoPedidoExterno
** Tipo: String 12
*projeto
** Tipo: String 12
*prioridade
** Tipo: String 1
*codigoTipoPagamento
** Tipo: String 2
*dataFaturado
** Tipo: Date
*horaFaturado
** Tipo: Int 6
*valorIcms
** Tipo: Float 11.2
*valorIrrf
** Tipo: Float 11.2
*valorIss
** Tipo: Float 11.2
*incluiSubstituicaoTributaria
** Tipo: String 1
*regraFrete
** Tipo: String 1
*percentualFreteInformativo
** Tipo: Float 8.6
*codigoContatoCliente
** Tipo: Int 8
*grade
** Tipo: String 2
*codigoUsuarioCriacao
** Tipo: String 3
*dataMovimentacao
** Tipo: Date
*dataInicioProducao
** Tipo: Date
*dataFaturamento
** Tipo: Date
*dataExpedicao
** Tipo: Date
*fornecedor
** Tipo: String 6
*despachante
** Tipo: String 6
*tgConversaoUnidades
** Tipo: String 6
*evento
** Tipo: String 6
*incidenciaIss
** Tipo: String 1
*ordemEnderecoEntrega
** Tipo: String 1
*ordemEnderecoCobranca
** Tipo: String 1
*origemPedido
** Tipo: String 2
*prazoBonificacao
** Tipo: String 2
*usuarioAutorizado
** Tipo: String 3
*entregaMercadoriaAposFaturar
** Tipo: String 3
*pedidoInconsistente
** Tipo: Bool
*gerouFaturamento
** Tipo: Bool
*buscarRegraFiscal
** Tipo: Bool
*percentualIrrf
** Tipo: Float
*totalItensBaixados
** Tipo: Float
*percentualMargemLucro
** Tipo: Float
*percIcmsResponsabilidade
** Tipo: Float 8.6
*vendasContato
** Tipo: Float 11.2
*percentualComissaoReceber
** Tipo: Float 8.6
*valorInfDesconto
** Tipo: Float 11.2
*valorSuframaSimbahia
** Tipo: Float 11.2
*usrpedi1
** Tipo: String 20
*usrpedi2
** Tipo: Bool
*usrpedi3
** Tipo: Float 11.2
*controle
** Tipo: String 2
*descricaoControle
** Tipo: String 60
*baseIcms
** Tipo: Float 11.2
*baseIpi
** Tipo: Float 11.2
*baseIss
** Tipo: Float 11.2
*valorDescontoDuplicata
** Tipo: Float 11.2
*cobrarPauta
** Tipo: String 1
*remessa
** Tipo: String 3
*placa
** Tipo: String 7
*totalFaturado
** Tipo: Float 11.2
*totalServicos
** Tipo: Float 11.2
*baseSubstituicaoTributaria
** Tipo: Float 11.2
*valorSubstituicaoTributaria
** Tipo: Float 11.2
*valorInss
** Tipo: Float 11.2
*taxaIndexador
** Tipo: Float 10.5
*indiceIndexador
** Tipo: String 5
*baseIrrf
** Tipo: Float 11.2
*ufPlacaTransportador
** Tipo: String 2
*percentualAcrescimoPreco
** Tipo: Float 8.6
*valorFunrural
** Tipo: Float 11.2
*pedRemessaContaOrdTerceiros
** Tipo: Bool
*percentualIss
** Tipo: Float 8.6
*percentualInss
** Tipo: Float 8.6
*tipoNota
** Tipo: String 1
*dataIem
** Tipo: Date
*codigoMaterial
** Tipo: String 20
*codigoGrupo
** Tipo: String 3
*codigoSubGrupo
** Tipo: String 3
*centroControle
** Tipo: String 2
*descricaoMaterial
** Tipo: String 60
*codigoUnidadeMedida
** Tipo: String 3
*codigoContaGerencial
** Tipo: String 25
*referencia
** Tipo: String 10
*codigoReduzido
** Tipo: Int 6
*quantidadeMaxima
** Tipo: Float 8.6
*utilizaGrade
** Tipo: String 1
*grade1
** Tipo: String 2
*quantidadeItem
** Tipo: Float 8.6
*quantidadeSaldoItem
** Tipo: Float 8.6
*codigoEspecie
** Tipo: String 16
*precoUnitario
** Tipo: Float 11.2
*sequenciaItem
** Tipo: Int 4
*codigoTipoOperacao1
** Tipo: String 5
*precoTabela
** Tipo: String 6
*valorDesconto
** Tipo: Float 11.2
*codigoNumeracao
** Tipo: String 5
*quantidadeGrade
** Tipo: Float 8.6
*quantidadeSaldoGrade
** Tipo: Float 8.6
*sequenciaGrade
** Tipo: Int 5
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/></p>
==== Excluir ====
==== Excluir ====
<p align="justify"><i></i></p>
<p align="justify"><i></i></p>

Edição das 18h48min de 23 de novembro de 2021

Cadastrar

  • Parâmetros:


Retornos:
   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

  • Parâmetros:


Retornos:
   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

  • Parâmetros:


Retornos:
   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.

ListarModificacoes

  • Parâmetros:


Retornos:
   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.

ListarPendentes

  • Parâmetros:


Retornos:
   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.

LiberarPendentes

  • Parâmetros:


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.

ListarPedidos

  • Parâmetros:


Retornos:
   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.

ListarPedidosCompleto

Os dados do Pedidos serão listados em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.

  • Parâmetros:


Retornos:
   Se sucesso:

  • Parâmetros para o elemento pedido:
  • Parâmetros para o elemento tipoOperacao:
  • Parâmetros para o elemento unidadeNegocio:
  • Parâmetros para o elemento cliente:
  • Parâmetros para o elemento cobranca:
  • Parâmetros para o elemento representante:
  • Parâmetros para o elemento transportadora:
  • Parâmetros para o elemento consignatario:
  • Parâmetros para o elemento fornecedorEmpresa:
  • Parâmetros para o elemento despachanteEmpresa:
  • Parâmetros para o elemento regiaoMercado:
  • Parâmetros para o elemento contatoEmpresa:
  • Parâmetros para o elemento impostos:
  • Parâmetros para o elemento material:
  • Parâmetros para o elemento compradorFinal:
  • Parâmetros para o elemento unidadeNegocioTransf:
  • Parâmetros para o elemento centroArmazenagem:
  • Parâmetros para o elemento centroArmazenagemTransf:
  • Parâmetros para o elemento tabelaPreco:
  • Parâmetros para o elemento contaGerencial:
  • Parâmetros para o elemento controleItem:
  • Parâmetros para o elemento especif1:
  • Parâmetros para o elemento Lancamento:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


   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.

ListarPedidosPorRepresentante

  • Parâmetros:


Retornos:
   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.

CadastrarPedidos

Cadastra pedidos, itens e grades em uma única requisição. Os dados do Pedido deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir.

  • Parâmetros:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


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

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

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

VisualizarPedidoWeb

  • Parâmetros:


Retornos:
   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.

Excluir

  • Parâmetros:


Retornos:
   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.