IN CadastroItensPedido.integrador: mudanças entre as edições
Sem resumo de edição |
Sem resumo de edição |
||
| Linha 6: | Linha 6: | ||
== Cadastrar == | == Cadastrar == | ||
*<b>Distribuição das Tags XML:</b> | *<b>Distribuição das Tags XML:</b> | ||
{{#tree: | *<b>Parâmetros:</b><br> | ||
{{#tree: minExpandLevel=2 | | |||
*pin | |||
** Obrigatório, Tipo: String 20 | |||
** | *statusRegistro | ||
** Tipo: String 1 | |||
**idCorrelato | ** 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 | |||
**codigoMaterial | *idCorrelato | ||
**centroControle | ** Tipo: Int | ||
**quantidade | ** Este parâmetro não é obrigatório, é uma alternativa ao parâmetro " codigoPedido ", pois pode estar vinculando a um pedido | ||
**precoUnitario | ** que ainda não está cadastrado, e este pendente de importação. | ||
**documento | ** Sempre que o idCorrelato for menor ou igual a 0 (zero), o parâmetro “codigoPedido” é obrigatório. | ||
**serie | |||
**nf | *codigoPedido | ||
**remessaDia | ** Obrigatório, Tipo: String 12 | ||
**descricao | |||
**codigoCliente | *codigoMaterial | ||
**atualiza | ** Obrigatório, Tipo: String 20 | ||
**prazoEntrega | |||
**plano | *centroControle | ||
**pecas | ** Tipo: String 2 | ||
**saldoPecas | |||
**sequencia | *quantidade | ||
**codigoTipoOperacao | ** Obrigatório, Tipo: Float 8.6 | ||
**cfop | |||
**dataEmbarque | *precoUnitario | ||
**codigoContaGerencial | ** Obrigatório, Tipo: Float 10.5 | ||
**incidenciaIpi | ** O parâmetro "precoUnitario" não é obrigatório se o parâmetro "gerarPrecoSugestao" for true (verdadeiro) | ||
**percentualIpi | |||
**codigoOrigem | *documento | ||
** | ** Tipo: String 10 | ||
**percentualComissao | |||
**ncm | *serie | ||
**percBonificacaoQuantidade | ** Tipo: String 5 | ||
**percentualDesconto | |||
**veiculo | *nf | ||
**prioridade | ** Tipo: Float 10.0 | ||
**codigoMercado | |||
**detalhe | *remessaDia | ||
**tabelaPrecos | ** Tipo: Float 8.6 | ||
**sequenciaOriginalSolicitacao | |||
**valorSuframaSimbahia | *descricao | ||
**precoOriginal | ** Tipo: String 201 | ||
**emissaoEtiqueta | |||
**dataValidade | *codigoCliente | ||
**codigoCompradorFinal | ** Tipo: String 6 | ||
**pedidoCliente | |||
**stockNumber | *atualiza | ||
**formaEmbarque | ** Tipo: String 1 | ||
**prazoProgramado | |||
**dataAprovacao | *prazoEntrega* | ||
**lote | ** Tipo: Date | ||
**dataLimiteCompraFinal | |||
** | *plano | ||
**tipoAmostra | ** Tipo: Int | ||
**dataCriacaoProduto | |||
**peso | *pecas | ||
**codigoUnidadeNegocio | ** Tipo: Float 8.6 | ||
**codigoCentroArmazenagem | |||
**codigoEspecif1 | *saldoPecas | ||
**especif2 | ** Tipo: Float 8.6 | ||
**valorDesconto | |||
**valorOutrasDespesasAcessorias | *sequencia | ||
**valorFrete | ** Tipo: Int | ||
**baseIcmsIpi | ** O parâmetro "sequencia" só é obrigatório para modificação. | ||
** | |||
**numeroRomaneio | *codigoTipoOperacao | ||
**dataRomaneio | ** Obrigatório, Tipo: String 5 | ||
**codigoContrato | |||
**quantidadeExtra | *cfop | ||
**codigoUnidadeMedida | ** Tipo: String 6 | ||
**totalDespesas | |||
**totalItemLiquido | *dataEmbarque | ||
**percentualIcms | ** Tipo: Date | ||
**incidenciaIcms | |||
**baseSubstituicao | *codigoContaGerencial | ||
**percentualSubstituicao | ** Tipo: String 25 | ||
**percentualIrrf | |||
**valorIpi | *incidenciaIpi | ||
**sequenciaBaixa | ** Tipo: String 1 | ||
**saldoReserva | |||
**saldoProducao | *percentualIpi | ||
**horarioPrometido | ** Tipo: Float 3.2 | ||
**dataFaturamento | |||
**codigoIndice | *codigoOrigem | ||
**codigoContabil | ** Tipo: String 1 | ||
**remessaSolicitacao | |||
**codigoRetorno | *centroArmazenagemTransf | ||
**largura | ** Tipo: String 4 | ||
**grade | |||
**numeracaoGrade | *percentualComissao | ||
**legendaMedidaProvisorioDoBem | ** Tipo: Float 3.2 | ||
**horaEntrega | |||
**excecaoNcm | *ncm | ||
**itemOs | ** Tipo: Float 10.0 | ||
**complementoIncidenciaIcms | |||
**tipoPedido | *percBonificacaoQuantidade | ||
**remessaGerada | ** Tipo: Float 8.6 | ||
**naoMovimentaEstoque | |||
**codigoUnidadeNegocioTransfer | *percentualDesconto | ||
**prazoFinanceiro | ** Tipo: Float 2.4 | ||
**ultimaSequenciaBaixa | |||
**entregaMercadoriaAposFatura | *veiculo | ||
**reducaoIcms | ** Tipo: String 1 | ||
**percentualIcmsSubstituicao | |||
**ordemServico | *prioridade | ||
**percentualMargemLucro | ** Tipo: String 1 | ||
**demandaGeral | |||
**entrega | *codigoMercado | ||
**remessaProdutoCliente | ** Tipo: String 2 | ||
**usritpe1 | |||
**usritpe2 | *detalhe | ||
**usritpe3 | ** Tipo: String 6 | ||
**usritpe4 | |||
**valorIcms | *tabelaPrecos | ||
**valorEncargoFinanceiro | ** Tipo: String 6 | ||
**controle | ** O parâmetro “tabelaPrecos” é obrigatório se o parâmetro “gerarPrecoSugestao” for true (verdadeiro) | ||
**impedimento1 | |||
**impedimento2 | *sequenciaOriginalSolicitacao | ||
**impedimento3 | ** Tipo: Int | ||
**impedimento4 | |||
**tipoBaixa | *valorSuframaSimbahia | ||
**valorBaseSubstituicao | ** Tipo: Float 8.6 | ||
**gerarPrecoSugestao | |||
**usouConversor | *precoOriginal | ||
**explodiuItemComercial | ** Tipo: Float 10.5 | ||
** | |||
* | *emissaoEtiqueta | ||
** | ** Tipo: Date | ||
*dataValidade | |||
** Tipo: Date | |||
*codigoCompradorFinal | |||
** Tipo: String 6 | |||
*pedidoCliente | |||
** Tipo: String 20 | |||
*stockNumber | |||
** Tipo: String 35 | |||
*formaEmbarque | |||
** Tipo: String 1 | |||
*prazoProgramado | |||
** Obrigatório, Tipo: Date | |||
*dataAprovacao | |||
** Tipo: Date | |||
*lote | |||
** Tipo: String 10 | |||
*dataLimiteCompraFinal | |||
** Tipo: Date | |||
*fabrica | |||
** Tipo: String 6 | |||
*tipoAmostra | |||
** Tipo: String 2 | |||
*dataCriacaoProduto | |||
** Tipo: Date | |||
*peso | |||
** Tipo: Float 8.5 | |||
*codigoUnidadeNegocio | |||
** Tipo: String 3 | |||
*codigoCentroArmazenagem | |||
** Tipo: String 4 | |||
*codigoEspecif1 | |||
** Tipo: String 6 | |||
*especif2 | |||
** Tipo: String 6 | |||
*valorDesconto | |||
** Tipo: Float 11.2 | |||
*valorOutrasDespesasAcessorias | |||
** Tipo: Float 11.2 | |||
*valorFrete | |||
** Tipo: Float 11.2 | |||
*baseIcmsIpi | |||
** Tipo: Bool | |||
*difAliquotaIcms | |||
** Tipo: Float 3.2 | |||
*numeroRomaneio | |||
** Tipo: Float 10.0 | |||
*dataRomaneio | |||
** Tipo: Date | |||
*codigoContrato | |||
** Tipo: String 8 | |||
*quantidadeExtra | |||
** Tipo: Float 8.6 | |||
*codigoUnidadeMedida | |||
** Tipo: String 3 | |||
*totalDespesas | |||
** Tipo: Float 11.2 | |||
*totalItemLiquido | |||
** Tipo: Float 11.2 | |||
*percentualIcms | |||
** Tipo: Float 2.4 | |||
*incidenciaIcms | |||
** Tipo: String 1 | |||
*baseSubstituicao | |||
** Tipo: Float 11.2 | |||
*percentualSubstituicao | |||
** Tipo: Float 3.2 | |||
*percentualIrrf | |||
** Tipo: Float 3.2 | |||
*valorIpi | |||
** Tipo: Float 11.2 | |||
*sequenciaBaixa | |||
** Tipo: Int | |||
*saldoReserva | |||
** Tipo: Float 8.6 | |||
*saldoProducao | |||
** Tipo: Float 8.6 | |||
*horarioPrometido | |||
** Tipo: String 6 | |||
*dataFaturamento | |||
** Tipo: Date | |||
*codigoIndice | |||
** Tipo: String 5 | |||
*codigoContabil | |||
** Tipo: String 8 | |||
*remessaSolicitacao | |||
** Tipo: String 12 | |||
*codigoRetorno | |||
** Tipo: String 2 | |||
*largura | |||
** Tipo: String 8 | |||
*grade | |||
** Tipo: String 2 | |||
*numeracaoGrade | |||
** Tipo: String 4 | |||
*legendaMedidaProvisorioDoBem | |||
** Tipo: Date | |||
*horaEntrega | |||
** Tipo: String 6 | |||
*excecaoNcm | |||
** Tipo: String 6 | |||
*itemOs | |||
** Tipo: String 6 | |||
*complementoIncidenciaIcms | |||
** Tipo: String 1 | |||
*tipoPedido | |||
** Tipo: String 1 | |||
*remessaGerada | |||
** Tipo: String 1 | |||
*naoMovimentaEstoque | |||
** Tipo: String 2 | |||
*codigoUnidadeNegocioTransfer | |||
** Tipo: String 3 | |||
*prazoFinanceiro | |||
** Tipo: String 3 | |||
*ultimaSequenciaBaixa | |||
** Tipo: String 5 | |||
*entregaMercadoriaAposFatura | |||
** Tipo: Bool | |||
*reducaoIcms | |||
** Tipo: Float 3.5 | |||
*percentualIcmsSubstituicao | |||
** Tipo: Float 8.6 | |||
*ordemServico | |||
** Tipo: Float 11.2 | |||
*percentualMargemLucro | |||
** Tipo: Float 11.2 | |||
*demandaGeral | |||
** Tipo: Float 11.0 | |||
*entrega | |||
** Tipo: String 12 | |||
*remessaProdutoCliente | |||
** Tipo: String 20 | |||
*usritpe1 | |||
** Tipo: String 10 | |||
*usritpe2 | |||
** Tipo: String 20 | |||
*usritpe3 | |||
** Tipo: Date | |||
*usritpe4 | |||
** Tipo: Float 11.2 | |||
*valorIcms | |||
** Tipo: Float 11.2 | |||
*valorEncargoFinanceiro | |||
** Tipo: Float 11.2 | |||
*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 | |||
** Tipo: String 1 | |||
*impedimento2 | |||
** Tipo: String 1 | |||
*impedimento3 | |||
** Tipo: String 1 | |||
*impedimento4 | |||
** Tipo: String 1 | |||
*tipoBaixa | |||
** Tipo: String 1 | |||
*valorBaseSubstituicao | |||
** Tipo: Float 8.6 | |||
*gerarPrecoSugestao | |||
** Tipo: Bool | |||
*usouConversor | |||
** Tipo: Bool | |||
*explodiuItemComercial | |||
** Tipo: String 1 | |||
*geraDupItemPedido | |||
** Tipo: Bool | |||
}} | }} | ||
<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/> | |||
Se sucesso:<br/> | |||
idRegistro - ID que representa este registro na tabela de integração.<br/> | |||
<br/> | |||
Se pin inválido:<br/> | |||
O usuário não possui direitos suficientes para executar esta rotina.<br/> | |||
<br/> | |||
Se algum parâmetro inválido:<br/> | |||
Parâmetro necessário não informado.</p> | |||
== ListarId == | == ListarId == | ||
Edição das 13h35min de 17 de fevereiro de 2022
- Requisição
- Soap: http://servidor/CadastroItensPedido.integrador.asmx
- Rest/JSon: http://servidor/CadastroItensPedido.integrador.ashx/metodo
- Tipo de registro: PEDITE
Cadastrar
- Distribuição das Tags XML:
- Parâmetros:
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.
- Parâmetros:
pin:
Obrigatório, Tipo: String 20
- Exemplo de Retorno:
- codigoPedido:
- sequencia:
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.
ListarIndividual
Método que tem por finalidade retornar através do código do pedido e sequencia as informações cadastradas no ERP CIGAM.
- Parâmetros:
pin:
Obrigatório, Tipo: String 20
codigoPedido:
Tipo: String 12
sequencia:
Tipo: int 5
- Exemplo:
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.
- Parâmetros:
pin:
Obrigatório, Tipo: String 20
dataInicial
Obrigatório, Tipo: Date
horaInicial
Obrigatório, Tipo: Time
dataFinal
Obrigatório, Tipo: date
horaFinal
Obrigatório, Tipo: Time
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.
- Parâmetros:
pin:
Obrigatório, Tipo: String 20
acao
Obrigatório, Tipo: String 1
C=Cadastrar, E=Excluir
Se for informado algo diferente de C ou E não será aplicado nenhum filtro.
statusRegistro
Obrigatório, Tipo: String 1
L=Liberado, P=Pendente
Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
- Exemplo de Retorno:
- idRegistro
- acao
- statusRegistro
- dataRequisicao
- horaRequisicao
- idCorrelato
- codigoPedido
- dataItem
- codigoMaterial
- situacao
- codigoTipoOperacao
LiberarPendentes
Método que tem por finalidade liberar registros que contenham o status 'P' (Pendente para Integração), conforme ID informado nos parâmetros.
- Parâmetros:
pin:
Obrigatório, Tipo: String 20
id
Obrigatório, Tipo: int
liberarCorrelatos
Tipo: bool
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.
Se Sucesso:
Sucesso.
Visualizar
Método que tem por finalidade o retorno de dados do item do pedido indicado nos parâmetros.
- Parâmetros:
pin:
Obrigatório, Tipo: String 20
codigoPedido
Obrigatório, Tipo: string 12
sequencia
Obrigatório, Tipo: int 5
Excluir
Método que tem por finalidade excluir o item conforme o código do pedido e sequencia indicados.
- Parâmetros:
pin:
Obrigatório, Tipo: String 20
codigoPedido:
Tipo: String 12
sequencia:
Tipo: int 5
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 excluir registro.
Se Sucesso:
Sucesso.
