IN CadastroNotaFiscal.integrador

De CIGAM WIKI
Revisão de 19h28min de 7 de outubro de 2026 por Camila.Oliveira (discussão | contribs)
(dif) ← Edição anterior | Revisão atual (dif) | Versão posterior → (dif)

Voltar
Integrador > WebServices > IN CadastroNotaFiscal.integrador

Requisição

[editar]

Métodos

[editar]
CadastrarNotasFiscais

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

Parâmetros:



Distribuição das Tags XML:



Distribuição das Tags Json:



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.

Voltar ao início

ListarNotasFiscaisInutilizadas

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

Parâmetros:



Retornos:
   Se sucesso:
      * Exemplo de retorno SOAP:


      * Exemplo de retorno REST:

Voltar ao início

RegistrarNotaFiscalInutilizada

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

Parâmetros:



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.

Voltar ao início

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>

Voltar ao início

ListarPendentes

Parâmetros:



Retornos:
    Se sucesso:


   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.

Voltar ao início

ListarNotasFiscais

Parâmetros:



Retornos:
   Se sucesso:
      * Exemplo de retorno SOAP:


      * Exemplo de retorno REST:


   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.

Voltar ao início