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

De CIGAM WIKI
Linha 1 396: Linha 1 396:


==== ListarPedidosCompleto ====
==== ListarPedidosCompleto ====
<p align="justify"><i>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.</i></p>
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
*codigoPedido
** Tipo: String 12
*dataPedidoInicial
** Tipo: Date
*dataPedidoFinal
** Tipo: Date
*suprimirNivelFilhoVazio
** Tipo: Bool
** False = Irá trazer todas as tags do xml
** True = Caso houver alguma tag vazia a mesma não sera exibida
}}
<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/>
*<b>Parâmetros para o elemento pedido:</b><br>
{{#tree: minExpandLevel=2 |
*codigoPedido
** Tipo: String 12
*dataPedido
** Tipo: Date
*viaTransporte
** Tipo: String 1
*colecao
** Tipo: String 10
*marca
** Tipo: String 10
*volume
** Tipo: String 15
*quantidade
** Tipo: String 6
*especie
** Tipo: String 16
*codigoConta
** Tipo: String 6
*codigoPortador
** Tipo: String 3
*itensNoPedido
** Tipo: String 5
*prazoEntrega
** Tipo: Date
*prazoProgramado
** Tipo: Date
*comprador
** Tipo: String 20
*situacao
** Tipo: String 1
*horaAprovacao
** Tipo: Time
*horaEntrega
** Tipo: Time
*horaLiberacao
** Tipo: Time
*tipoFrete
** Tipo: String 1
*codigoOrdemCompra
** Tipo: String 12
*observacao
** Tipo: String 251
*embarque
** Tipo: String 40
*destino
** Tipo: String 40
*viaEmbarque
** Tipo: String 40
*codigoCondicaoPagamento
** Tipo: String 3
*complementoFatura
** Tipo: String 5
*tipoProduto
** Tipo: String 1
*codigoNimexe
** Tipo: String 25
*CodigoIndice
** Tipo: String 5
*codigoCancelamento
** Tipo: String 3
*horaProgramada
** Tipo: Time
*codigoPedidoExterno
** Tipo: String 12
*projeto
** Tipo: String 12
*prioridade
** Tipo: String 1
*codigoTipoPagamento
** Tipo: String 2
*horaFaturado
** Tipo: Time
*incluiSubstituicaoTributaria
** Tipo: String 1
*regraFrete
** Tipo: String 1
*grade
** Tipo: String 2
*tgConversaoUnidades
** Tipo: String 6
*evento
** Tipo: String 6
*incidenciaIss
** Tipo: String 1
*ordemEnderecoEntrega
** Tipo: String 1
*ordemEnderecoCobranca
** Tipo: String 1
*origemPedido
** Tipo: String 1
*prazoBonificacao
** Tipo: String 2
*entregaMercadoriaAposFaturar
** Tipo: String 3
*usrpedi1
** Tipo: String 20
*controle
** Tipo: String 2
*cobrarPauta
** Tipo: String 1
*remessa
** Tipo: String 3
*placa
** Tipo: String 13
*indiceIndexador
** Tipo: String 5
*ufPlacaTransportador
** Tipo: String 2
*tipoNota
** Tipo: String 1
}}
*<b>Parâmetros para o elemento tipoOperacao:</b><br>
{{#tree: minExpandLevel=2 |
*codigoTipoOperacao
** Tipo: String 5
*descricao
** Tipo: String 40
*codigoNatureza
** Tipo: String 6
*descricaoNatureza
** Tipo: String 40
}}
*<b>Parâmetros para o elemento unidadeNegocio:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 3
*descricao
** Tipo: String 60
}}
*<b>Parâmetros para o elemento cliente:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*nomeCompleto
** Tipo: String 60
}}
*<b>Parâmetros para o elemento cobranca:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*descricao
** Tipo: String 60
}}
*<b>Parâmetros para o elemento representante:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*descricao
** Tipo: String 60
}}
*<b>Parâmetros para o elemento transportadora:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*descricao
** Tipo: String 60
}}
*<b>Parâmetros para o elemento consignatario:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*descricao
** Tipo: String 60
}}
*<b>Parâmetros para o elemento fornecedorEmpresa:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*descricao
** Tipo: String 60
}}
*<b>Parâmetros para o elemento despachanteEmpresa:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*descricao
** Tipo: String 60
}}
*<b>Parâmetros para o elemento regiaoMercado:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 2
*descricao
** Tipo: String 25
}}
*<b>Parâmetros para o elemento contatoEmpresa:</b><br>
{{#tree: minExpandLevel=2 |
*pessoaContato
** Tipo: String 40
*email
** Tipo: String 60
}}
*<b>Parâmetros para o elemento impostos:</b><br>
{{#tree: minExpandLevel=2 |
*percentualCofins
** Tipo: numeric 3.2
*percentualIcms
** Tipo: numeric 3.2
*percentuaSubstituicao
** Tipo: numeric 3.2
}}
*<b>Parâmetros para o elemento material:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 20
*descricao
** Tipo: String 60
}}
*<b>Parâmetros para o elemento compradorFinal:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*nomeCompleto
** Tipo: String 60
}}
*<b>Parâmetros para o elemento unidadeNegocioTransf:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 3
*descricao
** Tipo: String 60
}}
*<b>Parâmetros para o elemento centroArmazenagem:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 4
*descricao
** Tipo: String 40
}}
*<b>Parâmetros para o elemento centroArmazenagemTransf:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 4
*descricao
** Tipo: String 40
}}
*<b>Parâmetros para o elemento tabelaPreco:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*descricao
** Tipo: String 50
}}
*<b>Parâmetros para o elemento contaGerencial:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*descricao
** Tipo: String 40
}}
*<b>Parâmetros para o elemento controleItem:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 2
*descricao
** Tipo: String 40
}}
*<b>Parâmetros para o elemento especif1:</b><br>
{{#tree: minExpandLevel=2 |
*codigo
** Tipo: String 6
*descricao
** Tipo: String 40
}}
*<b>Parâmetros para o elemento Lancamento:</b><br>
{{#tree: minExpandLevel=2 |
*codigoLancamento
** Tipo: Int 12
*Data
** Tipo: Date
*dataVencimento
** Tipo: Date
*complemento
** Tipo: String 5
*codigoHistorico
** Tipo: String 3
*complementoHistorico
** Tipo: String 201
*codigoconta
** Tipo: String 6
*tipo
** Tipo: String 1
** R=Receber,  c=c Recebido, P=Pagar, d=d Pago, E=Entrada, S=Saída
*valor
** Tipo: Float 11.2
*codidoEmpresa
** Tipo: String 6
*codigoCobranca
** Tipo: String 6
*codigoPortador
** Tipo: String 3
*emissão
** Tipo: Date
*saldo
** Tipo: Float 11.2
*conferido
** Tipo: String 1
*situacao
** Tipo: String 1
** A=Aberto, B=Bonif/Desc/Tarifa, C=Cartorio,, D=Devolvido, E=Executado, I=Inadimplente,
** J=Juros/VM/Multa, L=Liquidado, P=Protestado, U=Unificado, V=Vale/Adiant., R=Retenção,
** S=Saldo Inicial, M=Monetário, T=Transferência
*Conciliado
** Tipo: String 1
*Serie
** Tipo: String 5
*contabilizado
** Tipo: String 1
** Branco=a Contabilizar, C=Contabilizado, A=Abertura, N=Não Contabilizar
*codigoTipoPagamento
** Tipo: String 2
*numeroBanco
** Tipo: String 15
*jurosDia
** Tipo: Float 8.6
*codigoUnidadeNegocio
** Tipo: String 3
*documento
** Tipo: String 12
*tipoDocumento
** Tipo: String 1
** Branco=Geral, A=Aglutinado, B=BRenegociação, C=Contrato, D=Devolução, E=EmpréstFinanciamento,
** F=Folha, I=Incobrável, M=MDiferimento, N=NotaDébito, P=Pedido, O=Ordem, R=Retenção, S=SubTributária,
** T=Transporte, U=Unificado, 1=1OrdFrete, 2=2Crédito, 3=3OrdServiço, 4=4Financeira, 5=5Embarque,
** 6=6Curso, 7=7 Evento, 8=8 GNRE, 9=9 Estorno
*valorIndexado
** Tipo: Float 10.5
*saldoIndexado
** Tipo: Float 10.5
*toleranciaVencimento
** Tipo: Int 3
*valorMulta
** Tipo: Float 11.2
*toleranciaMulta
** Tipo: Int 3
*toleranciaJuros
** Tipo: Int 3
*tipoJuros
** Tipo: String 1
** S=Simples, C=Composto
*lancamentoVinculado
** Tipo: Int 8
*dataInclusao
** Tipo: Date
*sacadorAvalista
** Tipo: String 6
*modalidadeVencimento
** Tipo: String 1
** Branco=Prazo, V=Vista, A=Apresentação, E=Entrada
*modalidadePagamento
** Tipo: String 1
** Branco=Exato, A=Anterior, S=Seguinte, P=Previsto
*especieDocumento
** Tipo: String 2
*vencimentoOriginal
** Tipo: Date
*projeto
** Tipo: String 12
*multiploRemessaEnviada
** Tipo: String 8
*indice
** Tipo: String 5
*adiantarRetornoCobranca
** Tipo: String 6
*formaCobrancaContrato
** Tipo: String 6
*comandoRemessa
** Tipo: String 6
*ordemEnderecoCobranca
** Tipo: String 1
*tipoMulta
** Tipo: String 1
** Branco=Normal, F=Fracionada
*pagamento
** Tipo: String 1
** Branco=Liberado, B=Bloqueado, A=Autorizado, V=Verba Bloqueado, N=Nfe Bloqueado
*listarIss
** Tipo: String 2
** _N=Não, Ab=Abertura NF, Si=Sim
*codigoBarrasLido
** Tipo: String 2
** S_, N_
*dataDirf
** Tipo: String 2
*codigoCaixa
** Tipo: String 3
*turnoSequencial
** Tipo: String 3
*ordemContaCorrente
** Tipo: String 3
*previsao
** Tipo: Bool
*limiteMultaFracionada
** Tipo: Float 8.6
*sessaoCaixa
** Tipo: String
*autorizadoPlacaGnre
** Tipo: String 20
}}
*<b>Distribuição das Tags XML:</b>
{{#tree:
* <cadastroPedido>
** <pedidos>
*** <pedido>
**** <tipoOperacao>
***** <codigoTipoOperacao></codigoTipoOperacao>
***** <descricao></descricao>
***** <codigoNatureza></codigoNatureza>
***** <descricaoNatureza></descricaoNatureza>
**** </tipoOperacao>
**** <unidadeNegocio>
***** <codigo></codigo>
***** <descricao></descricao>
**** </unidadeNegocio>
**** <cliente>
***** <codigo></codigo>
***** <nomeCompleto></nomeCompleto>
**** </cliente>
**** <cobranca>
***** <codigo></codigo>
***** <nomeCompleto></nomeCompleto>
**** </cobranca>
**** <representante>
***** <codigo />
***** <nomeCompleto></nomeCompleto>
**** </representante>
**** <transportadora>
***** <codigo />
***** <nomeCompleto></nomeCompleto>
**** </transportadora>
**** <consignatario>
***** <codigo />
***** <nomeCompleto></nomeCompleto>
**** </consignatario>
**** <fornecedorEmpresa>
***** <codigo />
***** <nomeCompleto></nomeCompleto>
**** </fornecedorEmpresa>
**** <despachanteEmpresa>
***** <codigo />
***** <nomeCompleto></nomeCompleto>
**** </despachanteEmpresa>
**** <regiaoMercado>
***** <codigo />
***** <descricao></descricao>
**** </regiaoMercado>
**** <contatoEmpresa>
***** <pessoaContato></pessoaContato>
***** <email></email>
**** </contatoEmpresa>
**** <codigoPedido></codigoPedido>
**** <dataPedido></dataPedido>
**** <viaTransporte></viaTransporte>
**** <colecao></colecao>
**** <marca></marca>
**** <volume></volume>
**** <quantidade></quantidade>
**** <especie></especie>
**** <codigoConta></codigoConta>
**** <codigoPortador></codigoPortador>
**** <itensNoPedido></itensNoPedido>
**** <prazoEntrega></prazoEntrega>
**** <prazoProgramado></prazoProgramado>
**** <comprador></comprador>
**** <situacao></situacao>
**** <horaAprovacao></horaAprovacao>
**** <horaEntrega></horaEntrega>
**** <horaLiberacao></horaLiberacao>
**** <tipoFrete></tipoFrete>
**** <codigoOrdemCompra></codigoOrdemCompra>
**** <observacao></observacao>
**** <embarque></embarque>
**** <destino></destino>
**** <viaEmbarque></viaEmbarque>
**** <codigoCondicaoPagamento></codigoCondicaoPagamento>
**** <descricaoCondicaoPagamento></descricaoCondicaoPagamento>
**** <complementoFatura></complementoFatura>
**** <tipoProduto></tipoProduto>
**** <codigoNimexe></codigoNimexe>
**** <codigoIndice></codigoIndice>
**** <codigoCancelamento></codigoCancelamento>
**** <horaProgramada></horaProgramada>
**** <codigoPedidoExterno></codigoPedidoExterno>
**** <projeto></projeto>
**** <prioridade></prioridade>
**** <codigoTipoPagamento></codigoTipoPagamento>
**** <horaFaturado></horaFaturado>
**** <incluiSubstituicaoTributaria></incluiSubstituicaoTributaria>
**** <regraFrete></regraFrete>
**** <grade></grade>
**** <tgConversaoUnidades></tgConversaoUnidades>
**** <evento></evento>
**** <incidenciaIss></incidenciaIss>
**** <ordemEnderecoEntrega></ordemEnderecoEntrega>
**** <ordemEnderecoCobranca></ordemEnderecoCobranca>
**** <origemPedido></origemPedido>
**** <prazoBonificacao></prazoBonificacao>
**** <entregaMercadoriaAposFaturar></entregaMercadoriaAposFaturar>
**** <usrpedi1></usrpedi1>
**** <controle></controle>
**** <cobrarPauta></cobrarPauta>
**** <remessa></remessa>
**** <placa></placa>
**** <indiceIndexador></indiceIndexador>
**** <ufPlacaTransportador></ufPlacaTransportador>
**** <tipoNota></tipoNota>
**** <itens>
***** <itemPedido>
****** <material>
******* <codigo></codigo>
******* <descricao></descricao>
****** </material>
****** <cliente>
******* <codigo></codigo>
******* <nomeCompleto></nomeCompleto>
****** </cliente>
****** <compradorFinal>
******* <codigo />
******* <nomeCompleto></nomeCompleto>
****** </compradorFinal>
****** <unidadeNegocio>
******* <codigo></codigo>
******* <descricao></descricao>
****** </unidadeNegocio>
****** <unidadeNegocioTransf>
******* <codigo />
******* <descricao />
****** </unidadeNegocioTransf>
****** <centroArmazenagem>
******* <codigo></codigo>
******* <descricao></descricao>
****** </centroArmazenagem>
****** <centroArmazenagemTransf>
******* <codigo />
******* <descricao />
****** </centroArmazenagemTransf>
****** <regiaoMercado>
******* <codigo />
******* <descricao></descricao>
****** </regiaoMercado>
****** <tabelaPreco>
******* <codigo></codigo>
******* <descricao></descricao>
****** </tabelaPreco>
****** <cfop></cfop>
****** <tipoOperacao>
******* <codigoTipoOperacao></codigoTipoOperacao>
******* <descricao></descricao>
******* <codigoNatureza></codigoNatureza>
******* <descricaoNatureza></descricaoNatureza>
****** </tipoOperacao>
****** <contaGerencial>
******* <codigo />
******* <descricao />
****** </contaGerencial>
****** <controleItem>
******* <codigo></codigo>
******* <descricao></descricao>
****** </controleItem>
****** <especif1>
******* <codigo />
******* <descricao />
****** </especif1>
****** <codigoPedido></codigoPedido>
****** <centroControle></centroControle>
****** <precoUnitario></precoUnitario>
****** <documento></documento>
****** <serie></serie>
****** <descricao></descricao>
****** <atualiza></atualiza>
****** <prazoEntrega></prazoEntrega>
****** <sequencia></sequencia>
****** <incidenciaIpi></incidenciaIpi>
****** <codigoOrigem></codigoOrigem>
****** <codigoTransfCentroArmazenagem></codigoTransfCentroArmazenagem>
****** <veiculo></veiculo>
****** <prioridade></prioridade>
****** <codigoMercado></codigoMercado>
****** <detalhe></detalhe>
****** <pedidoCliente></pedidoCliente>
****** <stockNumber></stockNumber>
****** <formaEmbarque></formaEmbarque>
****** <prazoProgramado></prazoProgramado>
****** <lote></lote>
****** <codigoFabrica></codigoFabrica>
****** <tipoAmostra></tipoAmostra>
****** <especif2></especif2>
****** <codigoContrato></codigoContrato>
****** <codigoUnidadeMedida></codigoUnidadeMedida>
****** <percentualIcms></percentualIcms>
****** <incidenciaIcms></incidenciaIcms>
****** <percentualSubstituicao></percentualSubstituicao>
****** <horarioPrometido></horarioPrometido>
****** <codigoIndice></codigoIndice>
****** <codigoContabil></codigoContabil>
****** <remessaSolicitacao></remessaSolicitacao>
****** <codigoRetorno></codigoRetorno>
****** <largura></largura>
****** <grade></grade>
****** <legendaMedidaProvisorioDoBem></legendaMedidaProvisorioDoBem>
****** <horaEntrega></horaEntrega>
****** <excecaoNcm></excecaoNcm>
****** <itemOs></itemOs>
****** <complementoIncidenciaIcms></complementoIncidenciaIcms>
****** <tipoPedido></tipoPedido>
****** <remessaGerada></remessaGerada>
****** <naoMovimentaEstoque></naoMovimentaEstoque>
****** <prazoFinanceiro></prazoFinanceiro>
****** <ultimaSequenciaBaixa></ultimaSequenciaBaixa>
****** <percentualIcmsSubstituicao></percentualIcmsSubstituicao>
****** <entrega></entrega>
****** <remessaProdutoCliente></remessaProdutoCliente>
****** <usritpe1></usritpe1>
****** <usritpe2></usritpe2>
****** <impedimento1></impedimento1>
****** <impedimento2></impedimento2>
****** <impedimento3></impedimento3>
****** <impedimento4></impedimento4>
****** <tipoBaixa></tipoBaixa>
****** <explodiuItemComercial></explodiuItemComercial>
****** <pedidoCompra />
****** <itemPedidoCompra />
****** <impostos>
******* <percentualCofins></percentualCofins>
******* <percentualIcms></percentualIcms>
******* <percentuaSubstituicao></percentuaSubstituicao>
****** </impostos>
***** </itemPedido>
**** </itens>
**** <impostos>
***** <incidenciaPis></incidenciaPis>
***** <incidenciaCofins></incidenciaCofins>
**** </impostos>
***** <lancamento>
****** <codigoLancamento></codigoLancamento>
****** <data></data>
****** <vencimento></vencimento>
****** <complemento></complemento>
****** <codHistorico></codHistorico>
****** <historico />
****** <conta />
****** <tipo> </tipo>
****** <valor></valor>
****** <cdEmpresa></cdEmpresa>
****** <cdCobranca></cdCobranca>
****** <cdPortador></cdPortador>
****** <emissao></emissao>
****** <saldo></saldo>
****** <conferido />
****** <situacao> </situacao>
****** <conciliado />
****** <contabilizado> </contabilizado>
****** <tipoPagamento />
****** <numeroBanco />
****** <jurosDia></jurosDia>
****** <documento></documento>
****** <tipoDocumento> </tipoDocumento>
****** <toleranciaVenc></toleranciaVenc>
****** <valorMulta></valorMulta>
****** <toleranciaJuros></toleranciaJuros>
****** <tipoJuros> </tipoJuros>
****** <dataInclusao></dataInclusao>
****** <sacadorAvalista />
****** <modalidadeVenc />
****** <modalidadePag />
****** <especieDoc />
****** <vencOriginal></vencOriginal>
****** <projeto />
****** <multRemessaEnviada />
****** <indice />
****** <autorizadoPor />
****** <sessao></sessao>
****** <adiantRetornCobran />
****** <formaCobranCtr />
****** <comandoRemessa />
****** <ordemEnderCobran />
****** <tipoMulta>F</tipoMulta>
****** <pagamento />
****** <listarIss>N</listarIss>
****** <codigoBarrasLido />
****** <dataDirf />
****** <cdCaixa />
****** <turnoSequencial />
****** <ordemContaCorrente />
****** <previsao>True</previsao>
****** <limitMultaFracio>2</limitMultaFracio>
****** <sessaoCaixa />
****** <autoriPlacaGnre />
****** <serie />
***** </lancamento>
**** </lancamentos>
*** </pedido>
** </pedidos>
* </cadastroPedido>
}}
*<b>Distribuição das Tags Json:</b>
{{#tree:
*{
** "pedidos": [
*** {
**** "tipoOperacao": {
***** "codigoTipoOperacao": "",
***** "descricao": "",
***** "codigoNatureza": "",
***** "descricaoNatureza": ""
**** },
**** "unidadeNegocio": {
***** "codigo": "",
***** "descricao": ""
**** },
**** "cliente": {
***** "codigo": "",
***** "nomeCompleto": ""
**** },
**** "cobranca": {
***** "codigo": "",
***** "nomeCompleto": ""
**** },
**** "representante": {
***** "codigo": "",
***** "nomeCompleto": ""
**** },
**** "transportadora": {
***** "codigo": "",
***** "nomeCompleto": ""
**** },
**** "consignatario": {
***** "codigo": "",
***** "nomeCompleto": ""
**** },
**** "fornecedorEmpresa": {
***** "codigo": "",
***** "nomeCompleto": ""
**** },
**** "despachanteEmpresa": {
***** "codigo": "",
***** "nomeCompleto": ""
**** },
**** "regiaoMercado": {
***** "codigo": "",
***** "descricao": "ESPANHOL"
**** },
**** "contatoEmpresa": {
***** "pessoaContato": "",
***** "email": ""
**** },
**** "codigoPedido": "",
**** "dataPedido": "",
**** "viaTransporte": "",
**** "colecao": "",
**** "totalPedido": "",
**** "marca": "",
**** "volume": "",
**** "quantidade": "",
**** "especie": "",
**** "pesoLiquido": "",
**** "pesoBruto": "",
**** "codigoConta": "",
**** "codigoPortador": "",
**** "itensNoPedido": "",
**** "totalMercadorias": "",
**** "prazoEntrega": "",
**** "prazoProgramado": "",
**** "comprador": "",
**** "situacao": "",
**** "horaAprovacao": "",
**** "horaEntrega": "",
**** "horaLiberacao": "",
**** "valorIpi": "",
**** "tipoFrete": "",
**** "notaFiscal": "",
**** "codigoOrdemCompra": "",
**** "observacao": "",
**** "embarque": "",
**** "destino": "",
**** "viaEmbarque": "",
**** "codigoCondicaoPagamento": "",
**** "descricaoCondicaoPagamento": "",
**** "complementoFatura": "",
**** "percentualEmissao": "",
**** "tipoProduto": "",
**** "codigoNimexe": "",
**** "codigoIndice": "",
**** "codigoCancelamento": "",
**** "quantidadeTotal": "",
**** "horaProgramada": "",
**** "codigoPedidoExterno": "",
**** "projeto": "",
**** "prioridade": "",
**** "codigoTipoPagamento": " ",
**** "horaFaturado": "",
**** "valorIcms": "",
**** "incluiSubstituicaoTributaria": "",
**** "regraFrete": "",
**** "grade": "",
**** "tgConversaoUnidades": "",
**** "evento": "",
**** "incidenciaIss": "",
**** "ordemEnderecoEntrega": "",
**** "ordemEnderecoCobranca": "",
**** "origemPedido": "",
**** "prazoBonificacao": "",
**** "entregaMercadoriaAposFaturar": "",
**** "percentualMargemLucro": "4.84",
**** "usrpedi1": "********** ",
**** "controle": "",
**** "baseIcms": "",
**** "cobrarPauta": "",
**** "remessa": "",
**** "placa": "",
**** "totalFaturado": "",
**** "indiceIndexador": "",
**** "ufPlacaTransportador": "",
**** "tipoNota": "",
**** "impostos": {}
***** {
****** "codigoLancamento": "",
****** "data": "",
****** "vencimento": "",
****** "complemento": "",
****** "codHistorico": "",
****** "historico": "",
****** "conta": "",
****** "tipo": "",
****** "valor": "",
****** "cdEmpresa": "",
****** "cdCobranca": "",
****** "cdPortador": "",
****** "emissao": "",
****** "saldo": "",
****** "conferido": "",
****** "situacao": "",
****** "conciliado": "",
****** "contabilizado": "",
****** "tipoPagamento": "",
****** "numeroBanco": "",
****** "jurosDia": "",
****** "documento": "",
****** "tipoDocumento": "",
****** "toleranciaVenc": "",
****** "valorMulta": "",
****** "toleranciaJuros": "",
****** "tipoJuros": "",
****** "dataInclusao": "",
****** "sacadorAvalista": "",
****** "modalidadeVenc": "",
****** "modalidadePag": "",
****** "especieDoc": "",
****** "vencOriginal": "",
****** "projeto": "",
****** "multRemessaEnviada": "",
****** "indice": "",
****** "autorizadoPor": "",
****** "sessao": "",
****** "adiantRetornCobran": "",
****** "formaCobranCtr": "",
****** "comandoRemessa": "",
****** "ordemEnderCobran": "",
****** "tipoMulta": "",
****** "pagamento": "",
****** "listarIss": "",
****** "codigoBarrasLido": "",
****** "dataDirf": "",
****** "cdCaixa": "",
****** "turnoSequencial": "",
****** "ordemContaCorrente": "",
****** "previsao": "True",
****** "limitMultaFracio": "",
****** "sessaoCaixa": "",
****** "autoriPlacaGnre": "",
****** "serie": ""
***** }
*** }
** ]
*}
}}
<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>
==== ListarPedidosPorRepresentante ====
==== ListarPedidosPorRepresentante ====



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

ListarPendentes

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

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.