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.
{"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.
- Parâmetros para o elemento notaFiscal:
{"minExpandLevel":2}
- Nf
- Serie
- valorPISRetencao
- tipoOperacao
- CFOP
- dataEmissao
- viaTransporte
- documentoFiscal
- Fornecedor
- baseICMS
- percentualICMS
- valorICMS
- ICMSNaoTributado
- ICMSOutros
- baseIPI
- valorIPI
- IPINaoTributado
- IPIOutros
- valorISS
- baseISS
- incidenciaPIS
- incidenciaCOFINS
- percDescontoAteVencimento
- valorDescDuplicata
- percDescontoSugestaoItens
- valorTotalDesconto
- percGeralOutrasDespAcessorias
- valorTotalFrete
- seguro
- totalMercadorias
- totalNF
- transportadora
- consignatario
- marca
- volume
- quantidade
- especie
- pesoLiquido
- pesoBruto
- conta
- portador
- fatura
- cobrarPauta
- Tipo: String 1
- S=Sim, N=Não
- remessa
- pedido
- dataSaida
- horaSaida
- percGeralEncargosFinanceiros
- gerouLancamentos
- itemsNaNota
- 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
- percentualComissao
- placa
- valorIRRF
- especieNota
- Tipo: String 1
- E=Entrada, S=Saída, N=Nula
- subtotalizar
- incidenciaISS
- ateNota
- totalFaturado
- totalServico
- valorTotalOutrasDespesasAcess
- valorTotalEncargosFinanceiros
- substitutoTributario
- notaReferencia
- baseSubstituicaoTributaria
- valorSubstituicaoTributaria
- percentualIRRF
- percentualINSS
- condicaoPagamento
- percentualISS
- complementoFatura
- contabilizado
- faturaAglutinada
- Tipo: String 1
- S=Sim, N=Não
- gerouINSS
- serieReferencia
- codigoMunicipio
- valorDeducoes
- valorINSS
- unidadeNegocio
- quantidadeTotal
- impressa
- declaracaoImportacao
- percentualICMSSubstituicao
- percentualComissaoAReceber
- notaIncentivada
- taxaIndexador
- indiceIndexador
- baseIRRF
- modeloCupom
- numeroControleFormulario
- romaneio
- dataRomaneio
- ufPlacaTransportador
- percGeralDesconto
- valorInformODA
- percFreteInformativo
- codigoCancelamento
- codigoDevolucao
- ordemCompra
- projeto
- modeloFormulario
- notaIPIECFGerada
- creditoICMSPresumido
- percentualFunrural
- valorFunrural
- dataNFTriangularAglutinada
- dataValidacao
- dataCancelamento
- campo125
- ordemDeCompraGerada
- totalItensServico
- pesoExtraEmbalagem
- usrnota1
- usrnota2
- chaveNFe
- numeroProtocolo
- numeroLote
- gerouPedidoConsignacao
- listarLivros
- 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
- incluiSubstituicaoTributaria
- mercado
- grade
- incidenciaContribSocial
- Tipo: String 1
- S=Soma, D=Diminui, N=Nao considera
- folhaLivroSaida
- tgConversaoUnidades
- fornecedor
- volumeAtualizado
- ordemEnderecoCobranca
- ordemEnderecoEntrega
- 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
- numeroLivroSaida
- usuarioAutorizado
- entregMercAposFatur
- impostosAjustados
- nfInconsistente
- buscarRegraFiscal
- contatoCliente
- percICMSResponsabilidade
- valorSuframaSimbahia
- valorAVista
- valorCOFINSRetencao
- valorContribuicaoSocial
- valorInformDesconto
- naoCalcularFinanceiro
- naoCalcularComissoes
- 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
- valorDifalOrigem
- valorDifalDestino
- entrega
- buscouNfDaSerie
- codigoReferenciaEmpresa
- Parâmetros para o elemento itemNf:
{"minExpandLevel":2}
- tipoOperacao
- dataMovimento
- codigoMaterial
- especif1
- especif2
- centroArmazenagem
- grade
- quantidade
- pecas
- precoUnitario
- descricao
- documento
- empresa
- contaGerencial
- tipoDocumento
- tabelaPreco
- incidenciaISS
- percentualISS
- percentualReducaoISS
- baseISS
- valorISS
- baseIRRF
- valorIRRF
- baseINSS
- valorINSS
- percentualReducaoINSS
- percentualINSSAdicional
- percentualImpImportacao
- tipoNota
- baseICMS
ICMSIsenta
ICMSOutros
IPIIsenta
IPIOutras
- percentualPISRetencao
- percentualCOFINSRetencao
- percentualCSLLRetencao
- percentualFunrural
- valorFunrural
- valorSimbahia
- serie
CFOP
- percentualICMS
- basePIS
- valorPIS
- baseCOFINS
- valorCOFINS
- transfCentroArmaz
- basePISRetencao
- valorPISRetencao
- baseCOFINSRetencao
- valorCOFINSRetencao
- baseCSLLRetencao
- valorCSLLRetencao
- valorImpImportacao
- percentualSimbahia
- percentualSuframa
- baseSimbahia
- baseSuframa
- baseImpImportacao
- baseFunrural
- codigoTipoDocumento
- percReducaoIPI
- percReducaoST
- percIGI
- percICMS_IGI
ICMSDiferido
- baseIGI
- retencaoInformada
- complementoIncidIPI
ICMSPresumido
CSTPIS
CSTCOFINS
- codBaseCreditoPisCofinsEntrad
- impostosAjustados
- sequenciaNota
- valorIGI
- baseSubtituicaoObs
- valorSubstituicaoObs
- freteInternacional
- seguroInternacional
- descontoISS
- valorContabil
- valorAcrescimo
- valorIcmsStFcp
- baseDifal
- valorDifalOrigem
- valorDifalDestino
- percentualDifalOrigem
- percentualDifalDestino
- proporcaoDifal
- Parâmetros para o elemento gradeItemNf:
{"minExpandLevel":2}
- movimento
- numeracao
- codigoEspecif3
- lote
- quantidade
- validadeLote
- Parâmetros para o elemento comissaoNf:
{"minExpandLevel":2}
- nf
- serie
- unidadeDeNegocio
- clienteFornecedor
- especieNF
- Tipo: String 1
- E=Entrada, S=Saida, N=Nula
- sequenciaNF
- representante
- valorBaseComissao
- percentualComissao
- tipoBaseComissao
- percComissaoOrigRepresentante
- percentualReducaoBaseComissao
- lancamentoComissao
- origem
- Tipo: String 1
- M=Manual, S=Sistema, V=Vendedor, C=Contato, A=Agenciamento
- Parâmetros para o elemento parcelaNf:
{"minExpandLevel":2}
- nf
- serie
- unidadeDeNegocio
- vencimento
- valorParcela
- nossoNumero
- modeloLancamento
- Parâmetros para o elemento lancamentoNf:
{"minExpandLevel":2}
- lancamento
- data
- vencimento
- fatura
- complemento
- codHistorico
- historico
- conta
- tipo
- valor
- cdEmpresa
- cdCobranca
- cdPortador
Emissão
- saldo
- conferido
- situacao
- conciliado
- contabilizado
- tipoPagamento
- numeroBanco
- documento
- tipoDocumento
- tipoJuros
- dataInclusao
- sacadorAvalista
- modalidadeVenc
- modalidadePag
- especieDoc
- vencOriginal
- projeto
- multRemessaEnviada
- indice
- autorizadoPor
- dataModif
- sessao
- adiantRetornCobran
- formaCobranCtr
- comandoRemessa
- ordemEnderCobran
- tipoMulta
- pagamento
- listarIss
- codigoBarrasLido
- dataDirf
- cdCaixa
- turnoSequencial
- ordemContaCorrente
- ctrSequencia
- sessaoCaixa
- autoriPlacaGnre
- lancamentoTerceiro
- autorizacaoCartao
- nsuAutenticacaoBancaria
- Parâmetros para o elemento cheque:
{"minExpandLevel":2}
- numero
- sequencia
- lancamentoVinculado
- lancamentoOrigPartRel
- lancamentoTrocaCheque
- vinculadoDadosPreenchido
- conta
- titulo
- cpfCnpj
- fone
- usrinchelan1
- banco
- agencia
- codigoSacado
- modeloLancamento
- vinculadoContaFinancei
- vinculadoOcorrencia
- div1div2div3
- digitoVerificador
- tipoPagamento
- vinculadoTipoPagamento
- vinculadoPortador
- camaraCompensacao
- vinculadoHistorico
- complementoNome1
- complementoNome2
- nome
- valor
- lancamentoDevolucao
- partesRelSaida
- remessaCustodiaEnviada
- usrinchelan3
- emissao
- vencimento
- devolucao
- dataValidacao
- usrinchelan2
- 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.
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.
{"minExpandLevel":2}
- pin:
- Obrigatório, Tipo: String 20
- statusRegistro
- Obrigatório, Tipo: String 1
- L=Liberado, P=Pendente
- notaFiscalXml
- Obrigatório apenas para requisições SOAP. Tipo: String
- Conteúdo de um arquivo XML com as notas fiscais, itens, grades, comissões e parcelas.
- notaFiscalJson:
- Obrigatório apenas para requisições REST/JSON. Tipo: String
- Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.
- Distribuição das Tags XML:
- Distribuição das Tags Json:
- {
- "notasFiscais": "",
- [{
- "unidadeNegocio": "",
- "nf": "",
- "serie": "",
- "valorPISRetencao": "",
- "tipoOperacao": "",
- "CFOP": "",
- "dataEmissao": "",
- "viaTransporte": "",
- "documentoFiscal": "",
- "cliente": "",
- "cobranca": "",
- "representante": "",
- "baseICMS": "",
- "percentualICMS": "",
- "valorICMS": "",
- "ICMSNaoTributado": "",
- "ICMSOutros": "",
- "baseIPI": "",
- "valorIPI": "",
- "IPINaoTributado": "",
- "IPIOutros": "",
- "valorISS": "",
- "baseISS": "",
- "incidenciaPIS": "",
- "incidenciaCOFINS": "",
- "percDescontoAteVencimento": "",
- "valorDescDuplicata": "",
- "percDescontoSugestaoItens": "",
- "valorTotalDesconto": "",
- "percGeralOutrasDespAcessorias": "",
- "valorTotalFrete": "",
- "seguro": "",
- "totalMercadorias": "",
- "totalNF": "",
- "transportadora": "",
- "consignatario": "",
- "marca": "",
- "volume": "",
- "quantidade": "",
- "especie": "",
- "pesoLiquido": "",
- "pesoBruto": "",
- "conta": "",
- "portador": "",
- "fatura": "",
- "cobrarPauta": "",
- "remessa": "",
- "pedido": "",
- "dataSaida": "",
- "horaSaida": "",
- "percGeralEncargosFinanceiros": "",
- "gerouLancamentos": "",
- "itemsNaNota": "",
- "tipoFrete": "",
- "uf": "",
- "percentualComissao": "",
- "placa": "",
- "valorIRRF": "",
- "especieNota": "",
- "subtotalizar": "",
- "incidenciaISS": "",
- "ateNota": "",
- "totalFaturado": "",
- "totalServico": "",
- "valorTotalOutrasDespesasAcess": "",
- "valorTotalEncargosFinanceiros": "",
- "substitutoTributario": "",
- "notaReferencia": "",
- "baseSubstituicaoTributaria": "",
- "valorSubstituicaoTributaria": "",
- "percentualIRRF": "",
- "percentualINSS": "",
- "condicaoPagamento": "",
- "percentualISS": "",
- "complementoFatura": "",
- "contabilizado": "",
- "faturaAglutinada": "",
- "gerouINSS": "",
- "serieReferencia": "",
- "codigoReferenciaEmpresa": "",
- "codigoMunicipio": "",
- "valorDeducoes": "",
- "valorINSS": "",
- "quantidadeTotal": "",
- "impressa": "",
- "declaracaoImportacao": "",
- "percentualICMSSubstituicao": "",
- "percentualComissaoAReceber": "",
- "notaIncentivada": "",
- "taxaIndexador": "",
- "indiceIndexador": "",
- "baseIRRF": "",
- "modeloCupom": "",
- "numeroControleFormulario": "",
- "romaneio": "",
- "dataRomaneio": "",
- "ufPlacaTransportador": "",
- "percentualDesconto2": "",
- "percGeralDesconto": "",
- "valorInformODA": "",
- "percFreteInformativo": "",
- "codigoCancelamento": "",
- "codigoDevolucao": "",
- "ordemCompra": "",
- "projeto": "",
- "modeloFormulario": "",
- "notaIPIECFGerada": "",
- "creditoICMSPresumido": "",
- "percentualFunrural": "",
- "valorFunrural": "",
- "dataNFTriangularAglutinada": "",
- "dataValidacao": "",
- "dataCancelamento": "",
- "campo125": "",
- "ordemDeCompraGerada": "",
- "totalItensServico": "",
- "pesoExtraEmbalagem": "",
- "usrnota1": "",
- "usrnota2": "",
- "chaveNFe": "",
- "numeroProtocolo": "",
- "numeroLote": "",
- "gerouPedidoConsignacao": "",
- "incluiSubstituicaoTributaria": "",
- "listarLivros": "",
- "tipoNota": "",
- "classificacaoDocumento": "",
- "mercado": "",
- "grade": "",
- "incidenciaContribSocial": "",
- "folhaLivroSaida": "",
- "tgConversaoUnidades": "",
- "fornecedor": "",
- "volumeAtualizado": "",
- "ordemEnderecoCobranca": "",
- "ordemEnderecoEntrega": "",
- "forma": "",
- "tipoFreteConsignatario": "",
- "conferido": "",
- "numeroLivroSaida": "",
- "usuarioAutorizado": "",
- "entregMercAposFatur": "",
- "impostosAjustados": "",
- "nfInconsistente": "",
- "buscarRegraFiscal": "",
- "contatoCliente": "",
- "percICMSResponsabilidade": "",
- "valorSuframaSimbahia": "",
- "valorAVista": "",
- "valorCOFINSRetencao": "",
- "valorContribuicaoSocial": "",
- "valorInformDesconto": "",
- "tipoPagamento": "",
- "naoCalcularFinanceiro": "",
- "naoCalcularComissoes": "",
- "observacoes": "",
- "status": "",
- 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)
- "operacaoPresencial": "",
- "baseDifal": "",
- "valorDifalOrigem": "",
- "valorDifalDestino": "",
- "usrfacomplnf3": "",
- "origem": "",
- 0 - NFS;
- 1 - NFE;
- 2 - Devolução NFE;
- 3 - Devolução NFS;
- 4 - Transferência
- "unidadeNegocioReferencia": "",
- "informacoesPAf": ""
- [{
- "nomeCliente": "",
- "cpfCnpjCliente": "",
- "pessoa": "",
- "endereco": "",
- "numero": "",
- "complemento": "",
- "bairro": "",
- "municipio": "",
- "uf": "",
- "cep": "",
- }],
- naoGerarChaveNfe
- Ao receber 'S' não deverá criar a NFS sem chave da Nota.
- "itensNf"
- [{
- "movimento": "",
- "unidadeNegocio": "",
- "tipoOperacao": "",
- "dataMovimento": "",
- "codigoMaterial": "",
- "especif1": "",
- "especif2": "",
- "centroArmazenagem": "",
- "grade": "",
- "quantidade": "",
- "pecas": "",
- "precoUnitario": "",
- "descricao": "",
- "documento": "",
- "empresa": "",
- "contaGerencial": "",
- "tipoDocumento": "",
- "tabelaPreco": "",
- "incidenciaISS": "",
- "percentualISS": "",
- "percentualReducaoISS": "",
- "baseISS": "",
- "valorISS": "",
- "baseIRRF": "",
- "valorIRRF": "",
- "baseINSS": "",
- "valorINSS": "",
- "percentualReducaoINSS": "",
- "percentualINSSAdicional": "",
- "percentualImpImportacao": "",
- "tipoNota": "",
- "baseICMS": "",
- "ICMSIsenta": "",
- "ICMSOutros": "",
- "baseIPI": "",
- "IPIIsenta": "",
- "IPIOutras": "",
- "percentualPISRetencao": "",
- "percentualCOFINSRetencao": "",
- "percentualCSLLRetencao": "",
- "percentualFunrural": "",
- "valorFunrural": "",
- "valorSimbahia": "",
- "serie": "",
- "notaFiscal": "",
- "CFOP": "",
- "percentualICMS": "",
- "basePIS": "",
- "valorPIS": "",
- "baseCOFINS": "",
- "valorCOFINS": "",
- "basePISRetencao": "",
- "valorPISRetencao": "",
- "baseCOFINSRetencao": "",
- "valorCOFINSRetencao": "",
- "baseCSLLRetencao": "",
- "valorCSLLRetencao": "",
- "valorImpImportacao": "",
- "percentualSimbahia": "",
- "percentualSuframa": "",
- "baseSimbahia": "",
- "baseSuframa": "",
- "baseImpImportacao": "",
- "baseFunrural": "",
- "codigoTipoDocumento": "",
- "percReducaoIPI": "",
- "percReducaoST": "",
- "percIGI": "",
- "percICMS_IGI": "",
- "ICMSDiferido": "",
- "baseIGI": "",
- "retencaoInformada": "",
- "complementoIncidIPI": "",
- "ICMSPresumido": "",
- "CSTPIS": "",
- "CSTCOFINS": "",
- "codBaseCreditoPisCofinsEntrad": "",
- "impostosAjustados": "",
- "sequenciaNota": "",
- "valorIGI": "",
- "baseSubtituicaoObs": "",
- "valorSubstituicaoObs": "",
- "freteInternacional": "",
- "seguroInternacional": "",
- "descontoISS": "",
- "valorContabil": "",
- "incidenciaIPI": "",
- "incidenciaICMS": "",
- "incidenciaPIS": "",
- "incidenciaCOFINS": "",
- "incidenciaICMSEntrada": "",
- "complementoIncidenciaICMS": "",
- "incidenciaContribSocial": "",
- "percentualIPI": "",
- "percentualIRRF": "",
- "percentualDesconto": "",
- "valorICMS": "",
- "valorIPI": "",
- "percentualComissao": "",
- "valorDesconto": "",
- "valorFrete": "",
- "baseSubstituicao": "",
- "percentualSubstituicao": "",
- "valorSuframaSimbahia": "",
- "percentualINSS": "",
- "percentualReducaoSimbahia": "",
- "percentualPIS": "",
- "percentualCreditoPISCOFINS": "",
- "reducaoICMSISS": "",
- "valorBaseSubstituicao": "",
- "percentualICMSSubstituicao": "",
- "valorIPIObs": "",
- "valorSeguro": "",
- "percentualCOFINS": "",
- "transfCentroArmaz": "",
- "estorno": "",
- "pedidoOc": "",
- "indice": "",
- "ordenacao": "",
- "transfUnNegocio": "",
- "contrato": "",
- "contabil": "",
- "codigoRetorno": "",
- "contabilidade": "",
- "excecaoNCM": "",
- "etiquetaHex": "",
- "inspecao": "",
- "classePedidoExclusivo4": "",
- "saidaSemSaldo": "",
- "usrmovi2": "",
- "valorSubstituicao": "",
- "totalDespesaItem": "",
- "totalCompras": "",
- "precoTotalCusto": "",
- "totalEntradas": "",
- "custoMedio": "",
- "totalEstoque": "",
- "percentualContribSocial": "",
- "outrasDespesasAcessorias": "",
- "difAliquotaPercImportacao": "",
- "valorEncargosFinanceiros": "",
- "valorICMSOutrosNaoDestacado": "",
- "totalEntradasIndepCA": "",
- "totalSaidasIndepCA": "",
- "totalSaidas": "",
- "usrmovi4": "",
- "contraPartTransferencia": "",
- "sequenciaDia": "",
- "sequenciaPedidoOC": "",
- "itemOS": "",
- "sequenciaDiaPedidoOC": "",
- "os": "",
- "dataValidacao": "",
- "usrmovi3": "",
- "baseICMSComIPI": "",
- "aglitinouConverteu": "",
- "buscarRegraFiscal": "",
- "impostoImportacao": "",
- "descontoInformado": "",
- "valorIcmsStFcp": "",
- "baseDifal": "",
- "valorDifalOrigem": "",
- "valorDifalDestino": "",
- "percentualDifalOrigem": "",
- "percentualDifalDestino": "",
- "proporcaoDifal": "",
- "usrmovimp2": "",
- "usrmovimp1": "",
- "valorAcrescimo": "",
- "grades":
- [{
- "movimento": "",
- "numeracao": "",
- "codigoEspecif3": "",
- "lote": "",
- "quantidade": "",
- "validadeLote": "",
- "sequencia": "",
- }],
- "comissoesItem":
- [{
- "nf": "",
- "serie": "",
- "unidadeDeNegocio": "",
- "clienteFornecedor": "",
- "especieNF": "",
- "sequenciaNF": "",
- "representante": "",
- "valorBaseComissao": "",
- "percentualComissao": "",
- "tipoBaseComissao": "",
- "percComissaoOrigRepresentante": "",
- "percentualReducaoBaseComissao": "",
- "lancamentoComissao": "",
- "origem": "",
- }],
- "unidadeNegocioItemReferencia": "",
- "serieItemReferencia": "",
- "notaItemReferencia": "",
- "empresaItemReferencia": "",
- "tipoItemReferencia": "",
- "sequenciaNfItemReferencia": "",
- "tipoOperacaoItemReferencia": "",
- ]}
- "comissoesNf":
- [{
- "nf": "",
- "serie": "",
- "unidadeDeNegocio": "",
- "clienteFornecedor": "",
- "especieNF": "",
- "sequenciaNF": "",
- "representante": "",
- "valorBaseComissao": "",
- "percentualComissao": "",
- "tipoBaseComissao": "",
- "percComissaoOrigRepresentante": "",
- "percentualReducaoBaseComissao": "",
- "lancamentoComissao": "",
- "origem": "",
- }],
- "parcelasNf"
- [{
- "nf": "",
- "serie": "",
- "unidadeNegocio": "",
- "vencimento": "",
- "valorParcela": "",
- "nossoNumero": "",
- "codigoCaixa": "",
- "turnoSequencial": "",
- "sessaoCaixa": "",
- "modeloLancamento": "",
- }],
- "lancamentosNf"
- [{
- "lancamento": "",
- "data": "",
- "vencimento": "",
- "fatura": "",
- "complemento": "",
- "codHistorico": "",
- "historico": "",
- "conta": "",
- "tipo": "",
- "valor": "",
- "cdEmpresa": "",
- "cdCobranca": "",
- "cheque": "",
- "cdPortador": "",
- "emissao": "",
- "cPartida": "",
- "saldo": "",
- "conferido": "",
- "situacao": "",
- "conciliado": "",
- "contabilizado": "",
- "tipoPagamento": "",
- "numeroBanco": "",
- "jurosDia": "",
- "ultimaLiquidacao": "",
- "documento": "",
- "tipoDocumento": "",
- "valorIndexado": "",
- "saldoIndexado": "",
- "toleranciaVenc": "",
- "valorMulta": "",
- "toleranciaMulta": "",
- "toleranciaJuros": "",
- "tipoJuros": "",
- "valorDesconto": "",
- "lancVinculado": "",
- "dataInclusao": "",
- "sacadorAvalista": "",
- "modalidadeVenc": "",
- "modalidadePag": "",
- "especieDoc": "",
- "vencOriginal": "",
- "projeto": "",
- "multRemessaEnviada": "",
- "indice": "",
- "bloqImpresso": "",
- "duplImpresso": "",
- "remessaEnviada": "",
- "autorizadoPor": "",
- "autorizadoEm": "",
- "dataModif": "",
- "sessao": "",
- "dataCompensBco": "",
- "dataFaturamentoCtr": "",
- "dataValidacao": "",
- "remessaSerasa": "",
- "adiantRetornCobran": "",
- "formaCobranCtr": "",
- "comandoRemessa": "",
- "ordemEnderCobran": "",
- "tipoMulta": "",
- "pagamento": "",
- "listarIss": "",
- "codigoBarrasLido": "",
- "dataDirf": "",
- "cdCaixa": "",
- "turnoSequencial": "",
- "ordemContaCorrente": "",
- "previsao": "",
- "listarDirf": "",
- "possuiChequesTitulo": "",
- "ctrSequencia": "",
- "limitMultaFracio": "",
- "valorCustoAdmin": "",
- "conciliacaoSeq": "",
- "percentIss": "",
- "sessaoCaixa": "",
- "autoriPlacaGnre": "",
- "userLancto1": "",
- "userLancto2": "",
- "userLancto3": "",
- "cheque"
- [{
- "numero": "",
- "sequencia": "",
- "lancamentoVinculado": "",
- "lancamentoOrigPartRel": "",
- "lancamentoTrocaCheque": "",
- "vinculadoDadosPreenchido": "",
- "conta": "",
- "titulo": "",
- "cpfCnpj": "",
- "fone": "",
- "usrinchelan1": "",
- "banco": "",
- "agencia": "",
- "codigoSacado": "",
- "modeloLancamento": "",
- "vinculadoContaFinancei": "",
- "vinculadoOcorrencia": "",
- "div1div2div3": "",
- "digitoVerificador": "",
- "tipoPagamento": "",
- "vinculadoTipoPagamento": "",
- "vinculadoPortador": "",
- "camaraCompensacao": "",
- "vinculadoHistorico": "",
- "complementoNome1": "",
- "complementoNome2": "",
- "nome": "",
- "valor": "",
- "lancamentoDevolucao": "",
- "partesRelSaida": "",
- "remessaCustodiaEnviada": "",
- "usrinchelan3": "",
- "emissao": "",
- "vencimento": "",
- "devolucao": "",
- "dataValidacao": "",
- "usrinchelan2": "",
- }],
- "lancamentoTerceiro": "",
- "nsuAutenticacaoBancaria": "",
- "autorizacaoCartao": "",
- }],
- "formasPagamentoNf"
- [{
- "pagamentoTroco": "",
- "sequencia": "",
- "condPagamento": "",
- "formaCondicao": "",
- "tipoPagamento": "",
- "formaPagamento": "",
- "empresa": "",
- "cobranca": "",
- "ordemEndCobran": "",
- "tipoDocumento": "",
- "documento": "",
- "primeiroVenctoSemAjuste": "",
- "fatura": "",
- "valorBruto": "",
- "vlrMercadFaturadas": "",
- "vlrServFaturados": "",
- "vlrDescItensFaturados": "",
- "vlrIpi": "",
- "vlrIcms": "",
- "vlrSubsTribut": "",
- "valorIrrf": "",
- "vlrOutrosImpSomamFatu": "",
- "vlrOutrosImpDiminueFa": "",
- "vlrFrete": "",
- "vlrSeguro": "",
- "vlrDescGeral": "",
- "percDescAteVencto": "",
- "vlrEncarFinanc": "",
- "tipoPagEntrada": "",
- "formaDePagEntrada": "",
- "empresaEntrada": "",
- "cobrancaEntrada": "",
- "ordemEndCobraEnt": "",
- "tipoDocEntrada": "",
- "docEntrada": "",
- "vlrEntrada": "",
- "vlrJuros": "",
- "vlrOutrasDespAcess": "",
- "vlrLiquido": "",
- "VlrTarifCartao": "",
- "prazoMedio": "",
- "LanctoCompetenciaVal": "",
- "usuCriacao": "",
- "dtCriacao": "",
- "hrCriacao": "",
- "usuModif": "",
- "dtModif": "",
- "hrModif": "",
- "gerouFinanc": "",
- "moduloOrig": "",
- "vlrLancamento": "",
- }],
- "buscouNfDaSerie": "",
- "valorContabil": "",
- "totalizarImpostoCapa": "",
- "idEnvioSat": "",
- "idCancelamentoSat": "",
- }]
- }
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 |
|
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>