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

De CIGAM WIKI
Linha 2 611: Linha 2 611:
== LiberarPendentes ==
== LiberarPendentes ==
== ListarNotasFiscais ==
== ListarNotasFiscais ==
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
*nf
** Tipo: Int 10
*serie
** Tipo: String 5
*codigoUnidadeNegocio
** Tipo: String 3
*tipoOperacao
** Tipo: String 5
*codigoCliente
** Tipo: String 6
*codigoRepresentante
** Tipo: String 6
*tipoNota
** Tipo: String 1
** 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
*codigoTransportadora
** Tipo: String 6
*dataEmissaoInicial
** Tipo: Date
*dataEmissaoFinal
** Tipo: Date
}}
<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/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
*<b>Parâmetros para o elemento notaFiscal:</b><br>
{{#tree: minExpandLevel=2 |
*nf
** Tipo: Int 10
*serie
** Tipo: String 5
*valorPISRetencao
** Tipo: Float 11.2
*tipoOperacao
** Tipo: String 5
*CFOP
** Tipo: String 6
*dataEmissao
** Tipo: Date
*viaTransporte
** Tipo: String 1
*documentoFiscal
** Tipo: String 5
*cliente
** Tipo: String 6
*cobranca
** Tipo: String 6
*representante
** Tipo: String 6
*baseICMS
** Tipo: Float 13.2
*percentualICMS
** Tipo: Float 2.4
*valorICMS
** Tipo: Float 11.2
*ICMSNaoTributado
** Tipo: Float 11.2
*ICMSOutros
** Tipo: Float 11.2
*baseIPI
** Tipo: Float 13.2
*valorIPI
** Tipo: Float 11.2
*IPINaoTributado
** Tipo: Float 11.2
*IPIOutros
** Tipo: Float 11.2
*valorISS
** Tipo: Float 11.2
*baseISS
** Tipo: Float 13.2
*incidenciaPIS
** Tipo: String 1
*incidenciaCOFINS
** Tipo: String 1
*percDescontoAteVencimento
** Tipo: Float 3.2
*valorDescDuplicata
** Tipo: Float 11.2
*percDescontoSugestaoItens
** Tipo: Float 3.2
*valorTotalDesconto
** Tipo: Float 11.2
*percGeralOutrasDespAcessorias
** Tipo: Float 3.2
*valorTotalFrete
** Tipo: Float 11.2
*seguro
** Tipo: Float 11.2
*totalMercadorias
** Tipo: Float 13.2
*totalNF
** Tipo: Float 13.2
*transportadora
** Tipo: String 6
*consignatario
** Tipo: String 6
*marca
** Tipo: String 12
*volume
** Tipo: String 15
*quantidade
** Tipo: String 6
*especie
** Tipo: String 16
*pesoLiquido
** Tipo: Float 8.2
*pesoBruto
** Tipo: Float 8.2
*conta
** Tipo: String 6
*portador
** Tipo: String 3
*fatura
** Tipo: Int 10
*cobrarPauta
** Tipo: String 1
** S=Sim, N=Não
*remessa
** Tipo: String 3
*pedido
** Tipo: String 12
*dataSaida
** Tipo: Date
*horaSaida
** Tipo: String 8
** hh:mm:ss
*percGeralEncargosFinanceiros
** Tipo: Float 2.3
*gerouLancamentos
** Tipo: Bool
*itemsNaNota
** Tipo: Int 5
*tipoFrete
** Tipo: String 1
** 1=Emitente (CIF), 2=Destinatario (FOB), 3=EXW, 4=FCA, 5=FAS, 6=CFR, 7=CPT, 8=CIP, 9=DAF, A=DES, B=DEQ, C=DDU, D= DDP
*uf
** Tipo: String 2
*percentualComissao
** Tipo: Float 3.2
*placa
** Tipo: String 8
*valorIRRF
** Tipo: Float 11.2
*especieNota
** Tipo: String 1
** E=Entrada, S=Saída, N=Nula
*subtotalizar
** Tipo: Bool
*incidenciaISS
** Tipo: String 1
*ateNota
** Tipo: Int 10
*totalFaturado
** Tipo: Float 13.2
*totalServico
** Tipo: Float 13.2
*valorTotalOutrasDespesasAcess
** Tipo: Float 11.2
*valorTotalEncargosFinanceiros
** Tipo: Float 11.2
*substitutoTributario
** Tipo: String 6
*notaReferencia
** Tipo: Int 10
*baseSubstituicaoTributaria
** Tipo: Float 13.2
*valorSubstituicaoTributaria
** Tipo: Float 13.2
*percentualIRRF
** Tipo: Float 3.2
*percentualINSS
** Tipo: Float 3.2
*condicaoPagamento
** Tipo: String 3
*percentualISS
** Tipo: Float 3.2
*complementoFatura
** Tipo: String 5
*contabilizado
** Tipo: String 1
*faturaAglutinada
** Tipo: String 1
** S=Sim, N=Não
*gerouINSS
** Tipo: String 1
*serieReferencia
** Tipo: String 5
*codigoMunicipio
** Tipo: String 10
*valorDeducoes
** Tipo: Float 13.2
*valorINSS
** Tipo: Float 11.2
*unidadeNegocio
** Tipo: String 3
*quantidadeTotal
** Tipo: Float 8.6
*impressa
** Tipo: Bool
*declaracaoImportacao
** Tipo: String 12
*percentualICMSSubstituicao
** Tipo: Float 3.2
*percentualComissaoAReceber
** Tipo: Float 3.2
*notaIncentivada
** Tipo: Bool
*taxaIndexador
** Tipo: Float 10.5
*indiceIndexador
** Tipo: String 5
*baseIRRF
** Tipo: Float 13.2
*modeloCupom
** Tipo: String 3
*numeroControleFormulario
** Tipo: String 12
*romaneio
** Tipo: Integer 10
*dataRomaneio
** Tipo: Date
*ufPlacaTransportador
** Tipo: String 2
*percGeralDesconto
** Tipo: Float 3.2
*valorInformODA
** Tipo: Float 4.2
*percFreteInformativo
** Tipo: Float 3.2
*codigoCancelamento
** Tipo: String 3
*codigoDevolucao
** Tipo: String 3
*ordemCompra
** Tipo: String 12
*projeto
** Tipo: String 12
*modeloFormulario
** Tipo: Int 2
*notaIPIECFGerada
** Tipo: Bool
*creditoICMSPresumido
** Tipo: Float 11.2
*percentualFunrural
** Tipo: Float 3.2
*valorFunrural
** Tipo: Float 11.2
*dataNFTriangularAglutinada
** Tipo: Date
*dataValidacao
** Tipo: Date
*dataCancelamento
** Tipo: Date
*campo125
** Tipo: Date
*ordemDeCompraGerada
** Tipo: String 2
*totalItensServico
** Tipo: Int 7
*pesoExtraEmbalagem
** Tipo: Float 8.6
*usrnota1
** Tipo: String 20
*usrnota2
** Tipo: Date
*chaveNFe
** Tipo: String 44
*numeroProtocolo
** Tipo: String 15
*numeroLote
** Tipo: String 15
*gerouPedidoConsignacao
** Tipo: String 1
*listarLivros
** Tipo: String 1
*tipoNota
** Tipo: String 1
** N=Normal, D=Devolução, T=Transferencia, C=Complementar, I=Importação, M=Mapa Resumo, S=Sessão Crédito ICMS,
** B=Brinde, F=Frete/Conhecimento, G=Garantia_Troca, V=Venda a Ordem, R=Remessa, 1=1 Genérico,
** 2=2 Genérico, 3=3 Genérico, E=Entrega_Futura
*classificacaoDocumento
** Tipo: String 1
*incluiSubstituicaoTributaria
** Tipo: String 1
*mercado
** Tipo: String 2
*grade
** Tipo: String 2
*incidenciaContribSocial
** Tipo: String 1
** S=Soma, D=Diminui, N=Nao considera
*folhaLivroSaida
** Tipo: String 6
*tgConversaoUnidades
** Tipo: String 6
*fornecedor
** Tipo: String 6
*volumeAtualizado
** Tipo: String 6
*ordemEnderecoCobranca
** Tipo: String 1
*ordemEnderecoEntrega
** Tipo: String 1
*forma
** Tipo: String 1
** C=Carnê, D=Duplicata, F=Financiamento, P=Prédatado, E=Empresa Convênio, R=Representada
*tipoFreteConsignatario
** Tipo: String 2
** 1=1 Emitente (CIF), 2=2 Destinatário (FOB)
*conferido
** Tipo: String 2
*numeroLivroSaida
** Tipo: String 3
*usuarioAutorizado
** Tipo: String 3
*entregMercAposFatur
** Tipo: String 3
*impostosAjustados
** Tipo: Bool
*nfInconsistente
** Tipo: Bool
*buscarRegraFiscal
** Tipo: Bool
*contatoCliente
** Tipo: Float 8.6
*percICMSResponsabilidade
** Tipo: Float 8.6
*valorSuframaSimbahia
** Tipo: Float 11.2
*valorAVista
** Tipo: Float 11.2
*valorCOFINSRetencao
** Tipo: Float 13.2
*valorContribuicaoSocial
** Tipo: Float 13.2
*valorInformDesconto
** Tipo: Float 11.2
*naoCalcularFinanceiro
** Tipo: Bool
*naoCalcularComissoes
** Tipo: Bool
*usrfacomplnf3
** Tipo: Double 11
}}<br/>
*<b>Parâmetros para o elemento itemNf:</b><br>
{{#tree: minExpandLevel=2 |
*tipoOperacao
** Tipo: String 5
*dataMovimento
** Tipo: Date
*codigoMaterial
** Tipo: String 20
*especif1
** Tipo: String 6
*especif2
** Tipo: String 6
*centroArmazenagem
** Tipo: String 4
*grade
** Tipo: String 2
*quantidade
** Tipo: Float 8.6
*pecas
** Tipo: Float 8.6
*precoUnitario
** Tipo: Float 9.6
*descricao
** Tipo: String 201
*documento
** Tipo: String 10
*empresa
** Tipo: String 6
*contaGerencial
** Tipo: String 25
*tipoDocumento
** Tipo: String 5
*tabelaPreco
** Tipo: String 6
*incidenciaISS
** Tipo: String 1
*percentualISS
** Tipo: Float 3.2
*percentualReducaoISS
** Tipo: Float 3.5
*baseISS
** Tipo: Float 3.2
*valorISS
** Tipo: Float 11.2
*baseIRRF
** Tipo: Float 13.2
*valorIRRF
** Tipo: Float 11.2
*baseINSS
** Tipo: Float 13.2
*valorINSS
** Tipo: Float 11.2
*percentualReducaoINSS
** Tipo: Float 3.2
*percentualINSSAdicional
** Tipo: Float 3.2
*percentualImpImportacao
** Tipo: Float 3.2
*tipoNota
** Tipo: String 1
*baseICMS
** Tipo: Float 13.2
*ICMSIsenta
** Tipo: Float 13.2
*ICMSOutros
** Tipo: Float 13.2
*baseIPI
** Tipo: Float 13.2
*IPIIsenta
** Tipo: Float 13.2
*IPIOutras
** Tipo: Float 13.2
*percentualPISRetencao
** Tipo: Float 3.2
*percentualCOFINSRetencao
** Tipo: Float 3.2
*percentualCSLLRetencao
** Tipo: Float 3.2
*percentualFunrural
** Tipo: Float 3.2
*valorFunrural
** Tipo: Float 11.2
*valorSimbahia
** Tipo: Float 11.2
*serie
** Tipo: String 5
*CFOP
** Tipo: String 6
*percentualICMS
** Tipo: Float 2.1
*basePIS
** Tipo: Float 11.2
*valorPIS
** Tipo: Float 11.2
*baseCOFINS
** Tipo: Float 11.2
*valorCOFINS
** Tipo: Float 11.2
*basePISRetencao
** Tipo: Float 11.2
*valorPISRetencao
** Tipo: Float 11.2
*baseCOFINSRetencao
** Tipo: Float 11.2
*valorCOFINSRetencao
** Tipo: Float 11.2
*baseCSLLRetencao
** Tipo: Float 11.2
*valorCSLLRetencao
** Tipo: Float 11.2
*valorImpImportacao
** Tipo: Float 11.2
*percentualSimbahia
** Tipo: Float 3.2
*percentualSuframa
** Tipo: Float 3.2
*baseSimbahia
** Tipo: Float 11.2
*baseSuframa
** Tipo: Float 11.2
*baseImpImportacao
** Tipo: Float 11.2
*baseFunrural
** Tipo: Float 11.2
*codigoTipoDocumento
** Tipo: String 3
*percReducaoIPI
** Tipo: Float 8.6
*percReducaoST
** Tipo: Float 8.6
*percIGI
** Tipo: Float 8.6
*percICMS*_IGI
** Tipo: Float 11.2
*ICMSDiferido
** Tipo: Float 11.2
*baseIGI
** Tipo: Float 11.2
*retencaoInformada
** Tipo: String 6
*complementoIncidIPI
** Tipo: String 1
*ICMSPresumido
** Tipo: String 1
*CSTPIS
** Tipo: String 2
*CSTCOFINS
** Tipo: String 2
*codBaseCreditoPisCofinsEntrad
** Tipo: String 2
*impostosAjustados
** Tipo: Bool
*sequenciaNota
** Tipo: Int 5
*valorIGI
** Tipo: Float 11.2
*baseSubtituicaoObs
** Tipo: Float 11.2
*valorSubstituicaoObs
** Tipo: Float 13.2
*freteInternacional
** Tipo: Float 13.2
*seguroInternacional
** Tipo: Float 13.2
*descontoISS
** Tipo: Float 13.2
*ValorContabil
** Tipo: Float 11.2
*incidenciaIPI
** Tipo: String 1
*percentualIPI
** Tipo: Float 2.1
*percentaulIRRF
** Tipo: Float 2.2
*percentualDesconto
** Tipo: Float 3.2
*ValorICMS
** Tipo: Float 11.2
*valorIPI
** Tipo: Float 11.2
*percentualComissao
** Tipo: Float 2.4
*valorDesconto
** Tipo: Float 11.2
*valorFrete
** Tipo: Float 11.2
*baseSubstituicao
** Tipo: Float 11.2
*percentaulSubstituicao
** Tipo: Float 3.2
*valorSuframaSimbahia
** Tipo: Float 11.2
*percentualINSS
** Tipo: Float 3.2
*incidenciaICMS
** Tipo: Bool 1
*incidenciaPIS
** Tipo: Bool 1
*incidenciaCOFINS
** Tipo: Bool 1
*incidenciaICMSEntrada
** Tipo: Bool 1
*complementoIncidenciaICMS
** Tipo: Bool 1
*percentualReducaoSimbahia
** Tipo: Float 3.2
*incidenciaContribSocial
** Tipo: Bool 1
*percentualPIS
** Tipo: Float 2.4
*percentualCreditoPIS*_COFINS
** Tipo: Float 3.2
*reducaoICMS*_ISS
** Tipo: Float 3.5
*valorBaseSubstituicao
** Tipo: Float 8.6
*percentualICMSSubstituicao
** Tipo: Float 3.2
*valorIPIObs
** Tipo: Float 11.2
*valorSeguro
** Tipo: Float 11.2
*percentualCOFINS
** Tipo: Float 3.2
*valorSubstituicao
** Tipo: Float 11.2
*totalDespesaItem
** Tipo: Float 13.2
*totalCompras
** Tipo: Float 8.6
*transfCentroArmaz
** Tipo: String 4
*precoTotalCusto
** Tipo: Float 10.5
*usuarioModificacao
** Tipo: String 3
*contraPartTransferencia
** Tipo: Int 8
*estorno
** Tipo: String 1
*sequenciaDia
** Tipo: Int 8
*pedidoOc
** Tipo: String 12
*totalEntradas
** Tipo: Float 8.6
*custoMedio
** Tipo: Float 10.5
*totalEstoque
** Tipo: Float 13.2
*percentualContribSocial
** Tipo: Float 3.2
*indice
** Tipo: String 5
*outrasDespesasAcessorias
** Tipo: Float 11.2
*ordenacao
** Tipo: String 6
*sequenciaPedidoOc
** Tipo: Int 5
*baseICMSComIPI
** Tipo: Bool 1
*difAliquotaPercImportacao
** Tipo: Float 3.
*transfUnNegocio
** Tipo: String 3
*contrato
** Tipo: String 8
*contabil
** Tipo: String 8
*aglitinouConverteu
** Tipo: Bool 1
*codigoRetorno
** Tipo: String 2
*contabilidade
** Tipo: String 1
*valorEncargosFinanceiros
** Tipo: Float 11.2
*sessao
** Tipo: Int 8
*dataModificacao
** Tipo: Date
*dataValidacao
** Tipo: Date
*valorICMSOutrosNaoDestacado
** Tipo: Float 11.2
*excecaoNCM
** Tipo: String 4
*etiquetaHex
** Tipo: String 6
*totalEntradasIndepCA
** Tipo: Float 8.6
*totalSaidasIndepCA
** Tipo: Float 8.6
*inspecao
** Tipo: String 1
*itemOS
** Tipo: Int 5
*classePedidoExclusivo4
** Tipo: String 1
*buscarRegraFiscal
** Tipo: Bool 1
*impostoImportacao
** Tipo: Bool 1
*descontoInformado
** Tipo: Bool 1
*totalSaidas
** Tipo: Float 8.6
*sequenciaDiaPedidoOC
** Tipo: Int 8
*os
** Tipo: Int 6
*saidaSemSaldo
** Tipo: String 10
*usrmovi2
** Tipo: String 20
*usrmovi3
** Tipo: Date
*usrmovi4
** Tipo: Float 10.5
}}<br/>
*<b>Parâmetros para o elemento gradeItemNf:</b><br>
{{#tree: minExpandLevel=2 |
*movimento
** Tipo: Int 8
*numeracao
** Tipo: String 4
*codigoEspecif3
** Tipo: String 6
*lote
** Tipo: String 14
*quantidade
** Tipo: Float 8.6
*validadeLote
** Tipo: Date
}}<br/>
*<b>Parâmetros para o elemento comissaoNf:</b><br>
{{#tree: minExpandLevel=2 |
*nf
** Tipo: Int 10
*Serie
** Tipo: String 5
*unidadeDeNegocio
** Tipo: String 3
*clienteFornecedor
** Tipo: String 5
*EspecieNF
** Tipo: String 1
** E=Entrada, S=Saida, N=Nula
*SequenciaNF
** Tipo: Int 5
*Representante
** Tipo: String 5
*valorBaseComissao
** Tipo: Float 11.2
*percentualComissao
** Tipo: Float 3.7
*tipoBaseComissao
** Tipo: String 5
*percComissaoOrigRepresentante
** Tipo: Float 3.7
*percentualReducaoBaseComissao
** Tipo: Float 3.2
*lancamentoComissao
** Tipo: Bool
*origem
** Tipo: String 1
** M=Manual, S=Sistema, V=Vendedor, C=Contato, A=Agenciamento
}}<br/>
*<b>Parâmetros para o elemento parcelaNf:</b><br>
{{#tree: minExpandLevel=2 |
*nf
** Tipo: Int 10
*serie
** Tipo: String 5
*unidadeDeNegocio
** Tipo: String 3
*vencimento
** Tipo: Date
*valorParcela
** Tipo: Float 12.6
*nossoNumero
** Tipo: String 25
*modeloLancamento
** Tipo: String 6
}}<br/>
<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/>
== ListarNotasFiscaisPaf ==
== ListarNotasFiscaisPaf ==
== ListasNFsMultiplasFormasPagamento ==
== ListasNFsMultiplasFormasPagamento ==
== ListarComissoesPorRepresentante ==
== ListarComissoesPorRepresentante ==

