IN CadastroNotaFiscal.integrador

De CIGAM WIKI
Revisão de 19h42min de 16 de fevereiro de 2022 por Camila.Oliveira (discussão | contribs) (CadastrarNotasFiscais)

Voltar

CadastrarNotasFiscais

Cadastra notas fiscais, itens, grades, comissões e parcelas em uma única requisição. Os dados da Nota Fiscal deverão estar em formato XML para requisições SOAP e JSON para requisições REST. Ambos com estrutura específica conforme descrito a seguir. As Notas Fiscais de Entrada não possuem listagem, foi liberado somente o cadastro da mesma via integração.

  • Parâmetros:


  • Parâmetros para o elemento notaFiscal:


  • Parâmetros para o elemento itemNf:


  • Parâmetros para o elemento gradeItemNf:


  • Parâmetros para o elemento comissaoNf:


  • Parâmetros para o elemento parcelaNf:


  • Parâmetros para o elemento lancamentoNf:


  • Parâmetros para o elemento cheque:


  • Distribuição das Tags XML:


  • Distribuição das Tags Json:

{{#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>