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

De CIGAM WIKI
← Edição anteriorEdição posterior →
Elizama.Dias (discussão | contribs)
Administradores da interface, Administradores
2 798 edições
Linha 9: Linha 9:
*<b>Parâmetros:</b><br>
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
**pin
*pin
*** Tipo: String 20
** Tipo: String 20


**statusRegistro
*statusRegistro
*** Tipo: String 1
** Tipo: String 1
*** L=Liberado, P=Pendente
** L=Liberado, P=Pendente
*** Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P,
** Este parâmetro não é obrigatório, mas se for informado algo diferente de L ou P,
*** por padrão, será cadastrado como P na tabela de integração.
** por padrão, será cadastrado como P na tabela de integração.


**codigoPedido
*codigoPedido
*** Tipo: String 12
** Tipo: String 12


**codigoTipoOperacao  
*codigoTipoOperacao  
*** Tipo: String 5
** Tipo: String 5


**dataPedido
*dataPedido
*** Tipo: Date
** Tipo: Date


**viaTransporte
*viaTransporte
*** Tipo: String 1
** Tipo: String 1
*** R=Rodoviaria, M=Maritima, A=Aerea, F=Ferroviaria.
** R=Rodoviaria, M=Maritima, A=Aerea, F=Ferroviaria.


**coleção
*coleção
*** Tipo: String 6
** Tipo: String 6


**codigoCliente
*codigoCliente
*** Tipo: String 6
** Tipo: String 6


**codigoCobranca
*codigoCobranca
*** Tipo: String 6
** Tipo: String 6


**codigoRepresentante
*codigoRepresentante
*** Tipo: String 6
** Tipo: String 6


**percDescontoAteVencimento
*percDescontoAteVencimento
*** Tipo: Float 3.2
** Tipo: Float 3.2


**valorTotalEncargosFinanceiros
*valorTotalEncargosFinanceiros
*** Tipo: Float 11.2
** Tipo: Float 11.2


**percDescontoSugestaoItens
*percDescontoSugestaoItens
*** Tipo: Float 3.2
** Tipo: Float 3.2


**valorTotalDesconto
*valorTotalDesconto
*** Tipo: Float 11.2
** Tipo: Float 11.2


**percGeralOutrasDespAcessorias
*percGeralOutrasDespAcessorias
*** Tipo: Float 3.2
** Tipo: Float 3.2


**valorTotalFrete
*valorTotalFrete
*** Tipo: Float 11.2
** Tipo: Float 11.2


**valorTotalOutrasDespAcessorias
*valorTotalOutrasDespAcessorias
*** Tipo: Float 11.2
** Tipo: Float 11.2


**totalPedido
*totalPedido
*** Tipo: Float 13.2
** Tipo: Float 13.2


**codigoTransportadora
*codigoTransportadora
*** Tipo: String 6
** Tipo: String 6


**codigoConsignatario
*codigoConsignatario
*** Tipo: String 6
** Tipo: String 6


**marca
*marca
*** Tipo: String 12
** Tipo: String 12


**volume
*volume
*** Tipo: String 15
** Tipo: String 15


**quantidade
*quantidade
*** Tipo: String 6
** Tipo: String 6


**especie
*especie
*** Tipo: String 16
** Tipo: String 16


**pesoLiquido
*pesoLiquido
*** Tipo: Float 8.5
** Tipo: Float 8.5


**pesoBruto
*pesoBruto
*** Tipo: Float 8.5
** Tipo: Float 8.5


**codigoConta
*codigoConta
*** Tipo: String 6
** Tipo: String 6


**codigoPortador
*codigoPortador
*** Tipo: String 3
** Tipo: String 3


**percGeralEncargosFinanceiros
*percGeralEncargosFinanceiros
*** Tipo: Float 3.2
** Tipo: Float 3.2


**itensNoPedido
*itensNoPedido
*** Tipo: Int 5
** Tipo: Int 5


**totalMercadorias
*totalMercadorias
*** Tipo: Float 13.2
** Tipo: Float 13.2


**prazoEntrega
*prazoEntrega
*** Tipo: Date
** Tipo: Date


**prazoProgramado
*prazoProgramado
*** Tipo: Date
** Tipo: Date


