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

De CIGAM WIKI
Sem resumo de edição
 
Linha 4: Linha 4:
[[IN CadastroNotaFiscal.integrador]]
[[IN CadastroNotaFiscal.integrador]]


*<b>Requisição</b>
=Requisição=
**<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> CADNF1
**<b>Tipo de registro:</b> CADNF1


== CadastrarNotasFiscais ==
=Métodos=
<p align=“justify”><i>
<!--bgcolor="#5F6B7A"-->
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.
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
As Notas Fiscais de Entrada não possuem listagem, foi liberado somente o cadastro da mesma via integração.
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>CadastrarNotasFiscais</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">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.<br>As Notas Fiscais de Entrada não possuem listagem, foi liberado somente o cadastro da mesma via integração.</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin
*pin
Linha 34: Linha 36:
** Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.
** Conteúdo de um arquivo JSON com as notas fiscais, itens, grades, comissões e parcelas.
** Obrigatório apenas para requisições REST/JSON.
** Obrigatório apenas para requisições REST/JSON.
}}<br>
}}


*<b>Distribuição das Tags XML:</b>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags XML:</b></p><br>
{{#tree: minExpandLevel=4 |
{{#tree: |
*<cadastroNotaFiscal>
*<cadastroNotaFiscal>
**<notasFiscais>
**<notasFiscais>
Linha 1 482: Linha 1 484:
**</notasFiscais>
**</notasFiscais>
*</cadastroNotaFiscal>
*</cadastroNotaFiscal>
}}<br>
}}


*<b>Distribuição das Tags Json:</b>
<br><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Distribuição das Tags Json:</b></p><br>
{{#tree: minExpandLevel=4 |
{{#tree:
*{
*{
**"notasFiscais": "",
**"notasFiscais": "",
Linha 2 891: Linha 2 893:
*}
*}
}}
}}
 
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align=“justify” style=“margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;”><br/>
<b>Retornos:</b><br/>
<b>Retorno:</b><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
Linha 2 902: Linha 2 903:
&nbsp;&nbsp;&nbsp;Se algum parâmetro inválido:<br/>
&nbsp;&nbsp;&nbsp;Se algum parâmetro inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Parâmetro necessário não informado.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarNotasFiscaisInutilizadas ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align="justify"><i>
    <tr>
Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarNotasFiscaisInutilizadas</b></font></td>
</i></p>
    </tr>
 
    <tr>
*<b>Parâmetros:</b><br>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Método que tem por finalidade filtrar as numerações de NFe inutilizadas no ERP CIGAM.</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin:
*pin:
Linha 2 921: Linha 2 926:
*codigoUnidadeNegocio:
*codigoUnidadeNegocio:
**Tipo: String
**Tipo: String
}}<br>
}}


*<b>Exemplo de Retorno XML:</b><br>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno SOAP:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*<Retorno>
*<Retorno>
Linha 2 946: Linha 2 954:
**</fagernfe>
**</fagernfe>
*</Retorno>
*</Retorno>
}}<br>
}}


*<b>Exemplo de Retorno JSON:</b><br>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno REST:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*[
*[
Linha 2 970: Linha 2 979:
*]
*]
}}
}}
{{VoltarInicio}}</td>
    </tr>
</table></center>


== RegistrarNotaFiscalInutilizada ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align="justify"><i>
    <tr>
Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>RegistrarNotaFiscalInutilizada </b></font></td>
</i></p>
    </tr>
 
    <tr>
*<b>Parâmetros:</b><br>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">Método que tem por finalidade registrar as numerações de NFe inutilizadas no ERP CIGAM.</p>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin</td>
*pin</td>
Linha 3 023: Linha 3 036:
** Obrigatório, Tipo: String 41A
** Obrigatório, Tipo: String 41A
}}
}}
<p align=“justify” style=“margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;”><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
Linha 3 030: Linha 3 043:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ExcluirNotaFiscal ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align="justify"><i>
    <tr>
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.<br>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ExcluirNotaFiscal</b></font></td>
<br>
    </tr>
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.
    <tr>
