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

De CIGAM WIKI
← Edição anteriorEdição posterior →
Camila.Oliveira (discussão | contribs)
Administradores da interface, Administradores
5 242 edições
Linha 2 950: Linha 2 950:


==== ListarPedidosPorRepresentante ====
==== ListarPedidosPorRepresentante ====
<p align="justify"><i>
</i></p>
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
*CodigoRepresentante
** Tipo: String 6
*controleInicial
** Tipo: String 2
*controleFinal
** Tipo: String 2
*situacaoInicial
** Tipo: String 1
** A=Aprovado, C=Cancelado, F=Faturado, L=Liberado, O=Orçamento, P=Pendente, S=Simulação
*situacaoFinal
** Tipo: String 1
** A=Aprovado, C=Cancelado, F=Faturado, L=Liberado, O=Orçamento, P=Pendente, S=Simulação
*dataInicial
** Tipo: Date
*horaInicial
** Tipo: Time 6
*dataFinal
** Tipo: Date
*horaFinal
** 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>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
*codigoPedido
** Tipo: String 12
*codigoTipoOperacao
** Tipo: String 5
*descricaoTipoOperacao
** Tipo: String 40
*dataPedido
** Tipo: Date
*viaTransporte
** Tipo: String 1
*colecao
** Tipo: String 6
*codigoCliente
** Tipo: String 6
*nomeCompletoCliente
** Tipo: String 60
*codigoCobranca
** Tipo: String 6
*codigoRepresentante
** Tipo: String 6
*nomeCompletoRepresentante
** Tipo: String 60
*percDescontoAteVencimento
** Tipo: Float 3.2
*valorTotalEncargosFinanceiros
** Tipo: Float 11.2
*percDescontoSugestaoItens
** Tipo: Float 3.2
*valorTotalDesconto
** Tipo: Float 11.2
*percGeralOutrasDespAcessorias
** Tipo: Float 3.2
*valorTotalFrete
** Tipo: Float 11.2
*valorTotalOutrasDespAcessorias
** Tipo: Float 11.2
*totalPedido
** Tipo: Float 13.2
*codigoTransportadora
** Tipo: String 6
*nomeCompletoTransportadora
** Tipo: String 60
*codigoConsignatario
** Tipo: String 6
*marca
** Tipo: String 12
*volume
** Tipo: String 15
*quantidade
** Tipo: String 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 3.2
*itensNoPedido
** Tipo: Int 5
*totalMercadorias
** Tipo: Float 13.2
*prazoEntrega
** Tipo: Date
*prazoProgramado
** Tipo: Date
*percentualGeralDesconto
** Tipo: Float 3.2
*valorInfOutrasDespAcessorias
** Tipo: Float 3.2
*comprador
** Tipo: String 20
*situacao
** Tipo: String 1
*descricaoSituacao
** Tipo: String 10
*codigoUsuarioModificacao
** Tipo: String 3
*codigoMercado
** Tipo: String 2
*dataCadastro
** Tipo: Date
*horaCadastro
** Tipo: Int 8
*dataAprovacao
** Tipo: Date
*horaAprovacao
** Tipo: Int 8
*dataEntrega
** Tipo: Date
*horaEntrega
** Tipo: Int 8
*dataLiberacao
** Tipo: Date
*horaLiberacao
** Tipo: Int 8
*dataValidade
** Tipo: Date
*valorIpi
** Tipo: Float 11.2
*tipoFrete
** Tipo: String 1
*notaFiscal
** Tipo: Float 10.0
*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 60
*fatura
** Tipo: Float 10.0
*complementoFatura
** Tipo: String 5
*percentualEmissao
** Tipo: Float 3.2
*tipoProduto
** Tipo: String 1
*codigoNimexe
** Tipo: String 25
*pedidoAmostra
** Tipo: Bool
*codigoIndice
** Tipo: String 5
*codigoUnidadeNegocio
** Tipo: String 3
*nomeCompletoUnidadeNegocio
** Tipo: String 60
*impresso
** Tipo: Bool
*sessao
** Tipo: Int 8
*alteracaoFt
** Tipo: Bool
*seguro
** Tipo: Float 11.2
*codigoCancelamento
** Tipo: String 3
*quantidadeTotal
** Tipo: Float 8.6
*horaProgramada
** Tipo: String 6
*codigoPedidoExterno
** Tipo: String 12
*projeto
** Tipo: String 12
*prioridade
** Tipo: String 1
*codigoTipoPagamento
** Tipo: String 2
*dataFaturado
** Tipo: Date
*horaFaturado
** Tipo: String 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 3.2
*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 8.6
*totalItensBaixados
** Tipo: Float 8.6
*percentualMargemLucro
** Tipo: Float 8.6
*percIcmsResponsabilidade
** Tipo: Float 8.6
*vendasContato
** Tipo: Float 11.2
*percentualComissaoReceber
** Tipo: Float 11.2
*valorInfDesconto
** Tipo: Float 11.2
*valorSuframaSimbahia
** Tipo: Float 11.2
*usrpedi1
** Tipo: String 20
*usrpedi2
** Tipo: Date
*usrpedi3
** Tipo: Float 11.2
*controle
** Tipo: String 2
*descricaoControle
** Tipo: String 40
*baseIcms
** Tipo: Float 13.2
*baseIpi
** Tipo: Float 13.2
*baseIss
** Tipo: Float 13.2
*cobrarPauta
** Tipo: String 1
*remessa
** Tipo: String 3
*placa
** Tipo: String 7
*totalFaturado
** Tipo: Float 13.2
*totalServicos
** Tipo: Float 13.2
*baseSubstituicaoTributaria
** Tipo: Float 13.2
*valorSubstituicaoTributaria
** Tipo: Float 11.2
*valorInss
** Tipo: Float 11.2
*taxaIndexador
** Tipo: Float 10.5
*indiceIndexador
** Tipo: String 5
*baseIrrf
** Tipo: Float 13.2
*ufPlacaTransportador
** Tipo: String 2
*percentualAcrescimoPreco
** Tipo: Float 3.2
*valorFunrural
** Tipo: Float 11.2
*pedRemessaContaOrdTerceiros
** Tipo: Bool
*percentualIss
** Tipo: Float 3.2
*percentualInss
** Tipo: Float 3.2
*tipoNota
** Tipo: String 1
}}
<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>


====  CadastrarPedidos ====
====  CadastrarPedidos ====

Edição das 18h45min 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

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.

Disponível em “https://www.cigam.com.br/wiki/index.php?title=IN_CadastroPedidos.integrador&oldid=63615”