**percentualGeralDesconto
*percentualGeralDesconto
*** Tipo: Float 3.2
** Tipo: Float 3.2


**valorInfOutrasDespAcessorias
*valorInfOutrasDespAcessorias
*** Tipo: Float 3.2
** Tipo: Float 3.2


**comprador
*comprador
*** Tipo: String 20
** Tipo: String 20


**codigoMercado
*codigoMercado
*** Tipo: String 3
** Tipo: String 3


**dataAprovacao
*dataAprovacao
*** Tipo: Date
** Tipo: Date


**horaAprovacao
*horaAprovacao
*** Tipo: String 6
** Tipo: String 6


**dataEntrega
*dataEntrega
*** Tipo: Date
** Tipo: Date


**horaEntrega
*horaEntrega
*** Tipo: String 6
** Tipo: String 6


**dataLiberacao
*dataLiberacao
*** Tipo: Date
** Tipo: Date


**horaLiberacao
*horaLiberacao
*** Tipo: String 6
** Tipo: String 6


**dataValidade
*dataValidade
*** Tipo: Date
** Tipo: Date


**valorIpi
*valorIpi
*** Tipo: Float 11.2
** Tipo: Float 11.2


**tipoFrete
*tipoFrete
*** Tipo: String 1
** Tipo: String 1


**notaFiscal
*notaFiscal
*** Tipo: Float 10.0
** Tipo: Float 10.0


**codigoOrdemCompra
*codigoOrdemCompra
*** Tipo: String 12
** Tipo: String 12


**observacao
*observacao
*** Tipo: String 251
** Tipo: String 251


**embarque
*embarque
*** Tipo: String 40
** Tipo: String 40


**destino
*destino
*** Tipo: String 40
** Tipo: String 40


**viaEmbarque
*viaEmbarque
*** Tipo: String 40
** Tipo: String 40


**codigoCondicaoPagamento
*codigoCondicaoPagamento
*** Tipo: String 3
** Tipo: String 3


**descricaoCondicaoPagamento
*descricaoCondicaoPagamento
*** Tipo: String 60
** Tipo: String 60


**fatura
*fatura
*** Tipo: Float 10.0
** Tipo: Float 10.0


**complementoFatura
*complementoFatura
*** Tipo: String 5
** Tipo: String 5


**percentualEmissao
*percentualEmissao
*** Tipo: Float 3.2
** Tipo: Float 3.2


**tipoProduto
*tipoProduto
*** Tipo: String 1
** Tipo: String 1


**codigoNimexe
*codigoNimexe
*** Tipo: String 25
** Tipo: String 25


**pedidoAmostra
*pedidoAmostra
*** Tipo: Bool
** Tipo: Bool


**codigoIndice
*codigoIndice
*** Tipo: String 5
** Tipo: String 5


**codigoUnidadeNegocio  
*codigoUnidadeNegocio  
*** Tipo: String 3
** Tipo: String 3


**impresso
*impresso
*** Tipo: Bool
** Tipo: Bool


**alteracaoFt
*alteracaoFt
*** Tipo: Bool
** Tipo: Bool


**seguro
*seguro
*** Tipo: Float 11.2
** Tipo: Float 11.2


**codigoCancelamento
*codigoCancelamento
*** Tipo: String 3
** Tipo: String 3


**quantidadeTotal
*quantidadeTotal
*** Tipo: Float 8.6
** Tipo: Float 8.6


**horaProgramada
*horaProgramada
*** Tipo: String 6
** Tipo: String 6


**codigoPedidoExterno
*codigoPedidoExterno
*** Tipo: String 12
** Tipo: String 12


**projeto
*projeto
*** Tipo: String 12
** Tipo: String 12


**prioridade
*prioridade
*** Tipo: String 1
** Tipo: String 1


**codigoTipoPagamento
*codigoTipoPagamento
*** Tipo: String 2
** Tipo: String 2


**dataFaturado
*dataFaturado
*** Tipo: Date
** Tipo: Date


**horaFaturado
*horaFaturado
*** Tipo: String 6
** Tipo: String 6


**valorIcms
*valorIcms
*** Tipo: Float 11.2
** Tipo: Float 11.2


**valorIrrf
*valorIrrf
*** Tipo: Float 11.2
** Tipo: Float 11.2