</i></p>
        <td><p style="margin: 0 0 6px 0; font-style: italic; line-height: 1.4;">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.<br><br>
 
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.</p>
*<b>Parâmetros:</b><br>
<p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p>
&nbsp;&nbsp;&nbsp; <pin Type="System.String">''001''</pin><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <pin Type="System.String">''001''</pin><br>
&nbsp;&nbsp;&nbsp; <statusRegistro Type="System.String">''L''</statusRegistro><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <statusRegistro Type="System.String">''L''</statusRegistro><br>
&nbsp;&nbsp;&nbsp; <nf Type="System.Int32">''número NF''</nf><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <nf Type="System.Int32">''número NF''</nf><br>
&nbsp;&nbsp;&nbsp; <serie Type="System.String">''série NF''</serie><br>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <serie Type="System.String">''série NF''</serie><br>
&nbsp;&nbsp;&nbsp; <codigoUnidadeNegocio Type="System.String">''UN NEG NF''</codigoUnidadeNegocio>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; <codigoUnidadeNegocio Type="System.String">''UN NEG NF''</codigoUnidadeNegocio>
 
{{VoltarInicio}}</td>
== ListarPendentes ==
    </tr>
<p align=“justify”><i>
</table></center>
</i></p>


*<b>Parâmetros:</b><br>
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
    <tr>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarPendentes</b></font></td>
    </tr>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin  
*pin  
Linha 3 065: Linha 3 085:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp; Se sucesso:<br/>
&nbsp;&nbsp;&nbsp; Se sucesso:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
Linha 3 102: Linha 3 122:
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;Se pin inválido:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;O usuário não possui direitos suficientes para executar esta rotina.<br/>
Linha 3 108: Linha 3 127:
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
{{VoltarInicio}}</td>
    </tr>
</table></center>


== ListarNotasFiscais ==
<center><table class="mw-collapsible mw-collapsed wikitable" width="95%">
<p align=“justify”><i>
    <tr>
</i></p>
        <td bgcolor="#6E6E6E" align="rigth" style="padding: 8px 20px;><font color="#FFFFFF"><b>ListarNotasFiscais</b></font></td>
 
    </tr>
*<b>Parâmetros:</b><br>
    <tr>
        <td><p align="justify" style="margin-left: 0.12in; text-indent: 0.25in; margin-bottom: 0.00in; font-weight: normal; line-height: 50%;"><b>Parâmetros:</b></p><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*pin  
*pin  
Linha 3 153: Linha 3 176:
** Tipo: Date
** Tipo: Date
}}
}}
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
<b>Retorno:</b><br/>
<b>Retornos:</b><br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
&nbsp;&nbsp;&nbsp;Se sucesso:<br/>
 
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno SOAP:<br/>
*<b>Distribuição das Tags XML:</b><br>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*<cadastrarNotasFiscais>
*<cadastrarNotasFiscais>
Linha 3 211: Linha 3 234:
**</notasFiscais>
**</notasFiscais>
*</cadastrarNotasFiscais>
*</cadastrarNotasFiscais>
}}<br>
}}
*<b>Distribuição das Tags Json:</b><br>
 
<p align="justify" style="margin-left: 0.32in; text-indent: 0.45in; margin-bottom: 0.08in; font-weight: normal; line-height: 150%;"><br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Exemplo de retorno REST:<br/>
{{#tree: minExpandLevel=2 |
{{#tree: minExpandLevel=2 |
*{
*{
Linha 3 272: Linha 3 297:
<br/>
<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;Se nenhum registro encontrado:<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.<br/>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;A consulta não retornou nenhum registro.</p>
 
{{VoltarInicio}}</td>
    </tr>
</table></center>
<!--
== ListarId ==
== ListarId ==
== LiberarPendentes ==
== LiberarPendentes ==
Linha 3 279: Linha 3 307:
== ListasNFsMultiplasFormasPagamento ==
== ListasNFsMultiplasFormasPagamento ==
== ListarComissoesPorRepresentante ==
== ListarComissoesPorRepresentante ==
-->

Edição atual tal como às 19h28min de 7 de outubro de 2026

Voltar
Integrador > WebServices > IN CadastroNotaFiscal.integrador

Requisição

Métodos

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