|
|
| Linha 1 438: |
Linha 1 438: |
| }} | | }} |
|
| |
|
| === Excluir ===
| | == Excluir == |
| <p align="justify"><i> | | <p align="justify"><i> |
| Método que tem por finalidade excluir o item conforme o código do pedido e sequencia indicados.</br></i></p> | | Método que tem por finalidade excluir o item conforme o código do pedido e sequencia indicados. |
| | </i></p> |
|
| |
|
| *<b>Parâmetros:</b></br> | | *<b>Parâmetros:</b><br> |
| <div style="background-color: #f2f2f2">
| | {{#tree: minExpandLevel=2 | |
| <b>pin:</b><br>
| | *pin |
| Obrigatório, Tipo: String 20<br>
| | ** Obrigatório, Tipo: String 20 |
|
| |
|
| <b>codigoPedido:</b><br>
| | *codigoPedido |
| Tipo: String 12<br>
| | ** Obrigatório, Tipo: String 12 |
|
| |
|
| <b>sequencia:</b><br>
| | *sequencia |
| Tipo: int 5<br>
| | ** Obrigatório, Tipo: int 5 |
| </div>
| | }} |
| </br>
| | <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/> | | <b>Retorno:</b><br/> |
| <b>Retornos:</b><br/> | |
| Se pin inválido:<br/> | | Se pin inválido:<br/> |
| O usuário não possui direitos suficientes para executar esta rotina.<br/> | | O usuário não possui direitos suficientes para executar esta rotina.<br/> |
Cadastrar
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- 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
- idCorrelato
- Tipo: Int
- Este parâmetro não é obrigatório, é uma alternativa ao parâmetro " codigoPedido ", pois pode estar vinculando a um pedido
- que ainda não está cadastrado, e este pendente de importação.
- Sempre que o idCorrelato for menor ou igual a 0 (zero), o parâmetro “codigoPedido” é obrigatório.
- codigoPedido
- Obrigatório, Tipo: String 12
- codigoMaterial
- Obrigatório, Tipo: String 20
- centroControle
- quantidade
- Obrigatório, Tipo: Float 8.6
- precoUnitario
- Obrigatório, Tipo: Float 10.5
- O parâmetro "precoUnitario" não é obrigatório se o parâmetro "gerarPrecoSugestao" for true (verdadeiro)
- documento
- serie
- nf
- remessaDia
- descricao
- codigoCliente
- atualiza
- prazoEntrega*
- plano
- pecas
- saldoPecas
- sequencia
- Tipo: Int
- O parâmetro "sequencia" só é obrigatório para modificação.
- codigoTipoOperacao
- Obrigatório, Tipo: String 5
- cfop
- dataEmbarque
- codigoContaGerencial
- incidenciaIpi
- percentualIpi
- codigoOrigem
- centroArmazenagemTransf
- percentualComissao
- ncm
- percBonificacaoQuantidade
- percentualDesconto
- veiculo
- prioridade
- codigoMercado
- detalhe
- tabelaPrecos
- Tipo: String 6
- O parâmetro “tabelaPrecos” é obrigatório se o parâmetro “gerarPrecoSugestao” for true (verdadeiro)
- sequenciaOriginalSolicitacao
- valorSuframaSimbahia
- precoOriginal
- emissaoEtiqueta
- dataValidade
- codigoCompradorFinal
- pedidoCliente
- stockNumber
- formaEmbarque
- prazoProgramado
- dataAprovacao
- lote
- dataLimiteCompraFinal
- fabrica
- 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
- Obrigatório, Tipo: String 2
- O parâmetro "controle" não será validado como obrigatório no serviço pois o programa de importação irá verificar a
- configuração FA - PE - 415 - Controle inicial pedido. Do contrário, será validado o valor do parâmetro “controle”
- de acordo com o respectivo cadastro de Controles.
- impedimento1
- impedimento2
- impedimento3
- impedimento4
- tipoBaixa
- valorBaseSubstituicao
- gerarPrecoSugestao
- usouConversor
- explodiuItemComercial
- geraDupItemPedido
Retorno:
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
Método que tem por finalidade retornar os códigos de pedidos e sequencia cadastradas no ERP CIGAM.
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
Retorno:
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
Método que tem por finalidade retornar através do código do pedido e sequencia as informações cadastradas no ERP CIGAM.
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoPedido
- Obrigatório, Tipo: String 12
- sequencia
Retorno:
Se sucesso:
Retornos:
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
Método que tem por finalidade retornar através de uma faixa de datas as requisições modificadas nessa faixa no ERP CIGAM.
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- dataInicial
- horaInicial
- dataFinal
- horaFinal
Retorno:
Se sucesso:
Retornos:
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
Método que tem por finalidade retornar o ID dos registros que contenham a ação de Cadastrar ou Excluir e tenham o status de Liberado para Integração ou Pendente para Integração, conforme for indicado nos parâmetros.
{"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.
Retorno:
Se sucesso:
{"minExpandLevel":2}
- idRegistro
- acao
- statusRegistro
- dataRequisicao
- horaRequisicao
- idCorrelato
- pedido
- dataItem
- material
- situacao
- tipoOperacao
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
Método que tem por finalidade liberar registros que contenham o status 'P' (Pendente para Integração), conforme ID informado nos parâmetros.
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- id
- liberarCorrelatos
Retorno:
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.
Se Sucesso:
Sucesso.
Visualizar
Método que tem por finalidade o retorno de dados do item do pedido indicado nos parâmetros.
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoPedido
- Obrigatório, Tipo: string 12
- sequencia
Retorno:
Se sucesso:
- codigoPedido
- dataItem
- codigoMaterial
- codigoMaterial1
- centroControle
- quantidade
- quantidadeSaldo
- precoUnitario
- descricao
- cliente
- dataPrazoEntrega
- sequencia
- codigoTipoOperacao
- tipoOperacao
- cfop
- codigoContaGerencial
- incidenciaIpi
- percentualIpi
- percentualComissao
- ncm
- percBonificacaoQuantidade
- percentualDesconto
- mercado
- codigoDetalhe
- precoOriginal
- dataPrazoProgramado
- codigoUnidadeNegocio
- valorDesconto
- valorEncargo
- valorFrete
- IpiIncluso
- percentualDiferencaAliquota
- quantidadeExtra
- codigoUnidadeMedida
- valorTotalDespesa
- valorTotalItemLiquido
- percentualIcms
- incidenciaIcms
- valorBaseSubstituicao
- percentualSubstituicao
- percentualIrrf
- valorIpi
- grade
- excecaoNcm
- complementoIcms
- reducaoIcms
- percentualIcmsSubstituicao
- percentualMargemLucro
- valorIcms
- valorEncargoFinanceiro
- valorBaseSubstituicao1
Excluir
Método que tem por finalidade excluir o item conforme o código do pedido e sequencia indicados.
{"minExpandLevel":2}
- pin
- Obrigatório, Tipo: String 20
- codigoPedido
- Obrigatório, Tipo: String 12
- sequencia
Retorno:
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 excluir registro.
Se Sucesso:
Sucesso.