**valorIss
*valorIss
*** Tipo: Float 11.2
** Tipo: Float 11.2


**incluiSubstituicaoTributaria
*incluiSubstituicaoTributaria
*** Tipo: String 1
** Tipo: String 1


**regraFrete
*regraFrete
*** Tipo: String 1
** Tipo: String 1


**percentualFreteInformativo
*percentualFreteInformativo
*** Tipo: Float 3.2
** Tipo: Float 3.2


**codigoContatoCliente
*codigoContatoCliente
*** Tipo: Int 8
** Tipo: Int 8


**grade
*grade
*** Tipo: String 2
** Tipo: String 2


**dataInicioProducao
*dataInicioProducao
*** Tip: Date
** Tip: Date


**dataFaturamento
*dataFaturamento
*** Tipo: Date
** Tipo: Date


**dataExpedicao
*dataExpedicao
*** Tipo: Date
** Tipo: Date


**fornecedor
*fornecedor
*** Tipo: String 6
** Tipo: String 6


**despachante
*despachante
*** Tipo: String 6
** Tipo: String 6


**tgConversaoUnidades
*tgConversaoUnidades
*** Tipo: String 6
** Tipo: String 6


**evento
*evento
*** Tipo: String 6
** Tipo: String 6


**incidenciaIss
*incidenciaIss
*** Tipo: String 1
** Tipo: String 1


**ordemEnderecoEntrega
*ordemEnderecoEntrega
*** Tipo: String 1
** Tipo: String 1


**ordemEnderecoCobranca
*ordemEnderecoCobranca
*** Tipo: String 1
** Tipo: String 1


**origemPedido
*origemPedido
*** Tipo: String 2
** Tipo: String 2


**prazoBonificacao
*prazoBonificacao
*** Tipo: String 2
** Tipo: String 2


**entregaMercadoriaAposFaturar
*entregaMercadoriaAposFaturar
*** Tipo: String 3
** Tipo: String 3


**percentualIrrf
*percentualIrrf
*** Tipo: Float 8.6
** Tipo: Float 8.6


**totalItensBaixados
*totalItensBaixados
*** Tipo: Float 8.6
** Tipo: Float 8.6


**percentualMargemLucro
*percentualMargemLucro
*** Tipo: Float 8.6
** Tipo: Float 8.6


**percIcmsResponsabilidade
*percIcmsResponsabilidade
*** Tipo: Float 8.6
** Tipo: Float 8.6


**vendasContato
*vendasContato
*** Tipo: Float 11.2
** Tipo: Float 11.2


**percentualComissaoReceber
*percentualComissaoReceber
*** Tipo: Float 11.2
** Tipo: Float 11.2


**valorInfDesconto
*valorInfDesconto
*** Tipo: Float 11.2
** Tipo: Float 11.2


**valorSuframaSimbahia
*valorSuframaSimbahia
*** Tipo: Float 11.2
** Tipo: Float 11.2


**usrpedi1
*usrpedi1
*** Tipo: String 20
** Tipo: String 20


**usrpedi2
*usrpedi2
*** Tipo: Date
** Tipo: Date


**usrpedi3
*usrpedi3
*** Tipo: Float 11.2
** Tipo: Float 11.2


**controle
*controle
*** Tipo: String 2
** Tipo: String 2


**baseIcms
*baseIcms
*** Tipo: Float 13.2
** Tipo: Float 13.2


**baseIpi
*baseIpi
*** Tipo: Float 13.2
** Tipo: Float 13.2


**baseIss
*baseIss
*** Tipo: Float 13.2
** Tipo: Float 13.2


**cobrarPauta
*cobrarPauta
*** Tipo: String 1
** Tipo: String 1


**remessa
*remessa
*** Tipo: String 3
** Tipo: String 3


**placa
*placa
*** Tipo: String 7
** Tipo: String 7


**totalFaturado
*totalFaturado
*** Tipo: Float 13.2
** Tipo: Float 13.2


**totalServicos
*totalServicos
*** Tipo: Float 13.2
** Tipo: Float 13.2


**baseSubstituicaoTributaria
*baseSubstituicaoTributaria
*** Tipo: Float 13.2
** Tipo: Float 13.2


