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

De CIGAM WIKI
← Edição anteriorEdição posterior →
Camila.Oliveira (discussão | contribs)
Administradores da interface, Administradores
5 242 edições
Sem resumo de edição
Sem resumo de edição
Linha 2: Linha 2:
**<b>Soap:</b> http://servidor/CadastroNotaFiscal.integrador.asmx
**<b>Soap:</b> http://servidor/CadastroNotaFiscal.integrador.asmx
**<b>Rest/JSon:</b> http://servidor/CadastroNotaFiscal.integrador.ashx/metodo
**<b>Rest/JSon:</b> http://servidor/CadastroNotaFiscal.integrador.ashx/metodo
***<b>Tipo de registro:</b> CADNF
***<b>Tipo de registro:</b> CADNF1
 
== CadastrarNotasFiscais ==
<p align=“justify”><i> 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.
</i></p>
 
*<b>Parâmetros:</b><br>
{{#tree: minExpandLevel=2 |
*pin
** Obrigatório, Tipo: String 20
 
*statusRegistro
** Tipo: String 1
** L=Liberado, P=Pendente
** Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
 
*notaFiscalXml
** Tipo: String -
** Conteúdo de um arquivo XML com as notas fiscais, itens, grades, comissões e parcelas.
** Obrigatório apenas para requisições SOAP.
 
*notaFiscalJson
** Tipo: String -
** Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.
** Obrigatório apenas para requisições REST/JSON.
}}<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
}}
 
*<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
}}
 
*<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
}}
 
*<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
}}
 
*<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
}}
 
*<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
}}
 
