|
|
| Linha 4 933: |
Linha 4 933: |
| }} | | }} |
|
| |
|
| | == ApontarSeparacaoEntrega == |
| | <!-- |
| | <p align="justify"> |
| | * <b>Coleção: MASP - Itens para Separação</b><br> |
| | * <b>CASP - CA para Separação</b></br> |
| | * <b>CPPS - Situação para itens de pedido para separação</b></br> |
| | * <b>CPSP - Situação para itens pedido para separação parcial</b></br> |
| | * <b>CPPI - Situação para itens pedido que já iniciaram a separação</b></br> |
| | **Os pedidos de venda com controle informado nas coleções CPPS e CPSP são disponibilizados para o WMS e têm seus respectivos controles modificados para o informado na coleção CPPI, bloqueando assim a sua edição no ERP.<br> |
| | <br> |
| | *<b>Parâmetros:</b></br> |
| | {{#tree: minExpandLevel=2 | |
| | *pin:<br> |
| | **Obrigatório, Tipo: String 20<br> |
| | *XML com codigoPedido + sequencia por registro<br> |
| | |
| | }}<br> |
| | *<b>Retorno:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *Atualização efetuada com sucesso. |
| | }}<br> |
| | *<b>Envio:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *<cadastroPedido> |
| | **<pedidos> |
| | ***<pedido> |
| | ****<codigo>C1</codigo> |
| | ****<itens> |
| | *****<item> |
| | ******<sequencia>C2</sequencia> |
| | ******<quantidade>C3</quantidade> |
| | *****</item> |
| | ****</itens> |
| | ***</pedido> |
| | **</pedidos> |
| | *</cadastroPedido> |
| | }} |
| | --> |
| | == DevolucaoSeparacaoEntrega == |
| | <!-- |
| | <p align="justify"> |
| | * <b>Coleção: MASP - Itens para Separação</b><br> |
| | * <b>CASP - CA para Separação</b></br> |
| | * <b>CPPS - Situação para itens de pedido para separação</b></br> |
| | * <b>CPSP - Situação para itens pedido para separação parcial</b></br> |
| | * <b>CPPI - Situação para itens pedido que já iniciaram a separação</b></br> |
| | **Os pedidos de venda com controle informado nas coleções CPPS e CPSP são disponibilizados para o WMS e têm seus respectivos controles modificados para o informado na coleção CPPI, bloqueando assim a sua edição no ERP.<br> |
| | <br> |
| | *<b>Parâmetros:</b></br> |
| | {{#tree: minExpandLevel=2 | |
| | *pin:<br> |
| | **Obrigatório, Tipo: String 20<br> |
| | *XML com codigoPedido + sequencia por registro<br> |
| | |
| | }}<br> |
| | *<b>Retorno:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *Atualização efetuada com sucesso. |
| | }}<br> |
| | *<b>Envio:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *<cadastroPedido> |
| | **<pedidos> |
| | ***<pedido> |
| | ****<codigo>C1</codigo> |
| | ****<itens> |
| | *****<item> |
| | ******<sequencia>C2</sequencia> |
| | ******<quantidade>C3</quantidade> |
| | *****</item> |
| | ****</itens> |
| | ***</pedido> |
| | **</pedidos> |
| | *</cadastroPedido> |
| | }} |
| | --> |
| | == DevolucaoSeparacaoEntregaParcial == |
| | <!-- |
| | <p align="justify"> |
| | * <b>Coleção: MASP - Itens para Separação</b><br> |
| | * <b>CASP - CA para Separação</b></br> |
| | * <b>CPPS - Situação para itens de pedido para separação</b></br> |
| | * <b>CPSP - Situação para itens pedido para separação parcial</b></br> |
| | * <b>CPPI - Situação para itens pedido que já iniciaram a separação</b></br> |
| | **Os pedidos de venda com controle informado nas coleções CPPS e CPSP são disponibilizados para o WMS e têm seus respectivos controles modificados para o informado na coleção CPPI, bloqueando assim a sua edição no ERP.<br> |
| | <br> |
| | *<b>Parâmetros:</b></br> |
| | {{#tree: minExpandLevel=2 | |
| | *pin:<br> |
| | **Obrigatório, Tipo: String 20<br> |
| | *XML com codigoPedido + sequencia por registro<br> |
| | |
| | }}<br> |
| | *<b>Retorno:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *Atualização efetuada com sucesso. |
| | }}<br> |
| | *<b>Envio:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *<cadastroPedido> |
| | **<pedidos> |
| | ***<pedido> |
| | ****<codigo>C1</codigo> |
| | ****<itens> |
| | *****<item> |
| | ******<sequencia>C2</sequencia> |
| | ******<quantidade>C3</quantidade> |
| | *****</item> |
| | ****</itens> |
| | ***</pedido> |
| | **</pedidos> |
| | *</cadastroPedido> |
| | }} |
| | --> |
| | == ListarEntregasSeparacao == |
| | <!-- |
| | <p align="justify"> |
| | * <b>Coleção: MASP - Itens para Separação</b><br> |
| | * <b>CASP - CA para Separação</b></br> |
| | * <b>CPPS - Situação para itens de pedido para separação</b></br> |
| | * <b>CPSP - Situação para itens pedido para separação parcial</b></br> |
| | * <b>CPPI - Situação para itens pedido que já iniciaram a separação</b></br> |
| | **Os pedidos de venda com controle informado nas coleções CPPS e CPSP são disponibilizados para o WMS e têm seus respectivos controles modificados para o informado na coleção CPPI, bloqueando assim a sua edição no ERP.<br> |
| | <br> |
| | *<b>Parâmetros:</b></br> |
| | {{#tree: minExpandLevel=2 | |
| | *pin:<br> |
| | **Obrigatório, Tipo: String 20<br> |
| | *XML com codigoPedido + sequencia por registro<br> |
| | |
| | }}<br> |
| | *<b>Retorno:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *Atualização efetuada com sucesso. |
| | }}<br> |
| | *<b>Envio:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *<cadastroPedido> |
| | **<pedidos> |
| | ***<pedido> |
| | ****<codigo>C1</codigo> |
| | ****<itens> |
| | *****<item> |
| | ******<sequencia>C2</sequencia> |
| | ******<quantidade>C3</quantidade> |
| | *****</item> |
| | ****</itens> |
| | ***</pedido> |
| | **</pedidos> |
| | *</cadastroPedido> |
| | }} |
| | --> |
| | == ListarPedidosSeparacao == |
| | <!-- |
| | <p align="justify"> |
| | * <b>Coleção: MASP - Itens para Separação</b><br> |
| | * <b>CASP - CA para Separação</b></br> |
| | * <b>CPPS - Situação para itens de pedido para separação</b></br> |
| | * <b>CPSP - Situação para itens pedido para separação parcial</b></br> |
| | * <b>CPPI - Situação para itens pedido que já iniciaram a separação</b></br> |
| | **Os pedidos de venda com controle informado nas coleções CPPS e CPSP são disponibilizados para o WMS e têm seus respectivos controles modificados para o informado na coleção CPPI, bloqueando assim a sua edição no ERP.<br> |
| | <br> |
| | *<b>Parâmetros:</b></br> |
| | {{#tree: minExpandLevel=2 | |
| | *pin:<br> |
| | **Obrigatório, Tipo: String 20<br> |
| | *XML com codigoPedido + sequencia por registro<br> |
| | |
| | }}<br> |
| | *<b>Retorno:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *Atualização efetuada com sucesso. |
| | }}<br> |
| | *<b>Envio:</b><br> |
| | {{#tree: minExpandLevel=3 | |
| | *<cadastroPedido> |
| | **<pedidos> |
| | ***<pedido> |
| | ****<codigo>C1</codigo> |
| | ****<itens> |
| | *****<item> |
| | ******<sequencia>C2</sequencia> |
| | ******<quantidade>C3</quantidade> |
| | *****</item> |
| | ****</itens> |
| | ***</pedido> |
| | **</pedidos> |
| | *</cadastroPedido> |
| | }} |
| | --> |
| == Excluir == | | == Excluir == |
| <p align="justify"><i></i></p> | | <p align="justify"><i></i></p> |
Voltar
Integrador >
WebServices >
IN CadastroPedidos.integrador
Cadastrar
Esse método é utilizado para a exportação de pedido em partes separadas, visando vincular seus itens correlatos chamando o serviço de CadastroItensPedido.Integrador, indicando o parâmetro statusRegistro como pendente tanto no método de Cadastrar do serviço de Pedidos quanto no método de Cadastrar do serviço de Itens Pedido no envio das requisições.
Para que seja completa a integração deve se utilizar o método LiberarPendentes para ser integrado com o CIGAM o pedido e suas dependências.
{"minExpandLevel":1}
- pin
- statusRegistro
- Tipo: String 1
- L=Liberado, P=Pendente
- 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.
- codigoPedido
- codigoTipoOperacao
- dataPedido
- viaTransporte
- Tipo: String 1
- R=Rodoviaria, M=Maritima, A=Aerea, F=Ferroviaria.
- coleção
- codigoCliente
- codigoCobranca
- codigoRepresentante
- percDescontoAteVencimento
- valorTotalEncargosFinanceiros
- percDescontoSugestaoItens
- valorTotalDesconto
- percGeralOutrasDespAcessorias
- valorTotalFrete
- valorTotalOutrasDespAcessorias
- totalPedido
- codigoTransportadora
- codigoConsignatario
- marca
- volume
- quantidade
- especie
- pesoLiquido
- pesoBruto
- codigoConta
- codigoPortador
- percGeralEncargosFinanceiros
- itensNoPedido
- totalMercadorias
- prazoEntrega
- prazoProgramado
- percentualGeralDesconto
- valorInfOutrasDespAcessorias
- comprador
- codigoMercado
- dataAprovacao
- horaAprovacao
- dataEntrega
- horaEntrega
- dataLiberacao
- horaLiberacao
- dataValidade
- valorIpi
- tipoFrete
- notaFiscal
- codigoOrdemCompra
- observacao
- embarque
- destino
- viaEmbarque
- codigoCondicaoPagamento
- descricaoCondicaoPagamento
- fatura
- complementoFatura
- percentualEmissao
- tipoProduto
- codigoNimexe
- pedidoAmostra
- codigoIndice
- codigoUnidadeNegocio
- impresso
- alteracaoFt
- seguro
- codigoCancelamento
- quantidadeTotal
- horaProgramada
- codigoPedidoExterno
- projeto
- prioridade
- codigoTipoPagamento
- dataFaturado
- horaFaturado
- valorIcms
- valorIrrf
- valorIss
- incluiSubstituicaoTributaria
- regraFrete
- percentualFreteInformativo
- codigoContatoCliente
- grade
- dataInicioProducao
- dataFaturamento
- dataExpedicao
- fornecedor
- despachante
- tgConversaoUnidades
- evento
- incidenciaIss
- ordemEnderecoEntrega
- ordemEnderecoCobranca
- origemPedido
- prazoBonificacao
- entregaMercadoriaAposFaturar
- percentualIrrf
- totalItensBaixados
- percentualMargemLucro
- percIcmsResponsabilidade
- vendasContato
- percentualComissaoReceber
- valorInfDesconto
- valorSuframaSimbahia
- usrpedi1
- usrpedi2
- usrpedi3
- controle
- baseIcms
- baseIpi
- baseIss
- cobrarPauta
- remessa
- placa
- totalFaturado
- totalServicos
- baseSubstituicaoTributaria
- valorSubstituicaoTributaria
- valorInss
- taxaIndexador
- indiceIndexador
- baseIrrf
- ufPlacaTransportador
- percentualAcrescimoPreco
- valorFunrural
- pedRemessaContaOrdTerceiros
- percentualIss
- percentualInss
- tipoNota
- Tipo: String 1
- 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,
- 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,
- 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
- Se não for informado, por padrão, será cadastrado como ‘N’.
- calcularImpostos
- responsavelFrete
- Tipo: String 1
- Opções:
- I = Interno
- R = Revenda
- C = Cliente
- responsavalEncargoFinanc
- Tipo: String 1
- Opções:
- I = Interno
- R = Revenda
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
Esse método é utilizado para importação dos códigos de pedidos já cadastrados no CIGAM.
{"minExpandLevel":1}
- pin
- Obrigatório, Tipo: String 20
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
{"minExpandLevel":1}
- pin
- Obrigatório, Tipo: String 20
- pedido
- Obrigatório, Tipo: String 12
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- dataInicial
- horaInicial
- dataFinal
- horaFinal
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- acao
- Tipo: String 1
- C=Cadastrar, E=Excluir
- Se for informado algo diferente de C ou E não será aplicado nenhum filtro
- statusRegistro
- Tipo: String 1
- L=Liberado,P=Pendente
- Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
Retornos:
Se sucesso:
{"minExpandLevel":2}
- idRegistro
- acao
- statusRegistro
- dataRequisicao
- horaRequisicao
- idCorrelato
- codigoPedido
- codigoCliente
- codigoTipoOperacao
- emissao
- situacao
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- id
- liberarCorrelatos
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoPedidoInicial
- codigoPedidoFinal
- controleInicial
- controleFinal
- 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
- codigoUnidadeNegocioInicial
- codigoUnidadeNegocioFinal
- codigoClienteInicial
- codigoClienteFinal
- tipoOperacaoInicial
- tipoOperacaoFinal
- dataInicial
- horaInicial
- dataFinal
- horaFinal
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.
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoPedido
- dataPedidoInicial
- dataPedidoFinal
- suprimirNivelFilhoVazio
- Tipo: Bool
- False = Irá trazer todas as tags do xml
- True = Caso houver alguma tag vazia a mesma não sera exibida
Retornos:
Se sucesso:
- Parâmetros para o elemento pedido:
{"minExpandLevel":2}
- codigoPedido
- dataPedido
- viaTransporte
- colecao
- marca
- volume
- quantidade
- especie
- codigoConta
- codigoPortador
- itensNoPedido
- prazoEntrega
- prazoProgramado
- comprador
- situacao
- horaAprovacao
- horaEntrega
- horaLiberacao
- tipoFrete
- codigoOrdemCompra
- observacao
- embarque
- destino
- viaEmbarque
- codigoCondicaoPagamento
- complementoFatura
- tipoProduto
- codigoNimexe
- CodigoIndice
- codigoCancelamento
- horaProgramada
- codigoPedidoExterno
- projeto
- prioridade
- codigoTipoPagamento
- horaFaturado
- incluiSubstituicaoTributaria
- regraFrete
- grade
- tgConversaoUnidades
- evento
- incidenciaIss
- ordemEnderecoEntrega
- ordemEnderecoCobranca
- origemPedido
- prazoBonificacao
- entregaMercadoriaAposFaturar
- usrpedi1
- controle
- cobrarPauta
- remessa
- placa
- indiceIndexador
- ufPlacaTransportador
- tipoNota
- Parâmetros para o elemento tipoOperacao:
{"minExpandLevel":2}
- codigoTipoOperacao
- descricao
- codigoNatureza
- descricaoNatureza
- 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:
{"minExpandLevel":2}
- percentualCofins
- percentualIcms
- percentuaSubstituicao
- 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:
{"minExpandLevel":2}
- codigoLancamento
- Data
- dataVencimento
- complemento
- codigoHistorico
- complementoHistorico
- codigoconta
- tipo
- Tipo: String 1
- R=Receber, c=c Recebido, P=Pagar, d=d Pago, E=Entrada, S=Saída
- valor
- codidoEmpresa
- codigoCobranca
- codigoPortador
- emissão
- saldo
- conferido
- 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
- Serie
- contabilizado
- Tipo: String 1
- Branco=a Contabilizar, C=Contabilizado, A=Abertura, N=Não Contabilizar
- codigoTipoPagamento
- numeroBanco
- jurosDia
- codigoUnidadeNegocio
- documento
- 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
- saldoIndexado
- toleranciaVencimento
- valorMulta
- toleranciaMulta
- toleranciaJuros
- tipoJuros
- Tipo: String 1
- S=Simples, C=Composto
- lancamentoVinculado
- dataInclusao
- sacadorAvalista
- 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
- vencimentoOriginal
- projeto
- multiploRemessaEnviada
- indice
- adiantarRetornoCobranca
- formaCobrancaContrato
- comandoRemessa
- ordemEnderecoCobranca
- 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
- dataDirf
- codigoCaixa
- turnoSequencial
- ordemContaCorrente
- previsao
- limiteMultaFracionada
- sessaoCaixa
- autorizadoPlacaGnre
- Distribuição das Tags XML:
- Distribuição das Tags Json:
- {
- "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": ""
- }
- }
- ]
- }
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
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- CodigoRepresentante
- controleInicial
- controleFinal
- 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
- horaInicial
- dataFinal
- horaFinal
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.
{"minExpandLevel":2}
- pin:
- Obrigatório, Tipo: String 20
- statusRegistro
- Obrigatório, Tipo: String 1
- L=Liberado, P=Pendente
- pedidoXml
- Obrigatório para requisições SOAP/XML. Tipo: String
- Conteúdo de um arquivo XML com os pedidos, itens, grades, impostos...
- pedidoJson:
- Obrigatório para requisições REST/JSON. Tipo: String
- Conteúdo de um arquivo JSON com os pedidos, itens, grades, impostos....
- Distribuição das Tags XML:
- Distribuição das Tags Json:
- {
- "pedidos":[
- {
- "codigoCliente":" ",
- "codigoCobranca":" ",
- "codigoRepresentante":" ",
- "codigoTransportadora":" ",
- "codigoConsignatario":" ",
- "fornecedor":" ",
- "despachante":" ",
- "codigoMercado":" ",
- "codigoContatoCliente":" ",
- "codigoPedido":" ",
- "dataPedido":" ",
- "codigoTipoOperacao":" ",
- "viaTransporte":" ",
- "colecao":" ",
- "codigoUnidadeNegocio":" ",
- "percDescontoAteVencimento":" ",
- "valorTotalEncargosFinanceiros":" ",
- "percDescontoSugestaoItens":" ",
- "valorTotalDesconto":" ",
- "percGeralOutrasDespAcessorias":" ",
- "valorTotalFrete":" ",
- "valorTotalOutrasDespAcessorias":" ",
- "totalPedido":" ",
- "marca":" ",
- "volume":" ",
- "quantidade":" ",
- "especie":" ",
- "pesoLiquido":" ",
- "pesoBruto":" ",
- "codigoConta":" ",
- "codigoPortador":" ",
- "percGeralEncargosFinanceiros":" ",
- "itensNoPedido":" ",
- "totalMercadorias":" ",
- "prazoEntrega":" ",
- "prazoProgramado":" ",
- "percentualGeralDesconto":" ",
- "valorInfOutrasDespAcessorias":" ",
- "comprador":" ",
- "situacao":" ",
- "dataAprovacao":" ",
- "horaAprovacao":" ",
- "dataEntrega":" ",
- "horaEntrega":" ",
- "dataLiberacao":" ",
- "horaLiberacao":" ",
- "dataValidade":" ",
- "valorIpi":" ",
- "tipoFrete":" ",
- "notaFiscal":" ",
- "codigoOrdemCompra":" ",
- "observacao":" ",
- "embarque":" ",
- "destino":" ",
- "viaEmbarque":" ",
- "codigoCondicaoPagamento":" ",
- "fatura":" ",
- "complementoFatura":" ",
- "percentualEmissao":" ",
- "tipoProduto":" ",
- "codigoNimexe":" ",
- "pedidoAmostra":" ",
- "codigoIndice":" ",
- "impresso":" ",
- "alteracaoFt":" ",
- "seguro":" ",
- "codigoCancelamento":" ",
- "quantidadeTotal":" ",
- "horaProgramada":" ",
- "codigoPedidoExterno":" ",
- "projeto":" ",
- "prioridade":" ",
- "codigoTipoPagamento":" ",
- "dataFaturado":" ",
- "horaFaturado":" ",
- "valorIcms":" ",
- "valorIrrf":" ",
- "valorIss":" ",
- "incluiSubstituicaoTributaria":" ",
- "regraFrete":" ",
- "percentualFreteInformativo":" ",
- "grade":" ",
- "dataInicioProducao":" ",
- "dataFaturamento":" ",
- "dataExpedicao":" ",
- "tgConversaoUnidades":" ",
- "evento":" ",
- "incidenciaIss":" ",
- "ordemEnderecoEntrega":" ",
- "ordemEnderecoCobranca":" ",
- "origemPedido":" ",
- "prazoBonificacao":" ",
- "entregaMercadoriaAposFaturar":" ",
- "percentualIrrf":" ",
- "totalItensBaixados":" ",
- "percentualMargemLucro":" ",
- "percIcmsResponsabilidade":" ",
- "vendasContato":" ",
- "percentualComissaoReceber":" ",
- "valorInfDesconto":" ",
- "valorSuframaSimbahia":" ",
- "usrpedi1":" ",
- "usrpedi2":" ",
- "usrpedi3":" ",
- "controle":" ",
- "baseIcms":" ",
- "baseIpi":" ",
- "baseIss":" ",
- "cobrarPauta":" ",
- "remessa":" ",
- "placa":" ",
- "totalFaturado":" ",
- "totalServicos":" ",
- "baseSubstituicaoTributaria":" ",
- "valorSubstituicaoTributaria":" ",
- "valorInss":" ",
- "taxaIndexador":" ",
- "indiceIndexador":" ",
- "baseIrrf":" ",
- "ufPlacaTransportador":" ",
- "percentualAcrescimoPreco":" ",
- "valorFunrural":" ",
- "pedRemessaContaOrdTerceiros":" ",
- "percentualIss":" ",
- "percentualInss":" ",
- "tipoNota":" ",
- "calcularImpostos":" ",
- "responsavelFrete":" ",
- "responsavelEncargoFinanc":" ",
- "itens":[
- {
- "codigoTipoOperacao":" ",
- "codigoPedido":" ",
- "codigoMaterial":" ",
- "quantidade":" ",
- "precoUnitario":" ",
- "documento":" ",
- "serie":" ",
- "nf":" ",
- "remessaDia":" ",
- "codigoCliente":" ",
- "prazoEntrega":" ",
- "plano":" ",
- "pecas":" ",
- "saldoPecas":" ",
- "sequencia":" ",
- "dataEmbarque":" ",
- "codigoContaGerencial":" ",
- "incidenciaIpi":" ",
- "percentualIpi":" ",
- "codigoOrigem":" ",
- "codigoTransfCentroArmazenagem":" ",
- "percentualComissao":" ",
- "ncm":" ",
- "percBonificacaoQuantidade":" ",
- "percentualDesconto":" ",
- "veiculo":" ",
- "prioridade":" ",
- "codigoMercado":" ",
- "detalhe":" ",
- "tabelaPrecos":" ",
- "sequenciaOriginalSolicitacao":" ",
- "valorSuframaSimbahia":" ",
- "precoOriginal":" ",
- "emissaoEtiqueta":" ",
- "dataValidade":" ",
- "codigoCompradorFinal":" ",
- "pedidoCliente":" ",
- "stockNumber":" ",
- "formaEmbarque":" ",
- "prazoProgramado":" ",
- "dataAprovacao":" ",
- "lote":" ",
- "dataLimiteCompraFinal":" ",
- "codigoFabrica":" ",
- "tipoAmostra":" ",
- "dataCriacaoProduto":" ",
- "peso":" ",
- "codigoUnidadeNegocio":" ",
- "codigoCentroArmazenagem":" ",
- "codigoEspecif1":" ",
- "especif2":" ",
- "valorDesconto":" ",
- "valorOutrasDespesasAcessorias":" ",
- "valorFrete":" ",
- "baseIcmsIpi":" ",
- "DifAliquotaIcms":" ",
- "numeroRomaneio":" ",
- "dataRomaneio":" ",
- "codigoContrato":" ",
- "quantidadeExtra":" ",
- "codigoUnidadeMedida":" ",
- "totalDespesas":" ",
- "totalItemLiquido":" ",
- "percentualIcms":" ",
- "incidenciaIcms":" ",
- "baseSubstituicao":" ",
- "percentualSubstituicao":" ",
- "percentualIrrf":" ",
- "valorIpi":" ",
- "sequenciaBaixa":" ",
- "saldoReserva":" ",
- "saldoProducao":" ",
- "horarioPrometido":" ",
- "dataFaturamento":" ",
- "codigoIndice":" ",
- "codigoContabil":" ",
- "remessaSolicitacao":" ",
- "codigoRetorno":" ",
- "largura":" ",
- "grade":" ",
- "numeracaoGrade":" ",
- "legendaMedidaProvisorioDoBem":" ",
- "horaEntrega":" ",
- "excecaoNcm":" ",
- "itemOs":" ",
- "complementoIncidenciaIcms":" ",
- "tipoPedido":" ",
- "remessaGerada":" ",
- "naoMovimentaEstoque":" ",
- "codigoUnidadeNegocioTransfer":" ",
- "prazoFinanceiro":" ",
- "ultimaSequenciaBaixa":" ",
- "entregaMercadoriaAposFatura":" ",
- "reducaoIcms":" ",
- "percentualIcmsSubstituicao":" ",
- "ordemServico":" ",
- "percentualMargemLucro":" ",
- "demandaGeral":" ",
- "entrega":" ",
- "remessaProdutoCliente":" ",
- "usritpe1":" ",
- "usritpe2":" ",
- "usritpe3":" ",
- "usritpe4":" ",
- "valorIcms":" ",
- "valorEncargoFinanceiro":" ",
- "controle":" ",
- "impedimento1":" ",
- "impedimento2":" ",
- "impedimento3":" ",
- "impedimento4":" ",
- "tipoBaixa":" ",
- "valorBaseSubstituicao":" ",
- "gerarPrecoSugestao":" ",
- "usouConversor":" ",
- "explodiuItemComercial":" ",
- "geraDupItemPedido":" ",
- "pedidoCompra":" ",
- "itemPedidoCompra":" ",
- "grades":[
- {
- "codigoMaterial":" ",
- "numeracao":" ",
- "quantidade":" ",
- "codigoUnidadeNegocio":" ",
- "dataMovimento":" ",
- "sequenciaGrade":" ",
- "usrgrap1":" ",
- "especif3":" ",
- "grade":" ",
- "codigoCentroArmazenagem":" ",
- "sequenciaBaixa":" ",
- "lote":" ",
- }
- ],
- "impostos":[
- {
- "percentualIpi":" ",
- "valorDesconto":" ",
- "percentualIcms":" ",
- "valorsubstituicao":" ",
- "percentuaSubstituicao":" ",
- "valorIpi":" ",
- "valorIcms":" ",
- }
- ]
- }
- ],
- "impostos":[
- {
- "basePis":" ",
- "baseCofins":" ",
- "valorPis":" ",
- "valorCofins":" ",
- "percentualPis":" ",
- "percentualCofins":" ",
- "incidenciaPis":" ",
- "incidenciaCofins":" ",
- "baseIcms":" ",
- }
- ],
- "lancamentos":[
- {
- "codigoLancamento":" ",
- "data":" ",
- "vencimento":" ",
- "fatura":" ",
- "complemento":" ",
- "codHistorico":" ",
- "historico":" ",
- "conta":" ",
- "tipo":" ",
- "valor":" ",
- "cdEmpresa":" ",
- "cdCobranca":" ",
- "cheque":" ",
- "cdPortador":" ",
- "emissao":" ",
- "cPartida":" ",
- "saldo":" ",
- "conferido":" ",
- "situacao":" ",
- "conciliado":" ",
- "contabilizado":" ",
- "tipoPagamento":" ",
- "numeroBanco":" ",
- "jurosDia":" ",
- "ultimaLiquidacao":" ",
- "documento":" ",
- "tipoDocumento":" ",
- "valorIndexado":" ",
- "saldoIndexado":" ",
- "toleranciaVenc":" ",
- "valorMulta":" ",
- "toleranciaMulta":" ",
- "toleranciaJuros":" ",
- "tipoJuros":" ",
- "valorDesconto":" ",
- "lancVinculado":" ",
- "dataInclusao":" ",
- "sacadorAvalista":" ",
- "modalidadeVenc":" ",
- "modalidadePag":" ",
- "especieDoc":" ",
- "vencOriginal":" ",
- "projeto":" ",
- "multRemessaEnviada":" ",
- "indice":" ",
- "bloqImpresso":" ",
- "duplImpresso":" ",
- "remessaEnviada":" ",
- "autorizadoPor":" ",
- "autorizadoEm":" ",
- "dataModif":" ",
- "sessao":" ",
- "dataCompensBco":" ",
- "dataFaturamentoCtr":" ",
- "dataValidacao":" ",
- "remessaSerasa":" ",
- "adiantRetornCobran":" ",
- "formaCobranCtr":" ",
- "comandoRemessa":" ",
- "ordemEnderCobran":" ",
- "tipoMulta":" ",
- "pagamento":" ",
- "listarIss":" ",
- "codigoBarrasLido":" ",
- "dataDirf":" ",
- "cdCaixa":" ",
- "turnoSequencial":" ",
- "ordemContaCorrente":" ",
- "previsao":" ",
- "listarDirf":" ",
- "possuiChequesTitulo":" ",
- "ctrSequencia":" ",
- "limitMultaFracio":" ",
- "valorCustoAdmin":" ",
- "conciliacaoSeq":" ",
- "percentIss":" ",
- "sessaoCaixa":" ",
- "autoriPlacaGnre":" ",
- "userLancto1":" ",
- "userLancto2":" ",
- "userLancto3":" ",
- }
- ]
- }
- ]
- }
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
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.
ApontamentoSeparacaoPedido
- Coleção: CAFA - CA para Faturamento
- CPFA - Controle para faturamento
- Envia as quantidades separadas dos pedidos de venda conforme importação do método ListarPedidosSeparação através do XML com número do documento, sequência da linha e quantidade separada.
{"minExpandLevel":2}
- pin:
- Obrigatório, Tipo: String 20
- XML com Numero pedido; Sequencia Linha; Qtde Executada
- considerarJaIniciados (fixo ‘true’)
{"minExpandLevel":3}
- <Retorno>
- <retornoApontamentoPedido>
- <codigoPedido>0</codigoPedido>
- <apontamentos>
- <apontamento>
- <sequencia>1</sequencia>
- <movimento>0</movimento>
- <movimentoContraPartida>0</movimentoContraPartida>
- </apontamento>
- </apontamentos>
- </retornoApontamentoPedido>
- </Retorno>
{"minExpandLevel":3}
- <cadastroPedido>
- <pedidos>
- <pedido>
- <codigo>C1</codigo>
- <itens>
- <item>
- <sequencia>C2</sequencia>
- <quantidade>C3</quantidade>
- </item>
- </itens>
- </pedido>
- </pedidos>
- </cadastroPedido>
ApontamentoSeparacaoItemPedido
- Coleção: CAFA - CA para Faturamento
- CPFA - Controle para faturamento
- Envia as quantidades atendidas para o CA de faturamento, transferindo o que foi separado no WMS do almoxarifado (CA de armazenagem) para o CA de faturamento.
{"minExpandLevel":2}
- pin:
- Obrigatório, Tipo: String 20
- CodigoPedido
- SequenciaItem
- Quantidade
{"minExpandLevel":3}
- <Retorno>
- <retornoApontamentoPedido>
- <codigoPedido>0</codigoPedido>
- <apontamentos>
- <apontamento>
- <sequencia>1</sequencia>
- <movimento>0</movimento>
- <movimentoContraPartida>0</movimentoContraPartida>
- </apontamento>
- </apontamentos>
- </retornoApontamentoPedido>
- </Retorno>
ApontamentoInicioSeparacaoPedido
- Coleção: MASP - Itens para Separação
- CASP - CA para Separação
- CPPS - Situação para itens de pedido para separação
- CPSP - Situação para itens pedido para separação parcial
- CPPI - Situação para itens pedido que já iniciaram a separação
- Os pedidos de venda com controle informado nas coleções CPPS e CPSP são disponibilizados para o WMS e têm seus respectivos controles modificados para o informado na coleção CPPI, bloqueando assim a sua edição no ERP.
{"minExpandLevel":2}
- pin:
- Obrigatório, Tipo: String 20
- XML com codigoPedido + sequencia por registro
{"minExpandLevel":3}
- Atualização efetuada com sucesso.
{"minExpandLevel":3}
- <cadastroPedido>
- <pedidos>
- <pedido>
- <codigo>C1</codigo>
- <itens>
- <item>
- <sequencia>C2</sequencia>
- <quantidade>C3</quantidade>
- </item>
- </itens>
- </pedido>
- </pedidos>
- </cadastroPedido>
ApontamentoInicioSeparacaoItemPedido
- Coleção: CAFA - CA para Faturamento
- CPFA - Controle para faturamento
- Envia as quantidades separadas dos pedidos de venda conforme importação do método ListarPedidosSeparação através dos parâmetros com número do documento, sequência da linha e quantidade separada.
{"minExpandLevel":2}
- pin:
- Obrigatório, Tipo: String 20
- CodigoPedido
- SequenciaItem
- Quantidade
{"minExpandLevel":3}
- Atualização efetuada com sucesso.
ApontarSeparacaoEntrega
DevolucaoSeparacaoEntrega
DevolucaoSeparacaoEntregaParcial
ListarEntregasSeparacao
ListarPedidosSeparacao
Excluir
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoPedido
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.
