IN Faturamento

De CIGAM WIKI
Revisão de 20h14min de 5 de outubro de 2020 por Elizama.Dias (discussão | contribs) (CadastrarNotasFiscais)

CancelamentoNotaFiscal.integrador

CadastroCondicaoPagamento.integrador

CadastroControlePedido.integrador

CadastroGradePedido.integrador

CadastroItensPedido.integrador

CadastroMapaResumo.integrador

CadastroNotaFiscal.integrador

Cadastrar

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
 • 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:
    • pin:
      • Obrigatório, Tipo: String 20
    • statusRegistro
      • Obrigatório, Tipo: String 1
        • L=Liberado, P=Pendente
        • Se for informado algo diferente de P ou L não será aplicado nenhum filtro.
    • 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.


  • Exemplo:
    • CadastroNotaFiscal.xml
      • <cadastroNotaFiscal>
        • <notasFiscais>
     <notaFiscal>
       <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>
        • <informacoesPAf>

<nomeCliente/> <cpfCnpjCliente/> <pessoa/> <endereco/> <numero/> <complemento/> <bairro/> <municipio/> <uf/> <cep/> <informacoesPAf/>

       <informacoesPaf/>
       <itemNf>

<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/> <gradeItemNf> <grades> <movimento/> <numeracao/> <codigoEspecif3/> <lote/> <quantidade/> <validadeLote/> <sequencia/> <grades/> <gradeItemNf/> <comissaoNf> <comissoesItem> <nf/> <serie/> <unidadeDeNegocio/> <clienteFornecedor/> <especieNF/> <sequenciaNF/> <representante/> <valorBaseComissao/> <percentualComissao/> <tipoBaseComissao/> <percComissaoOrigRepresentante/> <percentualReducaoBaseComissao/> <lancamentoComissao/> <origem/> <comissoesItem/> <comissaoNf/> <unidadeNegocioItemReferencia/> <serieItemReferencia/> <notaItemReferencia/> <empresaItemReferencia/> <tipoItemReferencia/> <sequenciaNfItemReferencia/> <tipoOperacaoItemReferencia/>

			<itensNf/>			

<itemNf/>

       <comissaoNf>

<comissoesNf> <nf/> <serie/> <unidadeDeNegocio/> <clienteFornecedor/> <especieNF/> <sequenciaNF/> <representante/> <valorBaseComissao/> <percentualComissao/> <tipoBaseComissao/> <percComissaoOrigRepresentante/> <percentualReducaoBaseComissao/> <lancamentoComissao/> <origem/> <comissoesNf/>

      <comissaoNf/>			
      <parcelaNf>

<parcelasNf> <nf/> <serie/> <unidadeNegocio/> <vencimento/> <valorParcela/> <nossoNumero/> <codigoCaixa/> <turnoSequencial/> <sessaoCaixa/> <modeloLancamento/> <parcelasNf/> <parcelaNf/>

       <lancamentoNf>

<lancamentosNf> <lancamento/> <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/> <cheques> <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/> <cheque/> <cheques/> <lancamentoTerceiro/> <nsuAutenticacaoBancaria/> <autorizacaoCartao/> <lancamentosNf/>

       <lancamentoNf/>		
       <formaPagamentoNf>

<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/> <formaPagamentoNf/>

       <formaPagamentoNf/>	
       <buscouNfDaSerie/>
       <valorContabil/>
       <totalizarImpostoCapa/>
       <idEnvioSat/>
       <idCancelamentoSat/>
     </notaFiscal>
   </notasFiscais>
 </cadastroNotaFiscal>

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.

CadastroPedidos.integrador

CadastroPrazoPagamento.integrador