*<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><br>
{{#tree: minExpandLevel=2 |
*<cadastroNotaFiscal>
**<notasFiscais>
***<notaFiscal>
****<serie>001</serie>
****<tipoOperacao>1101G</tipoOperacao>
****<CFOP>1101</CFOP>
****<dataEmissao>00/00/0000</dataEmissao>
****<viaTransporte>R</viaTransporte>
****<viaTransporte>R</viaTransporte>
****<documentoFiscal>NF</documentoFiscal>
****<baseICMS>00.00</baseICMS>
****<percentualICMS>12</percentualICMS>
****<valorICMS>0.00</valorICMS>
****<ICMSOutros>0</ICMSOutros>
****<baseIPI>0</baseIPI>
****<valorIPI>0</valorIPI>
****<IPINaoTributado>0</IPINaoTributado>
****<IPIOutros>00.00</IPIOutros>
****<valorISS>0</valorISS>
****<baseISS>0</baseISS>
****<incidenciaPIS>N</incidenciaPIS>
****<incidenciaCOFINS>N</incidenciaCOFINS>
****<totalMercadorias>500</totalMercadorias>
****<totalNF>500</totalNF>
****<quantidade>1</quantidade>
****<conta>010102</conta>
****<portador>000</portador>
****<fatura/>
****<remessa/>
****<dataSaida>00/00/0000</dataSaida>
****<gerouLancamentos>false</gerouLancamentos>
****<itemsNaNota>1</itemsNaNota>
****<tipoFrete>1</tipoFrete>
****<uf>BA</uf>
****<valorIRRF>0</valorIRRF>
****<ateNota/>
****<totalFaturado>500</totalFaturado>
****<notaReferencia/>
****<baseSubstituicaoTributaria>00.00</baseSubstituicaoTributaria>
****<valorSubstituicaoTributaria>0.00</valorSubstituicaoTributaria>
****<percentualINSS>0</percentualINSS>
****<condicaoPagamento>001</condicaoPagamento>
****<percentualISS>0</percentualISS>
****<contabilizado/>
****<serieReferencia/>
****<codigoMunicipio/>
****<valorINSS>0</valorINSS>
****<unidadeNegocio>2</unidadeNegocio>
****<impressa>false</impressa>
****<codigoCancelamento/>
****<codigoDevolucao/>
****<ordemCompra/>
****<projeto/>
****<modeloFormulario>55</modeloFormulario>
****<percentualFunrural>0</percentualFunrural>
****<valorFunrural>0</valorFunrural>
****<chaveNFe/>
****<numeroProtocolo/>
****<numeroLote>0</numeroLote>
****<listarLivros>2</listarLivros>
****<tipoNota>E</tipoNota>
****<classificacaoDocumento/>
****<mercado>05</mercado>
****<grade/>
****<folhaLivroSaida/>
****<tgConversaoUnidades/>
****<fornecedor>XXXXXX</fornecedor>
****<numeroLivroSaida/>
****<usuarioAutorizado/>
****<impostosAjustados>true</impostosAjustados>
****<nfInconsistente/>
****<buscarRegraFiscal>false</buscarRegraFiscal>
****<valorContribuicaoSocial/>
****<tipoPagamento/>
****<naoCalcularFinanceiro>true</naoCalcularFinanceiro>
****<status/>
****<observacoes>TESTE INTEGRACAO NFE</observacoes>
****<operacaoPresencial/>
****<origem>1</origem>
****<unidadeNegocioReferencia/>
****<buscouNfDaSerie/>
****<codigoReferenciaEmpresa />
****<itensNf>
*****<itemNotaFiscal>
******<movimento/>
******<unidadeNegocio>2</unidadeNegocio>
******<tipoOperacao>1101G</tipoOperacao>
******<dataMovimento>00/00/0000</dataMovimento>
******<codigoMaterial>000000</codigoMaterial>
******<especif1/>
******<especif2/>
******<centroArmazenagem>1</centroArmazenagem>
******<grade/>
******<quantidade>1</quantidade>
******<pecas>0</pecas>
******<precoUnitario>0</precoUnitario>
******<descricao/>
******<documento/>
******<empresa>XXXXXX</empresa>
******<contaGerencial/>
******<tipoDocumento>XX</tipoDocumento>
******<tabelaPreco/>
******<incidenciaISS>N</incidenciaISS>
******<percentualISS>0</percentualISS>
******<percentualReducaoISS>0</percentualReducaoISS>
******<baseISS>0</baseISS>
******<valorISS>0</valorISS>
******<baseIRRF>0</baseIRRF>
******<valorIRRF>0</valorIRRF>
******<baseINSS>0</baseINSS>
******<valorINSS>0</valorINSS>
******<percentualReducaoINSS>0</percentualReducaoINSS>
******<percentualINSSAdicional>0</percentualINSSAdicional>
******<percentualImpImportacao>0</percentualImpImportacao>
******<tipoNota>N</tipoNota>
******<baseICMS>00.00</baseICMS>
******<ICMSIsenta>0</ICMSIsenta>
******<ICMSOutros>0</ICMSOutros>
******<baseIPI>0</baseIPI>
******<IPIIsenta>0</IPIIsenta>
******<IPIOutras>00.00</IPIOutras>
******<percentualPISRetencao>0</percentualPISRetencao>
******<percentualCOFINSRetencao>0</percentualCOFINSRetencao>
******<percentualCSLLRetencao>0</percentualCSLLRetencao>
******<percentualFunrural>0</percentualFunrural>
******<valorFunrural>0</valorFunrural>
******<valorSimbahia>0</valorSimbahia>
******<serie>XXX</serie>
******<notaFiscal/>
******<CFOP>1101</CFOP>
******<percentualICMS>00</percentualICMS>
******<basePIS>0</basePIS>
******<valorPIS>0</valorPIS>
******<baseCOFINS>0</baseCOFINS>
******<valorCOFINS>0</valorCOFINS>
******<basePISRetencao>0</basePISRetencao>
******<valorPISRetencao>0</valorPISRetencao>
******<baseCOFINSRetencao>0</baseCOFINSRetencao>
******<valorCOFINSRetencao>0</valorCOFINSRetencao>
******<baseCSLLRetencao>0</baseCSLLRetencao>
******<valorCSLLRetencao>0</valorCSLLRetencao>
******<valorImpImportacao>0</valorImpImportacao>
******<percentualSimbahia>0</percentualSimbahia>
******<percentualSuframa>0</percentualSuframa>
******<baseSimbahia>0</baseSimbahia>
******<baseSuframa>0</baseSuframa>
******<baseImpImportacao>0</baseImpImportacao>
******<baseFunrural>0</baseFunrural>
******<codigoTipoDocumento/>
******<percReducaoIPI>0</percReducaoIPI>
******<percReducaoST/>
******<percIGI>0</percIGI>
******<percICMS_IGI>0</percICMS_IGI>
******<ICMSDiferido/>
******<baseIGI>0</baseIGI>
******<retencaoInformada/>
******<complementoIncidIPI>0</complementoIncidIPI>
******<ICMSPresumido>0</ICMSPresumido>
******<CSTPIS>00</CSTPIS>
******<CSTCOFINS>00</CSTCOFINS>
******<codBaseCreditoPisCofinsEntrad/>
******<impostosAjustados>true</impostosAjustados>
******<sequenciaNota>0</sequenciaNota>
******<valorIGI>0</valorIGI>
******<baseSubtituicaoObs/>
******<valorSubstituicaoObs/>
******<freteInternacional/>
******<seguroInternacional/>
******<descontoISS/>
******<valorContabil>00.00</valorContabil>
******<usrmovi2/>
******<usrmovi1/>
******<incidenciaIPI>3</incidenciaIPI>
******<incidenciaICMS>1</incidenciaICMS>
******<incidenciaPIS>N</incidenciaPIS>
******<incidenciaCOFINS>N</incidenciaCOFINS>
******<percentualIPI/>
******<percentualIRRF>0</percentualIRRF>
******<percentualDesconto>0</percentualDesconto>
******<valorICMS>0.00</valorICMS>
******<valorIPI>0</valorIPI>
******<percentualComissao>0</percentualComissao>
******<valorDesconto>0</valorDesconto>
******<valorFrete>0</valorFrete>
******<baseSubstituicao>00.00</baseSubstituicao>
******<percentualSubstituicao>00.00</percentualSubstituicao>
******<valorSuframaSimbahia>0</valorSuframaSimbahia>
******<percentualINSS>0</percentualINSS>
******<incidenciaICMSEntrada/>
******<complementoIncidenciaICMS>0</complementoIncidenciaICMS>
******<percentualReducaoSimbahia>0</percentualReducaoSimbahia>
******<incidenciaContribSocial>N</incidenciaContribSocial>
******<percentualPIS>0</percentualPIS>
******<percentualCreditoPISCOFINS>0</percentualCreditoPISCOFINS>
******<reducaoICMSISS>0</reducaoICMSISS>
******<valorBaseSubstituicao>0</valorBaseSubstituicao>
******<percentualICMSSubstituicao>00</percentualICMSSubstituicao>
******<valorIPIObs>0</valorIPIObs>
******<valorSeguro>0</valorSeguro>
******<percentualCOFINS>0</percentualCOFINS>
******<valorSubstituicao>0.0</valorSubstituicao>
******<totalDespesaItem>0</totalDespesaItem>
******<totalCompras>0</totalCompras>
******<transfCentroArmaz/>
******<precoTotalCusto>0</precoTotalCusto>
******<contraPartTransferencia/>
******<estorno/>
******<sequenciaDia/>
******<pedidoOc/>
******<totalEntradas/>
******<custoMedio/>
******<totalEstoque/>
******<percentualContribSocial/>
******<indice/>
******<outrasDespesasAcessorias/>
******<ordenacao/>
******<sequenciaPedidoOC/>
******<baseICMSComIPI/>
******<difAliquotaPercImportacao/>
******<transfUnNegocio/>
******<contrato/>
******<contabil/>
******<aglitinouConverteu/>
******<codigoRetorno/>
******<contabilidade/>
******<valorEncargosFinanceiros/>
******<dataValidacao/>
******<valorICMSOutrosNaoDestacado/>
******<excecaoNCM/>
******<etiquetaHex/>
******<totalEntradasIndepCA/>
******<totalSaidasIndepCA/>
******<inspecao/>
******<itemOS/>
******<classePedidoExclusivo4/>
******<buscarRegraFiscal>false</buscarRegraFiscal>
******<impostoImportacao/>
******<descontoInformado/>
******<totalSaidas/>
******<sequenciaDiaPedidoOC/>
******<os/>
******<saidaSemSaldo/>
******<usrmovi2_1/>
******<usrmovi3/>
******<usrmovi4/>
******<serieItemReferencia>XXX</serieItemReferencia>
******<notaItemReferencia>000000000</notaItemReferencia>
******<empresaItemReferencia>XXXXXX</empresaItemReferencia>
******<tipoItemReferencia>X</tipoItemReferencia>
******<sequenciaNfItemReferencia>0</sequenciaNfItemReferencia>
*******<tipoOperacaoItemReferencia>XXXX</tipoOperacaoItemReferencia>
******</itemNotaFiscal>
*****</itensNf>
****
****<lancamentosNf>
*****<lancamentoNf>
******  <data>00/00/0000</data>
******  <vencimento>00/00/0000</vencimento>
******  <fatura>0</fatura>
******  <complemento>XXXXX</complemento>
******  <historico>XXX</historico>
******  <tipo>X</tipo>
******  <valor>0</valor>
******  <cdEmpresa>XXXXXX</cdEmpresa>
******  <cdCobranca>XXXXXX</cdCobranca>
******  <cheque>0</cheque>
******  <cdPortador>000</cdPortador>
******  <emissao>00/00/0000</emissao>
******  <saldo>0</saldo>
******  <situacao>X</situacao>
******  <contabilizado>X</contabilizado>
******  <tipoJuros>X</tipoJuros>
******  <listarIss>N</listarIss>
******  <vencOriginal>00/00/0000</vencOriginal>
******  <autorizacaoCartao>9215566322185UA</autorizacaoCartao>
******  <nsuAutenticacaoBancaria>9621744OOS</nsuAutenticacaoBancaria>
*****  </lancamentoNf>
****</lancamentosNf>
****<parcelasNf>
*****<parcelaNf>
******<nf>0000000000</nf>
******<serie>000</serie>
******<unidadeNegocio>00</unidadeNegocio>
******<vencimento>00/00/0000</vencimento>
******<valorParcela>0</valorParcela>
*****</parcelaNf>
****</parcelasNf>
****</parcelasNf >
***</notaFiscal>
**</notasFiscais>
*</cadastroNotaFiscal>
}}<br>
 
