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

De CIGAM WIKI
← Edição anteriorEdição posterior →
Elizama.Dias (discussão | contribs)
Administradores da interface, Administradores
2 798 edições
Sem resumo de edição
Linha 33: Linha 33:
}}<br>
}}<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
*Fornecedor
** 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: Int 8
*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, E = Terceiros, F = Sem frete, G = Próprio(CIF), H = Próprio (FOB)
*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
*origem
** Tipo: Numeric 1
** 0=NFS, 1=Entrada, 2=Devolução de Entrada, 3 Devolução de Saída, 4=Transferência
*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
*status
** Tipo: String 1
** 1 Não enviado,2 Enviado,3 Confirmado,4 Erro,5 Cancelado,6 Inutilizado,7 Denegado,8 Nota Avulsa,9 EPEC
*operacaoPresencial
** Tipo: String 1
** 1 - Sim; 2 - Internet (não presencial); 3 - Teleatendimento; 4 - NFC-e entrega à domicílio;
** 5 - Sim (fora do estabelecimento); 9 - Outros (não presencial)
*baseDifal
** Tipo: Float 12.6
*valorDifalOrigem
** Tipo: Float 12.6
*valorDifalDestino
** Tipo: Float 12.6
*entrega
** Tipo: Double 11
*buscouNfDaSerie
** Tipo: Bool
*codigoReferenciaEmpresa
** Tipo: String 6
}}<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
*transfCentroArmaz
** Tipo: String 4
*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
*valorAcrescimo
** Tipo: Float 11.2
*valorIcmsStFcp
** Tipo: Bool
*baseDifal
** Tipo: Float 12.6
*valorDifalOrigem
** Tipo: Float 12.6
*valorDifalDestino
** Tipo: Float 12.6
*percentualDifalOrigem
** Tipo: Float 12.6
*percentualDifalDestino
** Tipo: Float 12.6
*proporcaoDifal
** Tipo: Float 12.6
}}<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>
*<b>Parâmetros para o elemento lancamentoNf:</b><br>
{{#tree: minExpandLevel=2 |
*lancamento
** Tipo: Int 10
*data
** Tipo: Date
*vencimento
** Tipo: Date
*fatura
** Tipo: Int 10
*complemento
** Tipo: String 5
*codHistorico
** Tipo: String 3
*historico
** Tipo: String 200
*conta
** Tipo: String 8
*tipo
** Tipo: String 1
*valor
** Tipo: Float 11.2
*cdEmpresa
** Tipo: String 6
*cdCobranca
** Tipo: String 6
*cdPortador
** Tipo: String 3
*Emissão
** Tipo: Date
*saldo
** Tipo: Float 11.2
*conferido
** Tipo: String 1
*situacao
** Tipo: String 1
*conciliado
** Tipo: String 1
*contabilizado
** Tipo: String 1
*tipoPagamento
** Tipo: String 2
*numeroBanco
** Tipo: String 15
*documento
** Tipo: String 20
*tipoDocumento
** Tipo: String 1
*tipoJuros
** Tipo: String 1
*dataInclusao
** Tipo: Date
*sacadorAvalista
** Tipo: String 6
*modalidadeVenc
** Tipo: String 1
*modalidadePag
** Tipo: String 1
*especieDoc
** Tipo: String 2
*vencOriginal
** Tipo: Date
*projeto
** Tipo: String 12
*multRemessaEnviada
** Tipo: String 8
*indice
** Tipo: String 5
*autorizadoPor
** Tipo: String 3
*dataModif
** Tipo: Date
*sessao
** Tipo: Int 8
*adiantRetornCobran
** Tipo: String 6
*formaCobranCtr
** Tipo: String 6
*comandoRemessa
** Tipo: String 6
*ordemEnderCobran
** Tipo: String 1
*tipoMulta
** Tipo: String 1
*pagamento
** Tipo: String 1
*listarIss
** Tipo: String 2
*codigoBarrasLido
** Tipo: String 2
*dataDirf
** Tipo: String 2
*cdCaixa
** Tipo: String 3
*turnoSequencial
** Tipo: String 3
*ordemContaCorrente
** Tipo: String 3
*ctrSequencia
** Tipo: Float 8.6
*sessaoCaixa
** Tipo: String 20
*autoriPlacaGnre
** Tipo: String 20
*lancamentoTerceiro
** Tipo: String 20
*autorizacaoCartao
** Tipo: String 15
*nsuAutenticacaoBancaria
** Tipo: String 10
}}<br>
*<b>Parâmetros para o elemento cheque:</b><br>
{{#tree: minExpandLevel=2 |
*numero
** Tipo: Int 8
*sequencia
** Tipo: Int 4
*lancamentoVinculado
** Tipo: Int 1
*lancamentoOrigPartRel
** Tipo: Int 1
*lancamentoTrocaCheque
** Tipo: Int 1
*vinculadoDadosPreenchido
** Tipo: Int 1
*conta
** Tipo: String 15
*titulo
** Tipo: String 15
*cpfCnpj
** Tipo: String 14
*fone
** Tipo: String 20
*usrinchelan1
** Tipo: String 20
*banco
** Tipo: String 4
*agencia
** Tipo: String 5
*codigoSacado
** Tipo: String 6
*modeloLancamento
** Tipo: String 6
*vinculadoContaFinancei
** Tipo: String 6
*vinculadoOcorrencia
** Tipo: String 6
*div1div2div3
** Tipo: String 6
*digitoVerificador
** Tipo: String 3
*tipoPagamento
** Tipo: String 2
*vinculadoTipoPagamento
** Tipo: String 2
*vinculadoPortador
** Tipo: String 3
*camaraCompensacao
** Tipo: String 3
*vinculadoHistorico
** Tipo: String 3
*complementoNome1
** Tipo: String 10
*complementoNome2
** Tipo: String 10
*nome
** Tipo: String 30
*valor
** Tipo: Float 11.2
*lancamentoDevolucao
** Tipo: Float 12.6
*partesRelSaida
** Tipo: Float 8.6
*remessaCustodiaEnviada
** Tipo: Float 8.6
*usrinchelan3
** Tipo: Float 8.6
*emissao
** Tipo: Date
*vencimento
** Tipo: Date
*devolucao
** Tipo: Date
*dataValidacao
** Tipo: Date
*usrinchelan2
** Tipo: Date
}}<br>


*<b>Distribuição das Tags XML:</b>
*<b>Distribuição das Tags XML:</b>

Edição das 17h28min de 1 de abril 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:



  • 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>

ListarPendentes

  • Parâmetros:


Retorno:
    Se sucesso:


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.

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:


  • 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.

ListarId

LiberarPendentes

ListarNotasFiscaisPaf

ListasNFsMultiplasFormasPagamento

ListarComissoesPorRepresentante

Disponível em “https://www.cigam.com.br/wiki/index.php?title=IN_CadastroNotaFiscal.integrador&oldid=69373”