Edição das 17h07min de 17 de fevereiro de 2022

Voltar

CadastrarNotasFiscais

Cadastra notas fiscais, itens, grades, comissões e parcelas em uma única requisição. Os dados da Nota Fiscal 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. As Notas Fiscais de Entrada não possuem listagem, foi liberado somente o cadastro da mesma via integração.

  • Parâmetros:


  • Parâmetros para o elemento notaFiscal:


  • Parâmetros para o elemento itemNf:


  • Parâmetros para o elemento gradeItemNf:


  • Parâmetros para o elemento comissaoNf:


  • Parâmetros para o elemento parcelaNf:


  • Parâmetros para o elemento lancamentoNf:


  • Parâmetros para o elemento cheque:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:


Retorno:
   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.

ListarNotasFiscaisInutilizadas

Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.

  • Parâmetros:


  • Exemplo de Retorno XML:


  • Exemplo de Retorno JSON:

RegistrarNotaFiscalInutilizada

Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.

  • Parâmetros:


Retorno:
   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.

ExcluirNotaFiscal

Esse método fará as mesmas validações que ocorrem ao tentar excluir uma NFe manualmente, com a diferença que permitirá a exclusão de notas fiscais confirmadas, visto que o cancelamento na SEFAZ já foi feito através de um sistema de terceiros.

Informações obrigatórias para a exclusão da nota: Número, Série e Unidade de Negócio. O sistema faz a validação se a série da nota fiscal está cadastrada para a unidade de negócio informada nos filtro do programa utilizado para integração.

  • Parâmetros:

    <pin Type="System.String">001</pin>
    <statusRegistro Type="System.String">L</statusRegistro>
    <nf Type="System.Int32">número NF</nf>
    <serie Type="System.String">série NF</serie>
    <codigoUnidadeNegocio Type="System.String">UN NEG NF</codigoUnidadeNegocio>

ListarId

ListarPendentes

LiberarPendentes

ListarNotasFiscais

  • Parâmetros:


Retorno:
   Se sucesso:

  • Parâmetros para o elemento notaFiscal:


  • Parâmetros para o elemento itemNf:


  • Parâmetros para o elemento gradeItemNf:


  • Parâmetros para o elemento comissaoNf:


  • Parâmetros para o elemento parcelaNf:



   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.

ListarNotasFiscaisPaf

ListasNFsMultiplasFormasPagamento

ListarComissoesPorRepresentante