*<b>Distribuição das Tags Json:</b><br>
{{#tree: minExpandLevel=2 |
*{
**"notasFiscais": [
***{
****"serie": "001",
****"tipoOperacao": "1101G",
****"CFOP": "1101",
****"dataEmissao": "00/00/0000",
****"viaTransporte": "R",
****"documentoFiscal": "NF",
****"baseICMS": "00.00",
****"percentualICMS": "12",
****"valorICMS": "0.00",
****"ICMSOutros": "0",
****"baseIPI": "0",
****"valorIPI": "0",
****"IPINaoTributado": "0",
****"IPIOutros": "00.00",
****"valorISS": "0",
****"baseISS": "0",
****"incidenciaPIS": "N",
****"incidenciaCOFINS": "N",
****"totalMercadorias": "500",
****"totalNF": "500",
****"quantidade": "1",
****"conta": "010102",
****"portador": "000",
****"fatura": "",
****"remessa": "",
****"dataSaida": "00/00/0000",
****"gerouLancamentos": "false",
****"itemsNaNota": "1",
****"tipoFrete": "1",
****"uf": "BA",
****"valorIRRF": "0",
****"ateNota": "",
****"totalFaturado": "500",
****"notaReferencia": "",
****"baseSubstituicaoTributaria": "00.00",
****"valorSubstituicaoTributaria": "0.00",
****"percentualINSS": "0",
****"condicaoPagamento": "001",
****"percentualISS": "0",
****"contabilizado": "",
****"serieReferencia": "",
****"codigoMunicipio": "",
****"valorINSS": "0",
****"unidadeNegocio": "2",
****"impressa": "false",
****"codigoCancelamento": "",
****"codigoDevolucao": "",
****"ordemCompra": "",
****"projeto": "",
****"modeloFormulario": "55",
****"percentualFunrural": "0",
****"valorFunrural": "0",
****"chaveNFe": "",
****"numeroProtocolo": "",
****"numeroLote": "0",
****"listarLivros": "2",
****"tipoNota": "E",
****"classificacaoDocumento": "",
****"mercado": "05",
****"grade": "",
****"folhaLivroSaida": "",
****"tgConversaoUnidades": "",
****"fornecedor": "XXXXXX",
****"numeroLivroSaida": "",
****"usuarioAutorizado": "",
****"impostosAjustados": "true",
****"nfInconsistente": "",
****"buscarRegraFiscal": "false",
****"valorContribuicaoSocial": "",
****"tipoPagamento": "",
****"naoCalcularFinanceiro": "true",
****"status": "",
****"observacoes": "TESTE INTEGRACAO NFE",
****"operacaoPresencial": "",
****"origem": "1",
****"unidadeNegocioReferencia": "",
****"buscouNfDaSerie": "",
****"codigoReferenciaEmpresa": "",
****"itensNf": [
*****{
******"movimento": "",
******"unidadeNegocio": "2",
******"tipoOperacao": "1101G",
******"dataMovimento": "00/00/0000",
******"codigoMaterial": "000000",
******"especif1": "",
******"especif2": "",
******"centroArmazenagem": "1",
******"grade": "",
******"quantidade": "1",
******"pecas": "0",
******"precoUnitario": "0",
******"descricao": "",
******"documento": "",
******"empresa": "XXXXXX",
******"contaGerencial": "",
******"tipoDocumento": "XX",
******"tabelaPreco": "",
******"incidenciaISS": "N",
******"percentualISS": "0",
******"percentualReducaoISS": "0",
******"baseISS": "0",
******"valorISS": "0",
******"baseIRRF": "0",
******"valorIRRF": "0",
******"baseINSS": "0",
******"valorINSS": "0",
******"percentualReducaoINSS": "0",
******"percentualINSSAdicional": "0",
******"percentualImpImportacao": "0",
******"tipoNota": "N",
******"baseICMS": "00.00",
******"ICMSIsenta": "0",
******"ICMSOutros": "0",
******"baseIPI": "0",
******"IPIIsenta": "0",
******"IPIOutras": "00.00",
******"percentualPISRetencao": "0",
******"percentualCOFINSRetencao": "0",
******"percentualCSLLRetencao": "0",
******"percentualFunrural": "0",
******"valorFunrural": "0",
******"valorSimbahia": "0",
******"serie": "XXX",
******"notaFiscal": "",
******"CFOP": "1101",
******"percentualICMS": "00",
******"basePIS": "0",
******"valorPIS": "0",
******"baseCOFINS": "0",
******"valorCOFINS": "0",
******"basePISRetencao": "0",
******"valorPISRetencao": "0",
******"baseCOFINSRetencao": "0",
******"valorCOFINSRetencao": "0",
******"baseCSLLRetencao": "0",
******"valorCSLLRetencao": "0",
******"valorImpImportacao": "0",
******"percentualSimbahia": "0",
******"percentualSuframa": "0",
******"baseSimbahia": "0",
******"baseSuframa": "0",
******"baseImpImportacao": "0",
******"baseFunrural": "0",
******"codigoTipoDocumento": "",
******"percReducaoIPI": "0",
******"percReducaoST": "",
******"percIGI": "0",
******"percICMS_IGI": "0",
******"ICMSDiferido": "",
******"baseIGI": "0",
******"retencaoInformada": "",
******"complementoIncidIPI": "0",
******"ICMSPresumido": "0",
******"CSTPIS": "00",
******"CSTCOFINS": "00",
******"codBaseCreditoPisCofinsEntrad": "",
******"impostosAjustados": "true",
******"sequenciaNota": "0",
******"valorIGI": "0",
******"baseSubtituicaoObs": "",
******"valorSubstituicaoObs": "",
******"freteInternacional": "",
******"seguroInternacional": "",
******"descontoISS": "",
******"valorContabil": "00.00",
******"usrmovi2": "",
******"usrmovi1": "",
******"incidenciaIPI": "3",
******"incidenciaICMS": "1",
******"incidenciaPIS": "N",
******"incidenciaCOFINS": "N",
******"percentualIPI": "",
******"percentualIRRF": "0",
******"percentualDesconto": "0",
******"valorICMS": "0.00",
******"valorIPI": "0",
******"percentualComissao": "0",
******"valorDesconto": "0",
******"valorFrete": "0",
******"baseSubstituicao": "00.00",
******"percentualSubstituicao": "00.00",
******"valorSuframaSimbahia": "0",
******"percentualINSS": "0",
******"incidenciaICMSEntrada": "",
******"complementoIncidenciaICMS": "0",
******"percentualReducaoSimbahia": "0",
******"incidenciaContribSocial": "N",
******"percentualPIS": "0",
******"percentualCreditoPISCOFINS": "0",
******"reducaoICMSISS": "0",
******"valorBaseSubstituicao": "0",
******"percentualICMSSubstituicao": "00",
******"valorIPIObs": "0",
******"valorSeguro": "0",
******"percentualCOFINS": "0",
******"valorSubstituicao": "0.0",
******"totalDespesaItem": "0",
******"totalCompras": "0",
******"transfCentroArmaz": "",
******"precoTotalCusto": "0",
******"contraPartTransferencia": "",
******"estorno": "",
******"sequenciaDia": "",
******"pedidoOc": "",
******"totalEntradas": "",
******"custoMedio": "",
******"totalEstoque": "",
******"percentualContribSocial": "",
******"indice": "",
******"outrasDespesasAcessorias": "",
******"ordenacao": "",
******"sequenciaPedidoOC": "",
******"baseICMSComIPI": "",
******"difAliquotaPercImportacao": "",
******"transfUnNegocio": "",
******"contrato": "",
******"contabil": "",
******"aglitinouConverteu": "",
******"codigoRetorno": "",
******"contabilidade": "",
******"valorEncargosFinanceiros": "",
******"dataValidacao": "",
******"valorICMSOutrosNaoDestacado": "",
******"excecaoNCM": "",
******"etiquetaHex": "",
******"totalEntradasIndepCA": "",
******"totalSaidasIndepCA": "",
******"inspecao": "",
******"itemOS": "",
******"classePedidoExclusivo4": "",
******"buscarRegraFiscal": "false",
******"impostoImportacao": "",
******"descontoInformado": "",
******"totalSaidas": "",
******"sequenciaDiaPedidoOC": "",
******"os": "",
******"saidaSemSaldo": "",
******"usrmovi2_1": "",
******"usrmovi3": "",
******"usrmovi4": "",
******"serieItemReferencia": "XXX",
******"notaItemReferencia": "000000000",
******"empresaItemReferencia": "XXXXXX",
******"tipoItemReferencia": "X",
******"sequenciaNfItemReferencia": "0",
******"tipoOperacaoItemReferencia": "XXXX"
*****}
****],
****"lancamentosNf": [
*****{
******"data": "00/00/0000",
******"vencimento": "00/00/0000",
******"fatura": "0",
******"complemento": "XXXXX",
******"historico": "XXX",
******"tipo": "X",
******"valor": "0",
******"cdEmpresa": "XXXXXX",
******"cdCobranca": "XXXXXX",
******"cheque": "0",
******"cdPortador": "000",
******"emissao": "00/00/0000",
******"saldo": "0",
******"situacao": "X",
******"contabilizado": "X",
******"tipoJuros": "X",
******"listarIss": "N",
******"vencOriginal": "00/00/0000"
******"autorizacaoCartao": "0000000000000000"
"nsuAutenticacaoBancaria":"0000000000"
*****}
****],
****"parcelasNf": [
*****{
******"nf": "0000000000",
******"serie": "000",
******"unidadeNegocio": "00",
******"vencimento": "00/00/0000",
******"valorParcela": "0"
*****}
****]
***}
*]
*}
 
 
 


==== Cadastrar====
==== ListarId ====
==== ListarId ====
==== ListarPendentes ====
==== ListarPendentes ====

Edição das 19h25min de 16 de fevereiro de 2022

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:

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
  • Parâmetros para o elemento gradeItemNf:
  • Parâmetros para o elemento comissaoNf:
  • Parâmetros para o elemento parcelaNf:
  • Parâmetros para o elemento lancamentoNf:

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
  • Parâmetros para o elemento cheque:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:

{{#tree: minExpandLevel=2 |

  • {
    • "notasFiscais": [
      • {
        • "serie": "001",
        • "tipoOperacao": "1101G",
        • "CFOP": "1101",
        • "dataEmissao": "00/00/0000",
        • "viaTransporte": "R",
        • "documentoFiscal": "NF",
        • "baseICMS": "00.00",
        • "percentualICMS": "12",
        • "valorICMS": "0.00",
        • "ICMSOutros": "0",
        • "baseIPI": "0",
        • "valorIPI": "0",
        • "IPINaoTributado": "0",
        • "IPIOutros": "00.00",
        • "valorISS": "0",
        • "baseISS": "0",
        • "incidenciaPIS": "N",
        • "incidenciaCOFINS": "N",
        • "totalMercadorias": "500",
        • "totalNF": "500",
        • "quantidade": "1",
        • "conta": "010102",
        • "portador": "000",
        • "fatura": "",
        • "remessa": "",
        • "dataSaida": "00/00/0000",
        • "gerouLancamentos": "false",
        • "itemsNaNota": "1",
        • "tipoFrete": "1",
        • "uf": "BA",
        • "valorIRRF": "0",
        • "ateNota": "",
        • "totalFaturado": "500",
        • "notaReferencia": "",
        • "baseSubstituicaoTributaria": "00.00",
        • "valorSubstituicaoTributaria": "0.00",
        • "percentualINSS": "0",
        • "condicaoPagamento": "001",
        • "percentualISS": "0",
        • "contabilizado": "",
        • "serieReferencia": "",
        • "codigoMunicipio": "",
        • "valorINSS": "0",
        • "unidadeNegocio": "2",
        • "impressa": "false",
        • "codigoCancelamento": "",
        • "codigoDevolucao": "",
        • "ordemCompra": "",
        • "projeto": "",
        • "modeloFormulario": "55",
        • "percentualFunrural": "0",
        • "valorFunrural": "0",
        • "chaveNFe": "",
        • "numeroProtocolo": "",
        • "numeroLote": "0",
        • "listarLivros": "2",
        • "tipoNota": "E",
        • "classificacaoDocumento": "",
        • "mercado": "05",
        • "grade": "",
        • "folhaLivroSaida": "",
        • "tgConversaoUnidades": "",
        • "fornecedor": "XXXXXX",
        • "numeroLivroSaida": "",
        • "usuarioAutorizado": "",
        • "impostosAjustados": "true",
        • "nfInconsistente": "",
        • "buscarRegraFiscal": "false",
        • "valorContribuicaoSocial": "",
        • "tipoPagamento": "",
        • "naoCalcularFinanceiro": "true",
        • "status": "",
        • "observacoes": "TESTE INTEGRACAO NFE",
        • "operacaoPresencial": "",
        • "origem": "1",
        • "unidadeNegocioReferencia": "",
        • "buscouNfDaSerie": "",
        • "codigoReferenciaEmpresa": "",
        • "itensNf": [
          • {
            • "movimento": "",
            • "unidadeNegocio": "2",
            • "tipoOperacao": "1101G",
            • "dataMovimento": "00/00/0000",
            • "codigoMaterial": "000000",
            • "especif1": "",
            • "especif2": "",
            • "centroArmazenagem": "1",
            • "grade": "",
            • "quantidade": "1",
            • "pecas": "0",
            • "precoUnitario": "0",
            • "descricao": "",
            • "documento": "",
            • "empresa": "XXXXXX",
            • "contaGerencial": "",
            • "tipoDocumento": "XX",
            • "tabelaPreco": "",
            • "incidenciaISS": "N",
            • "percentualISS": "0",
            • "percentualReducaoISS": "0",
            • "baseISS": "0",
            • "valorISS": "0",
            • "baseIRRF": "0",
            • "valorIRRF": "0",
            • "baseINSS": "0",
            • "valorINSS": "0",
            • "percentualReducaoINSS": "0",
            • "percentualINSSAdicional": "0",
            • "percentualImpImportacao": "0",
            • "tipoNota": "N",
            • "baseICMS": "00.00",
            • "ICMSIsenta": "0",
            • "ICMSOutros": "0",
            • "baseIPI": "0",
            • "IPIIsenta": "0",
            • "IPIOutras": "00.00",
            • "percentualPISRetencao": "0",
            • "percentualCOFINSRetencao": "0",
            • "percentualCSLLRetencao": "0",
            • "percentualFunrural": "0",
            • "valorFunrural": "0",
            • "valorSimbahia": "0",
            • "serie": "XXX",
            • "notaFiscal": "",
            • "CFOP": "1101",
            • "percentualICMS": "00",
            • "basePIS": "0",
            • "valorPIS": "0",
            • "baseCOFINS": "0",
            • "valorCOFINS": "0",
            • "basePISRetencao": "0",
            • "valorPISRetencao": "0",
            • "baseCOFINSRetencao": "0",
            • "valorCOFINSRetencao": "0",
            • "baseCSLLRetencao": "0",
            • "valorCSLLRetencao": "0",
            • "valorImpImportacao": "0",
            • "percentualSimbahia": "0",
            • "percentualSuframa": "0",
            • "baseSimbahia": "0",
            • "baseSuframa": "0",
            • "baseImpImportacao": "0",
            • "baseFunrural": "0",
            • "codigoTipoDocumento": "",
            • "percReducaoIPI": "0",
            • "percReducaoST": "",
            • "percIGI": "0",
            • "percICMS_IGI": "0",
            • "ICMSDiferido": "",
            • "baseIGI": "0",
            • "retencaoInformada": "",
            • "complementoIncidIPI": "0",
            • "ICMSPresumido": "0",
            • "CSTPIS": "00",
            • "CSTCOFINS": "00",
            • "codBaseCreditoPisCofinsEntrad": "",
            • "impostosAjustados": "true",
            • "sequenciaNota": "0",
            • "valorIGI": "0",
            • "baseSubtituicaoObs": "",
            • "valorSubstituicaoObs": "",
            • "freteInternacional": "",
            • "seguroInternacional": "",
            • "descontoISS": "",
            • "valorContabil": "00.00",
            • "usrmovi2": "",
            • "usrmovi1": "",
            • "incidenciaIPI": "3",
            • "incidenciaICMS": "1",
            • "incidenciaPIS": "N",
            • "incidenciaCOFINS": "N",
            • "percentualIPI": "",
            • "percentualIRRF": "0",
            • "percentualDesconto": "0",
            • "valorICMS": "0.00",
            • "valorIPI": "0",
            • "percentualComissao": "0",
            • "valorDesconto": "0",
            • "valorFrete": "0",
            • "baseSubstituicao": "00.00",
            • "percentualSubstituicao": "00.00",
            • "valorSuframaSimbahia": "0",
            • "percentualINSS": "0",
            • "incidenciaICMSEntrada": "",
            • "complementoIncidenciaICMS": "0",
            • "percentualReducaoSimbahia": "0",
            • "incidenciaContribSocial": "N",
            • "percentualPIS": "0",
            • "percentualCreditoPISCOFINS": "0",
            • "reducaoICMSISS": "0",
            • "valorBaseSubstituicao": "0",
            • "percentualICMSSubstituicao": "00",
            • "valorIPIObs": "0",
            • "valorSeguro": "0",
            • "percentualCOFINS": "0",
            • "valorSubstituicao": "0.0",
            • "totalDespesaItem": "0",
            • "totalCompras": "0",
            • "transfCentroArmaz": "",
            • "precoTotalCusto": "0",
            • "contraPartTransferencia": "",
            • "estorno": "",
            • "sequenciaDia": "",
            • "pedidoOc": "",
            • "totalEntradas": "",
            • "custoMedio": "",
            • "totalEstoque": "",
            • "percentualContribSocial": "",
            • "indice": "",
            • "outrasDespesasAcessorias": "",
            • "ordenacao": "",
            • "sequenciaPedidoOC": "",
            • "baseICMSComIPI": "",
            • "difAliquotaPercImportacao": "",
            • "transfUnNegocio": "",
            • "contrato": "",
            • "contabil": "",
            • "aglitinouConverteu": "",
            • "codigoRetorno": "",
            • "contabilidade": "",
            • "valorEncargosFinanceiros": "",
            • "dataValidacao": "",
            • "valorICMSOutrosNaoDestacado": "",
            • "excecaoNCM": "",
            • "etiquetaHex": "",
            • "totalEntradasIndepCA": "",
            • "totalSaidasIndepCA": "",
            • "inspecao": "",
            • "itemOS": "",
            • "classePedidoExclusivo4": "",
            • "buscarRegraFiscal": "false",
            • "impostoImportacao": "",
            • "descontoInformado": "",
            • "totalSaidas": "",
            • "sequenciaDiaPedidoOC": "",
            • "os": "",
            • "saidaSemSaldo": "",
            • "usrmovi2_1": "",
            • "usrmovi3": "",
            • "usrmovi4": "",
            • "serieItemReferencia": "XXX",
            • "notaItemReferencia": "000000000",
            • "empresaItemReferencia": "XXXXXX",
            • "tipoItemReferencia": "X",
            • "sequenciaNfItemReferencia": "0",
            • "tipoOperacaoItemReferencia": "XXXX"
          • }
        • ],
        • "lancamentosNf": [
          • {
            • "data": "00/00/0000",
            • "vencimento": "00/00/0000",
            • "fatura": "0",
            • "complemento": "XXXXX",
            • "historico": "XXX",
            • "tipo": "X",
            • "valor": "0",
            • "cdEmpresa": "XXXXXX",
            • "cdCobranca": "XXXXXX",
            • "cheque": "0",
            • "cdPortador": "000",
            • "emissao": "00/00/0000",
            • "saldo": "0",
            • "situacao": "X",
            • "contabilizado": "X",
            • "tipoJuros": "X",
            • "listarIss": "N",
            • "vencOriginal": "00/00/0000"
            • "autorizacaoCartao": "0000000000000000"

"nsuAutenticacaoBancaria":"0000000000"

          • }
        • ],
        • "parcelasNf": [
          • {
            • "nf": "0000000000",
            • "serie": "000",
            • "unidadeNegocio": "00",
            • "vencimento": "00/00/0000",
            • "valorParcela": "0"
          • }
        • ]
      • }
  • ]
  • }



ListarId

ListarPendentes

LiberarPendentes

ListarNotasFiscais

ListarNotasFiscaisInutilizadas

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

  • Parâmetros:

   pin:
       Obrigatório, Tipo: String 20

    nf:
      Tipo: numerico

   serie:
      Tipo: String

   codigoUnidadeNegocio:
      Tipo: String


Exemplo de Retorno XML:
<Retorno>
  <fagernfe>
    <reg>
      <nf>0000687623</nf>
      <serie>NFE</serie>
      <codigoUnidadeNegocio>2</codigoUnidadeNegocio>
      <codigoRetornoInutilizacao>102</codigoRetornoInutilizacao>
      <descricaoRetornoInutilizacao>Inutilizacao de numero Nfe</descricaoRetornoInutilizacao>
      <dataNota>DD/MM/AAAA</dataNota>
      <dataEnvio>DD/MM/AAAA</dataEnvio>
      <dataRetorno>DD/MM/AAAA</dataRetorno>
      <horaRetorno>HHMMSS</horaRetorno>
      <status>6</status>
      <numeroProtocolo>143170000292574</numeroProtocolo>
      <tipoAmbiente>2</tipoAmbiente>
      <especieNota>S</especieNota>
      <xmlEnvio>..........</xmlEnvio>
      <xmlRetorno>........</xmlRetorno>
    </reg>
  </fagernfe>
</Retorno>

Exemplo de Retorno JSON:
 [
   {
      "nf": "0000687623",
      "serie": "NFE",
      "codigoUnidadeNegocio": "2",
      "codigoRetornoInutilizacao": "102",
      "descricaoRetornoInutilizacao": "Inutilizacao de numero de Nfe",
      "dataNota": "DD/MM/AAAA",
      "dataEnvio": "DD/MM/AAAA",
      "dataRetorno": "DD/MM/AAAA",
      "horaRetorno": "HHMMSS",
      "status": "6",
      "numeroProtocolo": "143170000292574",
      "tipoAmbiente": "2",
      "especieNota": "S",
      "xmlEnvio": "............",
      "xmlRetorno": "..........."
   }
 ]

ListarNotasFiscaisPaf

ListasNFsMultiplasFormasPagamento

ListarComissoesPorRepresentante

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.

  • Parâmetros:



  • Distribuição das Tags XML:
  • Distribuição das Tags Json:


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.

RegistrarNotaFiscalInutilizada

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

Parâmetro Tipo Máscara Observação
   *pin: String 20A  
   *statusRegistro: String 1A L=Liberado, P=Pendente
   *codigoUnidadeNegocio: String 3A  
   *nf: numérico 10  
   *serie String 5A  
   *codigoRetorno: String 3A Retorno informado em cStat
   *descricaoRetorno: String 255A Retorno informado em xMotivo
   *dataRecibo: Date ##/##/##A  
   *horaRecibo: Time HH:MM:SS  
   *numeroProtocolo: String 15A Retorno informado em nProt
   *xmlEnvio: Blob   Xml de Envio
   *xmlRetorno: Blob   XML de Retorno
   *chaveAcesso: String 41A  
   (*) Campo obrigatório


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.

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>

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