**valorSubstituicaoTributaria
*valorSubstituicaoTributaria
*** Tipo: Float 11.2
** Tipo: Float 11.2


**valorInss
*valorInss
*** Tipo: Float 11.2
** Tipo: Float 11.2


**taxaIndexador
*taxaIndexador
*** Tipo: Float 10.5
** Tipo: Float 10.5


**indiceIndexador
*indiceIndexador
*** Tipo: String 5
** Tipo: String 5


**baseIrrf
*baseIrrf
*** Tipo: Float 13.2
** Tipo: Float 13.2


**ufPlacaTransportador
*ufPlacaTransportador
*** Tipo: String 2
** Tipo: String 2


**percentualAcrescimoPreco
*percentualAcrescimoPreco
*** Tipo: Float 3.2
** Tipo: Float 3.2


**valorFunrural
*valorFunrural
*** Tipo: Float 11.2
** Tipo: Float 11.2


**pedRemessaContaOrdTerceiros
*pedRemessaContaOrdTerceiros
*** Tipo: Bool
** Tipo: Bool


**percentualIss
*percentualIss
*** Tipo: Float 3.2
** Tipo: Float 3.2


**percentualInss
*percentualInss
*** Tipo: Float 3.2
** Tipo: Float 3.2


**tipoNota
*tipoNota
*** Tipo: String 1
** Tipo: String 1
*** Este campo não será obrigatório no serviço, mas se for informado, é necessário estar nesta faixa:
** Este campo não será obrigatório no serviço, mas se for informado, é necessário estar nesta faixa:
*** N=Normal, D=Devolução,T=Transferência,  C=Complementar, I=Importação, S=Sessão de Crédito ICMS, M=Mapa Resumo, B=Brinde,
** N=Normal, D=Devolução,T=Transferência,  C=Complementar, I=Importação, S=Sessão de Crédito ICMS, M=Mapa Resumo, B=Brinde,
*** F=Frete/Conhecimento, G=Garantia/Troca, E=Entrega Futura, V=Venda a Ordem, R=Remessa, 1=Genérico, 2=Genérico,
** F=Frete/Conhecimento, G=Garantia/Troca, E=Entrega Futura, V=Venda a Ordem, R=Remessa, 1=Genérico, 2=Genérico,
*** 3=Genérico, 4=Genérico, 5=Genérico, A=Beneficiamento, H=Conserto, J=Consignação, K=Demonstração, O=Remessa 1,
** 3=Genérico, 4=Genérico, 5=Genérico, A=Beneficiamento, H=Conserto, J=Consignação, K=Demonstração, O=Remessa 1,
*** P=Remessa 2, Q=Remessa 3, U=Correção, 6=Importação Drawback, 7=Normal Drawback, 8=Genérico, 9=Genérico, 0=Genérico,
** P=Remessa 2, Q=Remessa 3, U=Correção, 6=Importação Drawback, 7=Normal Drawback, 8=Genérico, 9=Genérico, 0=Genérico,
*** W=Genérico, X=Genérico, Y=Genérico, Z=Genérico, L=Genérico
** W=Genérico, X=Genérico, Y=Genérico, Z=Genérico, L=Genérico
*** Se não for informado, por padrão, será cadastrado como ‘N’.
** Se não for informado, por padrão, será cadastrado como ‘N’.


**calcularImpostos
*calcularImpostos
*** Tipo: Bool
** Tipo: Bool


**responsavelFrete  
*responsavelFrete  
*** Tipo: String 1
** Tipo: String 1
*** Opções:
** Opções:
*** I  = Interno
** I  = Interno
*** R = Revenda
** R = Revenda
*** C = Cliente   
** C = Cliente   


**responsavalEncargoFinanc
*responsavalEncargoFinanc
*** Tipo: String 1
** Tipo: String 1
*** Opções:
** Opções:
*** I = Interno
** I = Interno
*** R = Revenda
** R = Revenda
}}
}}
<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/>

Edição das 21h14min de 7 de dezembro de 2021

Cadastrar

Esse método é utilizado para o cadastro de pedido, podendo ser cadastradas suas dependências chamando outros serviços e métodos para que possa existir nele itens, títulos financeiros e outros.

  • 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.

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